Struct gtk4::builders::ShortcutsShortcutBuilder
source · pub struct ShortcutsShortcutBuilder { /* private fields */ }
Expand description
A builder-pattern type to construct ShortcutsShortcut
objects.
Implementations§
source§impl ShortcutsShortcutBuilder
impl ShortcutsShortcutBuilder
sourcepub fn accel_size_group(self, accel_size_group: &SizeGroup) -> Self
pub fn accel_size_group(self, accel_size_group: &SizeGroup) -> Self
The size group for the accelerator portion of this shortcut.
This is used internally by GTK, and must not be modified by applications.
sourcepub fn accelerator(self, accelerator: impl Into<GString>) -> Self
pub fn accelerator(self, accelerator: impl Into<GString>) -> Self
The accelerator(s) represented by this object.
This property is used if shortcut-type
is set to ShortcutType::Accelerator
.
The syntax of this property is (an extension of) the syntax understood
by 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 <
, >
; and &
; when used
in .ui files.
sourcepub fn action_name(self, action_name: impl Into<GString>) -> Self
pub fn action_name(self, action_name: impl Into<GString>) -> Self
A detailed action name.
If this is set for a shortcut of type ShortcutType::Accelerator
,
then GTK will use the accelerators that are associated with the
action via GtkApplicationExt::set_accels_for_action()
, and
setting accelerator
is not necessary.
sourcepub fn direction(self, direction: TextDirection) -> Self
pub fn direction(self, direction: TextDirection) -> Self
The text direction for which this shortcut is active.
If the shortcut is used regardless of the text direction,
set this property to TextDirection::None
.
sourcepub fn icon(self, icon: &impl IsA<Icon>) -> Self
pub fn icon(self, icon: &impl IsA<Icon>) -> Self
An icon to represent the shortcut or gesture.
This property is used if shortcut-type
is set to ShortcutType::Gesture
.
For the other predefined gesture types, GTK provides an icon on its own.
sourcepub fn shortcut_type(self, shortcut_type: ShortcutType) -> Self
pub fn shortcut_type(self, shortcut_type: ShortcutType) -> Self
The type of shortcut that is represented.
sourcepub fn subtitle(self, subtitle: impl Into<GString>) -> Self
pub fn subtitle(self, subtitle: impl Into<GString>) -> Self
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.
sourcepub fn subtitle_set(self, subtitle_set: bool) -> Self
pub fn subtitle_set(self, subtitle_set: bool) -> Self
true
if a subtitle has been set.
sourcepub fn title(self, title: impl Into<GString>) -> Self
pub fn title(self, title: impl Into<GString>) -> Self
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.
sourcepub fn title_size_group(self, title_size_group: &SizeGroup) -> Self
pub fn title_size_group(self, title_size_group: &SizeGroup) -> Self
The size group for the textual portion of this shortcut.
This is used internally by GTK, and must not be modified by applications.
sourcepub fn can_focus(self, can_focus: bool) -> Self
pub fn can_focus(self, can_focus: bool) -> Self
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.
sourcepub fn can_target(self, can_target: bool) -> Self
pub fn can_target(self, can_target: bool) -> Self
Whether the widget can receive pointer events.
sourcepub fn css_classes(self, css_classes: impl Into<StrV>) -> Self
pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self
A list of css classes applied to this widget.
sourcepub fn css_name(self, css_name: impl Into<GString>) -> Self
pub fn css_name(self, css_name: impl Into<GString>) -> Self
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.
sourcepub fn focus_on_click(self, focus_on_click: bool) -> Self
pub fn focus_on_click(self, focus_on_click: bool) -> Self
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
sourcepub fn focusable(self, focusable: bool) -> Self
pub fn focusable(self, focusable: bool) -> Self
Whether this widget itself will accept the input focus.
sourcepub fn halign(self, halign: Align) -> Self
pub fn halign(self, halign: Align) -> Self
How to distribute horizontal space if widget gets extra space.
sourcepub fn has_tooltip(self, has_tooltip: bool) -> Self
pub fn has_tooltip(self, has_tooltip: bool) -> Self
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 query-tooltip
to
determine whether it will provide a tooltip or not.
sourcepub fn height_request(self, height_request: i32) -> Self
pub fn height_request(self, height_request: i32) -> Self
Override for height request of the widget.
If this is -1, the natural request will be used.
sourcepub fn hexpand_set(self, hexpand_set: bool) -> Self
pub fn hexpand_set(self, hexpand_set: bool) -> Self
Whether to use the hexpand
property.
sourcepub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self
pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self
The LayoutManager
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.
sourcepub fn margin_bottom(self, margin_bottom: i32) -> Self
pub fn margin_bottom(self, margin_bottom: i32) -> Self
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
WidgetExt::set_size_request()
for example.
sourcepub fn margin_end(self, margin_end: i32) -> Self
pub fn margin_end(self, margin_end: i32) -> Self
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
WidgetExt::set_size_request()
for example.
sourcepub fn margin_start(self, margin_start: i32) -> Self
pub fn margin_start(self, margin_start: i32) -> Self
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
WidgetExt::set_size_request()
for example.
sourcepub fn margin_top(self, margin_top: i32) -> Self
pub fn margin_top(self, margin_top: i32) -> Self
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
WidgetExt::set_size_request()
for example.
sourcepub fn overflow(self, overflow: Overflow) -> Self
pub fn overflow(self, overflow: Overflow) -> Self
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.
sourcepub fn receives_default(self, receives_default: bool) -> Self
pub fn receives_default(self, receives_default: bool) -> Self
Whether the widget will receive the default action when it is focused.
sourcepub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self
pub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Tooltip::set_markup()
.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not None
:
has-tooltip
will automatically be set to true
and there will be taken care of query-tooltip
in
the default signal handler.
Note that if both tooltip-text
and
tooltip-markup
are set, the last one wins.
sourcepub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self
pub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self
Sets the text of tooltip to be the given string.
Also see Tooltip::set_text()
.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not None
:
has-tooltip
will automatically be set to true
and there will be taken care of query-tooltip
in
the default signal handler.
Note that if both tooltip-text
and
tooltip-markup
are set, the last one wins.
sourcepub fn valign(self, valign: Align) -> Self
pub fn valign(self, valign: Align) -> Self
How to distribute vertical space if widget gets extra space.
sourcepub fn vexpand_set(self, vexpand_set: bool) -> Self
pub fn vexpand_set(self, vexpand_set: bool) -> Self
Whether to use the vexpand
property.
sourcepub fn width_request(self, width_request: i32) -> Self
pub fn width_request(self, width_request: i32) -> Self
Override for width request of the widget.
If this is -1, the natural request will be used.
sourcepub fn accessible_role(self, accessible_role: AccessibleRole) -> Self
pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self
The accessible role of the given Accessible
implementation.
The accessible role cannot be changed once set.
sourcepub fn build(self) -> ShortcutsShortcut
pub fn build(self) -> ShortcutsShortcut
Build the ShortcutsShortcut
.