Class: Gtk::ShortcutsWindow
- Defined in:
- (unknown)
Overview
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
[classGtk.Builder], by using the <child> tag to populate a
GtkShortcutsWindow with one or more [classGtk.ShortcutsSection] objects,
which contain one or more [classGtk.ShortcutsGroup] instances, which, in turn,
contain [classGtk.ShortcutsShortcut] instances.
If you need to add a section programmatically, use [methodGtk.ShortcutsWindow.add_section] instead of [methodGtk.Window.set_child], 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 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.
CSS nodes
GtkShortcutsWindow has a single CSS node with the name window and style
class .shortcuts.
Instance Method Summary collapse
-
#add_section(section) ⇒ nil
Adds a section to the shortcuts window.
-
#section_name ⇒ String
The name of the section to show.
-
#section_name=(section_name) ⇒ String
The name of the section to show.
-
#view_name ⇒ String
The view name by which to filter the contents.
-
#view_name=(view_name) ⇒ String
The view name by which to filter the contents.
Methods inherited from Window
#application, #application=, auto_startup_notification=, #child, #child=, #close, #decorated, #decorated=, #decorated?, #default_height, #default_height=, default_icon_name, default_icon_name=, #default_widget, #default_widget=, #default_width, #default_width=, #deletable, #deletable=, #deletable?, #destroy, #destroy_with_parent, #destroy_with_parent=, #destroy_with_parent?, #display, #display=, #focus, #focus=, #focus_visible, #focus_visible=, #focus_visible?, #focus_widget, #focus_widget=, #fullscreen, #fullscreen_on_monitor, #fullscreened=, #fullscreened?, #get_default_size, #group, #handle_menubar_accel, #handle_menubar_accel=, #handle_menubar_accel?, #has_group, #hide_on_close, #hide_on_close=, #hide_on_close?, #icon_name, #icon_name=, #initialize, interactive_debugging=, #is_active, #is_active=, #is_active?, #is_fullscreen, #is_maximized, #is_suspended, list_toplevels, #maximize, #maximized=, #maximized?, #minimize, #mnemonics_visible, #mnemonics_visible=, #mnemonics_visible?, #modal, #modal=, #modal?, #present, #present_with_time, #resizable, #resizable=, #resizable?, #set_default_size, #startup_id=, #suspended=, #suspended?, #title, #title=, #titlebar, #titlebar=, toplevels, #transient_for, #transient_for=, #unfullscreen, #unmaximize, #unminimize
Methods inherited from Widget
#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #error_bell, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_state_flags, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #template=, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=
Constructor Details
This class inherits a constructor from Gtk::Window
Instance Method Details
#add_section(section) ⇒ nil
Adds a section to the shortcuts window.
This is the programmatic equivalent to using [classGtk.Builder] and a
<child> tag to add the child.
Using [methodGtk.Window.set_child] is not appropriate as the shortcuts window manages its children internally.
#section_name ⇒ String
The name of the section to show.
This should be the section-name of one of the GtkShortcutsSection
objects that are in this shortcuts window.
#section_name=(section_name) ⇒ String
The name of the section to show.
This should be the section-name of one of the GtkShortcutsSection
objects that are in this shortcuts window.
#view_name ⇒ String
The view name by which to filter the contents.
This should correspond to the [propertyGtk.ShortcutsGroup:view] property of some of the [classGtk.ShortcutsGroup] objects that are inside this shortcuts window.
Set this to nil to show all groups.
#view_name=(view_name) ⇒ String
The view name by which to filter the contents.
This should correspond to the [propertyGtk.ShortcutsGroup:view] property of some of the [classGtk.ShortcutsGroup] objects that are inside this shortcuts window.
Set this to nil to show all groups.