Struct gtk::builders::ShortcutsShortcutBuilder

pub struct ShortcutsShortcutBuilder { /* private fields */ }

A builder-pattern type to construct ShortcutsShortcut objects.

Implementations

impl ShortcutsShortcutBuilder

pub fn new() -> Self

Available on crate feature v3_20 only.

Create a new ShortcutsShortcutBuilder.

pub fn build(self) -> ShortcutsShortcut

Available on crate feature v3_20 only.

Build the ShortcutsShortcut.

pub fn accel_size_group(self, accel_size_group: &impl IsA<SizeGroup>) -> Self

Available on crate feature v3_20 only.

The size group for the accelerator portion of this shortcut.

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

pub fn accelerator(self, accelerator: &str) -> Self

Available on crate feature v3_20 only.

The accelerator(s) represented by this object. This property is used if property::ShortcutsShortcut::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>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.

pub fn action_name(self, action_name: &str) -> Self

Available on crate features v3_20 and v3_22 only.

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 signal::ShortcutsShortcut::accelerator is not necessary.

pub fn direction(self, direction: TextDirection) -> Self

Available on crate feature v3_20 only.

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.

pub fn icon(self, icon: &impl IsA<Icon>) -> Self

Available on crate feature v3_20 only.

An icon to represent the shortcut or gesture. This property is used if property::ShortcutsShortcut::shortcut-type is set to ShortcutType::Gesture. For the other predefined gesture types, GTK+ provides an icon on its own.

pub fn icon_set(self, icon_set: bool) -> Self

Available on crate feature v3_20 only.

true if an icon has been set.

pub fn shortcut_type(self, shortcut_type: ShortcutType) -> Self

Available on crate feature v3_20 only.

The type of shortcut that is represented.

pub fn subtitle(self, subtitle: &str) -> Self

Available on crate feature v3_20 only.

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.

pub fn subtitle_set(self, subtitle_set: bool) -> Self

Available on crate feature v3_20 only.

true if a subtitle has been set.

pub fn title(self, title: &str) -> Self

Available on crate feature v3_20 only.

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.

pub fn title_size_group(self, title_size_group: &impl IsA<SizeGroup>) -> Self

Available on crate feature v3_20 only.

The size group for the textual portion of this shortcut.

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

pub fn baseline_position(self, baseline_position: BaselinePosition) -> Self

Available on crate feature v3_20 only.

pub fn homogeneous(self, homogeneous: bool) -> Self

Available on crate feature v3_20 only.

pub fn spacing(self, spacing: i32) -> Self

Available on crate feature v3_20 only.

pub fn border_width(self, border_width: u32) -> Self

Available on crate feature v3_20 only.

pub fn child(self, child: &impl IsA<Widget>) -> Self

Available on crate feature v3_20 only.

pub fn resize_mode(self, resize_mode: ResizeMode) -> Self

Available on crate feature v3_20 only.

pub fn app_paintable(self, app_paintable: bool) -> Self

Available on crate feature v3_20 only.

pub fn can_default(self, can_default: bool) -> Self

Available on crate feature v3_20 only.

pub fn can_focus(self, can_focus: bool) -> Self

Available on crate feature v3_20 only.

pub fn events(self, events: EventMask) -> Self

Available on crate feature v3_20 only.

pub fn expand(self, expand: bool) -> Self

Available on crate feature v3_20 only.

Whether to expand in both directions. Setting this sets both property::Widget::hexpand and property::Widget::vexpand

pub fn focus_on_click(self, focus_on_click: bool) -> Self

Available on crate feature v3_20 only.

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

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

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

pub fn halign(self, halign: Align) -> Self

Available on crate feature v3_20 only.

How to distribute horizontal space if widget gets extra space, see Align

pub fn has_default(self, has_default: bool) -> Self

Available on crate feature v3_20 only.

pub fn has_focus(self, has_focus: bool) -> Self

Available on crate feature v3_20 only.

pub fn has_tooltip(self, has_tooltip: bool) -> Self

Available on crate feature v3_20 only.

Enables or disables the emission of signal::Widget::query-tooltip on widget. A value of true indicates that widget can have a tooltip, in this case the widget will be queried using signal::Widget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

pub fn height_request(self, height_request: i32) -> Self

Available on crate feature v3_20 only.

pub fn hexpand(self, hexpand: bool) -> Self

Available on crate feature v3_20 only.

Whether to expand horizontally. See WidgetExt::set_hexpand().

pub fn hexpand_set(self, hexpand_set: bool) -> Self

Available on crate feature v3_20 only.

Whether to use the property::Widget::hexpand property. See WidgetExt::is_hexpand_set().

pub fn is_focus(self, is_focus: bool) -> Self

Available on crate feature v3_20 only.

pub fn margin(self, margin: i32) -> Self

Available on crate feature v3_20 only.

Sets all four sides’ margin at once. If read, returns max margin on any side.

pub fn margin_bottom(self, margin_bottom: i32) -> Self

Available on crate feature v3_20 only.

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.

pub fn margin_end(self, margin_end: i32) -> Self

Available on crate feature v3_20 only.

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.

pub fn margin_start(self, margin_start: i32) -> Self

Available on crate feature v3_20 only.

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.

pub fn margin_top(self, margin_top: i32) -> Self

Available on crate feature v3_20 only.

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.

pub fn name(self, name: &str) -> Self

Available on crate feature v3_20 only.

pub fn no_show_all(self, no_show_all: bool) -> Self

Available on crate feature v3_20 only.

pub fn opacity(self, opacity: f64) -> Self

Available on crate feature v3_20 only.

The requested opacity of the widget. See WidgetExt::set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

pub fn parent(self, parent: &impl IsA<Container>) -> Self

Available on crate feature v3_20 only.

pub fn receives_default(self, receives_default: bool) -> Self

Available on crate feature v3_20 only.

pub fn sensitive(self, sensitive: bool) -> Self

Available on crate feature v3_20 only.

pub fn tooltip_markup(self, tooltip_markup: &str) -> Self

Available on crate feature v3_20 only.

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. 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: property::Widget::has-tooltip will automatically be set to true and there will be taken care of signal::Widget::query-tooltip in the default signal handler.

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

pub fn tooltip_text(self, tooltip_text: &str) -> Self

Available on crate feature v3_20 only.

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: property::Widget::has-tooltip will automatically be set to true and there will be taken care of signal::Widget::query-tooltip in the default signal handler.

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

pub fn valign(self, valign: Align) -> Self

Available on crate feature v3_20 only.

How to distribute vertical space if widget gets extra space, see Align

pub fn vexpand(self, vexpand: bool) -> Self

Available on crate feature v3_20 only.

Whether to expand vertically. See WidgetExt::set_vexpand().

pub fn vexpand_set(self, vexpand_set: bool) -> Self

Available on crate feature v3_20 only.

Whether to use the property::Widget::vexpand property. See WidgetExt::is_vexpand_set().

pub fn visible(self, visible: bool) -> Self

Available on crate feature v3_20 only.

pub fn width_request(self, width_request: i32) -> Self

Available on crate feature v3_20 only.

pub fn orientation(self, orientation: Orientation) -> Self

Available on crate feature v3_20 only.

The orientation of the orientable.

Trait Implementations

impl Clone for ShortcutsShortcutBuilder

Available on crate feature v3_20 only.

fn clone(&self) -> ShortcutsShortcutBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ShortcutsShortcutBuilder

Available on crate feature v3_20 only.

fn default() -> ShortcutsShortcutBuilder

Returns the “default value” for a type.