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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkstatusbar">
<refmeta>
<refentrytitle>gtk.Statusbar</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PyGTK Docs</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gtk.Statusbar</refname>
<refpurpose>report messages of minor importance to the user.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Statusbar</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkhbox">gtk.HBox</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtkstatusbar">gtk.Statusbar</link></methodname>
<methodparam></methodparam> </constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--get-context-id">get_context_id</link></methodname>
<methodparam><parameter
role="keyword">context_description</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--push">push</link></methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--pop">pop</link></methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--remove-message">remove_message</link></methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
<methodparam><parameter
role="keyword">message_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--remove">remove</link></methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
<methodparam><parameter
role="keyword">message_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkstatusbar--remove-all">remove_all</link></methodname>
<methodparam><parameter role="keyword">context_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--set-has-resize-grip">set_has_resize_grip</link></methodname>
<methodparam><parameter
role="keyword">setting</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkstatusbar--get-has-resize-grip">get_has_resize_grip</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkstatusbar--get-message-area">get_message_area</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbox">gtk.Box</link>
+-- <link linkend="class-gtkhbox">gtk.HBox</link>
+-- <link linkend="class-gtkstatusbar">gtk.Statusbar</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkstatusbar">
<title>gtk.Statusbar Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"has-resize-grip"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, the statusbar has a grip
for resizing the toplevel window. Available in GTK+ 2.4 and
above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkstatusbar">
<title>gtk.Statusbar Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"shadow-type"</entry>
<entry>Read</entry>
<entry>The style of bevel around the statusbar text</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="child-properties-gtkstatusbar">
<title>gtk.Statusbar Child Properties</title>
<para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkstatusbar">
<title>gtk.Statusbar Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link
linkend="signal-gtkstatusbar--text-popped">text-popped</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>statusbar</parameter></methodparam>
<methodparam><parameter>context_id</parameter></methodparam>
<methodparam><parameter>text</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtkstatusbar--text-pushed">text-pushed</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>statusbar</parameter></methodparam>
<methodparam><parameter>context_id</parameter></methodparam>
<methodparam><parameter>text</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link> is
usually placed along the bottom of an application's main <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. It may
provide a regular commentary of the application's status (as is usually the
case in a web browser, for example), or may be used to simply output a
message when the status changes, (when an upload is complete in an
<literal>FTP</literal> client, for example). It may also have a resize grip
(a triangular area in the lower right corner) which can be clicked on to
resize the window containing the statusbar. Status bars in PyGTK maintain a
stack of messages. The message at the top of the each bar's stack is the one
that will currently be displayed.</para>
<para>Any messages added to a statusbar's stack must specify a
<literal>context_id</literal> that is used to uniquely identify the source
of a message. The <literal>context_id</literal> can be generated by the
<link
linkend="method-gtkstatusbar--get-context-id"><methodname>get_context_id</methodname>()</link>
method, and associated with a context message. An existing context_id can be
retrieved using the context message using the <link
linkend="method-gtkstatusbar--get-context-id"><methodname>get_context_id</methodname>()</link>
method. Note that messages are stored in a stack, and when choosing which
message to display, the stack structure is adhered to, regardless of the
context identifier of a message.</para>
</refsect1>
<refsect1 id="constructor-gtkstatusbar">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.Statusbar</methodname>
<methodparam></methodparam> </constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>
widget</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>
widget.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkstatusbar--get-context-id">
<title>gtk.Statusbar.get_context_id</title>
<programlisting><methodsynopsis language="python">
<methodname>get_context_id</methodname>
<methodparam><parameter
role="keyword">context_description</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">context_description</parameter> :</term>
<listitem><simpara>a string identifying the context for the
message</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>an integer context
identifier</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_context_id</methodname>() method returns a
new or existing context identifier, given a description of the actual
context specified by <parameter>context_description</parameter>. In effect,
<methodname>get_context_id</methodname>() both registers and retrieves a
context identifier.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--push">
<title>gtk.Statusbar.push</title>
<programlisting><methodsynopsis language="python">
<methodname>push</methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">context_id</parameter> :</term>
<listitem><simpara>a context identifier</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>the message text</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>an integer message
identifier</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>push</methodname>() method pushes a new message
specified by <parameter>text</parameter> with the specified
<parameter>context_id</parameter> onto a statusbar's stack and returns a
message id that that can be used with the <link
linkend="method-gtkstatusbar--remove-message"><methodname>remove_message</methodname>()</link>
method.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--pop">
<title>gtk.Statusbar.pop</title>
<programlisting><methodsynopsis language="python">
<methodname>pop</methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">context_id</parameter> :</term>
<listitem><simpara>a context identifier</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>pop</methodname>() method removes the top
message with the specified <parameter>context_id</parameter> from the
statusbar's stack.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--remove-message">
<title>gtk.Statusbar.remove_message</title>
<programlisting><methodsynopsis language="python">
<methodname>remove_message</methodname>
<methodparam><parameter
role="keyword">context_id</parameter></methodparam>
<methodparam><parameter
role="keyword">message_id</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">context_id</parameter> :</term>
<listitem><simpara>the context identifier</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">message_id</parameter> :</term>
<listitem><simpara>the message identifier</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>remove_message</methodname>() method removes the message
with the specified <parameter>message_id</parameter> and
<parameter>context_id</parameter> from the statusbar's message stack.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--remove">
<title>gtk.Statusbar.remove</title>
<warning>
<para>This method is deprecated in PyGTK 2.22 and above</para>
</warning>
<para>This method calls either
<link linkend="method-gtkcontainer--remove">gtk.Container.remove</link>
or <link linkend="method-gtkstatusbar--remove-message">gtk.Statusbar.remove_message</link>
depending on parameters. The second option is for compatibility only and will be
eventually removed. New code should use <literal>remove</literal> only to remove
widgets (as in <literal>gtk.Container</literal> method). To remove messages, use
<link linkend="method-gtkstatusbar--remove-message">gtk.Statusbar.remove_message</link>
directly.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--remove-all">
<title>gtk.StatusBar.remove_all</title>
<programlisting><methodsynopsis language="python">
<methodname>remove_all</methodname>
<methodparam><parameter role="keyword">context_id</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">context_id</parameter> :</term>
<listitem><simpara>a context identifier.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>remove_all</methodname>() method forces the removal of all messages
from a statusbar's stack with the exact <parameter>context_id</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--set-has-resize-grip">
<title>gtk.Statusbar.set_has_resize_grip</title>
<programlisting><methodsynopsis language="python">
<methodname>set_has_resize_grip</methodname>
<methodparam><parameter
role="keyword">setting</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">setting</parameter> :</term>
<listitem><simpara>if <literal>True</literal> a resize grip is
displayed</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_has_resize_grip</methodname>() method sets
the internal "has_resize_grip" property to the value specified by
<parameter>setting</parameter>. If <parameter>setting</parameter> is
<literal>True</literal> a resize grip is displayed on the statusbar</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--get-has-resize-grip">
<title>gtk.Statusbar.get_has_resize_grip</title>
<programlisting><methodsynopsis language="python">
<methodname>get_has_resize_grip</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if a resize grip is
displayed</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_has_resize_grip</methodname>() method
returns the value of the internal "has_resize_grip" property that determines
if a resize grip is displayed on the statusbar.</para>
</refsect2>
<refsect2 id="method-gtkstatusbar--get-message-area">
<title>gtk.StatusBar.get_message_area</title>
<programlisting><methodsynopsis language="python">
<methodname>get_message_area</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_message_area</methodname>() method retrieves
the box containing the label widget.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkstatusbar--text-popped">
<title>The "text-popped" gtk.Statusbar Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>statusbar</parameter></methodparam>
<methodparam><parameter>context_id</parameter></methodparam>
<methodparam><parameter>text</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>statusbar</parameter> :</term>
<listitem><simpara>the statusbar that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context_id</parameter> :</term>
<listitem><simpara>the context identifier of the top
message</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter> :</term>
<listitem><simpara>the string containing the top message
text</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "text-popped" signal is emitted when a message is removed
from the statusbar message stack. Note the text and context_id are for the
top message on the statusbar stack not the message that was actually
removed.</para>
</refsect2>
<refsect2 id="signal-gtkstatusbar--text-pushed">
<title>The "text-pushed" gtk.Statusbar Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>statusbar</parameter></methodparam>
<methodparam><parameter>context_id</parameter></methodparam>
<methodparam><parameter>text</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>statusbar</parameter> :</term>
<listitem><simpara>the statusbar that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context_id</parameter> :</term>
<listitem><simpara>the context identifier of the message
added</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter> :</term>
<listitem><simpara>the string containing the message
text</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "text-pushed" signal is emitted when a message is added to
the statusbar message stack.</para>
</refsect2>
</refsect1>
</refentry>
|
