← Back to branch summary

~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-05-04 12:24:25 UTC
  • mfrom: (1.1.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20070504122425-0m8midgzrp40y8w2
Tags: 2.10.12-1ubuntu1
* Sync with Debian
* New upstream version:
  Fixed bugs:
  - 379414 file chooser warnings when changing path in the entry
  - 418585 GtkFileChooserDefault sizing code is not DPI independent
  - 419568 Crash in search if start with special letter
  - 435062 build dies with icon cache validation
  - 379399 Segfault to call gtk_print_operation_run twice.
  - 387889 cups backend has problems when there are too many printers
  - 418531 invalid read to gtkicontheme.c gtk_icon_theme_lookup_icon...
  - 423916 crash in color scheme code
  - 424042 Segmentation fault while quickly pressing Alt+arrows
  - 415260 Protect against negative indices when setting values in G...
  - 419171 XGetVisualInfo() may not set nxvisuals
  - 128852 Gdk cursors don't look good on win32
  - 344657 Ctrl-H doesn't toggle "Show Hidden Files" setting
  - 345345 PrintOperation::paginate is not emitted for class handler
  - 347567 GtkPrintOperation::end-print is not emitted if it's cance...
  - 369112 gtk_ui_manager_add_ui should accept unnamed separator
  - 392015 Selected menu item invisible on Windows Vista
  - 399253 MS-Windows Theme Bottom Tab placement rendering glitches
  - 399425 gtk_input_dialog_fill_axes() adds child to gtkscrolledwin...
  - 403251 [patch] little memory leak in GtkPrintJob
  - 403267 [patch] memory leak in GtkPageSetupUnixDialog
  - 403470 MS-Windows Theme tab placement other than on top leaks a ...
  - 404506 Windows system fonts that have multi-byte font names cann...
  - 405089 Incorrect window placement for GtkEventBox private window
  - 405515 Minor leak in gtkfilesystemmodel.c
  - 405539 gdk_pixbuf_save() for PNG saver can return FALSE without ...
  - 415681 gdk_window_clear_area includes an extra line and column o...
  - 418219 GtkRecentChooser should apply filter before sorting and c...
  - 418403 Scroll to printer after selecting it from settings
  - 421985 _gtk_print_operation_platform_backend_launch_preview
  - 421990 gtk_print_job_get_surface
  - 421993 gtk_print_operation_init
  - 423064 Conditional jump or move depends on uninitialised value(s...
  - 423722 Fix printing header in gtk-demo
  - 424168 gtk_print_operation_run on async preview
  - 425655 Don't install gtk+-unix-print-2.0.pc on non-UNIX platforms
  - 425786 GDK segfaults if XineramaQueryScreens fails
  - 428665 Lpr Backend gets stuck in infinite loop during gtk_enumer...
  - 429902 GtkPrintOperation leaks cairo contextes
  - 431997 First delay of GdkPixbufAnimationIter is wrong
  - 433242 Inconsistent scroll arrow position calculations
  - 433972 Placing gtk.Expander inside a gtk.TextView() changes gtk....
  - 434261 _gtk_toolbar_elide_underscores incorrectly handles some s...
  - 383354 ctrl-L should make 'Location' entry disappear
  - 418673 gtk_recent_manager_add_item
  - 429732 gtk_accel_group_finalize accesses invalid memory
  - 435028 WM_CLIENT_LEADER is wrong on the leader_window
  - 431067 Background of the header window is not updated
  - 338843 add recent files support inside the ui manager
  - 148535 add drop shadow to menus, tooltips, etc. under Windows XP
* debian/control.in:
  - Conflicts on ubuntulooks (<= 0.9.11-1)
* debian/patches/15_default-fallback-icon-theme.patch:
  - patch from Debian, fallback on gnome icon theme

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/tmpl/gtkprogressbar.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
GtkProgressBar
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
A widget which indicates progress visually
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
The #GtkProgressBar is typically used to display the progress of a long
 
10
running operation.  It provides a visual clue that processing
 
11
is underway.  The #GtkProgressBar can be used in two different
 
12
modes: percentage mode and activity mode.
 
13
</para>
 
14
 
 
15
<para>
 
16
When an application can determine how much work needs to take place 
 
17
(e.g. read a fixed number of bytes from a file) and can monitor its
 
18
progress, it can use the #GtkProgressBar in percentage mode and the user
 
19
sees a growing bar indicating the percentage of the work that has
 
20
been completed.  In this mode, the application is required to call
 
21
gtk_progress_bar_set_fraction() periodically to update the progress bar.
 
22
</para>
 
23
 
 
24
<para>
 
25
When an application has no accurate way of knowing the amount of work
 
26
to do, it can use the #GtkProgressBar in activity mode, which shows activity 
 
27
by a block moving back and forth within the progress area. In this mode,
 
28
the application is required to call gtk_progress_bar_pulse() perodically
 
29
to update the progress bar.
 
30
</para>
 
31
 
 
32
<para>
 
33
There is quite a bit of flexibility provided to control the appearance
 
34
of the #GtkProgressBar.  Functions are provided to control the 
 
35
orientation of the bar, optional text can be displayed along with
 
36
the bar, and the step size used in activity mode can be set.
 
37
</para>
 
38
 
 
39
<note>
 
40
<para>
 
41
The #GtkProgressBar/#GtkProgress API in GTK 1.2 was bloated, needlessly complex
 
42
and hard to use properly.  Therefore #GtkProgress has been deprecated
 
43
completely and the #GtkProgressBar API has been reduced to the following 10
 
44
functions: gtk_progress_bar_new(), gtk_progress_bar_pulse(), 
 
45
gtk_progress_bar_set_text(), gtk_progress_bar_set_fraction(), 
 
46
gtk_progress_bar_set_pulse_step(), gtk_progress_bar_set_orientation(), 
 
47
gtk_progress_bar_get_text(), gtk_progress_bar_get_fraction(), 
 
48
gtk_progress_bar_get_pulse_step(), gtk_progress_bar_get_orientation(). 
 
49
These have been grouped at the beginning of this section, followed by 
 
50
a large chunk of deprecated 1.2 compatibility functions.
 
51
</para>
 
52
</note>
 
53
 
 
54
<!-- ##### SECTION See_Also ##### -->
 
55
<para>
 
56
 
 
57
</para>
 
58
 
 
59
<!-- ##### SECTION Stability_Level ##### -->
 
60
 
 
61
 
 
62
<!-- ##### STRUCT GtkProgressBar ##### -->
 
63
<para>
 
64
The #GtkProgressBar-struct struct contains private data only, 
 
65
and should be accessed using the functions below.
 
66
</para>
 
67
 
 
68
 
 
69
<!-- ##### ARG GtkProgressBar:activity-blocks ##### -->
 
70
<para>
 
71
 
 
72
</para>
 
73
 
 
74
<!-- ##### ARG GtkProgressBar:activity-step ##### -->
 
75
<para>
 
76
 
 
77
</para>
 
78
 
 
79
<!-- ##### ARG GtkProgressBar:adjustment ##### -->
 
80
<para>
 
81
 
 
82
</para>
 
83
 
 
84
<!-- ##### ARG GtkProgressBar:bar-style ##### -->
 
85
<para>
 
86
 
 
87
</para>
 
88
 
 
89
<!-- ##### ARG GtkProgressBar:discrete-blocks ##### -->
 
90
<para>
 
91
 
 
92
</para>
 
93
 
 
94
<!-- ##### ARG GtkProgressBar:ellipsize ##### -->
 
95
<para>
 
96
 
 
97
</para>
 
98
 
 
99
<!-- ##### ARG GtkProgressBar:fraction ##### -->
 
100
<para>
 
101
 
 
102
</para>
 
103
 
 
104
<!-- ##### ARG GtkProgressBar:orientation ##### -->
 
105
<para>
 
106
 
 
107
</para>
 
108
 
 
109
<!-- ##### ARG GtkProgressBar:pulse-step ##### -->
 
110
<para>
 
111
 
 
112
</para>
 
113
 
 
114
<!-- ##### ARG GtkProgressBar:text ##### -->
 
115
<para>
 
116
 
 
117
</para>
 
118
 
 
119
<!-- ##### FUNCTION gtk_progress_bar_new ##### -->
 
120
<para>
 
121
Creates a new #GtkProgressBar.
 
122
</para>
 
123
 
 
124
@Returns: a #GtkProgressBar.
 
125
 
 
126
 
 
127
<!-- ##### FUNCTION gtk_progress_bar_pulse ##### -->
 
128
<para>
 
129
 
 
130
</para>
 
131
 
 
132
@pbar: 
 
133
 
 
134
 
 
135
<!-- ##### FUNCTION gtk_progress_bar_set_text ##### -->
 
136
<para>
 
137
 
 
138
</para>
 
139
 
 
140
@pbar: 
 
141
@text: 
 
142
 
 
143
 
 
144
<!-- ##### FUNCTION gtk_progress_bar_set_fraction ##### -->
 
145
<para>
 
146
 
 
147
</para>
 
148
 
 
149
@pbar: 
 
150
@fraction: 
 
151
 
 
152
 
 
153
<!-- ##### FUNCTION gtk_progress_bar_set_pulse_step ##### -->
 
154
<para>
 
155
 
 
156
</para>
 
157
 
 
158
@pbar: 
 
159
@fraction: 
 
160
 
 
161
 
 
162
<!-- ##### FUNCTION gtk_progress_bar_set_orientation ##### -->
 
163
<para>
 
164
 
 
165
</para>
 
166
 
 
167
@pbar: 
 
168
@orientation: 
 
169
 
 
170
 
 
171
<!-- ##### FUNCTION gtk_progress_bar_set_ellipsize ##### -->
 
172
<para>
 
173
 
 
174
</para>
 
175
 
 
176
@pbar: 
 
177
@mode: 
 
178
 
 
179
 
 
180
<!-- ##### ENUM GtkProgressBarOrientation ##### -->
 
181
<para>
 
182
An enumeration representing possible orientations and growth
 
183
directions for the visible progress bar.
 
184
</para>
 
185
 
 
186
@GTK_PROGRESS_LEFT_TO_RIGHT: A horizontal progress bar growing from left to right.
 
187
@GTK_PROGRESS_RIGHT_TO_LEFT: A horizontal progress bar growing from right to left.
 
188
@GTK_PROGRESS_BOTTOM_TO_TOP: A vertical progress bar growing from bottom to top.
 
189
@GTK_PROGRESS_TOP_TO_BOTTOM: A vertical progress bar growing from top to bottom.
 
190
 
 
191
<!-- ##### FUNCTION gtk_progress_bar_get_text ##### -->
 
192
<para>
 
193
 
 
194
</para>
 
195
 
 
196
@pbar: 
 
197
@Returns: 
 
198
 
 
199
 
 
200
<!-- ##### FUNCTION gtk_progress_bar_get_fraction ##### -->
 
201
<para>
 
202
 
 
203
</para>
 
204
 
 
205
@pbar: 
 
206
@Returns: 
 
207
 
 
208
 
 
209
<!-- ##### FUNCTION gtk_progress_bar_get_pulse_step ##### -->
 
210
<para>
 
211
 
 
212
</para>
 
213
 
 
214
@pbar: 
 
215
@Returns: 
 
216
 
 
217
 
 
218
<!-- ##### FUNCTION gtk_progress_bar_get_orientation ##### -->
 
219
<para>
 
220
 
 
221
</para>
 
222
 
 
223
@pbar: 
 
224
@Returns: 
 
225
 
 
226
 
 
227
<!-- ##### FUNCTION gtk_progress_bar_get_ellipsize ##### -->
 
228
<para>
 
229
 
 
230
</para>
 
231
 
 
232
@pbar: 
 
233
@Returns: 
 
234
 
 
235
 
 
236
<!-- ##### FUNCTION gtk_progress_bar_new_with_adjustment ##### -->
 
237
<para>
 
238
Creates a new #GtkProgressBar with an associated #GtkAdjustment.
 
239
</para>
 
240
 
 
241
@adjustment: a #GtkAdjustment.
 
242
@Returns: a #GtkProgressBar.
 
243
 
 
244
 
 
245
<!-- ##### FUNCTION gtk_progress_bar_set_bar_style ##### -->
 
246
<para>
 
247
Sets the style of the #GtkProgressBar.  The default style is
 
248
%GTK_PROGRESS_CONTINUOUS.
 
249
</para>
 
250
 
 
251
@pbar: a #GtkProgressBar.
 
252
@style: a #GtkProgressBarStyle value indicating the desired style.
 
253
 
 
254
 
 
255
<!-- ##### ENUM GtkProgressBarStyle ##### -->
 
256
<para>
 
257
An enumeration representing the styles for drawing the progress bar.
 
258
</para>
 
259
 
 
260
@GTK_PROGRESS_CONTINUOUS: The progress bar grows in a smooth, continuous manner.
 
261
@GTK_PROGRESS_DISCRETE: The progress bar grows in discrete, visible blocks.
 
262
 
 
263
<!-- ##### FUNCTION gtk_progress_bar_set_discrete_blocks ##### -->
 
264
<para>
 
265
Sets the number of blocks that the progress bar is divided into
 
266
when the style is %GTK_PROGRESS_DISCRETE.
 
267
</para>
 
268
 
 
269
@pbar: a #GtkProgressBar.
 
270
@blocks: number of individual blocks making up the bar.
 
271
 
 
272
 
 
273
<!-- ##### FUNCTION gtk_progress_bar_set_activity_step ##### -->
 
274
<para>
 
275
Sets the step value used when the progress bar is in activity
 
276
mode.  The step is the amount by which the progress is incremented
 
277
each iteration.
 
278
</para>
 
279
 
 
280
@pbar: a #GtkProgressBar.
 
281
@step: the amount which the progress is incremented in activity
 
282
mode.
 
283
 
 
284
 
 
285
<!-- ##### FUNCTION gtk_progress_bar_set_activity_blocks ##### -->
 
286
<para>
 
287
Sets the number of blocks used when the progress bar is in activity
 
288
mode.  Larger numbers make the visible block smaller.
 
289
</para>
 
290
 
 
291
@pbar: a #GtkProgressBar.
 
292
@blocks: number of blocks which can fit within the progress bar area.
 
293
 
 
294
 
 
295
<!-- ##### FUNCTION gtk_progress_bar_update ##### -->
 
296
<para>
 
297
This function is deprecated.  Please use gtk_progress_set_value() or
 
298
gtk_progress_set_percentage() instead.
 
299
</para>
 
300
 
 
301
@pbar: a #GtkProgressBar.
 
302
@percentage: the new percent complete value.
 
303
 
 
304