Create  Edit  FrontPage  Index  Search  Changes  History  RSS  Back  Login

Gtk::CellRendererProgress Diff - Ruby-GNOME2 Project Website

  • Added parts are displayed like this.
  • Deleted parts are displayed like this.

= class Gtk::CellRendererProgress

Gtk::CellRendererProgress renders numbers as progress bars.

== Object Hierarchy

* Object
  * GLib::Instantiatable
    * GLib::Object
      * GLib::InitiallyUnowned
        * Gtk::Object
          * Gtk::CellRenderer
            * Gtk::CellRendererProgress

== Class Methods

--- Gtk::CellRendererProgress.new

    Creates a new Gtk::CellRendererProgress. ((*Since 2.6*))
    * Returns: the new Gtk::CellRendererProgress

== Instance Methods

--- text

    Gets the String on the progress bar. ((*Since 2.6*))
    * Returns: the String on the progress bar

--- text=(text)

    Sets a String on the progress bar. ((*Since 2.6*))
    * text: a String on the progress bar
    * Returns: text

--- set_text(text)

    Same as Gtk::CellRendererProgress#text=. ((*Since 2.6*))
    * text: A String on the progress bar
    * Returns: self

--- value

    Gets the percentage to which the progress bar will be "filled in". ((*Since 2.6*))
    * Returns: the percentage to which the progress bar will be "filled in".

--- value=(value)

    Sets the percentage to which the progress bar will be "filled in". ((*Since 2.6*))
    * value: the percentage(Integer) to which the progress bar will be "filled in"
    * Returns: value

--- set_value(value)

    Same as Gtk::CellRendererProgress#value=. ((*Since 2.6*))
    * value: The percentage(Integer) to which the progress bar will be "filled in"
    * Returns: self

--- orientation

    Gets the Orientation and growth direction of the progress bar.
     * Returns: Orientation and growth direction of the progress bar

--- orientation=(orientation)

    Sets the Orientation and growth direction of the progress bar.
     * orientation: Orientation and growth direction of the progress bar
     * Returns: orientation

--- pulse

    Gets the Set this to positive values to indicate that some progress is made, but you don't know how much..
     * Returns: Set this to positive values to indicate that some progress is made, but you don't know how much.

--- pulse=(pulse)

    Sets the Set this to positive values to indicate that some progress is made, but you don't know how much..
     * pulse: Set this to positive values to indicate that some progress is made, but you don't know how much.
     * Returns: pulse

--- set_orientation(orientation)

    Same as orientation=.
     * orientation: Orientation and growth direction of the progress bar
     * Returns: self

--- set_pulse(pulse)

    Same as pulse=.
     * pulse: Set this to positive values to indicate that some progress is made, but you don't know how much.
     * Returns: self

--- set_text_xalign(text_xalign)

    Same as text_xalign=.
     * text_xalign: The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.
     * Returns: self

--- set_text_yalign(text_yalign)

    Same as text_yalign=.
     * text_yalign: The vertical text alignment, from 0 (top) to 1 (bottom).
     * Returns: self

--- text_xalign

    Gets the horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts..
     * Returns: The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

--- text_xalign=(text_xalign)

    Sets the horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts..
     * text_xalign: The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.
     * Returns: text_xalign

--- text_yalign

    Gets the vertical text alignment, from 0 (top) to 1 (bottom)..
     * Returns: The vertical text alignment, from 0 (top) to 1 (bottom).

--- text_yalign=(text_yalign)

    Sets the vertical text alignment, from 0 (top) to 1 (bottom)..
     * text_yalign: The vertical text alignment, from 0 (top) to 1 (bottom).
     * Returns: text_yalign

== Properties

--- text: String (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. ((*Since 2.6*))
    * Default value: nil

--- value: Integer (Read/Write)

    The "value" property determines the percentage to which the progress bar will be "filled in". ((*Since 2.6*))
    * Allowed values: [0,100]
    * Default value: 0

--- orientation: Gtk::ProgressBarOrientation (Read/Write)

    Orientation and growth direction of the progress bar

--- pulse: Integer (Read/Write)

    Set this to positive values to indicate that some progress is made, but you don't know how much.

--- text-xalign: Float (Read/Write)

    The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

--- text-yalign: Float (Read/Write)

    The vertical text alignment, from 0 (top) to 1 (bottom).

== See Also

== ChangeLog

* 2005-05-05 Added - ((<Masao>))