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

A Gtk::ShortcutTrigger that triggers when a specific keyval and (optionally) modifiers are pressed. More...

#include <gtkmm/shortcuttrigger.h>

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

Public Member Functions

 KeyvalTrigger (KeyvalTrigger &&src) noexcept
 
KeyvalTriggeroperator= (KeyvalTrigger &&src) noexcept
 
 ~KeyvalTrigger () noexcept override
 
GtkKeyvalTriggergobj ()
 Provides access to the underlying C GObject.
 
const GtkKeyvalTriggergobj () const
 Provides access to the underlying C GObject.
 
GtkKeyvalTriggergobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
 
guint get_keyval () const
 Gets the keyval that must be pressed to succeed triggering self.
 
Gdk::ModifierType get_modifiers () const
 Gets the modifiers that must be present to succeed triggering self.
 
Glib::PropertyProxy_ReadOnly< guint > property_keyval () const
 The key value for the trigger.
 
Glib::PropertyProxy_ReadOnly< Gdk::ModifierTypeproperty_modifiers () const
 The key modifiers for the trigger.
 
- Public Member Functions inherited from Gtk::ShortcutTrigger
 ShortcutTrigger (ShortcutTrigger &&src) noexcept
 
ShortcutTriggeroperator= (ShortcutTrigger &&src) noexcept
 
 ~ShortcutTrigger () noexcept override
 
GtkShortcutTriggergobj ()
 Provides access to the underlying C GObject.
 
const GtkShortcutTriggergobj () const
 Provides access to the underlying C GObject.
 
GtkShortcutTriggergobj_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 trigger into a human-readable string.
 
Glib::ustring to_label (const Glib::RefPtr< const Gdk::Display > &display) const
 Gets textual representation for the given trigger.
 
bool equal (const Glib::RefPtr< const ShortcutTrigger > &trigger2) const
 Checks if trigger1 and trigger2 trigger under the same conditions.
 
int compare (const Glib::RefPtr< const ShortcutTrigger > &trigger2) const
 The types of trigger1 and trigger2 are gconstpointer only to allow use of this function as a CompareFunc.
 
Gdk::KeyMatch trigger (const Glib::RefPtr< const Gdk::Event > & event, bool enable_mnemonics) const
 Checks if the given event triggers self.
 
- 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< KeyvalTriggercreate (guint keyval, Gdk::ModifierType modifiers=static_cast< Gdk::ModifierType >(0))
 
- Static Public Member Functions inherited from Gtk::ShortcutTrigger
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
static Glib::RefPtr< ShortcutTriggerparse_string (const Glib::ustring &string)
 Tries to parse the given string into a trigger.
 

Protected Member Functions

 KeyvalTrigger (guint keyval, Gdk::ModifierType modifiers)
 
- Protected Member Functions inherited from Gtk::ShortcutTrigger
 ShortcutTrigger ()
 
- 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::KeyvalTriggerwrap (GtkKeyvalTrigger *object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Additional Inherited Members

- 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::ShortcutTrigger that triggers when a specific keyval and (optionally) modifiers are pressed.

Key values are the codes which are sent whenever a key is pressed or released. The complete list of key values can be found in the gdk/gdkkeysyms.h header file. They are prefixed with GDK_KEY_.

Constructor & Destructor Documentation

◆ KeyvalTrigger() [1/2]

Gtk::KeyvalTrigger::KeyvalTrigger ( KeyvalTrigger &&  src)
noexcept

◆ ~KeyvalTrigger()

Gtk::KeyvalTrigger::~KeyvalTrigger ( )
overridenoexcept

◆ KeyvalTrigger() [2/2]

Gtk::KeyvalTrigger::KeyvalTrigger ( guint  keyval,
Gdk::ModifierType  modifiers 
)
explicitprotected

Member Function Documentation

◆ create()

static Glib::RefPtr< KeyvalTrigger > Gtk::KeyvalTrigger::create ( guint  keyval,
Gdk::ModifierType  modifiers = static_castGdk::ModifierType >(0) 
)
static

◆ get_keyval()

guint Gtk::KeyvalTrigger::get_keyval ( ) const

Gets the keyval that must be pressed to succeed triggering self.

Returns
The keyval.

◆ get_modifiers()

Gdk::ModifierType Gtk::KeyvalTrigger::get_modifiers ( ) const

Gets the modifiers that must be present to succeed triggering self.

Returns
The modifiers.

◆ get_type()

static GType Gtk::KeyvalTrigger::get_type ( )
static

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

◆ gobj() [1/2]

GtkKeyvalTrigger * Gtk::KeyvalTrigger::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkKeyvalTrigger * Gtk::KeyvalTrigger::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkKeyvalTrigger * Gtk::KeyvalTrigger::gobj_copy ( )

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

◆ operator=()

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

◆ property_keyval()

Glib::PropertyProxy_ReadOnly< guint > Gtk::KeyvalTrigger::property_keyval ( ) const

The key value for the trigger.

Default value: 0

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

Glib::PropertyProxy_ReadOnly< Gdk::ModifierType > Gtk::KeyvalTrigger::property_modifiers ( ) const

The key modifiers for the trigger.

Default value: Gdk::ModifierType::NO_MODIFIER_MASK

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::KeyvalTrigger > wrap ( GtkKeyvalTrigger 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.