Class: Gtk::CellRendererProgress

Inherits:

CellRenderer

• Object
• GObject::InitiallyUnowned
• CellRenderer
• Gtk::CellRendererProgress

Defined in:

(unknown)

Overview

Renders numbers as progress bars

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

Instance Method Summary

• #initialize ⇒ Gtk::CellRenderer constructor

  Creates a new GtkCellRendererProgress.

• #inverted=(inverted) ⇒ Boolean
• #inverted? ⇒ Boolean

  Inverted.

• #pulse ⇒ Integer

  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.

• #pulse=(pulse) ⇒ Integer

  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.

• #text ⇒ String

  The "text" property determines the label which will be drawn over the progress bar.

• #text=(text) ⇒ String

  The "text" property determines the label which will be drawn over the progress bar.

• #text_xalign ⇒ Gtk::gfloat

  The "text-xalign" property controls the horizontal alignment of the text in the progress bar.

• #text_xalign=(text_xalign) ⇒ Gtk::gfloat

  The "text-xalign" property controls the horizontal alignment of the text in the progress bar.

• #text_yalign ⇒ Gtk::gfloat

  The "text-yalign" property controls the vertical alignment of the text in the progress bar.

• #text_yalign=(text_yalign) ⇒ Gtk::gfloat

  The "text-yalign" property controls the vertical alignment of the text in the progress bar.

• #value ⇒ Integer

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

• #value=(value) ⇒ Integer

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

Methods inherited from CellRenderer

#activate, #cell_background=, #cell_background_rgba, #cell_background_rgba=, #cell_background_set=, #cell_background_set?, #editing=, #editing?, #get_aligned_area, #get_alignment, #get_fixed_size, #get_padding, #get_preferred_height, #get_preferred_height_for_width, #get_preferred_size, #get_preferred_width, #get_preferred_width_for_height, #get_state, #height, #height=, #is_activatable, #is_expanded, #is_expanded=, #is_expanded?, #is_expander, #is_expander=, #is_expander?, #mode, #mode=, #request_mode, #sensitive, #sensitive=, #sensitive?, #set_alignment, #set_fixed_size, #set_padding, #snapshot, #start_editing, #stop_editing, #visible, #visible=, #visible?, #width, #width=, #xalign, #xalign=, #xpad, #xpad=, #yalign, #yalign=, #ypad, #ypad=

Constructor Details

#initialize ⇒ Gtk::CellRenderer

Creates a new GtkCellRendererProgress.

Instance Method Details

#inverted=(inverted) ⇒ Boolean

Parameters:

• inverted (Boolean)

Returns:

• (Boolean) —

  inverted

• (Boolean) —

  inverted

#inverted? ⇒ Boolean

Returns inverted.

Returns:

• (Boolean) —

  inverted

#pulse ⇒ Integer

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.

Returns:

• (Integer) —

  pulse

#pulse=(pulse) ⇒ Integer

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.

Parameters:

• pulse (Integer)

Returns:

• (Integer) —

  pulse

• (Integer) —

  pulse

#text ⇒ String

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

Returns:

• (String) —

  text

#text=(text) ⇒ String

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

Parameters:

• text (String)

Returns:

• (String) —

  text

• (String) —

  text

#text_xalign ⇒ Gtk::gfloat

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.

Returns:

• (Gtk::gfloat) —

  text-xalign

#text_xalign=(text_xalign) ⇒ Gtk::gfloat

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.

Parameters:

• text_xalign (Gtk::gfloat)

Returns:

• (Gtk::gfloat) —

  text-xalign

• (Gtk::gfloat) —

  text-xalign

#text_yalign ⇒ Gtk::gfloat

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

Returns:

• (Gtk::gfloat) —

  text-yalign

#text_yalign=(text_yalign) ⇒ Gtk::gfloat

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

Parameters:

• text_yalign (Gtk::gfloat)

Returns:

• (Gtk::gfloat) —

  text-yalign

• (Gtk::gfloat) —

  text-yalign

#value ⇒ Integer

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

Returns:

• (Integer) —

  value

#value=(value) ⇒ Integer

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

Parameters:

• value (Integer)

Returns:

• (Integer) —

  value

• (Integer) —

  value