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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
<refentry id="GnomeAppBar">
<refmeta>
<refentrytitle role="top_of_page">GnomeAppBar</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeAppBar</refname>
<refpurpose>An application status and progress bar widget</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
#define <link linkend="GNOME-APPBAR-HAS-STATUS:CAPS">GNOME_APPBAR_HAS_STATUS</link> (appbar)
#define <link linkend="GNOME-APPBAR-HAS-PROGRESS:CAPS">GNOME_APPBAR_HAS_PROGRESS</link> (appbar)
#define <link linkend="GNOME-APPBAR-INTERACTIVE:CAPS">GNOME_APPBAR_INTERACTIVE</link> (ab)
<link linkend="GnomeAppBar-struct">GnomeAppBar</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-appbar-new">gnome_appbar_new</link> (<link linkend="gboolean">gboolean</link> has_progress,
<link linkend="gboolean">gboolean</link> has_status,
<link linkend="GnomePreferencesType">GnomePreferencesType</link> interactivity);
<link linkend="void">void</link> <link linkend="gnome-appbar-set-status">gnome_appbar_set_status</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *status);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-appbar-get-status">gnome_appbar_get_status</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
<link linkend="void">void</link> <link linkend="gnome-appbar-set-default">gnome_appbar_set_default</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *default_status);
<link linkend="void">void</link> <link linkend="gnome-appbar-push">gnome_appbar_push</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *status);
<link linkend="void">void</link> <link linkend="gnome-appbar-pop">gnome_appbar_pop</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
<link linkend="void">void</link> <link linkend="gnome-appbar-clear-stack">gnome_appbar_clear_stack</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
<link linkend="void">void</link> <link linkend="gnome-appbar-set-progress-percentage">gnome_appbar_set_progress_percentage</link>
(<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
<link linkend="gfloat">gfloat</link> percentage);
<link linkend="GtkProgressBar">GtkProgressBar</link>* <link linkend="gnome-appbar-get-progress">gnome_appbar_get_progress</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
<link linkend="void">void</link> <link linkend="gnome-appbar-refresh">gnome_appbar_refresh</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
<link linkend="void">void</link> <link linkend="gnome-appbar-set-prompt">gnome_appbar_set_prompt</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *prompt,
<link linkend="gboolean">gboolean</link> modal);
<link linkend="void">void</link> <link linkend="gnome-appbar-clear-prompt">gnome_appbar_clear_prompt</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
<link linkend="gchar">gchar</link>* <link linkend="gnome-appbar-get-response">gnome_appbar_get_response</link> (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkHBox">GtkHBox</link>
+----GnomeAppBar
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeAppBar implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GnomeAppBar--has-progress">has-progress</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
"<link linkend="GnomeAppBar--has-status">has-status</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
"<link linkend="GnomeAppBar--interactivity">interactivity</link>" <link linkend="GnomePreferencesType">GnomePreferencesType</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GnomeAppBar-clear-prompt">clear-prompt</link>" : Run Last
"<link linkend="GnomeAppBar-user-response">user-response</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> widget sits (usually) at the bottom of an application window and
contains a progress bar (for indicating time consuming tasks and their
completion status) and/or a status bar for sending short one-line message to
the user. It is also possible (in theory) for the user to edit the contents of
the status bar, should the application developer choose to allow that, however
<emphasis>note that this is not really working</emphasis> in the present
implementation, so developers are recommended to avoid using interactive status
bars and use proper editable widgets instead.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GNOME-APPBAR-HAS-STATUS:CAPS" role="macro"/>GNOME_APPBAR_HAS_STATUS()</title>
<indexterm><primary>GNOME_APPBAR_HAS_STATUS</primary></indexterm><programlisting>#define GNOME_APPBAR_HAS_STATUS(appbar) (gnome_appbar_get_status(GNOME_APPBAR(appbar)) != NULL)
</programlisting>
<para>
Whether or not the application bar contains a status box.
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara>A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is a status box is contained in the appbar.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GNOME-APPBAR-HAS-PROGRESS:CAPS" role="macro"/>GNOME_APPBAR_HAS_PROGRESS()</title>
<indexterm><primary>GNOME_APPBAR_HAS_PROGRESS</primary></indexterm><programlisting>#define GNOME_APPBAR_HAS_PROGRESS(appbar) (gnome_appbar_get_progress(GNOME_APPBAR(appbar)) != NULL)
</programlisting>
<para>
Whether or not the application bar contains a status box.
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara>A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is a status box is contained in the appbar.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GNOME-APPBAR-INTERACTIVE:CAPS" role="macro"/>GNOME_APPBAR_INTERACTIVE()</title>
<indexterm><primary>GNOME_APPBAR_INTERACTIVE</primary></indexterm><programlisting>#define GNOME_APPBAR_INTERACTIVE(ab) ((ab) ? (ab)->interactive : FALSE)
</programlisting>
<para>
Whether or not the user can edit the text in the statusbar portion of a
<link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</para><variablelist role="params">
<varlistentry><term><parameter>ab</parameter> :</term>
<listitem><simpara>A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the user can edit the statusbar text.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GnomeAppBar-struct" role="struct"/>GnomeAppBar</title>
<indexterm><primary>GnomeAppBar</primary></indexterm><programlisting>typedef struct _GnomeAppBar GnomeAppBar;</programlisting>
<para>
This widget contains the status bar and progress bar (if they are requested).
After creating a <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> widget (via <link linkend="gnome-appbar-new"><function>gnome_appbar_new()</function></link>, for example), it
can then be passed to <link linkend="gnome-app-set-statusbar"><function>gnome_app_set_statusbar()</function></link> to add it to the main
application window.
</para></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-new" role="function"/>gnome_appbar_new ()</title>
<indexterm><primary>gnome_appbar_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_appbar_new (<link linkend="gboolean">gboolean</link> has_progress,
<link linkend="gboolean">gboolean</link> has_status,
<link linkend="GnomePreferencesType">GnomePreferencesType</link> interactivity);</programlisting>
<para>
Create a new GNOME application status bar. If <parameter>has_progress</parameter> is
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, a small progress bar widget will be created, and placed on the
left side of the appbar. If <parameter>has_status</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, a status bar,
possibly an editable one, is created.
</para>
<para>
The <parameter>interactivity</parameter> parameter determines whether the appbar is an interactive
"minibuffer" or just a status bar. If it is set to
<link linkend="GNOME-PREFERENCES-NEVER:CAPS"><type>GNOME_PREFERENCES_NEVER</type></link>, it is never interactive. If it is set to
<link linkend="GNOME-PREFERENCES-USER:CAPS"><type>GNOME_PREFERENCES_USER</type></link> we respect user preferences from
ui-properties. If it's <link linkend="GNOME-PREFERENCES-ALWAYS:CAPS"><type>GNOME_PREFERENCES_ALWAYS</type></link> we are interactive
whether the user likes it or not. Basically, if your app supports
both interactive and not (for example, if you use the
gnome-app-util interfaces), you should use
<link linkend="GNOME-PREFERENCES-USER:CAPS"><type>GNOME_PREFERENCES_USER</type></link>. Otherwise, use the setting you
support. Please note that "interactive" mode is not functional now;
GtkEntry is inadequate and so a custom widget will be written
eventually.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>has_progress</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if appbar needs progress bar widget, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>has_status</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if appbar needs status bar widget, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>interactivity</parameter> :</term>
<listitem><simpara> Level of user activity required.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to new <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-set-status" role="function"/>gnome_appbar_set_status ()</title>
<indexterm><primary>gnome_appbar_set_status</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_set_status (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *status);</programlisting>
<para>
Sets the status label without changing widget state; next call to
<link linkend="gnome-appbar-set-status"><function>gnome_appbar_set_status()</function></link> or <link linkend="gnome-appbar-push"><function>gnome_appbar_push()</function></link> will destroy this
permanently.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> Text to which status label will be set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-get-status" role="function"/>gnome_appbar_get_status ()</title>
<indexterm><primary>gnome_appbar_get_status</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_appbar_get_status (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Retrieves the statusbar widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to the statusbar widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-set-default" role="function"/>gnome_appbar_set_default ()</title>
<indexterm><primary>gnome_appbar_set_default</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_set_default (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *default_status);</programlisting>
<para>
What to show when showing nothing else is on the stack; defaults to the
empty string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>default_status</parameter> :</term>
<listitem><simpara> Text for status label.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-push" role="function"/>gnome_appbar_push ()</title>
<indexterm><primary>gnome_appbar_push</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_push (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *status);</programlisting>
<para>
Push a new status message onto the status bar stack and display it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> Text of status message.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-pop" role="function"/>gnome_appbar_pop ()</title>
<indexterm><primary>gnome_appbar_pop</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_pop (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Remove current status message, and display previous status
message, if any. It is fine to call this with an empty stack.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-clear-stack" role="function"/>gnome_appbar_clear_stack ()</title>
<indexterm><primary>gnome_appbar_clear_stack</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_clear_stack (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Remove all status messages from <parameter>appbar</parameter>, and display default status
message (if present).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-set-progress-percentage" role="function"/>gnome_appbar_set_progress_percentage ()</title>
<indexterm><primary>gnome_appbar_set_progress_percentage</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_set_progress_percentage
(<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
<link linkend="gfloat">gfloat</link> percentage);</programlisting>
<para>
Sets progress bar to <parameter>percentage</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>percentage</parameter> :</term>
<listitem><simpara> Percentage to which progress bar should be set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-get-progress" role="function"/>gnome_appbar_get_progress ()</title>
<indexterm><primary>gnome_appbar_get_progress</primary></indexterm><programlisting><link linkend="GtkProgressBar">GtkProgressBar</link>* gnome_appbar_get_progress (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Retrieves the progress bar widget for further manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkProgressBar"><type>GtkProgressBar</type></link> widget which is <parameter>appbar</parameter>'s progress bar, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if <parameter>appbar</parameter> has no progress bar.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-refresh" role="function"/>gnome_appbar_refresh ()</title>
<indexterm><primary>gnome_appbar_refresh</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_refresh (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Refresh the status message bar by redrawing the item on the top of the
stack, or the default value if the stack is empty.. Useful to force the
message from a previous call to <link linkend="gnome-appbar-set-status"><function>gnome_appbar_set_status()</function></link> to disappear.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-set-prompt" role="function"/>gnome_appbar_set_prompt ()</title>
<indexterm><primary>gnome_appbar_set_prompt</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_set_prompt (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
const <link linkend="gchar">gchar</link> *prompt,
<link linkend="gboolean">gboolean</link> modal);</programlisting>
<para>
Put a prompt in the appbar and wait for a response. When the
user responds or cancels, a 'user_response' signal is emitted.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prompt</parameter> :</term>
<listitem><simpara> Text of the prompt message.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>modal</parameter> :</term>
<listitem><simpara> If <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, grabs input.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-clear-prompt" role="function"/>gnome_appbar_clear_prompt ()</title>
<indexterm><primary>gnome_appbar_clear_prompt</primary></indexterm><programlisting><link linkend="void">void</link> gnome_appbar_clear_prompt (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Remove any prompt from the status message bar.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-appbar-get-response" role="function"/>gnome_appbar_get_response ()</title>
<indexterm><primary>gnome_appbar_get_response</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gnome_appbar_get_response (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar);</programlisting>
<para>
Get the response to the prompt, if any.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara> A <link linkend="GnomeAppBar"><type>GnomeAppBar</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
Text from <parameter>appbar</parameter> entry widget, as entered by user. This string should be
freed by the caller (using <link linkend="gfree"><function>gfree()</function></link>) when no longer required.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomeAppBar--has-progress"/>The <literal>"has-progress"</literal> property</title>
<indexterm><primary>GnomeAppBar:has-progress</primary></indexterm><programlisting> "has-progress" <link linkend="gboolean">gboolean</link> : Read / Write / Construct</programlisting>
<para>Create a progress widget.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="GnomeAppBar--has-status"/>The <literal>"has-status"</literal> property</title>
<indexterm><primary>GnomeAppBar:has-status</primary></indexterm><programlisting> "has-status" <link linkend="gboolean">gboolean</link> : Read / Write / Construct</programlisting>
<para>Create a status widget.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="GnomeAppBar--interactivity"/>The <literal>"interactivity"</literal> property</title>
<indexterm><primary>GnomeAppBar:interactivity</primary></indexterm><programlisting> "interactivity" <link linkend="GnomePreferencesType">GnomePreferencesType</link> : Read / Write / Construct</programlisting>
<para>Level of user activity required.</para><para>Default value: GNOME_PREFERENCES_NEVER</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GnomeAppBar-clear-prompt"/>The <literal>"clear-prompt"</literal> signal</title>
<indexterm><primary>GnomeAppBar::clear-prompt</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeAppBar-user-response"/>The <literal>"user-response"</literal> signal</title>
<indexterm><primary>GnomeAppBar::user-response</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeAppBar">GnomeAppBar</link> *appbar,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appbar</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
