← Back to branch summary

~ubuntu-branches/ubuntu/utopic/xfce4-panel/utopic

« back to all changes in this revision

Viewing changes to docs/references/html/XfceArrowButton.html

  • Committer: Package Import Robot
  • Author(s): Jackson Doak
  • Date: 2014-02-16 14:34:33 UTC
  • mto: (4.1.8 experimental)
  • mto: This revision was merged to the branch mainline in revision 74.
  • Revision ID: package-import@ubuntu.com-20140216143433-p8txgs80qz1ybqns
Tags: upstream-4.11.0
Import upstream version 4.11.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/references/html/XfceArrowButton.html
49
49
#include <libxfce4panel/libxfce4panel.h>
50
50
 
51
51
                    <a class="link" href="XfceArrowButton.html#XfceArrowButton-struct" title="XfceArrowButton">XfceArrowButton</a>;
52
 
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="XfceArrowButton.html#xfce-arrow-button-new" title="xfce_arrow_button_new ()">xfce_arrow_button_new</a>               (<em class="parameter"><code><span class="type">GtkArrowType</span> arrow_type</code></em>);
53
 
<span class="returnvalue">GtkArrowType</span>        <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>);
 
52
<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>);
 
53
<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>);
54
54
<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>,
55
 
                                                         <em class="parameter"><code><span class="type">GtkArrowType</span> arrow_type</code></em>);
56
 
<span class="returnvalue">gboolean</span>            <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>);
 
55
                                                         <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>);
 
56
<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>);
57
57
<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>,
58
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> blinking</code></em>);
 
58
                                                         <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>);
59
59
</pre>
60
60
</div>
61
61
<div class="refsect1">
62
62
<a name="XfceArrowButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
63
63
<pre class="synopsis">
64
 
  GObject
65
 
   +----GInitiallyUnowned
66
 
         +----GtkObject
67
 
               +----GtkWidget
68
 
                     +----GtkContainer
69
 
                           +----GtkBin
70
 
                                 +----GtkButton
71
 
                                       +----GtkToggleButton
 
64
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
65
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
66
         +----<a href="../gtk2/GtkObject.html">GtkObject</a>
 
67
               +----<a href="http://developer.gnome.org/gtk2/GtkWidget.html">GtkWidget</a>
 
68
                     +----<a href="http://developer.gnome.org/gtk2/GtkContainer.html">GtkContainer</a>
 
69
                           +----<a href="http://developer.gnome.org/gtk2/GtkBin.html">GtkBin</a>
 
70
                                 +----<a href="http://developer.gnome.org/gtk2/GtkButton.html">GtkButton</a>
 
71
                                       +----<a href="http://developer.gnome.org/gtk2/GtkToggleButton.html">GtkToggleButton</a>
72
72
                                             +----XfceArrowButton
73
73
</pre>
74
74
</div>
76
76
<a name="XfceArrowButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
77
77
<p>
78
78
XfceArrowButton implements
79
 
 AtkImplementorIface,  GtkBuildable and  GtkActivatable.</p>
 
79
 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>
80
80
</div>
81
81
<div class="refsect1">
82
82
<a name="XfceArrowButton.properties"></a><h2>Properties</h2>
83
83
<pre class="synopsis">
84
 
  "<a class="link" href="XfceArrowButton.html#XfceArrowButton--arrow-type" title='The "arrow-type" property'>arrow-type</a>"               <span class="type">GtkArrowType</span>          : Read / Write
 
84
  "<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
85
85
</pre>
86
86
</div>
87
87
<div class="refsect1">
88
88
<a name="XfceArrowButton.signals"></a><h2>Signals</h2>
89
89
<pre class="synopsis">
90
 
  "<a class="link" href="XfceArrowButton.html#XfceArrowButton-arrow-type-changed" title='The "arrow-type-changed" signal'>arrow-type-changed</a>"                             : <code class="literal">Run Last</code>
 
90
  "<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>
91
91
</pre>
92
92
</div>
93
93
<div class="refsect1">
96
96
Toggle button with (optional) arrow. The arrow direction will be
97
97
inverted when the button is toggled.
98
98
Since 4.8 it is also possible to make the button blink and pack additional
99
 
widgets in the button, using <code class="function">gtk_container_add()</code>.
 
99
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>.
100
100
</p>
101
101
</div>
102
102
<div class="refsect1">
112
112
<hr>
113
113
<div class="refsect2">
114
114
<a name="xfce-arrow-button-new"></a><h3>xfce_arrow_button_new ()</h3>
115
 
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         xfce_arrow_button_new               (<em class="parameter"><code><span class="type">GtkArrowType</span> arrow_type</code></em>);</pre>
 
115
<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>
116
116
<p>
117
117
Creates a new <a class="link" href="XfceArrowButton.html" title="XfceArrowButton"><span class="type">XfceArrowButton</span></a> widget.
118
118
</p>
125
125
<tr>
126
126
<td><p><span class="term"><em class="parameter"><code>arrow_type</code></em> :</span></p></td>
127
127
<td>
128
 
<span class="type">GtkArrowType</span> for the arrow button</td>
 
128
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> for the arrow button</td>
129
129
</tr>
130
130
<tr>
131
131
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137
137
<hr>
138
138
<div class="refsect2">
139
139
<a name="xfce-arrow-button-get-arrow-type"></a><h3>xfce_arrow_button_get_arrow_type ()</h3>
140
 
<pre class="programlisting"><span class="returnvalue">GtkArrowType</span>        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>
 
140
<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>
141
141
<p>
142
142
Returns the value of the ::arrow-type property.
143
143
</p>
154
154
</tr>
155
155
<tr>
156
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
157
 
<td>the <span class="type">GtkArrowType</span> of <em class="parameter"><code>button</code></em>.</td>
 
157
<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>
158
158
</tr>
159
159
</tbody>
160
160
</table></div>
163
163
<div class="refsect2">
164
164
<a name="xfce-arrow-button-set-arrow-type"></a><h3>xfce_arrow_button_set_arrow_type ()</h3>
165
165
<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>,
166
 
                                                         <em class="parameter"><code><span class="type">GtkArrowType</span> arrow_type</code></em>);</pre>
 
166
                                                         <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>
167
167
<p>
168
168
Sets the arrow type for <em class="parameter"><code>button</code></em>.
169
169
</p>
180
180
</tr>
181
181
<tr>
182
182
<td><p><span class="term"><em class="parameter"><code>arrow_type</code></em> :</span></p></td>
183
 
<td>a valid  <span class="type">GtkArrowType</span>
 
183
<td>a valid  <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>
184
184
</td>
185
185
</tr>
186
186
</tbody>
189
189
<hr>
190
190
<div class="refsect2">
191
191
<a name="xfce-arrow-button-get-blinking"></a><h3>xfce_arrow_button_get_blinking ()</h3>
192
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>
 
192
<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>
193
193
<p>
194
194
Whether the button is blinking. If the blink timeout is finished
195
 
and the button is still highlighted, this functions returns <code class="literal">FALSE</code>.
 
195
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>.
196
196
</p>
197
197
<div class="variablelist"><table border="0" class="variablelist">
198
198
<colgroup>
208
208
<tr>
209
209
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210
210
<td>
211
 
<code class="literal">TRUE</code> when <em class="parameter"><code>button</code></em> is blinking.</td>
 
211
<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>
212
212
</tr>
213
213
</tbody>
214
214
</table></div>
218
218
<div class="refsect2">
219
219
<a name="xfce-arrow-button-set-blinking"></a><h3>xfce_arrow_button_set_blinking ()</h3>
220
220
<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>,
221
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> blinking</code></em>);</pre>
 
221
                                                         <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>
222
222
<p>
223
223
Make the button blink.
224
224
</p>
236
236
<tr>
237
237
<td><p><span class="term"><em class="parameter"><code>blinking</code></em> :</span></p></td>
238
238
<td>
239
 
<code class="literal">TRUE</code> when the button should start blinking, <code class="literal">FALSE</code> to
 
239
<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
240
240
stop the blinking.</td>
241
241
</tr>
242
242
</tbody>
248
248
<a name="XfceArrowButton.property-details"></a><h2>Property Details</h2>
249
249
<div class="refsect2">
250
250
<a name="XfceArrowButton--arrow-type"></a><h3>The <code class="literal">"arrow-type"</code> property</h3>
251
 
<pre class="programlisting">  "arrow-type"               <span class="type">GtkArrowType</span>          : Read / Write</pre>
 
251
<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>
252
252
<p>
253
253
The arrow type of the button. This value also determines the direction
254
254
of the popup menu.
261
261
<div class="refsect2">
262
262
<a name="XfceArrowButton-arrow-type-changed"></a><h3>The <code class="literal">"arrow-type-changed"</code> signal</h3>
263
263
<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,
264
 
                                                        <span class="type">GtkArrowType</span>     type,
265
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
264
                                                        <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>     type,
 
265
                                                        <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>
266
266
<p>
267
267
Emitted when the arrow direction of the menu button changes.
268
268
This value also determines the direction of the popup menu.
279
279
</tr>
280
280
<tr>
281
281
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
282
 
<td>the new <span class="type">GtkArrowType</span> of the button</td>
 
282
<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>
283
283
</tr>
284
284
<tr>
285
285
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>