Gtk::NamedAction Class Reference

A Gtk::ShortcutAction that activates an action by name. More...

#include <gtkmm/shortcutaction.h>

Inheritance diagram for Gtk::NamedAction:

Public Member Functions
	NamedAction (NamedAction && src) noexcept
NamedAction &	operator= (NamedAction && src) noexcept
	~NamedAction () noexcept override
GtkNamedAction *	gobj ()
	Provides access to the underlying C GObject.
const GtkNamedAction *	gobj () const
	Provides access to the underlying C GObject.
GtkNamedAction *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ustring	get_action_name () const
	Returns the name of the action that will be activated.
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_action_name () const
	The name of the action to activate.
Public Member Functions inherited from Gtk::ShortcutAction
	ShortcutAction (ShortcutAction && src) noexcept
ShortcutAction &	operator= (ShortcutAction && src) noexcept
	~ShortcutAction () noexcept override
GtkShortcutAction *	gobj ()
	Provides access to the underlying C GObject.
const GtkShortcutAction *	gobj () const
	Provides access to the underlying C GObject.
GtkShortcutAction *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ustring	to_string () const
	Prints the given action into a human-readable string.
bool	activate (Widget & widget, Flags flags=static_cast< Flags >(0), const Glib::VariantBase & args={})
	Activates the action on the widget with the given args.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< NamedAction >	create (const Glib::ustring & action_name)
Static Public Member Functions inherited from Gtk::ShortcutAction
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< ShortcutAction >	parse_string (const Glib::ustring & string)
	Tries to parse the given string into an action.

Protected Member Functions
	NamedAction (const Glib::ustring & action_name)
Protected Member Functions inherited from Gtk::ShortcutAction
	ShortcutAction ()

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::NamedAction >	wrap (GtkNamedAction * object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Functions inherited from Gtk::ShortcutAction
Glib::RefPtr< Gtk::ShortcutAction >	wrap (GtkShortcutAction * object, bool take_copy=false)
	A Glib::wrap() method for this object.

Additional Inherited Members
Public Types inherited from Gtk::ShortcutAction
enum class	Flags { Flags::EXCLUSIVE = 1 << 0 }
	List of flags that can be passed to action activation. More...

Detailed Description

A Gtk::ShortcutAction that activates an action by name.

Constructor & Destructor Documentation

NamedAction() [1/2]

Gtk::NamedAction::NamedAction ( NamedAction &&  src )

noexcept

~NamedAction()

Gtk::NamedAction::~NamedAction ( )

overridenoexcept

NamedAction() [2/2]

Gtk::NamedAction::NamedAction ( const Glib::ustring &  action_name )

explicitprotected

Member Function Documentation

create()

static Glib::RefPtr< NamedAction > Gtk::NamedAction::create ( const Glib::ustring &  action_name )

static

get_action_name()

Glib::ustring Gtk::NamedAction::get_action_name

(

)

const

Returns the name of the action that will be activated.

Returns

The name of the action to activate.

get_type()

static GType Gtk::NamedAction::get_type ( )

static

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

gobj() [1/2]

GtkNamedAction * Gtk::NamedAction::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GtkNamedAction * Gtk::NamedAction::gobj ( ) const

inline

Provides access to the underlying C GObject.

gobj_copy()

GtkNamedAction * Gtk::NamedAction::gobj_copy

(

)

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

operator=()

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

noexcept

property_action_name()

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::NamedAction::property_action_name

(

)

const

The name of the action to activate.

Default value: ""

Returns

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

Friends And Related Function Documentation

wrap()

Glib::RefPtr< Gtk::NamedAction > wrap ( GtkNamedAction *  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.