Ardour  8.7-14-g57a6773833
Gtk::CellRendererToggle Class Reference

#include <cellrenderertoggle.h>

Inheritance diagram for Gtk::CellRendererToggle:
[legend]

Public Member Functions

virtual ~CellRendererToggle ()
 
GtkCellRendererTogglegobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkCellRendererTogglegobj () const
 Provides access to the underlying C GtkObject. More...
 
 CellRendererToggle ()
 
bool get_radio () const
 
void set_radio (bool radio=true)
 
bool get_active () const
 
void set_active (bool setting=true)
 
bool get_activatable () const
 
void set_activatable (bool setting=true)
 
Glib::SignalProxy1< void, const Glib::ustring & > signal_toggled ()
 
Glib::PropertyProxy< bool > property_activatable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_activatable () const
 
Glib::PropertyProxy< bool > property_active ()
 
Glib::PropertyProxy_ReadOnly< bool > property_active () const
 
Glib::PropertyProxy< bool > property_inconsistent ()
 
Glib::PropertyProxy_ReadOnly< bool > property_inconsistent () const
 
Glib::PropertyProxy< bool > property_radio ()
 
Glib::PropertyProxy_ReadOnly< bool > property_radio () const
 
Glib::PropertyProxy< int > property_indicator_size ()
 
Glib::PropertyProxy_ReadOnly< int > property_indicator_size () const
 
virtual Glib::PropertyProxy_Base _property_renderable ()
 
- Public Member Functions inherited from Gtk::CellRenderer
virtual ~CellRenderer ()
 
GtkCellRenderergobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkCellRenderergobj () const
 Provides access to the underlying C GtkObject. More...
 
void get_size (Widget &widget, const Gdk::Rectangle &cell_area, int &x_offset, int &y_offset, int &width, int &height) const
 
void get_size (Widget &widget, int &x_offset, int &y_offset, int &width, int &height) const
 
void render (const Glib::RefPtr< Gdk::Window > &window, Widget &widget, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, const Gdk::Rectangle &expose_area, CellRendererState flags)
 
bool activate (GdkEvent *event, Widget &widget, const Glib::ustring &path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
 
CellEditablestart_editing (GdkEvent *event, Widget &widget, const Glib::ustring &path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags=CellRendererState(0))
 
void set_fixed_size (int width, int height)
 
void get_fixed_size (int &width, int &height) const
 
void set_alignment (float xalign, float yalign)
 
void get_alignment (float &xalign, float &yalign) const
 
void set_padding (int xpad, int ypad)
 
void get_padding (int &xpad, int &ypad) const
 
void set_visible (bool visible=true)
 
bool get_visible () const
 
void set_sensitive (bool sensitive=true)
 
bool get_sensitive () const
 
void editing_canceled ()
 
void stop_editing (bool canceled=false)
 
Glib::SignalProxy0< void > signal_editing_canceled ()
 
Glib::SignalProxy2< void, CellEditable *, const Glib::ustring & > signal_editing_started ()
 
Glib::PropertyProxy< CellRendererModeproperty_mode ()
 
Glib::PropertyProxy_ReadOnly< CellRendererModeproperty_mode () const
 
Glib::PropertyProxy< bool > property_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 
Glib::PropertyProxy< bool > property_sensitive ()
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 
Glib::PropertyProxy< float > property_xalign ()
 
Glib::PropertyProxy_ReadOnly< float > property_xalign () const
 
Glib::PropertyProxy< float > property_yalign ()
 
Glib::PropertyProxy_ReadOnly< float > property_yalign () const
 
Glib::PropertyProxy< unsigned int > property_xpad ()
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_xpad () const
 
Glib::PropertyProxy< unsigned int > property_ypad ()
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_ypad () const
 
Glib::PropertyProxy< int > property_width ()
 
Glib::PropertyProxy_ReadOnly< int > property_width () const
 
Glib::PropertyProxy< int > property_height ()
 
Glib::PropertyProxy_ReadOnly< int > property_height () const
 
Glib::PropertyProxy< bool > property_is_expander ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expander () const
 
Glib::PropertyProxy< bool > property_is_expanded ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expanded () const
 
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_cell_background ()
 
Glib::PropertyProxy< Gdk::Colorproperty_cell_background_gdk ()
 
Glib::PropertyProxy_ReadOnly< Gdk::Colorproperty_cell_background_gdk () const
 
Glib::PropertyProxy< bool > property_cell_background_set ()
 
Glib::PropertyProxy_ReadOnly< bool > property_cell_background_set () const
 
Glib::PropertyProxy_ReadOnly< bool > property_editing () const
 
- Public Member Functions inherited from Gtk::Object
virtual ~Object ()
 
GtkObjectgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkObjectgobj () const
 Provides access to the underlying C GtkObject. More...
 
Glib::PropertyProxy< void * > property_user_data ()
 
Glib::PropertyProxy_ReadOnly< void * > property_user_data () const
 

Protected Member Functions

virtual void on_toggled (const Glib::ustring &path)
 This is a default handler for the signal signal_toggled(). More...
 
- Protected Member Functions inherited from Gtk::CellRenderer
virtual void on_editing_canceled ()
 This is a default handler for the signal signal_editing_canceled(). More...
 
 CellRenderer ()
 
virtual void get_size_vfunc (Widget &widget, const Gdk::Rectangle *cell_area, int *x_offset, int *y_offset, int *width, int *height) const
 
virtual void render_vfunc (const Glib::RefPtr< Gdk::Drawable > &window, Widget &widget, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, const Gdk::Rectangle &expose_area, CellRendererState flags)
 
virtual bool activate_vfunc (GdkEvent *event, Widget &widget, const Glib::ustring &path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
 
virtual CellEditablestart_editing_vfunc (GdkEvent *event, Widget &widget, const Glib::ustring &path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
 

Related Functions

(Note that these are not member functions.)

Gtk::CellRendererTogglewrap (GtkCellRendererToggle *object, bool take_copy=false)
 

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.

Definition at line 52 of file cellrenderertoggle.h.

Constructor & Destructor Documentation

◆ ~CellRendererToggle()

virtual Gtk::CellRendererToggle::~CellRendererToggle ( )
virtual

◆ CellRendererToggle()

Gtk::CellRendererToggle::CellRendererToggle ( )

Member Function Documentation

◆ _property_renderable()

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.

◆ get_activatable()

bool Gtk::CellRendererToggle::get_activatable ( ) const

Returns whether the cell renderer is activatable. See set_activatable().

Returns
true if the cell renderer is activatable.

◆ get_active()

bool Gtk::CellRendererToggle::get_active ( ) const

Returns whether the cell renderer is active. See set_active().

Returns
true if the cell renderer is active.

◆ get_radio()

bool Gtk::CellRendererToggle::get_radio ( ) const

Returns whether we're rendering radio toggles rather than checkboxes.

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

◆ gobj() [1/2]

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

Provides access to the underlying C GtkObject.

Definition at line 89 of file cellrenderertoggle.h.

◆ gobj() [2/2]

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

Provides access to the underlying C GtkObject.

Definition at line 92 of file cellrenderertoggle.h.

◆ on_toggled()

virtual void Gtk::CellRendererToggle::on_toggled ( const Glib::ustring &  path)
protectedvirtual

This is a default handler for the signal signal_toggled().

◆ property_activatable() [1/2]

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

The toggle button can be activated.

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

◆ property_activatable() [2/2]

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

The toggle button can be activated.

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

◆ property_active() [1/2]

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

The toggle state of the button.

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

◆ property_active() [2/2]

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

The toggle state of the button.

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

◆ property_inconsistent() [1/2]

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

The inconsistent state of the button.

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

◆ property_inconsistent() [2/2]

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

The inconsistent state of the button.

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

◆ property_indicator_size() [1/2]

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

Size of check or radio indicator.

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

◆ property_indicator_size() [2/2]

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

Size of check or radio indicator.

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

◆ property_radio() [1/2]

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

Draw the toggle button as a radio button.

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

◆ property_radio() [2/2]

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

Draw the toggle button as a radio button.

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

◆ set_activatable()

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

Makes the cell renderer activatable.

Parameters
settingThe value to set.

◆ set_active()

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

Activates or deactivates a cell renderer.

Parameters
settingThe value to set.

◆ set_radio()

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
radiotrue to make the toggle look like a radio button.

◆ signal_toggled()

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

The toggled signal is emitted when the cell is toggled.

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

Friends And Related Function Documentation

◆ wrap()

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

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

Parameters
objectThe C instance.
take_copyFalse 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: