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
|
<?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="GimpPickButton">
<refmeta>
<refentrytitle id="top_of_page">GimpPickButton</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpPickButton</refname>
<refpurpose>Widget to pick a color from screen.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpPickButton-struct">GimpPickButton</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-pick-button-new">gimp_pick_button_new</link> (void);
</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="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkButton">GtkButton</link>
+----GimpPickButton
</synopsis>
</refsect1>
<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpPickButton implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpPickButton-color-picked">color-picked</link>"
<link linkend="void">void</link> user_function (<link linkend="GimpPickButton">GimpPickButton</link> *gimppickbutton,
<link linkend="gpointer">gpointer</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
<link linkend="GimpPickButton"><type>GimpPickButton</type></link> is a specialized button. When clicked, it changes the
cursor to a color-picker pipette and allows the user to pick a color
from any point on the screen.
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpPickButton-struct" role="struct"/>GimpPickButton</title>
<indexterm><primary>GimpPickButton</primary></indexterm><programlisting>typedef struct _GimpPickButton GimpPickButton;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-pick-button-new" role="function"/>gimp_pick_button_new ()</title>
<indexterm><primary>gimp_pick_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_pick_button_new (void);</programlisting>
<para>
Creates a new <link linkend="GimpPickButton"><type>GimpPickButton</type></link> widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpPickButton"><type>GimpPickButton</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpPickButton-color-picked"/>The "color-picked" signal</title>
<indexterm><primary>GimpPickButton::color-picked</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPickButton">GimpPickButton</link> *gimppickbutton,
<link linkend="gpointer">gpointer</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimppickbutton</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> structure that holds the picked color
</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>
|
