Class ShortcutController<T extends GObject>
- All Implemented Interfaces:
Proxy
,ListModelJavaList<T>
,Iterable<T>
,Collection<T>
,List<T>
,SequencedCollection<T>
,ListModel<T>
,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 Label
, or by installing a key
binding using WidgetClass#addBinding
, or by adding accelerators
to global actions using Application.setAccelsForAction(java.lang.String, java.lang.String[])
.
But it is possible to create your own shortcut controller, and add shortcuts to it.
GtkShortcutController
implements ListModel
for querying the
shortcuts that have been added to it.
GtkShortcutController as GtkBuildable
GtkShortcutController
s can be created in GtkBuilder
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'><Control>k</property>
<property name='action'>activate</property>
</object>
</child>
</object>
</child>
</object>
This example creates a ActivateAction
for triggering the
activate
signal of the Button
. See ShortcutAction.parseString(java.lang.String)
for the syntax for other kinds of ShortcutAction
. See
ShortcutTrigger.parseString(java.lang.String)
to learn more about the syntax
for triggers.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Inner class implementing a builder pattern to construct a GObject with properties.static class
Nested classes/interfaces inherited from class org.gnome.gtk.EventController
EventController.EventControllerClass, EventController.EventControllerImpl
Nested classes/interfaces inherited from class org.gnome.gobject.GObject
GObject.NotifyCallback, GObject.ObjectClass
Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable
Buildable.BuildableIface, Buildable.BuildableImpl
Nested classes/interfaces inherited from interface org.gnome.gio.ListModel
ListModel.ItemsChangedCallback, ListModel.ListModelImpl, ListModel.ListModelInterface
-
Constructor Summary
ConstructorDescriptionCreates a new shortcut controller.ShortcutController
(MemorySegment address) Create a ShortcutController proxy instance for the provided memory address. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addShortcut
(Shortcut shortcut) Addsshortcut
to the list of shortcuts handled by this ShortcutController.protected ShortcutController
asParent()
Returns this instance as if it were its parent type.static ShortcutController.Builder
<? extends ShortcutController.Builder> builder()
AShortcutController.Builder
object constructs aShortcutController
with the specified properties.static ShortcutController
Creates a new shortcut controller that takes its shortcuts from the given list model.Gets the mnemonics modifiers for when this controller activates its shortcuts.getScope()
Gets the scope for when this controller activates its shortcuts.static Type
getType()
Get the GType of the ShortcutController classvoid
removeShortcut
(Shortcut shortcut) Removesshortcut
from the list of shortcuts handled by this ShortcutController.void
setMnemonicsModifiers
(Set<ModifierType> modifiers) Sets the controller to use the given modifier for mnemonics.void
setMnemonicsModifiers
(ModifierType... modifiers) Sets the controller to use the given modifier for mnemonics.void
setScope
(ShortcutScope scope) Sets the controller to have the givenscope
.Methods inherited from class org.gnome.gtk.EventController
getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getName, getPropagationLimit, getPropagationPhase, getWidget, reset, setName, setPropagationLimit, setPropagationPhase, setStaticName
Methods inherited from class org.gnome.gobject.GObject
addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties
Methods inherited from class org.gnome.gobject.TypeInstance
callParent, callParent, getPrivate, readGClass, writeGClass
Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance
equals, handle, hashCode
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.gnome.gtk.Buildable
getBuildableId
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods inherited from interface java.util.List
addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator
Methods inherited from interface org.gnome.gio.ListModel
emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChanged
Methods inherited from interface io.github.jwharm.javagi.gio.ListModelJavaList
add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
-
Constructor Details
-
ShortcutController
Create a ShortcutController proxy instance for the provided memory address.- Parameters:
address
- the memory address of the native object
-
ShortcutController
public ShortcutController()Creates a new shortcut controller.
-
-
Method Details
-
getType
-
asParent
Returns this instance as if it were its parent type. This is mostly synonymous to the Javasuper
keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" withsuper.methodName()
doesn't work, because it invokes the overridden function pointer again. To chain up, callasParent().methodName()
. This will call the native function pointer of this virtual method in the typeclass of the parent type.- Overrides:
asParent
in classEventController
-
forModel
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.
- Parameters:
model
- aGListModel
containing shortcuts- Returns:
- a newly created shortcut controller
-
addShortcut
Addsshortcut
to the list of shortcuts handled by this ShortcutController.If this controller uses an external shortcut list, this function does nothing.
- Parameters:
shortcut
- aGtkShortcut
-
getMnemonicsModifiers
Gets the mnemonics modifiers for when this controller activates its shortcuts.- Returns:
- the controller's mnemonics modifiers
-
getScope
Gets the scope for when this controller activates its shortcuts.See
setScope(org.gnome.gtk.ShortcutScope)
for details.- Returns:
- the controller's scope
-
removeShortcut
Removesshortcut
from the list of shortcuts handled by this ShortcutController.If
shortcut
had not been added tocontroller
or this controller uses an external shortcut list, this function does nothing.- Parameters:
shortcut
- aGtkShortcut
-
setMnemonicsModifiers
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
GtkPopoverMenu
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.
- Parameters:
modifiers
- the new mnemonics_modifiers to use
-
setMnemonicsModifiers
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
GtkPopoverMenu
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.
- Parameters:
modifiers
- the new mnemonics_modifiers to use
-
setScope
Sets the controller to have the givenscope
.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
ShortcutScope.LOCAL
, shortcuts will only be activated when the widget has focus.- Parameters:
scope
- the new scope to use
-
builder
AShortcutController.Builder
object constructs aShortcutController
with the specified properties. Use the variousset...()
methods to set properties, and finish construction withShortcutController.Builder.build()
.
-