gtkmm 3.24.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::CellRendererToggle Class Reference

Renders a toggle button in a cell. More...

#include <gtkmm/cellrenderertoggle.h>

Inheritance diagram for Gtk::CellRendererToggle:
Inheritance graph
[legend]

Public Member Functions

 CellRendererToggle (CellRendererToggle && src) noexcept
 
CellRendererToggleoperator= (CellRendererToggle && src) noexcept
 
 CellRendererToggle (const CellRendererToggle &)=delete
 
CellRendererToggleoperator= (const CellRendererToggle &)=delete
 
 ~CellRendererToggle () noexcept override
 
GtkCellRendererToggle * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkCellRendererToggle * gobj () const
 Provides access to the underlying C GObject. More...
 
 CellRendererToggle ()
 
bool get_radio () const
 Returns whether we’re rendering radio toggles rather than checkboxes. More...
 
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). More...
 
bool get_active () const
 Returns whether the cell renderer is active. More...
 
void set_active (bool setting=true)
 Activates or deactivates a cell renderer. More...
 
bool get_activatable () const
 Returns whether the cell renderer is activatable. More...
 
void set_activatable (bool setting=true)
 Makes the cell renderer activatable. More...
 
Glib::SignalProxy< void, const Glib::ustring & > signal_toggled ()
 
Glib::PropertyProxy< bool > property_activatable ()
 The toggle button can be activated. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_activatable () const
 The toggle button can be activated. More...
 
Glib::PropertyProxy< bool > property_active ()
 The toggle state of the button. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_active () const
 The toggle state of the button. More...
 
Glib::PropertyProxy< bool > property_inconsistent ()
 The inconsistent state of the button. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_inconsistent () const
 The inconsistent state of the button. More...
 
Glib::PropertyProxy< bool > property_radio ()
 Draw the toggle button as a radio button. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_radio () const
 Draw the toggle button as a radio button. More...
 
Glib::PropertyProxy< int > property_indicator_size ()
 Size of check or radio indicator. More...
 
Glib::PropertyProxy_ReadOnly< int > property_indicator_size () const
 Size of check or radio indicator. More...
 
- Public Member Functions inherited from Gtk::CellRenderer
 CellRenderer (CellRenderer && src) noexcept
 
CellRendereroperator= (CellRenderer && src) noexcept
 
 CellRenderer (const CellRenderer &)=delete
 
CellRendereroperator= (const CellRenderer &)=delete
 
 ~CellRenderer () noexcept override
 
GtkCellRenderer * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkCellRenderer * gobj () const
 Provides access to the underlying C GObject. More...
 
SizeRequestMode get_request_mode () const
 Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. More...
 
void get_preferred_width (Widget & widget, int & minimum_width, int & natural_width) const
 Retreives a renderer’s natural size when rendered to widget. More...
 
void get_preferred_height_for_width (Widget & widget, int width, int & minimum_height, int & natural_height) const
 Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width. More...
 
void get_preferred_height (Widget & widget, int & minimum_height, int & natural_height) const
 Retreives a renderer’s natural size when rendered to widget. More...
 
void get_preferred_width_for_height (Widget & widget, int height, int & minimum_width, int & natural_width) const
 Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height. More...
 
void get_preferred_size (Widget & widget, Requisition & minimum_size, Requisition & natural_size) const
 Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management. More...
 
void get_aligned_area (Widget & widget, CellRendererState flags, const Gdk::Rectangle & cell_area, Gdk::Rectangle & aligned_area)
 Gets the aligned area used by cell inside cell_area. More...
 
void render (const ::Cairo::RefPtr< ::Cairo::Context > & cr, Widget & widget, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_area, CellRendererState flags)
 Invokes the virtual render function of the Gtk::CellRenderer. More...
 
bool activate (GdkEvent * event, Widget & widget, const Glib::ustring & path, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_area, CellRendererState flags)
 Passes an activate event to the cell renderer for possible processing. More...
 
CellEditablestart_editing (GdkEvent * event, Widget & widget, const Glib::ustring & path, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_area, CellRendererState flags=CellRendererState(0))
 Starts editing the contents of this cell, through a new Gtk::CellEditable widget created by the Gtk::CellRendererClass.start_editing virtual function. More...
 
void set_fixed_size (int width, int height)
 Sets the renderer size to be explicit, independent of the properties set. More...
 
void get_fixed_size (int & width, int & height) const
 Fills in width and height with the appropriate size of cell. More...
 
void set_alignment (float xalign, float yalign)
 Sets the renderer’s alignment within its available space. More...
 
void get_alignment (float & xalign, float & yalign) const
 Fills in xalign and yalign with the appropriate values of cell. More...
 
void set_padding (int xpad, int ypad)
 Sets the renderer’s padding. More...
 
void get_padding (int & xpad, int & ypad) const
 Fills in xpad and ypad with the appropriate values of cell. More...
 
void set_visible (bool visible=true)
 Sets the cell renderer’s visibility. More...
 
bool get_visible () const
 Returns the cell renderer’s visibility. More...
 
void set_sensitive (bool sensitive=true)
 Sets the cell renderer’s sensitivity. More...
 
bool get_sensitive () const
 Returns the cell renderer’s sensitivity. More...
 
bool is_activatable () const
 Checks whether the cell renderer can do something when activated. More...
 
void stop_editing (bool canceled=false)
 Informs the cell renderer that the editing is stopped. More...
 
StateFlags get_state (Widget & widget, CellRendererState cell_state) const
 Translates the cell renderer state to Gtk::StateFlags, based on the cell renderer and widget sensitivity, and the given Gtk::CellRendererState. More...
 
StateFlags get_state (CellRendererState cell_state) const
 Translates the cell renderer state to StateFlags, based on the cell renderer and the given CellRendererState. More...
 
Glib::SignalProxy< void > signal_editing_canceled ()
 
Glib::SignalProxy< void, CellEditable *, const Glib::ustring & > signal_editing_started ()
 
Glib::PropertyProxy< CellRendererModeproperty_mode ()
 Editable mode of the CellRenderer. More...
 
Glib::PropertyProxy_ReadOnly< CellRendererModeproperty_mode () const
 Editable mode of the CellRenderer. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Display the cell. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Display the cell. More...
 
Glib::PropertyProxy< bool > property_sensitive ()
 Display the cell sensitive. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Display the cell sensitive. More...
 
Glib::PropertyProxy< float > property_xalign ()
 The x-align. More...
 
Glib::PropertyProxy_ReadOnly< float > property_xalign () const
 The x-align. More...
 
Glib::PropertyProxy< float > property_yalign ()
 The y-align. More...
 
Glib::PropertyProxy_ReadOnly< float > property_yalign () const
 The y-align. More...
 
Glib::PropertyProxy< unsigned int > property_xpad ()
 The xpad. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_xpad () const
 The xpad. More...
 
Glib::PropertyProxy< unsigned int > property_ypad ()
 The ypad. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_ypad () const
 The ypad. More...
 
Glib::PropertyProxy< int > property_width ()
 The fixed width. More...
 
Glib::PropertyProxy_ReadOnly< int > property_width () const
 The fixed width. More...
 
Glib::PropertyProxy< int > property_height ()
 The fixed height. More...
 
Glib::PropertyProxy_ReadOnly< int > property_height () const
 The fixed height. More...
 
Glib::PropertyProxy< bool > property_is_expander ()
 Row has children. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expander () const
 Row has children. More...
 
Glib::PropertyProxy< bool > property_is_expanded ()
 Row is an expander row, and is expanded. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expanded () const
 Row is an expander row, and is expanded. More...
 
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_cell_background ()
 Cell background color as a string. More...
 
Glib::PropertyProxy< Gdk::Colorproperty_cell_background_gdk ()
 Cell background as a Gdk::Color. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::Colorproperty_cell_background_gdk () const
 Cell background as a Gdk::Color. More...
 
Glib::PropertyProxy< Gdk::RGBAproperty_cell_background_rgba ()
 Cell background as a Gdk::RGBA. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::RGBAproperty_cell_background_rgba () const
 Cell background as a Gdk::RGBA. More...
 
Glib::PropertyProxy< bool > property_cell_background_set ()
 Whether the cell background color is set. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_cell_background_set () const
 Whether the cell background color is set. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_editing () const
 Whether the cell renderer is currently in editing mode. More...
 
- Public Member Functions inherited from Gtk::Object
 Object (Object && src) noexcept
 
Objectoperator= (Object && src) noexcept
 
 ~Object () noexcept override
 
GObject * gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject * gobj () const
 Provides access to the underlying C GObject. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::CellRenderer
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

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...
 
virtual void on_editing_started (CellEditable * editable, const Glib::ustring & path)
 This is a default handler for the signal signal_editing_started(). More...
 
 CellRenderer ()
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void get_preferred_width_vfunc (Widget & widget, int & minimum_width, int & natural_width) const
 
virtual void get_preferred_height_for_width_vfunc (Widget & widget, int width, int & minimum_height, int & natural_height) const
 
virtual void get_preferred_height_vfunc (Widget & widget, int & minimum_height, int & natural_height) const
 
virtual void get_preferred_width_for_height_vfunc (Widget & widget, int height, int & minimum_width, int & natural_width) const
 
virtual void render_vfunc (const ::Cairo::RefPtr< ::Cairo::Context > & cr, Widget & widget, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_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)
 A Glib::wrap() method for this object. More...
 

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.

Constructor & Destructor Documentation

◆ CellRendererToggle() [1/3]

Gtk::CellRendererToggle::CellRendererToggle ( CellRendererToggle &&  src)
noexcept

◆ CellRendererToggle() [2/3]

Gtk::CellRendererToggle::CellRendererToggle ( const CellRendererToggle )
delete

◆ ~CellRendererToggle()

Gtk::CellRendererToggle::~CellRendererToggle ( )
overridenoexcept

◆ CellRendererToggle() [3/3]

Gtk::CellRendererToggle::CellRendererToggle ( )

Member Function Documentation

◆ get_activatable()

bool Gtk::CellRendererToggle::get_activatable ( ) const

Returns whether the cell renderer is activatable.

See set_activatable().

Since gtkmm 2.18:
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.

◆ get_type()

static GType Gtk::CellRendererToggle::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

◆ on_toggled()

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

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

◆ operator=() [1/2]

CellRendererToggle & Gtk::CellRendererToggle::operator= ( CellRendererToggle &&  src)
noexcept

◆ operator=() [2/2]

CellRendererToggle & Gtk::CellRendererToggle::operator= ( const CellRendererToggle )
delete

◆ property_activatable() [1/2]

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

The toggle button can be activated.

Default value: true

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.

Default value: true

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.

Default value: false

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.

Default value: false

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.

Default value: false

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.

Default value: false

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.

Deprecated:
Use the min-width/min-height CSS properties of the check/radio node instead.

Default value: 0

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.

Deprecated:
Use the min-width/min-height CSS properties of the check/radio node instead.

Default value: 0

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.

Default value: false

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.

Default value: false

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.

Since gtkmm 2.18:
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::SignalProxy< void, const Glib::ustring & > Gtk::CellRendererToggle::signal_toggled ( )
Slot Prototype:
void on_my_toggled(const Glib::ustring& path)

Flags: Run Last

The signal_toggled() signal is emitted when the cell is toggled.

It is the responsibility of the application to update the model with the correct value to store at path. Often this is simply the opposite of the value currently stored at path.

Parameters
pathString representation of Gtk::TreePath describing the event location.

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.