Gtk::CellRendererToggle Class Reference
[TreeView Classes]

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 | |
| Glib::PropertyProxy_ReadOnly <bool> | _activatable () const |
| The toggle button can be activated. | |
| Glib::PropertyProxy <bool> | _activatable () |
| The toggle button can be activated. | |
| Glib::PropertyProxy_ReadOnly <bool> | _active () const |
| The toggle state of the button. | |
| Glib::PropertyProxy <bool> | _active () |
| The toggle state of the button. | |
| Glib::PropertyProxy_ReadOnly <int> | _indicator_size () const |
| Size of check or radio indicator. | |
| Glib::PropertyProxy <int> | _indicator_size () |
| Size of check or radio indicator. | |
| virtual Glib::PropertyProxy_Base | _property_renderable () |
| Returns the property that this CellRenderer renders. | |
| Glib::PropertyProxy_ReadOnly <bool> | _radio () const |
| Draw the toggle button as a radio button. | |
| Glib::PropertyProxy <bool> | _radio () |
| Draw the toggle button as a radio button. | |
| 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. | |
| 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::CellRendererToggle* | wrap (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
| Glib::PropertyProxy_ReadOnly<bool> Gtk::CellRendererToggle::_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::_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::_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::_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::_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::_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.
| 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.
| Glib::PropertyProxy_ReadOnly<bool> Gtk::CellRendererToggle::_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::_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.
| bool Gtk::CellRendererToggle::get_active | ( | ) | const |
Return value: true if the cell renderer is active.
- Returns:
trueif the cell renderer is active.
| bool Gtk::CellRendererToggle::get_radio | ( | ) | const |
Return value: true if we're rendering radio toggles rather than checkboxes.
- Returns:
trueif we're rendering radio toggles rather than checkboxes.
| const GtkCellRendererToggle* Gtk::CellRendererToggle::gobj | ( | ) | const [inline] |
| GtkCellRendererToggle* Gtk::CellRendererToggle::gobj | ( | ) | [inline] |
| virtual void Gtk::CellRendererToggle::on_toggled | ( | const Glib::ustring & | path | ) | [protected, virtual] |
| 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 trueto 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:
