gtk4/org.gtkkn.bindings.gtk/ShortcutController

ShortcutController

open class ShortcutController(pointer: <Error class: unknown class><<Error class: unknown class>>) : EventController, Buildable

GtkShortcutController is an event controller that manages shortcuts.

Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a GtkLabel, or by installing a key binding using method@Gtk.WidgetClass.add_binding, or by adding accelerators to global actions using method@Gtk.Application.set_accels_for_action.

But it is possible to create your own shortcut controller, and add shortcuts to it.

GtkShortcutController implements GListModel for querying the shortcuts that have been added to it.

GtkShortcutController as a GtkBuildable

GtkShortcutControllers can be creates in ui files to set up shortcuts in the same place as the widgets.

An example of a UI definition fragment with GtkShortcutController:

<object class='GtkButton'>
  <child>
    <object class='GtkShortcutController'>
      <property name='scope'>managed</property>
      <child>
        <object class='GtkShortcut'>
          <property name='trigger'>`&lt;`Control`&gt;`k</property>
          <property name='action'>activate</property>
        </object>
      </child>
    </object>
  </child>
</object>

This example creates a class@Gtk.ActivateAction for triggering the activate signal of the GtkButton. See ctor@Gtk.ShortcutAction.parse_string for the syntax for other kinds of GtkShortcutAction. See ctor@Gtk.ShortcutTrigger.parse_string to learn more about the syntax for triggers.

Skipped during bindings generation

method mnemonic-modifiers: Property has no getter nor setter
method model: Property has no getter nor setter

Constructors

ShortcutController

constructor()

Creates a new shortcut controller.

constructor(model: <Error class: unknown class>)

Creates a new shortcut controller that takes its shortcuts from the given list model.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

gioListModelPointer

open val gioListModelPointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkEventControllerPointer

val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>

gtkShortcutControllerPointer

val gtkShortcutControllerPointer: <Error class: unknown class><<Error class: unknown class>>

open var name: String?

The name for this controller, typically used for debugging purposes.

propagationLimit

open var propagationLimit: PropagationLimit

The limit for which events this controller will handle.

propagationPhase

open var propagationPhase: PropagationPhase

The propagation phase at which this controller will handle events.

open var scope: ShortcutScope

What scope the shortcuts will be handled in.

open val widget: Widget

The widget receiving the GdkEvents that the controller will handle.

Functions

open fun addShortcut(shortcut: Shortcut)

Adds @shortcut to the list of shortcuts handled by @self.

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getCurrentEvent

open fun getCurrentEvent(): <Error class: unknown class>?

Returns the event that is currently being handled by the controller.

getCurrentEventDevice

open fun getCurrentEventDevice(): <Error class: unknown class>?

Returns the device of the event that is currently being handled by the controller.

getCurrentEventState

open fun getCurrentEventState(): <Error class: unknown class>

Returns the modifier state of the event that is currently being handled by the controller.

getCurrentEventTime

open fun getCurrentEventTime(): <Error class: unknown class>

Returns the timestamp of the event that is currently being handled by the controller.

getMnemonicsModifiers

open fun getMnemonicsModifiers(): <Error class: unknown class>

Gets the mnemonics modifiers for when this controller activates its shortcuts.

open fun getName(): String?

Gets the name of @controller.

getPropagationLimit

open fun getPropagationLimit(): PropagationLimit

Gets the propagation limit of the event controller.

getPropagationPhase

open fun getPropagationPhase(): PropagationPhase

Gets the propagation phase at which @controller handles events.

open fun getScope(): ShortcutScope

Gets the scope for when this controller activates its shortcuts.

open fun getWidget(): Widget

Returns the GtkWidget this controller relates to.

open fun removeShortcut(shortcut: Shortcut)

Removes @shortcut from the list of shortcuts handled by @self.

open fun reset()

Resets the @controller to a clean state.

setMnemonicsModifiers

open fun setMnemonicsModifiers(modifiers: <Error class: unknown class>)

Sets the controller to use the given modifier for mnemonics.

open fun setName(name: String? = null)

Sets a name on the controller that can be used for debugging.

setPropagationLimit

open fun setPropagationLimit(limit: PropagationLimit)

Sets the event propagation limit on the event controller.

setPropagationPhase

open fun setPropagationPhase(phase: PropagationPhase)

Sets the propagation phase at which a controller handles events.

open fun setScope(scope: ShortcutScope)

Sets the controller to have the given @scope.