gtkmm 4.17.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gtk::NamedAction Class Reference

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

#include <gtkmm/shortcutaction.h>

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

Public Member Functions

 NamedAction (NamedAction &&src) noexcept
 
NamedActionoperator= (NamedAction &&src) noexcept
 
 ~NamedAction () noexcept override
 
GtkNamedActiongobj ()
 Provides access to the underlying C GObject.
 
const GtkNamedActiongobj () const
 Provides access to the underlying C GObject.
 
GtkNamedActiongobj_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::ustringproperty_action_name () const
 The name of the action to activate.
 
- Public Member Functions inherited from Gtk::ShortcutAction
 ShortcutAction (ShortcutAction &&src) noexcept
 
ShortcutActionoperator= (ShortcutAction &&src) noexcept
 
 ~ShortcutAction () noexcept override
 
GtkShortcutActiongobj ()
 Provides access to the underlying C GObject.
 
const GtkShortcutActiongobj () const
 Provides access to the underlying C GObject.
 
GtkShortcutActiongobj_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.
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
voidget_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data_with_c_callback (const Quark &key, void *data, GDestroyNotify notify)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
voidsteal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObjectgobj ()
 
const GObjectgobj () const
 
GObjectgobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 

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< NamedActioncreate (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< ShortcutActionparse_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 ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

Related Symbols

(Note that these are not member symbols.)

Glib::RefPtr< Gtk::NamedActionwrap (GtkNamedAction *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...
 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

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 Symbol Documentation

◆ wrap()

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