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
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkProgressBar: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
<link rel="prev" href="GtkInfoBar.html" title="GtkInfoBar">
<link rel="next" href="GtkLevelBar.html" title="GtkLevelBar">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkProgressBar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkProgressBar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkProgressBar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkProgressBar.properties" class="shortcut">Properties</a></span><span id="nav_style_properties"> <span class="dim">|</span>
<a href="#GtkProgressBar.style-properties" class="shortcut">Style Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkInfoBar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkLevelBar.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkProgressBar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkProgressBar.top_of_page"></a>GtkProgressBar</span></h2>
<p>GtkProgressBar — A widget which indicates progress visually</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="progressbar.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkProgressBar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-new" title="gtk_progress_bar_new ()">gtk_progress_bar_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()">gtk_progress_bar_pulse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-fraction" title="gtk_progress_bar_set_fraction ()">gtk_progress_bar_set_fraction</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-fraction" title="gtk_progress_bar_get_fraction ()">gtk_progress_bar_get_fraction</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-inverted" title="gtk_progress_bar_set_inverted ()">gtk_progress_bar_set_inverted</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-inverted" title="gtk_progress_bar_get_inverted ()">gtk_progress_bar_get_inverted</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-show-text" title="gtk_progress_bar_set_show_text ()">gtk_progress_bar_set_show_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-show-text" title="gtk_progress_bar_get_show_text ()">gtk_progress_bar_get_show_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-text" title="gtk_progress_bar_set_text ()">gtk_progress_bar_set_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-text" title="gtk_progress_bar_get_text ()">gtk_progress_bar_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-ellipsize" title="gtk_progress_bar_set_ellipsize ()">gtk_progress_bar_set_ellipsize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="returnvalue">PangoEllipsizeMode</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-ellipsize" title="gtk_progress_bar_get_ellipsize ()">gtk_progress_bar_get_ellipsize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-pulse-step" title="gtk_progress_bar_set_pulse_step ()">gtk_progress_bar_set_pulse_step</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-get-pulse-step" title="gtk_progress_bar_get_pulse_step ()">gtk_progress_bar_get_pulse_step</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--ellipsize" title="The “ellipsize” property">ellipsize</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title="The “fraction” property">fraction</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--inverted" title="The “inverted” property">inverted</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--pulse-step" title="The “pulse-step” property">pulse-step</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property">show-text</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title="The “text” property">text</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.style-properties"></a><h2>Style Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="style_properties_type">
<col width="300px" class="style_properties_name">
<col width="200px" class="style_properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-horizontal-bar-height" title="The “min-horizontal-bar-height” style property">min-horizontal-bar-height</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-horizontal-bar-width" title="The “min-horizontal-bar-width” style property">min-horizontal-bar-width</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-vertical-bar-height" title="The “min-vertical-bar-height” style property">min-vertical-bar-height</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--s-min-vertical-bar-width" title="The “min-vertical-bar-width” style property">min-vertical-bar-width</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--s-xspacing" title="The “xspacing” style property">xspacing</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar--s-yspacing" title="The “yspacing” style property">yspacing</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkProgressBar.html#GtkProgressBar-struct" title="struct GtkProgressBar">GtkProgressBar</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> GtkProgressBar
</pre>
</div>
<div class="refsect1">
<a name="GtkProgressBar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkProgressBar implements
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkProgressBar.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkProgressBar.description"></a><h2>Description</h2>
<p>The <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> is typically used to display the progress of a long
running operation. It provides a visual clue that processing is underway.
The GtkProgressBar can be used in two different modes: percentage mode
and activity mode.</p>
<p>When an application can determine how much work needs to take place
(e.g. read a fixed number of bytes from a file) and can monitor its
progress, it can use the GtkProgressBar in percentage mode and the
user sees a growing bar indicating the percentage of the work that
has been completed. In this mode, the application is required to call
<a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-fraction" title="gtk_progress_bar_set_fraction ()"><code class="function">gtk_progress_bar_set_fraction()</code></a> periodically to update the progress bar.</p>
<p>When an application has no accurate way of knowing the amount of work
to do, it can use the <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> in activity mode, which shows
activity by a block moving back and forth within the progress area. In
this mode, the application is required to call <a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()"><code class="function">gtk_progress_bar_pulse()</code></a>
periodically to update the progress bar.</p>
<p>There is quite a bit of flexibility provided to control the appearance
of the <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>. Functions are provided to control the orientation
of the bar, optional text can be displayed along with the bar, and the
step size used in activity mode can be set.</p>
<div class="refsect2">
<a name="id-1.3.8.6.10.6"></a><h3>CSS nodes</h3>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting">progressbar<span class="gtkdoc opt">[.</span>osd<span class="gtkdoc opt">]</span>
╰── trough<span class="gtkdoc opt">[.</span>empty<span class="gtkdoc opt">][.</span>full<span class="gtkdoc opt">]</span>
├── <span class="gtkdoc opt">[</span>text<span class="gtkdoc opt">]</span>
╰── progress<span class="gtkdoc opt">[.</span>pulse<span class="gtkdoc opt">]</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>GtkProgressBar has a main CSS node with name progressbar and subnodes with
names text, trough and progress. The text subnode is only present if text
is shown. The progress subnode has the style class .pulse when in activity
mode. It gets the style classes .left, .right, .top or .bottom added when
the progress 'touches' the corresponding end of the GtkProgressBar.
The .osd class on the progressbar node is for use in overlays like the one
epiphany has for page loading progress.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-progress-bar-new"></a><h3>gtk_progress_bar_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_progress_bar_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-pulse"></a><h3>gtk_progress_bar_pulse ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_pulse (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Indicates that some progress has been made, but you don’t know how much.
Causes the progress bar to enter “activity mode,” where a block
bounces back and forth. Each call to <a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()"><code class="function">gtk_progress_bar_pulse()</code></a>
causes the block to move by a little bit (the amount of movement
per pulse is determined by <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-pulse-step" title="gtk_progress_bar_set_pulse_step ()"><code class="function">gtk_progress_bar_set_pulse_step()</code></a>).</p>
<div class="refsect3">
<a name="gtk-progress-bar-pulse.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-set-fraction"></a><h3>gtk_progress_bar_set_fraction ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_set_fraction (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
<p>Causes the progress bar to “fill in” the given fraction
of the bar. The fraction should be between 0.0 and 1.0,
inclusive.</p>
<div class="refsect3">
<a name="gtk-progress-bar-set-fraction.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fraction</p></td>
<td class="parameter_description"><p>fraction of the task that’s been completed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-get-fraction"></a><h3>gtk_progress_bar_get_fraction ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_progress_bar_get_fraction (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Returns the current fraction of the task that’s been completed.</p>
<div class="refsect3">
<a name="gtk-progress-bar-get-fraction.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-progress-bar-get-fraction.returns"></a><h4>Returns</h4>
<p> a fraction from 0.0 to 1.0</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-set-inverted"></a><h3>gtk_progress_bar_set_inverted ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_set_inverted (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> inverted</code></em>);</pre>
<p>Progress bars normally grow from top to bottom or left to right.
Inverted progress bars grow in the opposite direction.</p>
<div class="refsect3">
<a name="gtk-progress-bar-set-inverted.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inverted</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to invert the progress bar</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-get-inverted"></a><h3>gtk_progress_bar_get_inverted ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_progress_bar_get_inverted (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Gets the value set by <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-inverted" title="gtk_progress_bar_set_inverted ()"><code class="function">gtk_progress_bar_set_inverted()</code></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-get-inverted.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-progress-bar-get-inverted.returns"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the progress bar is inverted</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-set-show-text"></a><h3>gtk_progress_bar_set_show_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_set_show_text (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_text</code></em>);</pre>
<p>Sets whether the progress bar will show text next to the bar.
The shown text is either the value of the <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title="The “text” property"><span class="type">“text”</span></a>
property or, if that is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title="The “fraction” property"><span class="type">“fraction”</span></a> value,
as a percentage.</p>
<p>To make a progress bar that is styled and sized suitably for containing
text (even if the actual text is blank), set <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property"><span class="type">“show-text”</span></a> to
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title="The “text” property"><span class="type">“text”</span></a> to the empty string (not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</p>
<div class="refsect3">
<a name="gtk-progress-bar-set-show-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_text</p></td>
<td class="parameter_description"><p>whether to show superimposed text</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-get-show-text"></a><h3>gtk_progress_bar_get_show_text ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_progress_bar_get_show_text (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Gets the value of the <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property"><span class="type">“show-text”</span></a> property.
See <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-show-text" title="gtk_progress_bar_set_show_text ()"><code class="function">gtk_progress_bar_set_show_text()</code></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-get-show-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-progress-bar-get-show-text.returns"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if text is shown in the progress bar</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-set-text"></a><h3>gtk_progress_bar_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_set_text (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>Causes the given <em class="parameter"><code>text</code></em>
to appear next to the progress bar.</p>
<p>If <em class="parameter"><code>text</code></em>
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property"><span class="type">“show-text”</span></a> is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the current
value of <a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title="The “fraction” property"><span class="type">“fraction”</span></a> will be displayed as a percentage.</p>
<p>If <em class="parameter"><code>text</code></em>
is non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property"><span class="type">“show-text”</span></a> is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the text
will be displayed. In this case, it will not display the progress
percentage. If <em class="parameter"><code>text</code></em>
is the empty string, the progress bar will still
be styled and sized suitably for containing text, as long as
<a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property"><span class="type">“show-text”</span></a> is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-set-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p> a UTF-8 string, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-get-text"></a><h3>gtk_progress_bar_get_text ()</h3>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_progress_bar_get_text (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Retrieves the text that is displayed with the progress bar,
if any, otherwise <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The return value is a reference
to the text, not a copy of it, so will become invalid
if you change the text in the progress bar.</p>
<div class="refsect3">
<a name="gtk-progress-bar-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-progress-bar-get-text.returns"></a><h4>Returns</h4>
<p> text, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; this string is owned by the widget
and should not be modified or freed. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-set-ellipsize"></a><h3>gtk_progress_bar_set_ellipsize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_set_ellipsize (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
<em class="parameter"><code><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a> mode</code></em>);</pre>
<p>Sets the mode used to ellipsize (add an ellipsis: "...") the
text if there is not enough space to render the entire string.</p>
<div class="refsect3">
<a name="gtk-progress-bar-set-ellipsize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>a <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-get-ellipsize"></a><h3>gtk_progress_bar_get_ellipsize ()</h3>
<pre class="programlisting"><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="returnvalue">PangoEllipsizeMode</span></a>
gtk_progress_bar_get_ellipsize (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Returns the ellipsizing position of the progress bar.
See <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-ellipsize" title="gtk_progress_bar_set_ellipsize ()"><code class="function">gtk_progress_bar_set_ellipsize()</code></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-get-ellipsize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-progress-bar-get-ellipsize.returns"></a><h4>Returns</h4>
<p> <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a></p>
</div>
<p class="since">Since: 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-set-pulse-step"></a><h3>gtk_progress_bar_set_pulse_step ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_progress_bar_set_pulse_step (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
<p>Sets the fraction of total progress bar length to move the
bouncing block for each call to <a class="link" href="GtkProgressBar.html#gtk-progress-bar-pulse" title="gtk_progress_bar_pulse ()"><code class="function">gtk_progress_bar_pulse()</code></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-set-pulse-step.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fraction</p></td>
<td class="parameter_description"><p>fraction between 0.0 and 1.0</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-progress-bar-get-pulse-step"></a><h3>gtk_progress_bar_get_pulse_step ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_progress_bar_get_pulse_step (<em class="parameter"><code><a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> *pbar</code></em>);</pre>
<p>Retrieves the pulse step set with <a class="link" href="GtkProgressBar.html#gtk-progress-bar-set-pulse-step" title="gtk_progress_bar_set_pulse_step ()"><code class="function">gtk_progress_bar_set_pulse_step()</code></a>.</p>
<div class="refsect3">
<a name="gtk-progress-bar-get-pulse-step.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pbar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-progress-bar-get-pulse-step.returns"></a><h4>Returns</h4>
<p> a fraction from 0.0 to 1.0</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkProgressBar-struct"></a><h3>struct GtkProgressBar</h3>
<pre class="programlisting">struct GtkProgressBar;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkProgressBar--ellipsize"></a><h3>The <code class="literal">“ellipsize”</code> property</h3>
<pre class="programlisting"> “ellipsize” <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a></pre>
<p>The preferred place to ellipsize the string, if the progress bar does
not have enough room to display the entire string, specified as a
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>.</p>
<p>Note that setting this property to a value other than
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Layout-Objects.html#PANGO-ELLIPSIZE-NONE:CAPS"><code class="literal">PANGO_ELLIPSIZE_NONE</code></a> has the side-effect that the progress bar requests
only enough space to display the ellipsis ("..."). Another means to set a
progress bar's width is <a class="link" href="GtkWidget.html#gtk-widget-set-size-request" title="gtk_widget_set_size_request ()"><code class="function">gtk_widget_set_size_request()</code></a>.</p>
<p>Flags: Read / Write</p>
<p>Default value: PANGO_ELLIPSIZE_NONE</p>
<p class="since">Since: 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--fraction"></a><h3>The <code class="literal">“fraction”</code> property</h3>
<pre class="programlisting"> “fraction” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The fraction of total work that has been completed.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--inverted"></a><h3>The <code class="literal">“inverted”</code> property</h3>
<pre class="programlisting"> “inverted” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Invert the direction in which the progress bar grows.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--pulse-step"></a><h3>The <code class="literal">“pulse-step”</code> property</h3>
<pre class="programlisting"> “pulse-step” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The fraction of total progress to move the bouncing block when pulsed.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.1</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--show-text"></a><h3>The <code class="literal">“show-text”</code> property</h3>
<pre class="programlisting"> “show-text” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Sets whether the progress bar will show a text in addition
to the bar itself. The shown text is either the value of
the <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title="The “text” property"><span class="type">“text”</span></a> property or, if that is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
the <a class="link" href="GtkProgressBar.html#GtkProgressBar--fraction" title="The “fraction” property"><span class="type">“fraction”</span></a> value, as a percentage.</p>
<p>To make a progress bar that is styled and sized suitably for
showing text (even if the actual text is blank), set
<a class="link" href="GtkProgressBar.html#GtkProgressBar--show-text" title="The “show-text” property"><span class="type">“show-text”</span></a> to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and <a class="link" href="GtkProgressBar.html#GtkProgressBar--text" title="The “text” property"><span class="type">“text”</span></a>
to the empty string (not <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--text"></a><h3>The <code class="literal">“text”</code> property</h3>
<pre class="programlisting"> “text” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Text to be displayed in the progress bar.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GtkProgressBar.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="GtkProgressBar--s-min-horizontal-bar-height"></a><h3>The <code class="literal">“min-horizontal-bar-height”</code> style property</h3>
<pre class="programlisting"> “min-horizontal-bar-height” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Minimum horizontal height of the progress bar.</p>
<div class="warning">
<p><code class="literal">GtkProgressBar:min-horizontal-bar-height</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use the standard CSS property min-height.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 6</p>
<p class="since">Since: 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--s-min-horizontal-bar-width"></a><h3>The <code class="literal">“min-horizontal-bar-width”</code> style property</h3>
<pre class="programlisting"> “min-horizontal-bar-width” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The minimum horizontal width of the progress bar.</p>
<div class="warning">
<p><code class="literal">GtkProgressBar:min-horizontal-bar-width</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use the standard CSS property min-width.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 150</p>
<p class="since">Since: 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--s-min-vertical-bar-height"></a><h3>The <code class="literal">“min-vertical-bar-height”</code> style property</h3>
<pre class="programlisting"> “min-vertical-bar-height” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The minimum vertical height of the progress bar.</p>
<div class="warning">
<p><code class="literal">GtkProgressBar:min-vertical-bar-height</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use the standard CSS property min-height.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 80</p>
<p class="since">Since: 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--s-min-vertical-bar-width"></a><h3>The <code class="literal">“min-vertical-bar-width”</code> style property</h3>
<pre class="programlisting"> “min-vertical-bar-width” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The minimum vertical width of the progress bar.</p>
<div class="warning">
<p><code class="literal">GtkProgressBar:min-vertical-bar-width</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use the standard CSS proeprty min-width.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 7</p>
<p class="since">Since: 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--s-xspacing"></a><h3>The <code class="literal">“xspacing”</code> style property</h3>
<pre class="programlisting"> “xspacing” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Extra spacing applied to the width of a progress bar.</p>
<div class="warning">
<p><code class="literal">GtkProgressBar:xspacing</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use the standard CSS padding and margins; the
value of this style property is ignored.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 2</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkProgressBar--s-yspacing"></a><h3>The <code class="literal">“yspacing”</code> style property</h3>
<pre class="programlisting"> “yspacing” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Extra spacing applied to the height of a progress bar.</p>
<div class="warning">
<p><code class="literal">GtkProgressBar:yspacing</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use the standard CSS padding and margins; the
value of this style property is ignored.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 2</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>
|
