gtkmm 4.18.0
Gtk::MnemonicAction Class Reference

A Gtk::ShortcutAction that calls Gtk::Widget::mnemonic_activate(). More...

#include <gtkmm/shortcutaction.h>

Inheritance diagram for Gtk::MnemonicAction:

Public Member Functions

 MnemonicAction (MnemonicAction && src) noexcept
MnemonicActionoperator= (MnemonicAction && src) noexcept
 ~MnemonicAction () noexcept override
GtkMnemonicAction * gobj ()
 Provides access to the underlying C GObject.
const GtkMnemonicAction * gobj () const
 Provides access to the underlying C GObject.
GtkMnemonicAction * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Public Member Functions inherited from Gtk::ShortcutAction
 ShortcutAction (ShortcutAction && src) noexcept
ShortcutActionoperator= (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< MnemonicActionget ()
 Gets the mnemonic action.
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

 MnemonicAction ()
Protected Member Functions inherited from Gtk::ShortcutAction
 ShortcutAction ()

(Note that these are not member symbols.)

Glib::RefPtr< Gtk::MnemonicActionwrap (GtkMnemonicAction * 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 }
 Flags that can be passed to action activation. More...

Detailed Description

Constructor & Destructor Documentation

◆ MnemonicAction() [1/2]

Gtk::MnemonicAction::MnemonicAction ( MnemonicAction && src)
noexcept

◆ ~MnemonicAction()

Gtk::MnemonicAction::~MnemonicAction ( )
overridenoexcept

◆ MnemonicAction() [2/2]

Gtk::MnemonicAction::MnemonicAction ( )
protected

Member Function Documentation

◆ get()

Glib::RefPtr< MnemonicAction > Gtk::MnemonicAction::get ( )
static

Gets the mnemonic action.

This is an action that calls Gtk::Widget::mnemonic_activate() on the given widget upon activation.

Returns
The mnemonic action.

◆ get_type()

GType Gtk::MnemonicAction::get_type ( )
static

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

◆ gobj() [1/2]

GtkMnemonicAction * Gtk::MnemonicAction::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkMnemonicAction * Gtk::MnemonicAction::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkMnemonicAction * Gtk::MnemonicAction::gobj_copy ( )

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

◆ operator=()

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

◆ wrap()

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