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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfceArrowButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
<link rel="up" href="libxfce4panel-widgets.html" title="Part III. Additional Widgets">
<link rel="prev" href="libxfce4panel-widgets.html" title="Part III. Additional Widgets">
<link rel="next" href="XfceHVBox.html" title="XfceHVBox">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libxfce4panel-widgets.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfce4panel-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libxfce4panel Reference Manual</th>
<td><a accesskey="n" href="XfceHVBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#XfceArrowButton.synopsis" class="shortcut">Top</a>
|
<a href="#XfceArrowButton.description" class="shortcut">Description</a>
|
<a href="#XfceArrowButton.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#XfceArrowButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#XfceArrowButton.properties" class="shortcut">Properties</a>
|
<a href="#XfceArrowButton.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="XfceArrowButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XfceArrowButton.top_of_page"></a>XfceArrowButton</span></h2>
<p>XfceArrowButton — Toggle button with arrow</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="XfceArrowButton.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libxfce4panel/libxfce4panel.h>
<a class="link" href="XfceArrowButton.html#XfceArrowButton-struct" title="XfceArrowButton">XfceArrowButton</a>;
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="XfceArrowButton.html#xfce-arrow-button-new" title="xfce_arrow_button_new ()">xfce_arrow_button_new</a> (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> arrow_type</code></em>);
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="returnvalue">GtkArrowType</span></a> <a class="link" href="XfceArrowButton.html#xfce-arrow-button-get-arrow-type" title="xfce_arrow_button_get_arrow_type ()">xfce_arrow_button_get_arrow_type</a> (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>);
<span class="returnvalue">void</span> <a class="link" href="XfceArrowButton.html#xfce-arrow-button-set-arrow-type" title="xfce_arrow_button_set_arrow_type ()">xfce_arrow_button_set_arrow_type</a> (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> arrow_type</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="XfceArrowButton.html#xfce-arrow-button-get-blinking" title="xfce_arrow_button_get_blinking ()">xfce_arrow_button_get_blinking</a> (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>);
<span class="returnvalue">void</span> <a class="link" href="XfceArrowButton.html#xfce-arrow-button-set-blinking" title="xfce_arrow_button_set_blinking ()">xfce_arrow_button_set_blinking</a> (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blinking</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="XfceArrowButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
+----<a href="http://developer.gnome.org/gtk2/GtkWidget.html">GtkWidget</a>
+----<a href="http://developer.gnome.org/gtk2/GtkContainer.html">GtkContainer</a>
+----<a href="http://developer.gnome.org/gtk2/GtkBin.html">GtkBin</a>
+----<a href="http://developer.gnome.org/gtk2/GtkButton.html">GtkButton</a>
+----<a href="http://developer.gnome.org/gtk2/GtkToggleButton.html">GtkToggleButton</a>
+----XfceArrowButton
</pre>
</div>
<div class="refsect1">
<a name="XfceArrowButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XfceArrowButton implements
AtkImplementorIface, <a href="http://developer.gnome.org/gtk2/GtkBuildable.html">GtkBuildable</a> and <a href="http://developer.gnome.org/gtk2/GtkActivatable.html">GtkActivatable</a>.</p>
</div>
<div class="refsect1">
<a name="XfceArrowButton.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="XfceArrowButton.html#XfceArrowButton--arrow-type" title='The "arrow-type" property'>arrow-type</a>" <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="XfceArrowButton.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="XfceArrowButton.html#XfceArrowButton-arrow-type-changed" title='The "arrow-type-changed" signal'>arrow-type-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="XfceArrowButton.description"></a><h2>Description</h2>
<p>
Toggle button with (optional) arrow. The arrow direction will be
inverted when the button is toggled.
Since 4.8 it is also possible to make the button blink and pack additional
widgets in the button, using <a href="http://developer.gnome.org/gtk2/GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="XfceArrowButton.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="XfceArrowButton-struct"></a><h3>XfceArrowButton</h3>
<pre class="programlisting">typedef struct _XfceArrowButton XfceArrowButton;</pre>
<p>
This struct contain private data only and should be accessed by
the functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-arrow-button-new"></a><h3>xfce_arrow_button_new ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * xfce_arrow_button_new (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> arrow_type</code></em>);</pre>
<p>
Creates a new <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> widget.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>arrow_type</code></em> :</span></p></td>
<td>
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> for the arrow button</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> widget.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-arrow-button-get-arrow-type"></a><h3>xfce_arrow_button_get_arrow_type ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="returnvalue">GtkArrowType</span></a> xfce_arrow_button_get_arrow_type (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>);</pre>
<p>
Returns the value of the ::arrow-type property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td>a <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> of <em class="parameter"><code>button</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-arrow-button-set-arrow-type"></a><h3>xfce_arrow_button_set_arrow_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfce_arrow_button_set_arrow_type (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> arrow_type</code></em>);</pre>
<p>
Sets the arrow type for <em class="parameter"><code>button</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td>a <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arrow_type</code></em> :</span></p></td>
<td>a valid <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-arrow-button-get-blinking"></a><h3>xfce_arrow_button_get_blinking ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> xfce_arrow_button_get_blinking (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>);</pre>
<p>
Whether the button is blinking. If the blink timeout is finished
and the button is still highlighted, this functions returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td>a <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when <em class="parameter"><code>button</code></em> is blinking.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.8</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-arrow-button-set-blinking"></a><h3>xfce_arrow_button_set_blinking ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfce_arrow_button_set_blinking (<em class="parameter"><code><a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blinking</code></em>);</pre>
<p>
Make the button blink.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td>a <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>blinking</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the button should start blinking, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to
stop the blinking.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.8</p>
</div>
</div>
<div class="refsect1">
<a name="XfceArrowButton.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XfceArrowButton--arrow-type"></a><h3>The <code class="literal">"arrow-type"</code> property</h3>
<pre class="programlisting"> "arrow-type" <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> : Read / Write</pre>
<p>
The arrow type of the button. This value also determines the direction
of the popup menu.
</p>
<p>Default value: GTK_ARROW_UP</p>
</div>
</div>
<div class="refsect1">
<a name="XfceArrowButton.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="XfceArrowButton-arrow-type-changed"></a><h3>The <code class="literal">"arrow-type-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> *button,
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> type,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when the arrow direction of the menu button changes.
This value also determines the direction of the popup menu.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td>the object which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the new <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> of the button</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|