GtkCellRendererProgress

GtkCellRendererProgress — Renders numbers as progress bars

Synopsis


#include <gtk/gtk.h>


                    GtkCellRendererProgress;
GtkCellRenderer*    gtk_cell_renderer_progress_new      (void);


Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkCellRenderer
                     +----GtkCellRendererProgress

Properties


  "orientation"              GtkProgressBarOrientation  : Read / Write
  "pulse"                    gint                  : Read / Write
  "text"                     gchararray            : Read / Write
  "text-xalign"              gfloat                : Read / Write
  "text-yalign"              gfloat                : Read / Write
  "value"                    gint                  : Read / Write

Description

GtkCellRendererProgress renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.

The GtkCellRendererProgress cell renderer was added in GTK+ 2.6.

Details

GtkCellRendererProgress

typedef struct _GtkCellRendererProgress GtkCellRendererProgress;


gtk_cell_renderer_progress_new ()

GtkCellRenderer*    gtk_cell_renderer_progress_new      (void);

Creates a new GtkCellRendererProgress.

Returns :

the new cell renderer

Since 2.6

Property Details

The "orientation" property

  "orientation"              GtkProgressBarOrientation  : Read / Write

The "orientation" property controls the direction and growth direction of the progress bar (left-to-right, right-to-left, top-to-bottom or bottom-to-top).

Default value: GTK_PROGRESS_LEFT_TO_RIGHT

Since 2.12


The "pulse" property

  "pulse"                    gint                  : Read / Write

Setting this to a non-negative value causes the cell renderer to enter "activity mode", where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.

Each increment of the property causes the block to move by a little bit.

To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to G_MAXINT.

Allowed values: >= -1

Default value: -1

Since 2.12


The "text" property

  "text"                     gchararray            : Read / Write

The "text" property determines the label which will be drawn over the progress bar. Setting this property to NULL causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.

Default value: NULL

Since 2.6


The "text-xalign" property

  "text-xalign"              gfloat                : Read / Write

The "text-xalign" property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.

Allowed values: [0,1]

Default value: 0.5

Since 2.12


The "text-yalign" property

  "text-yalign"              gfloat                : Read / Write

The "text-yalign" property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).

Allowed values: [0,1]

Default value: 0.5

Since 2.12


The "value" property

  "value"                    gint                  : Read / Write

The "value" property determines the percentage to which the progress bar will be "filled in".

Allowed values: [0,100]

Default value: 0

Since 2.6