← Back to branch summary

~ubuntu-branches/debian/experimental/xfce4-panel/experimental

« back to all changes in this revision

Viewing changes to docs/API/xml/xfce-itembar.xml

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez, Lionel Le Folgoc, Yves-Alexis Perez
  • Date: 2011-02-06 18:10:07 UTC
  • mfrom: (1.3.13 upstream) (5.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20110206181007-vpw5z3xnm3hdvybx
Tags: 4.8.1-1
https://launchpad.net/bugs/586012
https://launchpad.net/bugs/53897
http://bugs.debian.org/432914
https://launchpad.net/bugs/176174
https://launchpad.net/bugs/420187
http://bugs.debian.org/480380
[ Lionel Le Folgoc ]
* New upstream bugfix release.
* debian/control:
  - refreshed (b-)deps for this new major release
  - add myself to Uploaders
  - bump Standards-Version to 3.9.1.
* debian/NEWS: dropped, unneeded.
* debian/xfce4-panel.shlibs: refreshed, bump to (>= 4.7.2).
* debian/xfce4-panel.lintian-overrides: refreshed, new lib name.
* debian/xfce4-panel.preinst: added, handles removal of old conffiles.
* debian/xfce4-panel.postinst: explicitly set -e.
* debian/*.install: refreshed.
* debian/rules:
  - call dpkg-buildflags
  - dropped rc files mangling as they don't exist anymore
  - updated removal of *.{l,}a files.
  - drop overrides for dh_auto_{configure,clean}, obsolete.
* debian/xfce4-panel.{preinst,postinst,prerm}: use dpkg-maintscript-helper
  to remove pre-xfconf config files.
* Bugs fixed by 4.7.x/4.8.x series:
  - rgba support                                                  lp: #586012
  - disappearing menus                                             lp: #53897
  - xrandr support                               lp: #176174, Closes: #432914
  - Fails to reap children, creating zombies                      lp: #420187
  - DND of desktop-files on the panel to create new launchers Closes: #480380
* Bumped shlibs to >= 4.7.7, abi break for external plugins.

[ Yves-Alexis Perez ]
* New upstream development release
* debian/xfce4-panel.install:
  - install wrapper and migrate tools in xfce4-panel package
  - update plugins paths
* debian/rules:
  - update path when removing .a/.la files for plugins.
  - add hardening flags to {C,LD}FLAGS
* debian/control:
  - add build-dep on hardening-includes
  - update build-dep on garcon to 0.1.4.
* debian/copyright updated for new release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/API/xml/xfce-itembar.xml
1
 
<refentry id="XfceItembar">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="XfceItembar.top_of_page">XfceItembar</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>XfceItembar</refname>
10
 
<refpurpose>Container widget with configurable orientation.</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
 
</refnamediv>
13
 
 
14
 
<refsynopsisdiv id="XfceItembar.synopsis" role="synopsis">
15
 
<title role="synopsis.title">Synopsis</title>
16
 
 
17
 
<synopsis>
18
 
 
19
 
#include &lt;libxfce4panel/libxfce4panel.h&gt;
20
 
 
21
 
                    <link linkend="XfceItembar-struct">XfceItembar</link>;
22
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="xfce-itembar-new">xfce_itembar_new</link>                    (<link linkend="GtkOrientation">GtkOrientation</link> orientation);
23
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-set-orientation">xfce_itembar_set_orientation</link>        (<link linkend="XfceItembar">XfceItembar</link> *itembar,
24
 
                                                         <link linkend="GtkOrientation">GtkOrientation</link> orientation);
25
 
<link linkend="GtkOrientation">GtkOrientation</link>      <link linkend="xfce-itembar-get-orientation">xfce_itembar_get_orientation</link>        (<link linkend="XfceItembar">XfceItembar</link> *itembar);
26
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-insert">xfce_itembar_insert</link>                 (<link linkend="XfceItembar">XfceItembar</link> *itembar,
27
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item,
28
 
                                                         <link linkend="gint">gint</link> position);
29
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-append">xfce_itembar_append</link>                 (<link linkend="XfceItembar">XfceItembar</link> *itembar,
30
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);
31
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-prepend">xfce_itembar_prepend</link>                (<link linkend="XfceItembar">XfceItembar</link> *itembar,
32
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);
33
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-reorder-child">xfce_itembar_reorder_child</link>          (<link linkend="XfceItembar">XfceItembar</link> *itembar,
34
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item,
35
 
                                                         <link linkend="gint">gint</link> position);
36
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-set-child-expand">xfce_itembar_set_child_expand</link>       (<link linkend="XfceItembar">XfceItembar</link> *itembar,
37
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item,
38
 
                                                         <link linkend="gboolean">gboolean</link> expand);
39
 
<link linkend="gboolean">gboolean</link>            <link linkend="xfce-itembar-get-child-expand">xfce_itembar_get_child_expand</link>       (<link linkend="XfceItembar">XfceItembar</link> *itembar,
40
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);
41
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-set-allow-expand">xfce_itembar_set_allow_expand</link>       (<link linkend="XfceItembar">XfceItembar</link> *itembar,
42
 
                                                         <link linkend="gboolean">gboolean</link> allow);
43
 
<link linkend="gint">gint</link>                <link linkend="xfce-itembar-get-n-items">xfce_itembar_get_n_items</link>            (<link linkend="XfceItembar">XfceItembar</link> *itembar);
44
 
<link linkend="gint">gint</link>                <link linkend="xfce-itembar-get-item-index">xfce_itembar_get_item_index</link>         (<link linkend="XfceItembar">XfceItembar</link> *itembar,
45
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);
46
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="xfce-itembar-get-nth-item">xfce_itembar_get_nth_item</link>           (<link linkend="XfceItembar">XfceItembar</link> *itembar,
47
 
                                                         <link linkend="gint">gint</link> n);
48
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-raise-event-window">xfce_itembar_raise_event_window</link>     (<link linkend="XfceItembar">XfceItembar</link> *itembar);
49
 
<link linkend="void">void</link>                <link linkend="xfce-itembar-lower-event-window">xfce_itembar_lower_event_window</link>     (<link linkend="XfceItembar">XfceItembar</link> *itembar);
50
 
<link linkend="gboolean">gboolean</link>            <link linkend="xfce-itembar-event-window-is-raised">xfce_itembar_event_window_is_raised</link> (<link linkend="XfceItembar">XfceItembar</link> *itembar);
51
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="xfce-itembar-get-item-at-point">xfce_itembar_get_item_at_point</link>      (<link linkend="XfceItembar">XfceItembar</link> *itembar,
52
 
                                                         <link linkend="gint">gint</link> x,
53
 
                                                         <link linkend="gint">gint</link> y);
54
 
<link linkend="gint">gint</link>                <link linkend="xfce-itembar-get-drop-index">xfce_itembar_get_drop_index</link>         (<link linkend="XfceItembar">XfceItembar</link> *itembar,
55
 
                                                         <link linkend="gint">gint</link> x,
56
 
                                                         <link linkend="gint">gint</link> y);
57
 
</synopsis>
58
 
</refsynopsisdiv>
59
 
 
60
 
<refsect1 id="XfceItembar.object-hierarchy" role="object_hierarchy">
61
 
<title role="object_hierarchy.title">Object Hierarchy</title>
62
 
<synopsis>
63
 
  <link linkend="GObject">GObject</link>
64
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
65
 
         +----<link linkend="GtkObject">GtkObject</link>
66
 
               +----<link linkend="GtkWidget">GtkWidget</link>
67
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
68
 
                           +----XfceItembar
69
 
</synopsis>
70
 
 
71
 
</refsect1>
72
 
 
73
 
 
74
 
 
75
 
<refsect1 id="XfceItembar.implemented-interfaces" role="impl_interfaces">
76
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
77
 
<para>
78
 
XfceItembar implements
79
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
80
 
 
81
 
</refsect1>
82
 
 
83
 
 
84
 
<refsect1 id="XfceItembar.properties" role="properties">
85
 
<title role="properties.title">Properties</title>
86
 
<synopsis>
87
 
  &quot;<link linkend="XfceItembar--orientation">orientation</link>&quot;              <link linkend="GtkOrientation">GtkOrientation</link>        : Read / Write
88
 
</synopsis>
89
 
</refsect1>
90
 
<refsect1 id="XfceItembar.child-properties" role="child_properties">
91
 
<title role="child_properties.title">Child Properties</title>
92
 
<synopsis>
93
 
  &quot;<link linkend="XfceItembar--expand">expand</link>&quot;                   <link linkend="gboolean">gboolean</link>              : Read / Write
94
 
</synopsis>
95
 
</refsect1>
96
 
 
97
 
<refsect1 id="XfceItembar.signals" role="signal_proto">
98
 
<title role="signal_proto.title">Signals</title>
99
 
<synopsis>
100
 
  &quot;<link linkend="XfceItembar-contents-changed">contents-changed</link>&quot;                               : Run First
101
 
  &quot;<link linkend="XfceItembar-orientation-changed">orientation-changed</link>&quot;                            : Run First
102
 
</synopsis>
103
 
</refsect1>
104
 
 
105
 
 
106
 
<refsect1 id="XfceItembar.description" role="desc">
107
 
<title role="desc.title">Description</title>
108
 
<para>
109
 
<link linkend="XfceItembar"><type>XfceItembar</type></link> is a container widget that can hold multiple widgets. The
110
 
orientation of the bar is configurable and can be changed at any time.
111
 
</para>
112
 
</refsect1>
113
 
 
114
 
<refsect1 id="XfceItembar.details" role="details">
115
 
<title role="details.title">Details</title>
116
 
<refsect2 id="XfceItembar-struct" role="struct">
117
 
<title>XfceItembar</title>
118
 
<indexterm zone="XfceItembar-struct"><primary>XfceItembar</primary></indexterm><programlisting>typedef struct _XfceItembar XfceItembar;</programlisting>
119
 
<para>
120
 
The <link linkend="XfceItembar-struct"><type>XfceItembar</type></link> struct contains private data only, and
121
 
should be accessed using the functions below.
122
 
</para></refsect2>
123
 
<refsect2 id="xfce-itembar-new" role="function">
124
 
<title>xfce_itembar_new ()</title>
125
 
<indexterm zone="xfce-itembar-new"><primary>xfce_itembar_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          xfce_itembar_new                    (<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
126
 
<para>
127
 
Creates a new <link linkend="XfceItembar"><type>XfceItembar</type></link> widget.</para>
128
 
<para>
129
 
 
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>orientation</parameter>&nbsp;:</term>
132
 
<listitem><simpara> <link linkend="GtkOrientation"><type>GtkOrientation</type></link> for new itembar.
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> new <link linkend="XfceItembar"><type>XfceItembar</type></link> widget with <parameter>orientation</parameter>.
135
 
</simpara></listitem></varlistentry>
136
 
</variablelist></refsect2>
137
 
<refsect2 id="xfce-itembar-set-orientation" role="function">
138
 
<title>xfce_itembar_set_orientation ()</title>
139
 
<indexterm zone="xfce-itembar-set-orientation"><primary>xfce_itembar_set_orientation</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_set_orientation        (<link linkend="XfceItembar">XfceItembar</link> *itembar,
140
 
                                                         <link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
141
 
<para>
142
 
Set the orienation of <parameter>itembar</parameter>.</para>
143
 
<para>
144
 
 
145
 
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
147
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>orientation</parameter>&nbsp;:</term>
150
 
<listitem><simpara> new <link linkend="GtkOrientation"><type>GtkOrientation</type></link>
151
 
</simpara></listitem></varlistentry>
152
 
</variablelist></refsect2>
153
 
<refsect2 id="xfce-itembar-get-orientation" role="function">
154
 
<title>xfce_itembar_get_orientation ()</title>
155
 
<indexterm zone="xfce-itembar-get-orientation"><primary>xfce_itembar_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link>      xfce_itembar_get_orientation        (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
156
 
<para>
157
 
Return the orientation of the <link linkend="XfceItembar"><type>XfceItembar</type></link>.</para>
158
 
<para>
159
 
 
160
 
</para><variablelist role="params">
161
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
162
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
163
 
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="GtkOrienation"><type>GtkOrienation</type></link> of <parameter>itembar</parameter>.
165
 
</simpara></listitem></varlistentry>
166
 
</variablelist></refsect2>
167
 
<refsect2 id="xfce-itembar-insert" role="function">
168
 
<title>xfce_itembar_insert ()</title>
169
 
<indexterm zone="xfce-itembar-insert"><primary>xfce_itembar_insert</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_insert                 (<link linkend="XfceItembar">XfceItembar</link> *itembar,
170
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item,
171
 
                                                         <link linkend="gint">gint</link> position);</programlisting>
172
 
<para>
173
 
Insert new item at <parameter>position</parameter> on <parameter>itembar</parameter>.</para>
174
 
<para>
175
 
 
176
 
</para><variablelist role="params">
177
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
178
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
179
 
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
181
 
<listitem><simpara> <link linkend="GtkWidget"><type>GtkWidget</type></link> to insert
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><parameter>position</parameter>&nbsp;:</term>
184
 
<listitem><simpara> position for <parameter>item</parameter>
185
 
</simpara></listitem></varlistentry>
186
 
</variablelist></refsect2>
187
 
<refsect2 id="xfce-itembar-append" role="function">
188
 
<title>xfce_itembar_append ()</title>
189
 
<indexterm zone="xfce-itembar-append"><primary>xfce_itembar_append</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_append                 (<link linkend="XfceItembar">XfceItembar</link> *itembar,
190
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
191
 
<para>
192
 
Add a new item at the end of <parameter>itembar</parameter>.</para>
193
 
<para>
194
 
 
195
 
</para><variablelist role="params">
196
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
197
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
200
 
<listitem><simpara> <link linkend="GtkWidget"><type>GtkWidget</type></link> to add
201
 
</simpara></listitem></varlistentry>
202
 
</variablelist></refsect2>
203
 
<refsect2 id="xfce-itembar-prepend" role="function">
204
 
<title>xfce_itembar_prepend ()</title>
205
 
<indexterm zone="xfce-itembar-prepend"><primary>xfce_itembar_prepend</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_prepend                (<link linkend="XfceItembar">XfceItembar</link> *itembar,
206
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
207
 
<para>
208
 
Add a new item at the start of <parameter>itembar</parameter>.</para>
209
 
<para>
210
 
 
211
 
</para><variablelist role="params">
212
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
213
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
216
 
<listitem><simpara> <link linkend="GtkWidget"><type>GtkWidget</type></link> to add
217
 
</simpara></listitem></varlistentry>
218
 
</variablelist></refsect2>
219
 
<refsect2 id="xfce-itembar-reorder-child" role="function">
220
 
<title>xfce_itembar_reorder_child ()</title>
221
 
<indexterm zone="xfce-itembar-reorder-child"><primary>xfce_itembar_reorder_child</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_reorder_child          (<link linkend="XfceItembar">XfceItembar</link> *itembar,
222
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item,
223
 
                                                         <link linkend="gint">gint</link> position);</programlisting>
224
 
<para>
225
 
Move <parameter>item</parameter> to a new position on <parameter>itembar</parameter>.</para>
226
 
<para>
227
 
 
228
 
</para><variablelist role="params">
229
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
230
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
231
 
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
233
 
<listitem><simpara> a child <link linkend="GtkWidget"><type>GtkWidget</type></link> of <parameter>itembar</parameter>
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>position</parameter>&nbsp;:</term>
236
 
<listitem><simpara> new index for <parameter>item</parameter>
237
 
</simpara></listitem></varlistentry>
238
 
</variablelist></refsect2>
239
 
<refsect2 id="xfce-itembar-set-child-expand" role="function">
240
 
<title>xfce_itembar_set_child_expand ()</title>
241
 
<indexterm zone="xfce-itembar-set-child-expand"><primary>xfce_itembar_set_child_expand</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_set_child_expand       (<link linkend="XfceItembar">XfceItembar</link> *itembar,
242
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item,
243
 
                                                         <link linkend="gboolean">gboolean</link> expand);</programlisting>
244
 
<para>
245
 
Sets whether <parameter>item</parameter> should expand when the size of <parameter>itembar</parameter> increases.</para>
246
 
<para>
247
 
 
248
 
</para><variablelist role="params">
249
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
250
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
251
 
</simpara></listitem></varlistentry>
252
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
253
 
<listitem><simpara> a child <link linkend="GtkWidget"><type>GtkWidget</type></link> of <parameter>itembar</parameter>
254
 
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><parameter>expand</parameter>&nbsp;:</term>
256
 
<listitem><simpara> whether to expand the item
257
 
</simpara></listitem></varlistentry>
258
 
</variablelist></refsect2>
259
 
<refsect2 id="xfce-itembar-get-child-expand" role="function">
260
 
<title>xfce_itembar_get_child_expand ()</title>
261
 
<indexterm zone="xfce-itembar-get-child-expand"><primary>xfce_itembar_get_child_expand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            xfce_itembar_get_child_expand       (<link linkend="XfceItembar">XfceItembar</link> *itembar,
262
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
263
 
<para>
264
 
Return if the <link linkend="GtkWidget"><type>GtkWidget</type></link> in the <link linkend="XfceItembar"><type>XfceItembar</type></link> expands when the panel
265
 
is resized.</para>
266
 
<para>
267
 
 
268
 
</para><variablelist role="params">
269
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
270
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
271
 
</simpara></listitem></varlistentry>
272
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
273
 
<listitem><simpara> a child <link linkend="GtkWidget"><type>GtkWidget</type></link> of <parameter>itembar</parameter>
274
 
</simpara></listitem></varlistentry>
275
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>item</parameter> will expand when the size of <parameter>itembar</parameter> increases,
276
 
         otherwise <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
277
 
</simpara></listitem></varlistentry>
278
 
</variablelist></refsect2>
279
 
<refsect2 id="xfce-itembar-set-allow-expand" role="function">
280
 
<title>xfce_itembar_set_allow_expand ()</title>
281
 
<indexterm zone="xfce-itembar-set-allow-expand"><primary>xfce_itembar_set_allow_expand</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_set_allow_expand       (<link linkend="XfceItembar">XfceItembar</link> *itembar,
282
 
                                                         <link linkend="gboolean">gboolean</link> allow);</programlisting>
283
 
<para>
284
 
Set whether the 'expand' child property is honored.
285
 
</para>
286
 
<para>
287
 
See also: <link linkend="xfce-itembar-set-child-expand"><function>xfce_itembar_set_child_expand()</function></link>.</para>
288
 
<para>
289
 
 
290
 
</para><variablelist role="params">
291
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
292
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
293
 
</simpara></listitem></varlistentry>
294
 
<varlistentry><term><parameter>allow</parameter>&nbsp;:</term>
295
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> when the expansion is allowed.
296
 
</simpara></listitem></varlistentry>
297
 
</variablelist></refsect2>
298
 
<refsect2 id="xfce-itembar-get-n-items" role="function">
299
 
<title>xfce_itembar_get_n_items ()</title>
300
 
<indexterm zone="xfce-itembar-get-n-items"><primary>xfce_itembar_get_n_items</primary></indexterm><programlisting><link linkend="gint">gint</link>                xfce_itembar_get_n_items            (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
301
 
<para>
302
 
Return the number of items on a <link linkend="XfceItembar"><type>XfceItembar</type></link>.</para>
303
 
<para>
304
 
 
305
 
</para><variablelist role="params">
306
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
307
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
308
 
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of items on <parameter>itembar</parameter>.
310
 
</simpara></listitem></varlistentry>
311
 
</variablelist></refsect2>
312
 
<refsect2 id="xfce-itembar-get-item-index" role="function">
313
 
<title>xfce_itembar_get_item_index ()</title>
314
 
<indexterm zone="xfce-itembar-get-item-index"><primary>xfce_itembar_get_item_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                xfce_itembar_get_item_index         (<link linkend="XfceItembar">XfceItembar</link> *itembar,
315
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
316
 
<para>
317
 
The index if the child <link linkend="GtkWidget"><type>GtkWidget</type></link> in a <link linkend="XfceItembar"><type>XfceItembar</type></link>.</para>
318
 
<para>
319
 
 
320
 
</para><variablelist role="params">
321
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
322
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
323
 
</simpara></listitem></varlistentry>
324
 
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
325
 
<listitem><simpara> a child <link linkend="GtkWidget"><type>GtkWidget</type></link> of <parameter>itembar</parameter>
326
 
</simpara></listitem></varlistentry>
327
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the index of <parameter>item</parameter> or -1 if <parameter>itembar</parameter> does not contain <parameter>item</parameter>.
328
 
</simpara></listitem></varlistentry>
329
 
</variablelist></refsect2>
330
 
<refsect2 id="xfce-itembar-get-nth-item" role="function">
331
 
<title>xfce_itembar_get_nth_item ()</title>
332
 
<indexterm zone="xfce-itembar-get-nth-item"><primary>xfce_itembar_get_nth_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          xfce_itembar_get_nth_item           (<link linkend="XfceItembar">XfceItembar</link> *itembar,
333
 
                                                         <link linkend="gint">gint</link> n);</programlisting>
334
 
<para>
335
 
Return the <link linkend="GtkWidget"><type>GtkWidget</type></link> inside the <link linkend="XfceItembar"><type>XfceItembar</type></link> with the <parameter>n</parameter><!-- -->'s
336
 
index.</para>
337
 
<para>
338
 
 
339
 
</para><variablelist role="params">
340
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
341
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
342
 
</simpara></listitem></varlistentry>
343
 
<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
344
 
<listitem><simpara> a position on the itembar
345
 
</simpara></listitem></varlistentry>
346
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <parameter>n</parameter><!-- -->'s item on <parameter>itembar</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the
347
 
itembar does not contain an <parameter>n</parameter><!-- -->'th item.
348
 
</simpara></listitem></varlistentry>
349
 
</variablelist></refsect2>
350
 
<refsect2 id="xfce-itembar-raise-event-window" role="function">
351
 
<title>xfce_itembar_raise_event_window ()</title>
352
 
<indexterm zone="xfce-itembar-raise-event-window"><primary>xfce_itembar_raise_event_window</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_raise_event_window     (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
353
 
<para>
354
 
Raise the event window of <parameter>itembar</parameter>. This causes all events, like
355
 
mouse clicks or key presses to be send to the itembar and not to
356
 
any item.
357
 
</para>
358
 
<para>
359
 
See also: <link linkend="xfce-itembar-lower-event-window"><function>xfce_itembar_lower_event_window()</function></link></para>
360
 
<para>
361
 
 
362
 
</para><variablelist role="params">
363
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
364
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
365
 
</simpara></listitem></varlistentry>
366
 
</variablelist></refsect2>
367
 
<refsect2 id="xfce-itembar-lower-event-window" role="function">
368
 
<title>xfce_itembar_lower_event_window ()</title>
369
 
<indexterm zone="xfce-itembar-lower-event-window"><primary>xfce_itembar_lower_event_window</primary></indexterm><programlisting><link linkend="void">void</link>                xfce_itembar_lower_event_window     (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
370
 
<para>
371
 
Lower the event window of <parameter>itembar</parameter>. This causes all events, like
372
 
mouse clicks or key presses to be send to the items, before reaching the
373
 
itembar.
374
 
</para>
375
 
<para>
376
 
See also: <link linkend="xfce-itembar-raise-event-window"><function>xfce_itembar_raise_event_window()</function></link></para>
377
 
<para>
378
 
 
379
 
</para><variablelist role="params">
380
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
381
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
382
 
</simpara></listitem></varlistentry>
383
 
</variablelist></refsect2>
384
 
<refsect2 id="xfce-itembar-event-window-is-raised" role="function">
385
 
<title>xfce_itembar_event_window_is_raised ()</title>
386
 
<indexterm zone="xfce-itembar-event-window-is-raised"><primary>xfce_itembar_event_window_is_raised</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            xfce_itembar_event_window_is_raised (<link linkend="XfceItembar">XfceItembar</link> *itembar);</programlisting>
387
 
<para>
388
 
Whether the event window of the <link linkend="XfceItembar"><type>XfceItembar</type></link> is raised.</para>
389
 
<para>
390
 
 
391
 
</para><variablelist role="params">
392
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
393
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
394
 
</simpara></listitem></varlistentry>
395
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if event window is raised.
396
 
</simpara></listitem></varlistentry>
397
 
</variablelist></refsect2>
398
 
<refsect2 id="xfce-itembar-get-item-at-point" role="function">
399
 
<title>xfce_itembar_get_item_at_point ()</title>
400
 
<indexterm zone="xfce-itembar-get-item-at-point"><primary>xfce_itembar_get_item_at_point</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          xfce_itembar_get_item_at_point      (<link linkend="XfceItembar">XfceItembar</link> *itembar,
401
 
                                                         <link linkend="gint">gint</link> x,
402
 
                                                         <link linkend="gint">gint</link> y);</programlisting>
403
 
<para>
404
 
Return the <link linkend="GtkWidget"><type>GtkWidget</type></link> in the <link linkend="XfceItembar"><type>XfceItembar</type></link> that is below the (x,y)
405
 
coordinate.</para>
406
 
<para>
407
 
 
408
 
</para><variablelist role="params">
409
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
410
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
411
 
</simpara></listitem></varlistentry>
412
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
413
 
<listitem><simpara> x coordinate relative to the itembar window
414
 
</simpara></listitem></varlistentry>
415
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
416
 
<listitem><simpara> y coordinate relative to the itembar window
417
 
</simpara></listitem></varlistentry>
418
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
419
 
</simpara></listitem></varlistentry>
420
 
</variablelist></refsect2>
421
 
<refsect2 id="xfce-itembar-get-drop-index" role="function">
422
 
<title>xfce_itembar_get_drop_index ()</title>
423
 
<indexterm zone="xfce-itembar-get-drop-index"><primary>xfce_itembar_get_drop_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                xfce_itembar_get_drop_index         (<link linkend="XfceItembar">XfceItembar</link> *itembar,
424
 
                                                         <link linkend="gint">gint</link> x,
425
 
                                                         <link linkend="gint">gint</link> y);</programlisting>
426
 
<para>
427
 
Returns the position corresponding to the indicated point on
428
 
<parameter>itembar</parameter>. This is useful when dragging items to the itembar:
429
 
this function returns the position a new item should be
430
 
inserted.
431
 
</para>
432
 
<para>
433
 
<parameter>x</parameter> and <parameter>y</parameter> are in <parameter>itembar</parameter> coordinates.</para>
434
 
<para>
435
 
 
436
 
</para><variablelist role="params">
437
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
438
 
<listitem><simpara> a <link linkend="XfceItembar"><type>XfceItembar</type></link>
439
 
</simpara></listitem></varlistentry>
440
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
441
 
<listitem><simpara> x coordinate of a point on the itembar
442
 
</simpara></listitem></varlistentry>
443
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
444
 
<listitem><simpara> y coordinate of a point on the itembar
445
 
</simpara></listitem></varlistentry>
446
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The position corresponding to the point (<parameter>x</parameter>, <parameter>y</parameter>) on the
447
 
itembar.
448
 
</simpara></listitem></varlistentry>
449
 
</variablelist></refsect2>
450
 
 
451
 
</refsect1>
452
 
<refsect1 id="XfceItembar.property-details" role="property_details">
453
 
<title role="property_details.title">Property Details</title>
454
 
<refsect2 id="XfceItembar--orientation"><title>The <literal>&quot;orientation&quot;</literal> property</title>
455
 
<indexterm zone="XfceItembar--orientation"><primary>XfceItembar:orientation</primary></indexterm><programlisting>  &quot;orientation&quot;              <link linkend="GtkOrientation">GtkOrientation</link>        : Read / Write</programlisting>
456
 
<para>
457
 
The orientation of the <link linkend="XfceItembar"><type>XfceItembar</type></link>.</para>
458
 
<para>
459
 
 
460
 
</para><para>Default value: GTK_ORIENTATION_HORIZONTAL</para>
461
 
</refsect2>
462
 
 
463
 
</refsect1>
464
 
<refsect1 id="XfceItembar.child-property-details" role="child_property_details">
465
 
<title role="child_property_details.title">Child Property Details</title>
466
 
<refsect2 id="XfceItembar--expand"><title>The <literal>&quot;expand&quot;</literal> child property</title>
467
 
<indexterm zone="XfceItembar--expand"><primary>XfceItembar:expand</primary></indexterm><programlisting>  &quot;expand&quot;                   <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
468
 
<para>
469
 
Whether the child of the <link linkend="XfceItembar"><type>XfceItembar</type></link> should fill available space.</para>
470
 
<para>
471
 
 
472
 
</para><para>Default value: FALSE</para>
473
 
</refsect2>
474
 
 
475
 
</refsect1>
476
 
 
477
 
<refsect1 id="XfceItembar.signal-details" role="signals">
478
 
<title role="signals.title">Signal Details</title>
479
 
<refsect2 id="XfceItembar-contents-changed"><title>The <literal>&quot;contents-changed&quot;</literal> signal</title>
480
 
<indexterm zone="XfceItembar-contents-changed"><primary>XfceItembar::contents-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="XfceItembar">XfceItembar</link> *itembar,
481
 
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run First</programlisting>
482
 
<para>
483
 
Emitted when the contents of the itembar change, either by adding
484
 
a child, removing a child, or reordering a child.</para>
485
 
<para>
486
 
 
487
 
</para><variablelist role="params">
488
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
489
 
<listitem><simpara> the object which emitted the signal
490
 
</simpara></listitem></varlistentry>
491
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
492
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
493
 
</variablelist></refsect2><refsect2 id="XfceItembar-orientation-changed"><title>The <literal>&quot;orientation-changed&quot;</literal> signal</title>
494
 
<indexterm zone="XfceItembar-orientation-changed"><primary>XfceItembar::orientation-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="XfceItembar">XfceItembar</link>   *itembar,
495
 
                                                        <link linkend="GtkOrientation">GtkOrientation</link> orientation,
496
 
                                                        <link linkend="gpointer">gpointer</link>       user_data)        : Run First</programlisting>
497
 
<para>
498
 
Emitted when the orientation of the itembar changes.</para>
499
 
<para>
500
 
 
501
 
</para><variablelist role="params">
502
 
<varlistentry><term><parameter>itembar</parameter>&nbsp;:</term>
503
 
<listitem><simpara> the object which emitted the signal
504
 
</simpara></listitem></varlistentry>
505
 
<varlistentry><term><parameter>orientation</parameter>&nbsp;:</term>
506
 
<listitem><simpara> the new <link linkend="GtkOrientation"><type>GtkOrientation</type></link> of the itembar
507
 
</simpara></listitem></varlistentry>
508
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
509
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
510
 
</variablelist></refsect2>
511
 
</refsect1>
512
 
 
513
 
 
514
 
<refsect1 id="XfceItembar.see-also">
515
 
<title>See Also</title>
516
 
<para>
517
 
<link linkend="GtkHBox"><type>GtkHBox</type></link> and <link linkend="GtkVBox"><type>GtkVBox</type></link>.
518
 
</para>
519
 
</refsect1>
520
 
 
521
 
</refentry>