gtkmm  4.8.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::ShortcutAction Class Reference

Tracking if shortcuts should be activated. More...

#include <gtkmm/shortcutaction.h>

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

Public Types

enum class  Flags { EXCLUSIVE = 1 << 0 }
 List of flags that can be passed to action activation. More...
 

Public Member Functions

 ShortcutAction (ShortcutAction && src) noexcept
 
ShortcutActionoperator= (ShortcutAction && src) noexcept
 
 ~ShortcutAction () noexcept override
 
GtkShortcutAction * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkShortcutAction * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkShortcutAction * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring to_string () const
 Prints the given action into a human-readable string. More...
 
bool activate (Widget & widget, Flags flags=static_cast< Flags >(0), const Glib::VariantBase & args={})
 Activates the action on the widget with the given args. 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 Glib::RefPtr< ShortcutActionparse_string (const Glib::ustring &string)
 Tries to parse the given string into an action. More...
 

Protected Member Functions

 ShortcutAction ()
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::ShortcutActionwrap (GtkShortcutAction * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Tracking if shortcuts should be activated.

Gtk::ShortcutAction is the object used to describe what a Gtk::Shortcut should do when triggered. To activate a ShortcutAction manually, activate() can be called.

ShortcutActions contain methods that allow easy presentation to end users as well as being printed for debugging.

All ShortcutActions are immutable, you can only specify their properties during construction. If you want to change an action, you have to replace it with a new one. If you need to pass arguments to an action, these are specified by the higher-level Gtk::Shortcut object.

GTK provides various actions:

See also
Gtk::Shortcut
Since gtkmm 3.98:

Constructor & Destructor Documentation

◆ ShortcutAction() [1/2]

Gtk::ShortcutAction::ShortcutAction ( ShortcutAction &&  src)
noexcept

◆ ~ShortcutAction()

Gtk::ShortcutAction::~ShortcutAction ( )
overridenoexcept

◆ ShortcutAction() [2/2]

Gtk::ShortcutAction::ShortcutAction ( )
protected

Member Function Documentation

◆ activate()

bool Gtk::ShortcutAction::activate ( Widget widget,
Flags  flags = static_cast< Flags >(0),
const Glib::VariantBase &  args = {} 
)

Activates the action on the widget with the given args.

Note that some actions ignore the passed in flags, widget or args.

Activation of an action can fail for various reasons. If the action is not supported by the widget, if the args don't match the action or if the activation otherwise had no effect, false will be returned.

Parameters
flagsFlags to activate with.
widgetTarget of the activation.
argsArguments to pass.
Returns
true if this action was activated successfully.

◆ get_type()

static GType Gtk::ShortcutAction::get_type ( )
static

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

◆ gobj() [1/2]

GtkShortcutAction* Gtk::ShortcutAction::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkShortcutAction* Gtk::ShortcutAction::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkShortcutAction* Gtk::ShortcutAction::gobj_copy ( )

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

◆ operator=()

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

◆ parse_string()

static Glib::RefPtr<ShortcutAction> Gtk::ShortcutAction::parse_string ( const Glib::ustring &  string)
static

Tries to parse the given string into an action.

On success, the parsed action is returned. When parsing failed, nullptr is returned.

The accepted strings are:

Parameters
stringThe string to parse.
Returns
A new Gtk::ShortcutAction.

◆ to_string()

Glib::ustring Gtk::ShortcutAction::to_string ( ) const

Prints the given action into a human-readable string.

This is meant for debugging and logging. The form of the representation may change at any time and is not guaranteed to stay identical.

Returns
A new string.

Friends And Related Function Documentation

◆ wrap()

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