← Back to branch summary

~ubuntu-branches/ubuntu/precise/gtk+2.0/precise-updates

« back to all changes in this revision

Viewing changes to docs/reference/gtk/tmpl/gtkstatusbar.sgml

  • Committer: Package Import Robot
  • Author(s): Ken VanDine
  • Date: 2011-12-01 11:40:06 UTC
  • mfrom: (1.14.11)
  • Revision ID: package-import@ubuntu.com-20111201114006-nrmf6qu3pg512veo
Tags: 2.24.8-0ubuntu1
https://launchpad.net/bugs/189494
https://launchpad.net/bugs/889019
* New upstream release 
  - gtkfilechooser should be more robust to malformed URIs
    in .gtk-bookmarks (LP: #189494)
* debian/patches/010_make_bg_changes_queue_repaint.patch
  - dropped it introduces performance regressions in some gtk2 
    apps (LP: #889019)
* 101_filechooser.patch, 000git_file_chooser.patch: dropped, upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/tmpl/gtkstatusbar.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
GtkStatusbar
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
Report messages of minor importance to the user
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
A #GtkStatusbar is usually placed along the bottom of an application's main
10
 
#GtkWindow. It may provide a regular commentary of the application's status
11
 
(as is usually the case in a web browser, for example), or may be used to
12
 
simply output a message when the status changes, (when an upload is complete
13
 
in an FTP client, for example). 
14
 
It may also have a resize grip (a triangular area in the lower right corner) 
15
 
which can be clicked on to resize the window containing the statusbar.
16
 
</para>
17
 
<para>
18
 
Status bars in GTK+ maintain a stack of messages. The message at
19
 
the top of the each bar's stack is the one that will currently be displayed.
20
 
</para>
21
 
<para>
22
 
Any messages added to a statusbar's stack must specify a <emphasis>context 
23
 
id</emphasis> that is used to uniquely identify the source of a message. 
24
 
This context id can be generated by gtk_statusbar_get_context_id(), given a 
25
 
message and the statusbar that it will be added to. Note that messages are 
26
 
stored in a stack, and when choosing which message to display, the stack 
27
 
structure is adhered to, regardless of the context identifier of a message.
28
 
</para>
29
 
<para>
30
 
One could say that a statusbar maintains one stack of messages for display
31
 
purposes, but allows multiple message producers to maintain sub-stacks of
32
 
the messages they produced (via context ids).
33
 
</para>
34
 
<para>
35
 
Status bars are created using gtk_statusbar_new().
36
 
</para>
37
 
<para>
38
 
Messages are added to the bar's stack with gtk_statusbar_push().
39
 
</para>
40
 
<para>
41
 
The message at the top of the stack can be removed using gtk_statusbar_pop(). 
42
 
A message can be removed from anywhere in the stack if its message_id was 
43
 
recorded at the time it was added. This is done using gtk_statusbar_remove().
44
 
</para>
45
 
 
46
 
<!-- ##### SECTION See_Also ##### -->
47
 
 
48
 
 
49
 
<!-- ##### SECTION Stability_Level ##### -->
50
 
 
51
 
 
52
 
<!-- ##### SECTION Image ##### -->
53
 
 
54
 
 
55
 
<!-- ##### STRUCT GtkStatusbar ##### -->
56
 
<para>
57
 
Contains private data that should be modified with the functions described 
58
 
below.
59
 
</para>
60
 
 
61
 
 
62
 
<!-- ##### SIGNAL GtkStatusbar::text-popped ##### -->
63
 
<para>
64
 
 
65
 
</para>
66
 
 
67
 
@statusbar: 
68
 
@context_id: 
69
 
@text: 
70
 
 
71
 
<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### -->
72
 
<para>
73
 
 
74
 
</para>
75
 
 
76
 
@statusbar: 
77
 
@context_id: 
78
 
@text: 
79
 
 
80
 
<!-- ##### ARG GtkStatusbar:has-resize-grip ##### -->
81
 
<para>
82
 
 
83
 
</para>
84
 
 
85
 
<!-- ##### ARG GtkStatusbar:shadow-type ##### -->
86
 
<para>
87
 
 
88
 
</para>
89
 
 
90
 
<!-- ##### FUNCTION gtk_statusbar_new ##### -->
91
 
<para>
92
 
 
93
 
</para>
94
 
 
95
 
@void: 
96
 
@Returns: 
97
 
 
98
 
 
99
 
<!-- ##### FUNCTION gtk_statusbar_get_context_id ##### -->
100
 
<para>
101
 
 
102
 
</para>
103
 
 
104
 
@statusbar: 
105
 
@context_description: 
106
 
@Returns: 
107
 
 
108
 
 
109
 
<!-- ##### FUNCTION gtk_statusbar_push ##### -->
110
 
<para>
111
 
 
112
 
</para>
113
 
 
114
 
@statusbar: 
115
 
@context_id: 
116
 
@text: 
117
 
@Returns: 
118
 
 
119
 
 
120
 
<!-- ##### FUNCTION gtk_statusbar_pop ##### -->
121
 
<para>
122
 
 
123
 
</para>
124
 
 
125
 
@statusbar: 
126
 
@context_id: 
127
 
 
128
 
 
129
 
<!-- ##### FUNCTION gtk_statusbar_remove ##### -->
130
 
<para>
131
 
 
132
 
</para>
133
 
 
134
 
@statusbar: 
135
 
@context_id: 
136
 
@message_id: 
137
 
 
138
 
 
139
 
<!-- ##### FUNCTION gtk_statusbar_remove_all ##### -->
140
 
<para>
141
 
 
142
 
</para>
143
 
 
144
 
@statusbar: 
145
 
@context_id: 
146
 
 
147
 
 
148
 
<!-- ##### FUNCTION gtk_statusbar_set_has_resize_grip ##### -->
149
 
<para>
150
 
 
151
 
</para>
152
 
 
153
 
@statusbar: 
154
 
@setting: 
155
 
 
156
 
 
157
 
<!-- ##### FUNCTION gtk_statusbar_get_has_resize_grip ##### -->
158
 
<para>
159
 
 
160
 
</para>
161
 
 
162
 
@statusbar: 
163
 
@Returns: 
164
 
 
165
 
 
166
 
<!-- ##### FUNCTION gtk_statusbar_get_message_area ##### -->
167
 
<para>
168
 
 
169
 
</para>
170
 
 
171
 
@statusbar: 
172
 
@Returns: 
173
 
 
174