gtkmm 4.18.0
|
Event controller for shortcuts. More...
#include <gtkmm/shortcutcontroller.h>
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< ShortcutController > | create () |
static Glib::RefPtr< ShortcutController > | create (const Glib::RefPtr< Gio::ListModel > &model) |
Creates a new shortcut controller that takes its shortcuts from the given list model. | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gtk::ShortcutController > | wrap (GtkShortcutController *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
![]() | |
Glib::RefPtr< Gtk::EventController > | wrap (GtkEventController *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
![]() | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Additional Inherited Members | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
Event controller for shortcuts.
Gtk::ShortcutController is an event controller that manages shortcuts.
Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a Gtk::Label, or by installing a key binding using gtk_widget_class_add_binding(), or by adding accelerators to global actions using Gtk::Application::set_accels_for_action().
But it is possible to create your own shortcut controller, and add shortcuts to it.
Gtk::ShortcutController implements Gio::ListModel for querying the shortcuts that have been added to it.
ShortcutControllers can be created in ui files to set up shortcuts in the same place as the widgets.
An example of a UI definition fragment with GtkShortcutController:
|
noexcept |
|
overridenoexcept |
|
protected |
|
explicitprotected |
void Gtk::ShortcutController::add_shortcut | ( | const Glib::RefPtr< Shortcut > & | shortcut | ) |
Adds shortcut to the list of shortcuts handled by self.
If this controller uses an external shortcut list, this function does nothing.
shortcut | A Gtk::Shortcut . |
|
static |
|
static |
Creates a new shortcut controller that takes its shortcuts from the given list model.
A controller created by this function does not let you add or remove individual shortcuts using the shortcut controller api, but you can change the contents of the model.
model | A ListModel containing shortcuts. |
Gdk::ModifierType Gtk::ShortcutController::get_mnemonics_modifiers | ( | ) | const |
Gets the mnemonics modifiers for when this controller activates its shortcuts.
ShortcutScope Gtk::ShortcutController::get_scope | ( | ) | const |
Gets the scope for when this controller activates its shortcuts.
See set_scope() for details.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkShortcutController * Gtk::ShortcutController::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
noexcept |
Glib::PropertyProxy_ReadOnly< GType > Gtk::ShortcutController::property_item_type | ( | ) | const |
The type of items.
See Gio::ListModel::get_item_type().
Glib::PropertyProxy< Gdk::ModifierType > Gtk::ShortcutController::property_mnemonic_modifiers | ( | ) |
The modifiers that need to be pressed to allow mnemonics activation.
Default value: Gdk::ModifierType::ALT_MASK
Glib::PropertyProxy_ReadOnly< Gdk::ModifierType > Gtk::ShortcutController::property_mnemonic_modifiers | ( | ) | const |
The modifiers that need to be pressed to allow mnemonics activation.
Default value: Gdk::ModifierType::ALT_MASK
Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::ShortcutController::property_n_items | ( | ) | const |
The number of items.
See Gio::ListModel::get_n_items().
Default value: 0
Glib::PropertyProxy< ShortcutScope > Gtk::ShortcutController::property_scope | ( | ) |
What scope the shortcuts will be handled in.
Default value: Gtk::ShortcutScope::LOCAL
Glib::PropertyProxy_ReadOnly< ShortcutScope > Gtk::ShortcutController::property_scope | ( | ) | const |
What scope the shortcuts will be handled in.
Default value: Gtk::ShortcutScope::LOCAL
void Gtk::ShortcutController::remove_shortcut | ( | const Glib::RefPtr< const Shortcut > & | shortcut | ) |
Removes shortcut from the list of shortcuts handled by self.
If shortcut had not been added to controller or this controller uses an external shortcut list, this function does nothing.
shortcut | A Gtk::Shortcut . |
void Gtk::ShortcutController::set_mnemonics_modifiers | ( | Gdk::ModifierType | modifiers | ) |
Sets the controller to use the given modifier for mnemonics.
The mnemonics modifiers determines which modifiers need to be pressed to allow activation of shortcuts with mnemonics triggers.
GTK normally uses the Alt modifier for mnemonics, except in Gtk::PopoverMenu
s, where mnemonics can be triggered without any modifiers. It should be very rarely necessary to change this, and doing so is likely to interfere with other shortcuts.
This value is only relevant for local shortcut controllers. Global and managed shortcut controllers will have their shortcuts activated from other places which have their own modifiers for activating mnemonics.
modifiers | The new mnemonics_modifiers to use. |
ShortcutScope Gtk::ShortcutController::set_scope | ( | ) | const |
Gets the scope for when this controller activates its shortcuts.
See set_scope() for details.
void Gtk::ShortcutController::set_scope | ( | ShortcutScope | scope | ) |
Sets the controller to have the given scope.
The scope allows shortcuts to be activated outside of the normal event propagation. In particular, it allows installing global keyboard shortcuts that can be activated even when a widget does not have focus.
With Gtk::ShortcutScope::LOCAL, shortcuts will only be activated when the widget has focus.
scope | The new scope to use. |
|
related |
A Glib::wrap() method for this object.
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. |