← Back to branch summary

~ubuntu-branches/ubuntu/vivid/xfce4-panel/vivid

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Lionel Le Folgoc
  • Date: 2013-07-07 10:54:09 UTC
  • mfrom: (4.2.15 sid)
  • Revision ID: package-import@ubuntu.com-20130707105409-nam2sh68h1reuiv4
Tags: 4.10.1-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/patches:
    + xubuntu_migrate-tasklist-separator.patch: added, try to be smart and
      work around the non-expandable tasklist plugin from 4.10 by setting
      as expandable the separator next to it (should work with the default
      panel layouts from Xubuntu, Mythbuntu and UbuntuStudio).
    + xubuntu_add-calendar-popup-to-clock-plugin.patch: added, taken from
      upstream git to show a calendar when left-clicking on the clock plugin
      (so we don't need orage/xfce4-datetime-plugin for this feature only).

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/references/html/XfceArrowButton.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>XfceArrowButton</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
8
8
<link rel="up" href="libxfce4panel-widgets.html" title="Part III. Additional Widgets">
9
9
<link rel="prev" href="libxfce4panel-widgets.html" title="Part III. Additional Widgets">
49
49
#include &lt;libxfce4panel/libxfce4panel.h&gt;
50
50
 
51
51
                    <a class="link" href="XfceArrowButton.html#XfceArrowButton-struct" title="XfceArrowButton">XfceArrowButton</a>;
52
 
<a href="http://library.gnome.org/devel/gtk3/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://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> arrow_type</code></em>);
53
 
<a href="http://library.gnome.org/devel/gtk3/gtk-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>);
 
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><a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> arrow_type</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
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
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>);
64
64
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
65
65
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
66
66
         +----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
67
 
               +----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
68
 
                     +----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
69
 
                           +----<a href="http://library.gnome.org/devel/gtk3/GtkBin.html">GtkBin</a>
70
 
                                 +----<a href="http://library.gnome.org/devel/gtk3/GtkButton.html">GtkButton</a>
71
 
                                       +----<a href="http://library.gnome.org/devel/gtk3/GtkToggleButton.html">GtkToggleButton</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,  <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk3/GtkActivatable.html">GtkActivatable</a>.</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>"               <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>          : 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">
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 <a href="http://library.gnome.org/devel/gtk3/GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a>.
 
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"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_arrow_button_new               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> 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>
119
 
<div class="variablelist"><table border="0">
 
119
<div class="variablelist"><table border="0" class="variablelist">
 
120
<colgroup>
120
121
<col align="left" valign="top">
 
122
<col>
 
123
</colgroup>
121
124
<tbody>
122
125
<tr>
123
126
<td><p><span class="term"><em class="parameter"><code>arrow_type</code></em> :</span></p></td>
124
127
<td>
125
 
<a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> 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>
126
129
</tr>
127
130
<tr>
128
131
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
134
137
<hr>
135
138
<div class="refsect2">
136
139
<a name="xfce-arrow-button-get-arrow-type"></a><h3>xfce_arrow_button_get_arrow_type ()</h3>
137
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/gtk-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>
 
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>
138
141
<p>
139
142
Returns the value of the ::arrow-type property.
140
143
</p>
141
 
<div class="variablelist"><table border="0">
 
144
<div class="variablelist"><table border="0" class="variablelist">
 
145
<colgroup>
142
146
<col align="left" valign="top">
 
147
<col>
 
148
</colgroup>
143
149
<tbody>
144
150
<tr>
145
151
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
148
154
</tr>
149
155
<tr>
150
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
151
 
<td>the <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> 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>
152
158
</tr>
153
159
</tbody>
154
160
</table></div>
157
163
<div class="refsect2">
158
164
<a name="xfce-arrow-button-set-arrow-type"></a><h3>xfce_arrow_button_set_arrow_type ()</h3>
159
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>,
160
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> 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>
161
167
<p>
162
168
Sets the arrow type for <em class="parameter"><code>button</code></em>.
163
169
</p>
164
 
<div class="variablelist"><table border="0">
 
170
<div class="variablelist"><table border="0" class="variablelist">
 
171
<colgroup>
165
172
<col align="left" valign="top">
 
173
<col>
 
174
</colgroup>
166
175
<tbody>
167
176
<tr>
168
177
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
171
180
</tr>
172
181
<tr>
173
182
<td><p><span class="term"><em class="parameter"><code>arrow_type</code></em> :</span></p></td>
174
 
<td>a valid  <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>
 
183
<td>a valid  <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>
175
184
</td>
176
185
</tr>
177
186
</tbody>
185
194
Whether the button is blinking. If the blink timeout is finished
186
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>.
187
196
</p>
188
 
<div class="variablelist"><table border="0">
 
197
<div class="variablelist"><table border="0" class="variablelist">
 
198
<colgroup>
189
199
<col align="left" valign="top">
 
200
<col>
 
201
</colgroup>
190
202
<tbody>
191
203
<tr>
192
204
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
210
222
<p>
211
223
Make the button blink.
212
224
</p>
213
 
<div class="variablelist"><table border="0">
 
225
<div class="variablelist"><table border="0" class="variablelist">
 
226
<colgroup>
214
227
<col align="left" valign="top">
 
228
<col>
 
229
</colgroup>
215
230
<tbody>
216
231
<tr>
217
232
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
233
248
<a name="XfceArrowButton.property-details"></a><h2>Property Details</h2>
234
249
<div class="refsect2">
235
250
<a name="XfceArrowButton--arrow-type"></a><h3>The <code class="literal">"arrow-type"</code> property</h3>
236
 
<pre class="programlisting">  "arrow-type"               <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>          : 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>
237
252
<p>
238
253
The arrow type of the button. This value also determines the direction
239
254
of the popup menu.
246
261
<div class="refsect2">
247
262
<a name="XfceArrowButton-arrow-type-changed"></a><h3>The <code class="literal">"arrow-type-changed"</code> signal</h3>
248
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,
249
 
                                                        <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>     type,
 
264
                                                        <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a>     type,
250
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>
251
266
<p>
252
267
Emitted when the arrow direction of the menu button changes.
253
268
This value also determines the direction of the popup menu.
254
269
</p>
255
 
<div class="variablelist"><table border="0">
 
270
<div class="variablelist"><table border="0" class="variablelist">
 
271
<colgroup>
256
272
<col align="left" valign="top">
 
273
<col>
 
274
</colgroup>
257
275
<tbody>
258
276
<tr>
259
277
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
261
279
</tr>
262
280
<tr>
263
281
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
264
 
<td>the new <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> 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>
265
283
</tr>
266
284
<tr>
267
285
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>