Renders a spinning animation in a cell. More...

#include <gtkmm/cellrendererspinner.h>

Inheritance diagram for Gtk::CellRendererSpinner:

Public Member Functions
	CellRendererSpinner (CellRendererSpinner && src) noexcept

CellRendererSpinner &	operator= (CellRendererSpinner && src) noexcept

	CellRendererSpinner (const CellRendererSpinner &)=delete

CellRendererSpinner &	operator= (const CellRendererSpinner &)=delete

	~CellRendererSpinner () noexcept override

GtkCellRendererSpinner *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkCellRendererSpinner *	gobj () const
	Provides access to the underlying C GObject. More...

	CellRendererSpinner ()

Glib::PropertyProxy< bool >	property_active ()
	Whether the spinner is active (ie. More...

Glib::PropertyProxy_ReadOnly< bool >	property_active () const
	Whether the spinner is active (ie. More...

Glib::PropertyProxy< guint >	property_pulse ()
	Pulse of the spinner. More...

Glib::PropertyProxy_ReadOnly< guint >	property_pulse () const
	Pulse of the spinner. More...

Glib::PropertyProxy< Gtk::IconSize >	property_size ()
	The Gtk::IconSize value that specifies the size of the rendered spinner. More...

Glib::PropertyProxy_ReadOnly< Gtk::IconSize >	property_size () const
	The Gtk::IconSize value that specifies the size of the rendered spinner. More...

Public Member Functions inherited from Gtk::CellRenderer
	CellRenderer (CellRenderer && src) noexcept

CellRenderer &	operator= (CellRenderer && src) noexcept

	CellRenderer (const CellRenderer &)=delete

CellRenderer &	operator= (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...

CellEditable *	start_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< CellRendererMode >	property_mode ()
	Editable mode of the CellRenderer. More...

Glib::PropertyProxy_ReadOnly< CellRendererMode >	property_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::Color >	property_cell_background_gdk ()
	Cell background as a Gdk::Color. More...

Glib::PropertyProxy_ReadOnly< Gdk::Color >	property_cell_background_gdk () const
	Cell background as a Gdk::Color. More...

Glib::PropertyProxy< Gdk::RGBA >	property_cell_background_rgba ()
	Cell background as a Gdk::RGBA. More...

Glib::PropertyProxy_ReadOnly< Gdk::RGBA >	property_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

Object &	operator= (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...

Related Functions
(Note that these are not member functions.)
Gtk::CellRendererSpinner *	wrap (GtkCellRendererSpinner * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::CellRenderer
Gtk::CellRenderer *	wrap (GtkCellRenderer * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
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 CellEditable *	start_editing_vfunc (GdkEvent * event, Widget & widget, const Glib::ustring & path, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_area, CellRendererState flags)

Detailed Description

Renders a spinning animation in a cell.

A CellRendererSpinner can be used as an alternative to CellRendererProgress for displaying indefinite activity, instead of actual progress.

To start the animation in a cell, set the active property to true and increment the pulse property at regular intervals.

Constructor & Destructor Documentation

◆ CellRendererSpinner() [1/3]

Gtk::CellRendererSpinner::CellRendererSpinner ( CellRendererSpinner && src )

noexcept

◆ CellRendererSpinner() [2/3]

Gtk::CellRendererSpinner::CellRendererSpinner ( const CellRendererSpinner & )

delete

◆ ~CellRendererSpinner()

Gtk::CellRendererSpinner::~CellRendererSpinner ( )

overridenoexcept

◆ CellRendererSpinner() [3/3]

Gtk::CellRendererSpinner::CellRendererSpinner ( )

Member Function Documentation

◆ get_type()

static GType Gtk::CellRendererSpinner::get_type ( )

static

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

◆ gobj() [1/2]

GtkCellRendererSpinner * Gtk::CellRendererSpinner::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkCellRendererSpinner * Gtk::CellRendererSpinner::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ operator=() [1/2]

CellRendererSpinner & Gtk::CellRendererSpinner::operator= ( CellRendererSpinner && src )

noexcept

◆ operator=() [2/2]

CellRendererSpinner & Gtk::CellRendererSpinner::operator= ( const CellRendererSpinner & )

delete

◆ property_active() [1/2]

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

Whether the spinner is active (ie.

shown) in the cell.

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::CellRendererSpinner::property_active ( ) const

Whether the spinner is active (ie.

shown) in the cell.

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_pulse() [1/2]

Glib::PropertyProxy< guint > Gtk::CellRendererSpinner::property_pulse ( )

Pulse of the spinner.

Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout.

By default, the Gtk::Spinner widget draws one full cycle of the animation, consisting of 12 frames, in 750 milliseconds.

Since gtkmm 2.20:

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_pulse() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gtk::CellRendererSpinner::property_pulse ( ) const

Pulse of the spinner.

Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout.

By default, the Gtk::Spinner widget draws one full cycle of the animation, consisting of 12 frames, in 750 milliseconds.

Since gtkmm 2.20:

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_size() [1/2]

Glib::PropertyProxy< Gtk::IconSize > Gtk::CellRendererSpinner::property_size ( )

The Gtk::IconSize value that specifies the size of the rendered spinner.

Since gtkmm 2.20:

Default value: Gtk::ICON_SIZE_MENU

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_size() [2/2]

Glib::PropertyProxy_ReadOnly< Gtk::IconSize > Gtk::CellRendererSpinner::property_size ( ) const