ShortcutsWindow

A GtkShortcutsWindow shows information about the keyboard shortcuts and gestures of an application.

The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.

Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.

The recommended way to construct a GtkShortcutsWindow is with [class@Gtk.Builder], by populating a GtkShortcutsWindow with one or more GtkShortcutsSection objects, which contain GtkShortcutsGroups that in turn contain objects of class GtkShortcutsShortcut.

A simple example:

This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.

The .ui file for this example can be found here.

An example with multiple views:

This example shows a GtkShortcutsWindow that has been configured to show only the shortcuts relevant to the "stopwatch" view.

The .ui file for this example can be found here.

An example with multiple sections:

This example shows a GtkShortcutsWindow with two sections, "Editor Shortcuts" and "Terminal Shortcuts".

The .ui file for this example can be found here.

class ShortcutsWindow : Window {

protected

GtkShortcutsWindow* gtkShortcutsWindow;

GtkShortcutsWindow* getShortcutsWindowStruct(bool transferOwnership);

void* getStruct();

this(GtkShortcutsWindow* gtkShortcutsWindow, bool ownedRef);

static GType getType();

gulong addOnClose(void delegate(ShortcutsWindow) dlg, ConnectFlags connectFlags);

gulong addOnSearch(void delegate(ShortcutsWindow) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkShortcutsWindow* gtkShortcutsWindow, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

addOnClose gulong addOnClose(void delegate(ShortcutsWindow) dlg, ConnectFlags connectFlags): Emitted when the user uses a keybinding to close the window.
addOnSearch gulong addOnSearch(void delegate(ShortcutsWindow) dlg, ConnectFlags connectFlags): Emitted when the user uses a keybinding to start a search.
getShortcutsWindowStruct GtkShortcutsWindow* getShortcutsWindowStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Static functions

getType GType getType()

Variables

gtkShortcutsWindow GtkShortcutsWindow* gtkShortcutsWindow;: the main Gtk struct

Inherited Members

From Window

gtkWindow GtkWindow* gtkWindow;: the main Gtk struct
getWindowStruct GtkWindow* getWindowStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin NativeT!(GtkWindow): Undocumented in source.
__anonymous mixin RootT!(GtkWindow): Undocumented in source.
__anonymous mixin ShortcutManagerT!(GtkWindow): Undocumented in source.
getType GType getType()
getDefaultIconName string getDefaultIconName(): Returns the fallback icon name for windows.
getToplevels ListModelIF getToplevels(): Returns a list of all existing toplevel windows.
listToplevels ListG listToplevels(): Returns a list of all existing toplevel windows.
setAutoStartupNotification void setAutoStartupNotification(bool setting): Sets whether the window should request startup notification.
setDefaultIconName void setDefaultIconName(string name): Sets an icon to be used as fallback.
setInteractiveDebugging void setInteractiveDebugging(bool enable): Opens or closes the interactive debugger.
close void close(): Requests that the window is closed.
destroy void destroy(): Drop the internal reference GTK holds on toplevel windows.
fullscreen void fullscreen(): Asks to place @window in the fullscreen state.
fullscreenOnMonitor void fullscreenOnMonitor(MonitorGdk monitor): Asks to place @window in the fullscreen state on the given @monitor.
getApplication Application getApplication(): Gets the GtkApplication associated with the window.
getChild Widget getChild(): Gets the child widget of @window.
getDecorated bool getDecorated(): Returns whether the window has been set to have decorations.
getDefaultSize void getDefaultSize(int width, int height): Gets the default size of the window.
getDefaultWidget Widget getDefaultWidget(): Returns the default widget for @window.
getDeletable bool getDeletable(): Returns whether the window has been set to have a close button.
getDestroyWithParent bool getDestroyWithParent(): Returns whether the window will be destroyed with its transient parent.
getFocus Widget getFocus(): Retrieves the current focused widget within the window.
getFocusVisible bool getFocusVisible(): Gets whether “focus rectangles” are supposed to be visible.
getGroup WindowGroup getGroup(): Returns the group for @window.
getHandleMenubarAccel bool getHandleMenubarAccel(): Returns whether this window reacts to F10 key presses by activating a menubar it contains.
getHideOnClose bool getHideOnClose(): Returns whether the window will be hidden when the close button is clicked.
getIconName string getIconName(): Returns the name of the themed icon for the window.
getMnemonicsVisible bool getMnemonicsVisible(): Gets whether mnemonics are supposed to be visible.
getModal bool getModal(): Returns whether the window is modal.
getResizable bool getResizable(): Gets the value set by gtk_window_set_resizable().
getTitle string getTitle(): Retrieves the title of the window.
getTitlebar Widget getTitlebar(): Returns the custom titlebar that has been set with gtk_window_set_titlebar().
getTransientFor Window getTransientFor(): Fetches the transient parent for this window.
hasGroup bool hasGroup(): Returns whether @window has an explicit window group.
isActive bool isActive(): Returns whether the window is part of the current active toplevel.
isFullscreen bool isFullscreen(): Retrieves the current fullscreen state of @window.
isMaximized bool isMaximized(): Retrieves the current maximized state of @window.
maximize void maximize(): Asks to maximize @window, so that it fills the screen.
minimize void minimize(): Asks to minimize the specified @window.
present void present(): Presents a window to the user.
presentWithTime void presentWithTime(uint timestamp): Presents a window to the user.
setApplication void setApplication(Application application): Sets or unsets the GtkApplication associated with the window.
setChild void setChild(Widget child): Sets the child widget of @window.
setDecorated void setDecorated(bool setting): Sets whether the window should be decorated.
setDefaultSize void setDefaultSize(int width, int height): Sets the default size of a window.
setDefaultWidget void setDefaultWidget(Widget defaultWidget): Sets the default widget.
setDeletable void setDeletable(bool setting): Sets whether the window should be deletable.
setDestroyWithParent void setDestroyWithParent(bool setting): If @setting is %TRUE, then destroying the transient parent of @window will also destroy @window itself.
setDisplay void setDisplay(Display display): Sets the GdkDisplay where the @window is displayed.
setFocus void setFocus(Widget focus): Sets the focus widget.
setFocusVisible void setFocusVisible(bool setting): Sets whether “focus rectangles” are supposed to be visible.
setHandleMenubarAccel void setHandleMenubarAccel(bool handleMenubarAccel): Sets whether this window should react to F10 key presses by activating a menubar it contains.
setHideOnClose void setHideOnClose(bool setting): If @setting is %TRUE, then clicking the close button on the window will not destroy it, but only hide it.
setIconName void setIconName(string name): Sets the icon for the window from a named themed icon.
setMnemonicsVisible void setMnemonicsVisible(bool setting): Sets whether mnemonics are supposed to be visible.
setModal void setModal(bool modal): Sets a window modal or non-modal.
setResizable void setResizable(bool resizable): Sets whether the user can resize a window.
setStartupId void setStartupId(string startupId): Sets the startup notification ID.
setTitle void setTitle(string title): Sets the title of the GtkWindow.
setTitlebar void setTitlebar(Widget titlebar): Sets a custom titlebar for @window.
setTransientFor void setTransientFor(Window parent): Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. [ctor@Gtk.Dialog.new_with_buttons] and other convenience functions in GTK will sometimes call gtk_window_set_transient_for() on your behalf.
unfullscreen void unfullscreen(): Asks to remove the fullscreen state for @window, and return to its previous state.
unmaximize void unmaximize(): Asks to unmaximize @window.
unminimize void unminimize(): Asks to unminimize the specified @window.
addOnActivateDefault gulong addOnActivateDefault(void delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user activates the default widget of @window.
addOnActivateFocus gulong addOnActivateFocus(void delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user activates the currently focused widget of @window.
addOnCloseRequest gulong addOnCloseRequest(bool delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user clicks on the close button of the window.
addOnEnableDebugging gulong addOnEnableDebugging(bool delegate(bool, Window) dlg, ConnectFlags connectFlags): Emitted when the user enables or disables interactive debugging.
addOnKeysChanged gulong addOnKeysChanged(void delegate(Window) dlg, ConnectFlags connectFlags): emitted when the set of accelerators or mnemonics that are associated with @window changes.

ShortcutsWindow

A simple example:

An example with multiple views:

An example with multiple sections:

Constructors

Members

Functions

Static functions

Variables

Inherited Members

From Window

Meta

Source