Pileus Git - ~andy/gtk/blob - 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 <!-- ##### SECTION See_Also ##### -->
  40 <para>
  41
  42 </para>
  43
  44 <!-- ##### SECTION Stability_Level ##### -->
  45
  46
  47 <!-- ##### SECTION Image ##### -->
  48
  49
  50 <!-- ##### STRUCT GtkProgressBar ##### -->
  51 <para>
  52 The #GtkProgressBar-struct struct contains private data only,
  53 and should be accessed using the functions below.
  54 </para>
  55
  56
  57 <!-- ##### ARG GtkProgressBar:ellipsize ##### -->
  58 <para>
  59
  60 </para>
  61
  62 <!-- ##### ARG GtkProgressBar:fraction ##### -->
  63 <para>
  64
  65 </para>
  66
  67 <!-- ##### ARG GtkProgressBar:inverted ##### -->
  68 <para>
  69
  70 </para>
  71
  72 <!-- ##### ARG GtkProgressBar:pulse-step ##### -->
  73 <para>
  74
  75 </para>
  76
  77 <!-- ##### ARG GtkProgressBar:show-text ##### -->
  78 <para>
  79
  80 </para>
  81
  82 <!-- ##### ARG GtkProgressBar:text ##### -->
  83 <para>
  84
  85 </para>
  86
  87 <!-- ##### ARG GtkProgressBar:min-horizontal-bar-height ##### -->
  88 <para>
  89
  90 </para>
  91
  92 <!-- ##### ARG GtkProgressBar:min-horizontal-bar-width ##### -->
  93 <para>
  94
  95 </para>
  96
  97 <!-- ##### ARG GtkProgressBar:min-vertical-bar-height ##### -->
  98 <para>
  99
 100 </para>
 101
 102 <!-- ##### ARG GtkProgressBar:min-vertical-bar-width ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkProgressBar:xspacing ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkProgressBar:yspacing ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### FUNCTION gtk_progress_bar_new ##### -->
 118 <para>
 119 Creates a new #GtkProgressBar.
 120 </para>
 121
 122 @void:
 123 @Returns: a #GtkProgressBar.
 124
 125
 126 <!-- ##### FUNCTION gtk_progress_bar_pulse ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @pbar:
 132
 133
 134 <!-- ##### FUNCTION gtk_progress_bar_set_fraction ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @pbar:
 140 @fraction:
 141
 142
 143 <!-- ##### FUNCTION gtk_progress_bar_get_fraction ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @pbar:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION gtk_progress_bar_set_inverted ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @pbar:
 158 @inverted:
 159
 160
 161 <!-- ##### FUNCTION gtk_progress_bar_get_inverted ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @pbar:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION gtk_progress_bar_set_show_text ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @pbar:
 176 @show_text:
 177
 178
 179 <!-- ##### FUNCTION gtk_progress_bar_get_show_text ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @pbar:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION gtk_progress_bar_set_text ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @pbar:
 194 @text:
 195
 196
 197 <!-- ##### FUNCTION gtk_progress_bar_get_text ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @pbar:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_progress_bar_set_ellipsize ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @pbar:
 212 @mode:
 213
 214
 215 <!-- ##### FUNCTION gtk_progress_bar_get_ellipsize ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @pbar:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION gtk_progress_bar_set_pulse_step ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @pbar:
 230 @fraction:
 231
 232
 233 <!-- ##### FUNCTION gtk_progress_bar_get_pulse_step ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @pbar:
 239 @Returns:
 240
 241