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
|
<?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>GimpColorHexEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpColorHexEntry</refname><refpurpose>Widget for entering a color's hex triplet.</refpurpose>
</refnamediv>
<refsynopsisdiv><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>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkEntry">GtkEntry</link>
+----GimpColorHexEntry
</synopsis>
</refsect1>
<refsect1>
<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>
<title>Signal Prototypes</title>
<synopsis>
"<link linkend="GimpColorHexEntry-color-changed">color-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *gimpcolorhexentry,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Widget for entering a color's hex triplet.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpColorHexEntry-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"/>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> :</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"/>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> :</term>
<listitem><simpara> a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</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"/>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> :</term>
<listitem><simpara> a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</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>
<title>Signals</title>
<refsect2><title><anchor id="GimpColorHexEntry-color-changed"/>The "color-changed" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *gimpcolorhexentry,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpcolorhexentry</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|