Gjsify LogoGjsify Logo

Interface ShortcutsShortcut_ConstructProps

Hierarchy

Index

Properties

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.

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: delete
  • Two alternative shortcuts: a Home
  • A range of shortcuts: 1...9
  • Several keys pressed together: Control_L&Control_R
  • A sequence of shortcuts or keys: c+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 <, > and & when used in .ui files.

accessible_role?: AccessibleRole

The accessible role of the given GtkAccessible implementation.

The accessible role cannot be changed once set.

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.

can_focus?: boolean

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

can_target?: boolean

Whether the widget can receive pointer events.

css_classes?: string[]

A list of css classes applied to this widget.

css_name?: string

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

cursor?: Gdk.Cursor

The cursor used by widget.

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.

focus_on_click?: boolean

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

focusable?: boolean

Whether this widget itself will accept the input focus.

halign?: Gtk.Align

How to distribute horizontal space if widget gets extra space.

has_tooltip?: boolean

Enables or disables the emission of the ::query-tooltip signal on widget.

A value of %TRUE indicates that widget can have a tooltip, in this case the widget will be queried using [signalGtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

height_request?: number

Override for height request of the widget.

If this is -1, the natural request will be used.

hexpand?: boolean

Whether to expand horizontally.

hexpand_set?: boolean

Whether to use the hexpand property.

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.

icon_set?: boolean

%TRUE if an icon has been set.

layout_manager?: Gtk.LayoutManager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

margin_bottom?: number

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

margin_end?: number

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

margin_start?: number

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

margin_top?: number

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

name?: string

The name of the widget.

opacity?: number

The requested opacity of the widget.

overflow?: Overflow

How content outside the widget's content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

receives_default?: boolean

Whether the widget will receive the default action when it is focused.

sensitive?: boolean

Whether the widget responds to input.

shortcut_type?: Gtk.ShortcutType

The type of shortcut that is represented.

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.

subtitle_set?: boolean

%TRUE if a subtitle has been 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.

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.

tooltip_markup?: string

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [methodGtk.Tooltip.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: [propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

tooltip_text?: string

Sets the text of tooltip to be the given string.

Also see [methodGtk.Tooltip.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: [propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

valign?: Gtk.Align

How to distribute vertical space if widget gets extra space.

vexpand?: boolean

Whether to expand vertically.

vexpand_set?: boolean

Whether to use the vexpand property.

visible?: boolean

Whether the widget is visible.

width_request?: number

Override for width request of the widget.

If this is -1, the natural request will be used.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method