ShortcutsWindow

A gtk.shortcuts_window.ShortcutsWindow 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 gtk.shortcuts_window.ShortcutsWindow is with gtk.builder.Builder, by using the <child> tag to populate a gtk.shortcuts_window.ShortcutsWindow with one or more gtk.shortcuts_section.ShortcutsSection objects, which contain one or more gtk.shortcuts_group.ShortcutsGroup instances, which, in turn, contain gtk.shortcuts_shortcut.ShortcutsShortcut instances.

If you need to add a section programmatically, use gtk.shortcuts_window.ShortcutsWindow.addSection instead of gtk.window.Window.setChild, as the shortcuts window manages its children directly.

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 gtk.shortcuts_window.ShortcutsWindow 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 gtk.shortcuts_window.ShortcutsWindow with two sections, "Editor Shortcuts" and "Terminal Shortcuts".

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

CSS nodes

gtk.shortcuts_window.ShortcutsWindow has a single CSS node with the name window and style class .shortcuts.

Members

Functions

addSection
void addSection(gtk.shortcuts_section.ShortcutsSection section)

Adds a section to the shortcuts window.

connectClose
ulong connectClose(T callback, Flag!"After" after)

Connect to Close signal.

connectSearch
ulong connectSearch(T callback, Flag!"After" after)

Connect to Search signal.

Inherited Members

From Window

getDefaultIconName
string getDefaultIconName()

Returns the fallback icon name for windows.

getToplevels
gio.list_model.ListModel getToplevels()

Returns a list of all existing toplevel windows.

listToplevels
gtk.widget.Widget[] 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(gdk.monitor.MonitorG monitor)

Asks to place window in the fullscreen state on the given monitor.

getApplication
gtk.application.Application getApplication()

Gets the gtk.application.Application associated with the window.

getChild
gtk.widget.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
gtk.widget.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
gtk.widget.Widget getFocus()

Retrieves the current focused widget within the window.

getFocusVisible
bool getFocusVisible()

Gets whether “focus rectangles” are supposed to be visible.

getGroup
gtk.window_group.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.Window.setResizable.

getTitle
string getTitle()

Retrieves the title of the window.

getTitlebar
gtk.widget.Widget getTitlebar()

Returns the custom titlebar that has been set with gtk.window.Window.setTitlebar.

getTransientFor
gtk.window.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.

isSuspended
bool isSuspended()

Retrieves the current suspended 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 in response to an user interaction.

setApplication
void setApplication(gtk.application.Application application)

Sets or unsets the gtk.application.Application associated with the window.

setChild
void setChild(gtk.widget.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(gtk.widget.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(gdk.display.Display display)

Sets the gdk.display.Display where the window is displayed.

setFocus
void setFocus(gtk.widget.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 gtk.window.Window.

setTitlebar
void setTitlebar(gtk.widget.Widget titlebar)

Sets a custom titlebar for window.

setTransientFor
void setTransientFor(gtk.window.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. gtk.dialog.Dialog.newWithButtons and other convenience functions in GTK will sometimes call gtk.window.Window.setTransientFor 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.

connectActivateDefault
ulong connectActivateDefault(T callback, Flag!"After" after)

Connect to ActivateDefault signal.

connectActivateFocus
ulong connectActivateFocus(T callback, Flag!"After" after)

Connect to ActivateFocus signal.

connectCloseRequest
ulong connectCloseRequest(T callback, Flag!"After" after)

Connect to CloseRequest signal.

connectEnableDebugging
ulong connectEnableDebugging(T callback, Flag!"After" after)

Connect to EnableDebugging signal.

connectKeysChanged
ulong connectKeysChanged(T callback, Flag!"After" after)

Connect to KeysChanged signal.