logo top
Main Page   Widgets   Namespaces   Book  

Gtk::CellRendererToggle Class Reference
[TreeView Classes]

Inheritance diagram for Gtk::CellRendererToggle:

List of all members.


Detailed Description

Renders a toggle button in a cell.

The button is drawn as a radio- or checkbutton, depending on the radio property. When activated, it emits the toggled signal.

Public Member Functions

virtual Glib::PropertyProxy_Base _property_renderable ()
 Returns the property that this CellRenderer renders.
 CellRendererToggle ()
bool get_active () const
 Return value: true if the cell renderer is active.
bool get_radio () const
 Return value: true if we're rendering radio toggles rather than checkboxes.
const GtkCellRendererToggle* gobj () const
 Provides access to the underlying C GtkObject.
GtkCellRendererToggle* gobj ()
 Provides access to the underlying C GtkObject.
Glib::PropertyProxy_ReadOnly
<bool> 
property_activatable () const
 The toggle button can be activated.
Glib::PropertyProxy<bool> property_activatable ()
 The toggle button can be activated.
Glib::PropertyProxy_ReadOnly
<bool> 
property_active () const
 The toggle state of the button.
Glib::PropertyProxy<bool> property_active ()
 The toggle state of the button.
Glib::PropertyProxy_ReadOnly<int> property_indicator_size () const
 Size of check or radio indicator.
Glib::PropertyProxy<int> property_indicator_size ()
 Size of check or radio indicator.
Glib::PropertyProxy_ReadOnly
<bool> 
property_radio () const
 Draw the toggle button as a radio button.
Glib::PropertyProxy<bool> property_radio ()
 Draw the toggle button as a radio button.
void set_active (bool setting=true)
 Activates or deactivates a cell renderer.
void set_radio (bool radio=true)
 If radio is true, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles).
Glib::SignalProxy1< void,
const Glib::ustring& > 
signal_toggled ()
 The toggled signal is emitted when the cell is toggled.
virtual ~CellRendererToggle ()

Protected Member Functions

virtual void on_toggled (const Glib::ustring& path)

Related Functions

(Note that these are not member functions.)

Gtk::CellRendererTogglewrap (GtkCellRendererToggle* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Constructor & Destructor Documentation

virtual Gtk::CellRendererToggle::~CellRendererToggle (  )  [virtual]

Gtk::CellRendererToggle::CellRendererToggle (  ) 


Member Function Documentation

virtual Glib::PropertyProxy_Base Gtk::CellRendererToggle::_property_renderable (  )  [virtual]

Returns the property that this CellRenderer renders.

For instance, property_text for CellRendererText, and property_active for CellRendererToggle Needs to be overridden in derived classes.

Reimplemented from Gtk::CellRenderer.

bool Gtk::CellRendererToggle::get_active (  )  const

Return value: true if the cell renderer is active.

Returns:
true if the cell renderer is active.

bool Gtk::CellRendererToggle::get_radio (  )  const

Return value: true if we're rendering radio toggles rather than checkboxes.

Returns:
true if we're rendering radio toggles rather than checkboxes.

const GtkCellRendererToggle* Gtk::CellRendererToggle::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::CellRenderer.

GtkCellRendererToggle* Gtk::CellRendererToggle::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::CellRenderer.

virtual void Gtk::CellRendererToggle::on_toggled ( const Glib::ustring path  )  [protected, virtual]

Glib::PropertyProxy_ReadOnly<bool> Gtk::CellRendererToggle::property_activatable (  )  const

The toggle button can be activated.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::CellRendererToggle::property_activatable (  ) 

The toggle button can be activated.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::CellRendererToggle::property_active (  )  const

The toggle state of the button.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::CellRendererToggle::property_active (  ) 

The toggle state of the button.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<int> Gtk::CellRendererToggle::property_indicator_size (  )  const

Size of check or radio indicator.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<int> Gtk::CellRendererToggle::property_indicator_size (  ) 

Size of check or radio indicator.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::CellRendererToggle::property_radio (  )  const

Draw the toggle button as a radio button.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::CellRendererToggle::property_radio (  ) 

Draw the toggle button as a radio button.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gtk::CellRendererToggle::set_active ( bool  setting = true  ) 

Activates or deactivates a cell renderer.

Parameters:
setting The value to set.

void Gtk::CellRendererToggle::set_radio ( bool  radio = true  ) 

If radio is true, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles).

If false, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for Gtk::TreeView, you set up a per-row setting using Gtk::TreeViewColumn to associate model columns with cell renderer properties).

Parameters:
radio true to make the toggle look like a radio button.

Glib::SignalProxy1< void,const Glib::ustring& > Gtk::CellRendererToggle::signal_toggled (  ) 

The toggled signal is emitted when the cell is toggled.

Parameters:
path string representation of TreePath describing the event location
Prototype:
void on_my_toggled(const Glib::ustring& path)


Friends And Related Function Documentation

Gtk::CellRendererToggle* wrap ( GtkCellRendererToggle *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated for gtkmm 2.4 by Doxygen 1.5.6 © 1997-2001