File: gimpcolorhexentry.xml

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (158 lines) | stat: -rw-r--r-- 7,242 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="GimpColorHexEntry">
<refmeta>
<refentrytitle id="top_of_page">GimpColorHexEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GimpColorHexEntry</refname>
<refpurpose>Widget for entering a color's hex triplet.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>

<synopsis>



            <link linkend="GimpColorHexEntry-struct">GimpColorHexEntry</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-color-hex-entry-new">gimp_color_hex_entry_new</link>        (void);
<link linkend="void">void</link>        <link linkend="gimp-color-hex-entry-set-color">gimp_color_hex_entry_set_color</link>  (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="void">void</link>        <link linkend="gimp-color-hex-entry-get-color">gimp_color_hex_entry_get_color</link>  (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
                                             <link linkend="GimpRGB">GimpRGB</link> *color);

</synopsis>
</refsynopsisdiv>

<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkEntry">GtkEntry</link>
                           +----GimpColorHexEntry
</synopsis>

</refsect1>



<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpColorHexEntry implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkEditable">GtkEditable</link> and  <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>

</refsect1>



<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>

&quot;<link linkend="GimpColorHexEntry-color-changed">color-changed</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *gimpcolorhexentry,
                                            <link linkend="gpointer">gpointer</link>           user_data)              : Run first
</synopsis>
</refsect1>


<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
Widget for entering a color's hex triplet.
</para>
</refsect1>

<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpColorHexEntry-struct" role="struct"/>GimpColorHexEntry</title>
<indexterm><primary>GimpColorHexEntry</primary></indexterm><programlisting>typedef struct _GimpColorHexEntry GimpColorHexEntry;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-hex-entry-new" role="function" condition="since:GIMP 2.2"/>gimp_color_hex_entry_new ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_color_hex_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_color_hex_entry_new        (void);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget

</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-hex-entry-set-color" role="function" condition="since:GIMP 2.2"/>gimp_color_hex_entry_set_color ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_color_hex_entry_set_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_hex_entry_set_color  (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Sets the color displayed by a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link>. If the new color
is different to the previously set color, the "color_changed"
signal is emitted.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
<listitem><simpara> pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-hex-entry-get-color" role="function" condition="since:GIMP 2.2"/>gimp_color_hex_entry_get_color ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_color_hex_entry_get_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_hex_entry_get_color  (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Retrieves the color value displayed by a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
<listitem><simpara> pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>

</refsect1>

<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpColorHexEntry-color-changed"/>The &quot;color-changed&quot; signal</title>
<indexterm><primary>GimpColorHexEntry::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *gimpcolorhexentry,
                                            <link linkend="gpointer">gpointer</link>           user_data)              : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gimpcolorhexentry</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>