src/gtk/ProgressBar.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * duit is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with duit; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = GtkProgressBar.html
  26  * outPack = gtk
  27  * outFile = ProgressBar
  28  * strct   = GtkProgressBar
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = ProgressBar
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gtk_progress_bar_
  40  *      - gtk_
  41  * omit structs:
  42  * omit prefixes:
  43  * omit code:
  44  * imports:
  45  *      - glib.Str
  46  *      - gtk.Adjustment
  47  * structWrap:
  48  *      - GtkAdjustment* -> Adjustment
  49  * local aliases:
  50  */
  51
  52 module gtk.ProgressBar;
  53
  54 private import gtk.gtktypes;
  55
  56 private import lib.gtk;
  57
  58 private import glib.Str;
  59 private import gtk.Adjustment;
  60
  61 /**
  62  * Description
  63  * The GtkProgressBar is typically used to display the progress of a long
  64  * running operation. It provides a visual clue that processing
  65  * is underway. The GtkProgressBar can be used in two different
  66  * modes: percentage mode and activity mode.
  67  * When an application can determine how much work needs to take place
  68  * (e.g. read a fixed number of bytes from a file) and can monitor its
  69  * progress, it can use the GtkProgressBar in percentage mode and the user
  70  * sees a growing bar indicating the percentage of the work that has
  71  * been completed. In this mode, the application is required to call
  72  * gtk_progress_bar_set_fraction() periodically to update the progress bar.
  73  * When an application has no accurate way of knowing the amount of work
  74  * to do, it can use the GtkProgressBar in activity mode, which shows activity
  75  * by a block moving back and forth within the progress area. In this mode,
  76  * the application is required to call gtk_progress_bar_pulse() perodically
  77  * to update the progress bar.
  78  * There is quite a bit of flexibility provided to control the appearance
  79  * of the GtkProgressBar. Functions are provided to control the
  80  * orientation of the bar, optional text can be displayed along with
  81  * the bar, and the step size used in activity mode can be set.
  82  * Note
  83  * The GtkProgressBar/GtkProgress API in GTK 1.2 was bloated, needlessly complex
  84  * and hard to use properly. Therefore GtkProgress has been deprecated
  85  * completely and the GtkProgressBar API has been reduced to the following 10
  86  * functions: gtk_progress_bar_new(), gtk_progress_bar_pulse(),
  87  * gtk_progress_bar_set_text(), gtk_progress_bar_set_fraction(),
  88  * gtk_progress_bar_set_pulse_step(), gtk_progress_bar_set_orientation(),
  89  * gtk_progress_bar_get_text(), gtk_progress_bar_get_fraction(),
  90  * gtk_progress_bar_get_pulse_step(), gtk_progress_bar_get_orientation().
  91  * These have been grouped at the beginning of this section, followed by
  92  * a large chunk of deprecated 1.2 compatibility functions.
  93  */
  94 private import gtk.Progress;
  95 public class ProgressBar : Progress
  96 {
  97
  98         /** the main Gtk struct */
  99         protected GtkProgressBar* gtkProgressBar;
 100
 101
 102         public GtkProgressBar* getProgressBarStruct()
 103         {
 104                 return gtkProgressBar;
 105         }
 106
 107
 108         /** the main Gtk struct as a void* */
 109         protected void* getStruct()
 110         {
 111                 return cast(void*)gtkProgressBar;
 112         }
 113
 114         /**
 115          * Sets our main struct and passes it to the parent class
 116          */
 117         public this (GtkProgressBar* gtkProgressBar)
 118         {
 119                 super(cast(GtkProgress*)gtkProgressBar);
 120                 this.gtkProgressBar = gtkProgressBar;
 121         }
 122
 123         /**
 124          */
 125
 126
 127         /**
 128          * Creates a new GtkProgressBar.
 129          * Returns:
 130          * a GtkProgressBar.
 131          */
 132         public this ()
 133         {
 134                 // GtkWidget* gtk_progress_bar_new (void);
 135                 this(cast(GtkProgressBar*)gtk_progress_bar_new() );
 136         }
 137
 138         /**
 139          * Indicates that some progress is made, but you don't know how much.
 140          * Causes the progress bar to enter "activity mode," where a block
 141          * bounces back and forth. Each call to gtk_progress_bar_pulse()
 142          * causes the block to move by a little bit (the amount of movement
 143          * per pulse is determined by gtk_progress_bar_set_pulse_step()).
 144          * pbar:
 145          *  a GtkProgressBar
 146          */
 147         public void pulse()
 148         {
 149                 // void gtk_progress_bar_pulse (GtkProgressBar *pbar);
 150                 gtk_progress_bar_pulse(gtkProgressBar);
 151         }
 152
 153         /**
 154          * Causes the given text to appear superimposed on the progress bar.
 155          * pbar:
 156          *  a GtkProgressBar
 157          * text:
 158          *  a UTF-8 string, or NULL
 159          */
 160         public void setText(char[] text)
 161         {
 162                 // void gtk_progress_bar_set_text (GtkProgressBar *pbar,  const gchar *text);
 163                 gtk_progress_bar_set_text(gtkProgressBar, Str.toStringz(text));
 164         }
 165
 166         /**
 167          * Causes the progress bar to "fill in" the given fraction
 168          * of the bar. The fraction should be between 0.0 and 1.0,
 169          * inclusive.
 170          * pbar:
 171          *  a GtkProgressBar
 172          * fraction:
 173          *  fraction of the task that's been completed
 174          */
 175         public void setFraction(double fraction)
 176         {
 177                 // void gtk_progress_bar_set_fraction (GtkProgressBar *pbar,  gdouble fraction);
 178                 gtk_progress_bar_set_fraction(gtkProgressBar, fraction);
 179         }
 180
 181         /**
 182          * Sets the fraction of total progress bar length to move the
 183          * bouncing block for each call to gtk_progress_bar_pulse().
 184          * pbar:
 185          *  a GtkProgressBar
 186          * fraction:
 187          *  fraction between 0.0 and 1.0
 188          */
 189         public void setPulseStep(double fraction)
 190         {
 191                 // void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar,  gdouble fraction);
 192                 gtk_progress_bar_set_pulse_step(gtkProgressBar, fraction);
 193         }
 194
 195         /**
 196          * Causes the progress bar to switch to a different orientation
 197          * (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
 198          * pbar:
 199          *  a GtkProgressBar
 200          * orientation:
 201          *  orientation of the progress bar
 202          */
 203         public void setOrientation(GtkProgressBarOrientation orientation)
 204         {
 205                 // void gtk_progress_bar_set_orientation  (GtkProgressBar *pbar,  GtkProgressBarOrientation orientation);
 206                 gtk_progress_bar_set_orientation(gtkProgressBar, orientation);
 207         }
 208
 209         /**
 210          * Sets the mode used to ellipsize (add an ellipsis: "...") the text
 211          * if there is not enough space to render the entire string.
 212          * pbar:
 213          *  a GtkProgressBar
 214          * mode:
 215          *  a PangoEllipsizeMode
 216          * Since 2.6
 217          */
 218         public void setEllipsize(PangoEllipsizeMode mode)
 219         {
 220                 // void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar,  PangoEllipsizeMode mode);
 221                 gtk_progress_bar_set_ellipsize(gtkProgressBar, mode);
 222         }
 223
 224
 225         /**
 226          * Retrieves the text displayed superimposed on the progress bar,
 227          * if any, otherwise NULL. The return value is a reference
 228          * to the text, not a copy of it, so will become invalid
 229          * if you change the text in the progress bar.
 230          * pbar:
 231          *  a GtkProgressBar
 232          * Returns:
 233          *  text, or NULL; this string is owned by the widget
 234          * and should not be modified or freed.
 235          */
 236         public char[] getText()
 237         {
 238                 // const gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar);
 239                 return Str.toString(gtk_progress_bar_get_text(gtkProgressBar) );
 240         }
 241
 242         /**
 243          * Returns the current fraction of the task that's been completed.
 244          * pbar:
 245          *  a GtkProgressBar
 246          * Returns:
 247          *  a fraction from 0.0 to 1.0
 248          */
 249         public double getFraction()
 250         {
 251                 // gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar);
 252                 return gtk_progress_bar_get_fraction(gtkProgressBar);
 253         }
 254
 255         /**
 256          * Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
 257          * pbar:
 258          *  a GtkProgressBar
 259          * Returns:
 260          *  a fraction from 0.0 to 1.0
 261          */
 262         public double getPulseStep()
 263         {
 264                 // gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
 265                 return gtk_progress_bar_get_pulse_step(gtkProgressBar);
 266         }
 267
 268         /**
 269          * Retrieves the current progress bar orientation.
 270          * pbar:
 271          *  a GtkProgressBar
 272          * Returns:
 273          *  orientation of the progress bar
 274          */
 275         public GtkProgressBarOrientation getOrientation()
 276         {
 277                 // GtkProgressBarOrientation gtk_progress_bar_get_orientation  (GtkProgressBar *pbar);
 278                 return gtk_progress_bar_get_orientation(gtkProgressBar);
 279         }
 280
 281         /**
 282          * Returns the ellipsizing position of the progressbar.
 283          * See gtk_progress_bar_set_ellipsize().
 284          * pbar:
 285          *  a GtkProgressBar
 286          * Returns:
 287          *  PangoEllipsizeMode
 288          * Since 2.6
 289          */
 290         public PangoEllipsizeMode getEllipsize()
 291         {
 292                 // PangoEllipsizeMode gtk_progress_bar_get_ellipsize  (GtkProgressBar *pbar);
 293                 return gtk_progress_bar_get_ellipsize(gtkProgressBar);
 294         }
 295
 296         /**
 297          * Warning
 298          * gtk_progress_bar_new_with_adjustment is deprecated and should not be used in newly-written code.
 299          * Creates a new GtkProgressBar with an associated GtkAdjustment.
 300          * adjustment:
 301          * a GtkAdjustment.
 302          * Returns:
 303          * a GtkProgressBar.
 304          */
 305         public this (Adjustment adjustment)
 306         {
 307                 // GtkWidget* gtk_progress_bar_new_with_adjustment  (GtkAdjustment *adjustment);
 308                 this(cast(GtkProgressBar*)gtk_progress_bar_new_with_adjustment((adjustment is null) ? null : adjustment.getAdjustmentStruct()) );
 309         }
 310
 311         /**
 312          * Warning
 313          * gtk_progress_bar_set_bar_style is deprecated and should not be used in newly-written code.
 314          * Sets the style of the GtkProgressBar. The default style is
 315          * GTK_PROGRESS_CONTINUOUS.
 316          * pbar:
 317          * a GtkProgressBar.
 318          * style:
 319          * a GtkProgressBarStyle value indicating the desired style.
 320          */
 321         public void setBarStyle(GtkProgressBarStyle style)
 322         {
 323                 // void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar,  GtkProgressBarStyle style);
 324                 gtk_progress_bar_set_bar_style(gtkProgressBar, style);
 325         }
 326
 327
 328         /**
 329          * Warning
 330          * gtk_progress_bar_set_discrete_blocks is deprecated and should not be used in newly-written code.
 331          * Sets the number of blocks that the progress bar is divided into
 332          * when the style is GTK_PROGRESS_DISCRETE.
 333          * pbar:
 334          * a GtkProgressBar.
 335          * blocks:
 336          * number of individual blocks making up the bar.
 337          */
 338         public void setDiscreteBlocks(uint blocks)
 339         {
 340                 // void gtk_progress_bar_set_discrete_blocks  (GtkProgressBar *pbar,  guint blocks);
 341                 gtk_progress_bar_set_discrete_blocks(gtkProgressBar, blocks);
 342         }
 343
 344         /**
 345          * Warning
 346          * gtk_progress_bar_set_activity_step is deprecated and should not be used in newly-written code.
 347          * Sets the step value used when the progress bar is in activity
 348          * mode. The step is the amount by which the progress is incremented
 349          * each iteration.
 350          * pbar:
 351          * a GtkProgressBar.
 352          * step:
 353          * the amount which the progress is incremented in activity
 354          * mode.
 355          */
 356         public void setActivityStep(uint step)
 357         {
 358                 // void gtk_progress_bar_set_activity_step  (GtkProgressBar *pbar,  guint step);
 359                 gtk_progress_bar_set_activity_step(gtkProgressBar, step);
 360         }
 361
 362         /**
 363          * Warning
 364          * gtk_progress_bar_set_activity_blocks is deprecated and should not be used in newly-written code.
 365          * Sets the number of blocks used when the progress bar is in activity
 366          * mode. Larger numbers make the visible block smaller.
 367          * pbar:
 368          * a GtkProgressBar.
 369          * blocks:
 370          * number of blocks which can fit within the progress bar area.
 371          */
 372         public void setActivityBlocks(uint blocks)
 373         {
 374                 // void gtk_progress_bar_set_activity_blocks  (GtkProgressBar *pbar,  guint blocks);
 375                 gtk_progress_bar_set_activity_blocks(gtkProgressBar, blocks);
 376         }
 377
 378         /**
 379          * Warning
 380          * gtk_progress_bar_update is deprecated and should not be used in newly-written code.
 381          * This function is deprecated. Please use gtk_progress_set_value() or
 382          * gtk_progress_set_percentage() instead.
 383          * pbar:
 384          * a GtkProgressBar.
 385          * percentage:
 386          * the new percent complete value.
 387          * Property Details
 388          * The "activity-blocks" property
 389          *  "activity-blocks" guint : Read / Write
 390          * The number of blocks which can fit in the progress bar area in activity mode (Deprecated).
 391          * Allowed values: >= 2
 392          * Default value: 5
 393          */
 394         public void update(double percentage)
 395         {
 396                 // void gtk_progress_bar_update (GtkProgressBar *pbar,  gdouble percentage);
 397                 gtk_progress_bar_update(gtkProgressBar, percentage);
 398         }
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409 }