Class ShortcutController<T extends GObject>
- All Implemented Interfaces:
Iterable<T>,Collection<T>,List<T>,SequencedCollection<T>,ListModel<T>,Buildable,Proxy,ListModelJavaList<T>
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
GtkShortcutControllers 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
Nested ClassesModifier and TypeClassDescriptionstatic classInner class implementing a builder pattern to construct a GObject with properties.static classNested classes/interfaces inherited from class org.gnome.gtk.EventController
EventController.EventController$Impl, EventController.EventControllerClassNested classes/interfaces inherited from class org.gnome.gobject.GObject
GObject.NotifyCallback, GObject.ObjectClassNested classes/interfaces inherited from interface org.gnome.gtk.Buildable
Buildable.Buildable$Impl, Buildable.BuildableIfaceNested classes/interfaces inherited from interface org.gnome.gio.ListModel
ListModel.ItemsChangedCallback, ListModel.ListModel$Impl, ListModel.ListModelInterfaceNested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaList
ListModelJavaList.SubList<E extends @Nullable GObject,List extends ListModelJavaList<E>> -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new ShortcutController.ShortcutController(MemorySegment address) Create a ShortcutController proxy instance for the provided memory address. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddShortcut(Shortcut shortcut) Addsshortcutto the list of shortcuts handled byself.protected ShortcutControllerasParent()Returns this instance as if it were its parent type.static ShortcutController.Builder<? extends ShortcutController.Builder> builder()AShortcutController.Builderobject constructs aShortcutControllerwith the specified properties.static EventControllerCreates 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 @Nullable TypegetType()Get the GType of the ShortcutController classvoidremoveShortcut(Shortcut shortcut) Removesshortcutfrom the list of shortcuts handled byself.voidsetMnemonicsModifiers(Set<ModifierType> modifiers) Sets the controller to use the given modifier for mnemonics.voidsetMnemonicsModifiers(ModifierType... modifiers) Sets the controller to use the given modifier for mnemonics.voidsetScope(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, setStaticNameMethods 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, 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, withPropertiesMethods inherited from class org.gnome.gobject.TypeInstance
callParent, callParent, cast, getPrivate, readGClass, writeGClassMethods inherited from class org.javagi.base.ProxyInstance
equals, handle, hashCodeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gnome.gtk.Buildable
getBuildableIdMethods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.List
addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliteratorMethods inherited from interface org.gnome.gio.ListModel
emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChangedMethods inherited from interface org.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 ShortcutController.
-
-
Method Details
-
getType
Get the GType of the ShortcutController class- Returns:
- the GType
-
asParent
Returns this instance as if it were its parent type. This is mostly synonymous to the Javasuperkeyword, 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:
asParentin 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- aGListModelcontaining shortcuts- Returns:
- a newly created shortcut controller
-
addShortcut
Addsshortcutto the list of shortcuts handled byself.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
Removesshortcutfrom the list of shortcuts handled byself.If
shortcuthad not been added tocontrolleror 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
GtkPopoverMenus, 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
GtkPopoverMenus, 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.Builderobject constructs aShortcutControllerwith the specified properties. Use the variousset...()methods to set properties, and finish construction withShortcutController.Builder.build().- Returns:
- the builder object
-