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
|
<?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="GimpButton">
<refmeta>
<refentrytitle id="top_of_page">GimpButton</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpButton</refname>
<refpurpose>A <link linkend="GtkButton"><type>GtkButton</type></link> with a little extra functionality.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpButton-struct">GimpButton</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-button-new">gimp_button_new</link> (void);
<link linkend="void">void</link> <link linkend="gimp-button-extended-clicked">gimp_button_extended_clicked</link> (<link linkend="GimpButton">GimpButton</link> *button,
<link linkend="GdkModifierType">GdkModifierType</link> state);
</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>
+----GimpButton
+----<link linkend="GimpColorButton">GimpColorButton</link>
</synopsis>
</refsect1>
<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpButton implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpButton-extended-clicked">extended-clicked</link>"
<link linkend="void">void</link> user_function (<link linkend="GimpButton">GimpButton</link> *gimpbutton,
<link linkend="GdkModifierType">GdkModifierType</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="GimpButton"><type>GimpButton</type></link> adds an extra signal to the <link linkend="GtkButton"><type>GtkButton</type></link> widget that allows
to distinguish a normal click from a click that was performed with
modifier keys pressed.
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpButton-struct" role="struct"/>GimpButton</title>
<indexterm><primary>GimpButton</primary></indexterm><programlisting>typedef struct _GimpButton GimpButton;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-button-new" role="function"/>gimp_button_new ()</title>
<indexterm><primary>gimp_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_button_new (void);</programlisting>
<para>
Creates a new <link linkend="GimpButton"><type>GimpButton</type></link> widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpButton"><type>GimpButton</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-button-extended-clicked" role="function"/>gimp_button_extended_clicked ()</title>
<indexterm><primary>gimp_button_extended_clicked</primary></indexterm><programlisting><link linkend="void">void</link> gimp_button_extended_clicked (<link linkend="GimpButton">GimpButton</link> *button,
<link linkend="GdkModifierType">GdkModifierType</link> state);</programlisting>
<para>
Emits the button's "extended_clicked" signal.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> a <link linkend="GimpButton"><type>GimpButton</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> a state as found in <link linkend="GdkEventButton-"><type>GdkEventButton-</type></link>>state, e.g. <link linkend="GDK-SHIFT-MASK:CAPS"><type>GDK_SHIFT_MASK</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpButton-extended-clicked"/>The "extended-clicked" signal</title>
<indexterm><primary>GimpButton::extended-clicked</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpButton">GimpButton</link> *gimpbutton,
<link linkend="GdkModifierType">GdkModifierType</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpbutton</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>the state of modifier keys when the button was clicked
</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>
|
