class Gtk::Shortcut

Overview

A Gtk::Shortcut describes a keyboard shortcut.

It contains a description of how to trigger the shortcut via a Gtk::ShortcutTrigger and a way to activate the shortcut on a widget via a Gtk::ShortcutAction.

The actual work is usually done via Gtk::ShortcutController, which decides if and when to activate a shortcut. Using that controller directly however is rarely necessary as various higher level convenience APIs exist on Gtk::Widgets that make it easier to use shortcuts in GTK.

Gtk::Shortcut does provide functionality to make it easy for users to work with shortcuts, either by providing informational strings for display purposes or by allowing shortcuts to be configured.

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/shortcut.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(trigger : Gtk::ShortcutTrigger | Nil, action : Gtk::ShortcutAction | Nil) : self #

Creates a new Gtk::Shortcut that is triggered by trigger and then activates action.


[View source]
def self.new #

Initialize a new Shortcut.


[View source]
def self.new(*, action : Gtk::ShortcutAction | Nil = nil, arguments : GLib::Variant | Nil = nil, trigger : Gtk::ShortcutTrigger | Nil = nil) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def action : Gtk::ShortcutAction | Nil #

Gets the action that is activated by this shortcut.


[View source]
def action=(action : Gtk::ShortcutAction | Nil) : Nil #

Sets the new action for self to be action.


[View source]
def arguments : GLib::Variant | Nil #

Gets the arguments that are passed when activating the shortcut.


[View source]
def arguments=(value : GLib::Variant | Nil) : GLib::Variant | Nil #

[View source]
def arguments=(args : _ | Nil) : Nil #

Sets the arguments to pass when activating the shortcut.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def trigger : Gtk::ShortcutTrigger | Nil #

Gets the trigger used to trigger self.


[View source]
def trigger=(trigger : Gtk::ShortcutTrigger | Nil) : Nil #

Sets the new trigger for self to be trigger.


[View source]