#include <activatable.h>

Inheritance diagram for Gtk::Activatable:

Public Member Functions
virtual	~Activatable ()

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

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

void	do_set_related_action (const Glib::RefPtr< Action > &action)

Glib::RefPtr< Action >	get_related_action ()

Glib::RefPtr< const Action >	get_related_action () const

bool	get_use_action_appearance () const

void	sync_action_properties (const Glib::RefPtr< Action > &action)

void	set_related_action (const Glib::RefPtr< Action > &action)

void	set_use_action_appearance (bool use_appearance=true)

Glib::PropertyProxy< Glib::RefPtr< Action > >	property_related_action ()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Action > >	property_related_action () const

Glib::PropertyProxy< bool >	property_use_action_appearance ()

Glib::PropertyProxy_ReadOnly< bool >	property_use_action_appearance () const

virtual void	update_vfunc (const Glib::RefPtr< Action > &action, const Glib::ustring &property_name)

virtual void	sync_action_properties_vfunc (const Glib::RefPtr< Action > &action)

Static Public Member Functions
static void	add_interface (GType gtype_implementer)

static GType	get_type () G_GNUC_CONST

Protected Member Functions
	Activatable ()

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::Activatable >	wrap (GtkActivatable *object, bool take_copy=false)

Detailed Description

Activatable widgets can be connected to a Gtk::Action and reflect the state of the action. An Activatable can also provide feedback through its action, as it is responsible for activating the related action.

Definition at line 61 of file tk/ytkmm/ytkmm/gtkmm/activatable.h.

Constructor & Destructor Documentation

◆ Activatable()

Gtk::Activatable::Activatable ( )

protected

You should derive from this class to use it.

◆ ~Activatable()

virtual Gtk::Activatable::~Activatable ( )

virtual

Member Function Documentation

◆ add_interface()

static void Gtk::Activatable::add_interface ( GType gtype_implementer )

static

◆ do_set_related_action()

void Gtk::Activatable::do_set_related_action ( const Glib::RefPtr< Action > & action )

This is a utility function for Gtk::Activatable implementors.

When implementing Gtk::Activatable you must call this when handling changes of the Gtk::Activatable::property_related_action(), and you must also use this to break references in Object->dispose().

This function adds a reference to the currently set related action for you, it also makes sure the Gtk::Activatable->update() method is called when the related Gtk::Action properties change and registers to the action's proxy list.

Note: Be careful to call this before setting the local copy of the Gtk::Action property, since this function uses gtk_activatable_get_action() to retrieve the previous action

Parameters

action The Gtk::Action to set.

◆ get_related_action() [1/2]

Glib::RefPtr<Action> Gtk::Activatable::get_related_action ( )

Gets the related Gtk::Action for activatable.

Returns: The related Gtk::Action if one is set.

◆ get_related_action() [2/2]

Glib::RefPtr<const Action> Gtk::Activatable::get_related_action ( ) const

Gets the related Gtk::Action for activatable.

Returns: The related Gtk::Action if one is set.

◆ get_type()

static GType Gtk::Activatable::get_type ( )

static

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

◆ get_use_action_appearance()

bool Gtk::Activatable::get_use_action_appearance ( ) const

Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.

Returns: Whether activatable uses its actions appearance.

◆ gobj() [1/2]

GtkActivatable* Gtk::Activatable::gobj ( )

inline

Provides access to the underlying C GObject.

Definition at line 119 of file tk/ytkmm/ytkmm/gtkmm/activatable.h.

◆ gobj() [2/2]

const GtkActivatable* Gtk::Activatable::gobj ( ) const

inline

Provides access to the underlying C GObject.

Definition at line 122 of file tk/ytkmm/ytkmm/gtkmm/activatable.h.

◆ property_related_action() [1/2]

Glib::PropertyProxy< Glib::RefPtr<Action> > Gtk::Activatable::property_related_action ( )

The action this activatable will activate and receive updates from.

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

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Action> > Gtk::Activatable::property_related_action ( ) const

The action this activatable will activate and receive updates from.

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

Glib::PropertyProxy< bool > Gtk::Activatable::property_use_action_appearance ( )

Whether to use the related actions appearance properties.

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

Glib::PropertyProxy_ReadOnly< bool > Gtk::Activatable::property_use_action_appearance ( ) const

Whether to use the related actions appearance properties.

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_related_action()

void Gtk::Activatable::set_related_action ( const Glib::RefPtr< Action > & action )

Sets the related action on the activatable object.

Note: Gtk::Activatable implementors need to handle the Gtk::Activatable::property_related_action() property and call do_set_related_action() when it changes.

Parameters

action The Gtk::Action to set.

◆ set_use_action_appearance()

void Gtk::Activatable::set_use_action_appearance ( bool use_appearance = true )

Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance

Note: Gtk::Activatable implementors need to handle the Gtk::Activatable::property_use_action_appearance() property and call sync_action_properties() to update activatable if needed.

Parameters

use_appearance Whether to use the actions appearance.

◆ sync_action_properties()

void Gtk::Activatable::sync_action_properties ( const Glib::RefPtr< Action > & action )

This is called to update the activatable completely, this is called internally when the Gtk::Activatable::property_related_action() property is set or unset and by the implementing class when Gtk::Activatable::signal_use_action_appearance() changes.

Parameters

action The related Gtk::Action or 0.

◆ sync_action_properties_vfunc()

virtual void Gtk::Activatable::sync_action_properties_vfunc ( const Glib::RefPtr< Action > & action )

virtual

◆ update_vfunc()

virtual void Gtk::Activatable::update_vfunc	(	const Glib::RefPtr< Action > &	action,
		const Glib::ustring &	property_name
	)

virtual

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::Activatable > wrap	(	GtkActivatable *	object,
		bool	take_copy = `false`
	)

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:

tk/ytkmm/ytkmm/gtkmm/activatable.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ Activatable()

◆ ~Activatable()

Member Function Documentation

◆ add_interface()

◆ do_set_related_action()

◆ get_related_action() [1/2]

◆ get_related_action() [2/2]

◆ get_type()

◆ get_use_action_appearance()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ property_related_action() [1/2]

◆ property_related_action() [2/2]

◆ property_use_action_appearance() [1/2]

◆ property_use_action_appearance() [2/2]

◆ set_related_action()

◆ set_use_action_appearance()

◆ sync_action_properties()

◆ sync_action_properties_vfunc()

◆ update_vfunc()

Friends And Related Function Documentation

◆ wrap()