Class: Gtk::ShortcutsShortcut

Inherits:
Widget
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

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_events, #add_events_raw, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #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=, #display, #dispose_template, #drag_check_threshold, #drag_dest_set, #drag_dest_set_raw, #drag_source_set, #drag_source_set_raw, #error_bell, #events, #events_raw, #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, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #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, #render_icon_pixbuf, #render_icon_pixbuf_raw, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_allocation, set_connect_func, set_connect_func_raw, #set_events, #set_events_raw, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #style_get_property, #style_get_property_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #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=

Instance Method Details

#accel_size_group=(accel_size_group) ⇒ Gtk::SizeGroup

The size group for the accelerator portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

Parameters:

Returns:

#accelerator ⇒ String

The accelerator(s) represented by this object.

This property is used if [propertyGtk.ShortcutsShortcut:shortcut-type]
is set to %GTK_SHORTCUT_ACCELERATOR.

The syntax of this property is (an extension of) the syntax understood
by [funcGtk.accelerator_parse]. Multiple accelerators can be specified
by separating them with a space, but keep in mind that the available width
is limited.

It is also possible to specify ranges of shortcuts, using ... between
the keys. Sequences of keys can be specified using a + or & between
the keys.

Examples:

  • A single shortcut: <ctl><alt>delete
  • Two alternative shortcuts: <shift>a Home
  • A range of shortcuts: <alt>1...<alt>9
  • Several keys pressed together: Control_L&Control_R
  • A sequence of shortcuts or keys: <ctl>c+<ctl>x

Use "+" instead of "&" when the keys may (or have to be) pressed
sequentially (e.g use "t+t" for 'press the t key twice').

Note that <, > and & need to be escaped as &lt;, &gt; and &amp; when used
in .ui files.

Returns:

  • (String) —

    accelerator

#accelerator=(accelerator) ⇒ String

The accelerator(s) represented by this object.

This property is used if [propertyGtk.ShortcutsShortcut:shortcut-type]
is set to %GTK_SHORTCUT_ACCELERATOR.

The syntax of this property is (an extension of) the syntax understood
by [funcGtk.accelerator_parse]. Multiple accelerators can be specified
by separating them with a space, but keep in mind that the available width
is limited.

It is also possible to specify ranges of shortcuts, using ... between
the keys. Sequences of keys can be specified using a + or & between
the keys.

Examples:

  • A single shortcut: <ctl><alt>delete
  • Two alternative shortcuts: <shift>a Home
  • A range of shortcuts: <alt>1...<alt>9
  • Several keys pressed together: Control_L&Control_R
  • A sequence of shortcuts or keys: <ctl>c+<ctl>x

Use "+" instead of "&" when the keys may (or have to be) pressed
sequentially (e.g use "t+t" for 'press the t key twice').

Note that <, > and & need to be escaped as &lt;, &gt; and &amp; when used
in .ui files.

Parameters:

  • accelerator (String)

Returns:

  • (String) —

    accelerator

  • (String) —

    accelerator

#action_name ⇒ String

A detailed action name.

If this is set for a shortcut of type %GTK_SHORTCUT_ACCELERATOR,
then GTK will use the accelerators that are associated with the
action via [methodGtk.Application.set_accels_for_action], and
setting [propertyGtk.ShortcutsShortcut:accelerator] is not necessary.

Returns:

  • (String) —

    action-name

#action_name=(action_name) ⇒ String

A detailed action name.

If this is set for a shortcut of type %GTK_SHORTCUT_ACCELERATOR,
then GTK will use the accelerators that are associated with the
action via [methodGtk.Application.set_accels_for_action], and
setting [propertyGtk.ShortcutsShortcut:accelerator] is not necessary.

Parameters:

  • action_name (String)

Returns:

  • (String) —

    action-name

  • (String) —

    action-name

#direction ⇒ Gtk::TextDirection

The text direction for which this shortcut is active.

If the shortcut is used regardless of the text direction,
set this property to %GTK_TEXT_DIR_NONE.

Returns:

#direction=(direction) ⇒ Gtk::TextDirection

The text direction for which this shortcut is active.

If the shortcut is used regardless of the text direction,
set this property to %GTK_TEXT_DIR_NONE.

Parameters:

Returns:

#icon ⇒ Gio::Icon

An icon to represent the shortcut or gesture.

This property is used if [propertyGtk.ShortcutsShortcut:shortcut-type]
is set to %GTK_SHORTCUT_GESTURE.

For the other predefined gesture types, GTK provides an icon on its own.

Returns:

  • (Gio::Icon) —

    icon

#icon=(icon) ⇒ Gio::Icon

An icon to represent the shortcut or gesture.

This property is used if [propertyGtk.ShortcutsShortcut:shortcut-type]
is set to %GTK_SHORTCUT_GESTURE.

For the other predefined gesture types, GTK provides an icon on its own.

Parameters:

  • icon (Gio::Icon)

Returns:

  • (Gio::Icon) —

    icon

  • (Gio::Icon) —

    icon

#icon_set=(icon_set) ⇒ Boolean

true if an icon has been set.

Parameters:

  • icon_set (Boolean)

Returns:

  • (Boolean) —

    icon-set

  • (Boolean) —

    icon-set

#icon_set? ⇒ Boolean

true if an icon has been set.

Returns:

  • (Boolean) —

    icon-set

#shortcut_type ⇒ Gtk::ShortcutType

The type of shortcut that is represented.

Returns:

#shortcut_type=(shortcut_type) ⇒ Gtk::ShortcutType

The type of shortcut that is represented.

Parameters:

Returns:

#subtitle ⇒ String

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line
text that describes the gesture itself. For the predefined gesture
types, GTK provides a subtitle on its own.

Returns:

  • (String) —

    subtitle

#subtitle=(subtitle) ⇒ String

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line
text that describes the gesture itself. For the predefined gesture
types, GTK provides a subtitle on its own.

Parameters:

  • subtitle (String)

Returns:

  • (String) —

    subtitle

  • (String) —

    subtitle

#subtitle_set=(subtitle_set) ⇒ Boolean

true if a subtitle has been set.

Parameters:

  • subtitle_set (Boolean)

Returns:

  • (Boolean) —

    subtitle-set

  • (Boolean) —

    subtitle-set

#subtitle_set? ⇒ Boolean

true if a subtitle has been set.

Returns:

  • (Boolean) —

    subtitle-set

#title ⇒ String

The textual description for the shortcut or gesture represented by
this object.

This should be a short string that can fit in a single line.

Returns:

  • (String) —

    title

#title=(title) ⇒ String

The textual description for the shortcut or gesture represented by
this object.

This should be a short string that can fit in a single line.

Parameters:

  • title (String)

Returns:

  • (String) —

    title

  • (String) —

    title

#title_size_group=(title_size_group) ⇒ Gtk::SizeGroup

The size group for the textual portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

Parameters:

Returns: