Struct gtk4::ShortcutsGroup

#[repr(transparent)]
pub struct ShortcutsGroup { /* private fields */ }

A ShortcutsGroup represents a group of related keyboard shortcuts or gestures.

The group has a title. It may optionally be associated with a view of the application, which can be used to show only relevant shortcuts depending on the application context.

This widget is only meant to be used with ShortcutsWindow.

The recommended way to construct a ShortcutsGroup is with Builder, by using the <child> tag to populate a ShortcutsGroup with one or more ShortcutsShortcut instances.

If you need to add a shortcut programmatically, use add_shortcut().

Properties

accel-size-group

The size group for the accelerator portion of shortcuts in this group.

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

Writeable

height

A rough measure for the number of lines in this group.

This is used internally by GTK, and is not useful for applications.

Readable

title

The title for this group of shortcuts.

Readable | Writeable

title-size-group

The size group for the textual portion of shortcuts in this group.

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

Writeable

view

An optional view that the shortcuts in this group are relevant for.

The group will be hidden if the view-name property does not match the view of this group.

Set this to None to make the group always visible.

Readable | Writeable

Box

baseline-child

The child that determines the baseline, in vertical orientation.

Readable | Writeable

baseline-position

The position of the baseline aligned widgets if extra space is available.

Readable | Writeable

homogeneous

Whether the children should all be the same size.

Readable | Writeable

spacing

The amount of space between children.

Readable | Writeable

Widget

can-focus

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.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

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.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

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

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

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

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.

Readable | Writeable

height-request

Override for height request of the widget.

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

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

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.

Readable | Writeable

margin-bottom

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.

Readable | Writeable

margin-end

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.

Readable | Writeable

margin-start

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.

Readable | Writeable

margin-top

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.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

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.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

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

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

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.

Readable | Writeable

tooltip-text

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.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

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

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

BoxExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ShortcutsGroup

pub fn builder() -> ShortcutsGroupBuilder

Creates a new builder-pattern struct instance to construct ShortcutsGroup objects.

This method returns an instance of ShortcutsGroupBuilder which can be used to create ShortcutsGroup objects.

pub fn add_shortcut(&self, shortcut: &ShortcutsShortcut)

Available on crate feature v4_14 only.

Adds a shortcut to the shortcuts group.

This is the programmatic equivalent to using Builder and a <child> tag to add the child. Adding children with other API is not appropriate as ShortcutsGroup manages its children internally.

shortcut

the ShortcutsShortcut to add

pub fn set_accel_size_group(&self, accel_size_group: Option<&SizeGroup>)

The size group for the accelerator portion of shortcuts in this group.

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

pub fn height(&self) -> u32

A rough measure for the number of lines in this group.

This is used internally by GTK, and is not useful for applications.

pub fn title(&self) -> Option<GString>

The title for this group of shortcuts.

pub fn set_title(&self, title: Option<&str>)

The title for this group of shortcuts.

pub fn set_title_size_group(&self, title_size_group: Option<&SizeGroup>)

The size group for the textual portion of shortcuts in this group.

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

pub fn view(&self) -> Option<GString>

An optional view that the shortcuts in this group are relevant for.

The group will be hidden if the view-name property does not match the view of this group.

Set this to None to make the group always visible.

pub fn set_view(&self, view: Option<&str>)

An optional view that the shortcuts in this group are relevant for.

The group will be hidden if the view-name property does not match the view of this group.

Set this to None to make the group always visible.

pub fn connect_accel_size_group_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_height_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_title_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_title_size_group_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_view_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for ShortcutsGroup

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShortcutsGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ShortcutsGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ShortcutsGroup

type ParamSpec = ParamSpecObject

type SetValue = ShortcutsGroup

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ShortcutsGroup>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ShortcutsGroup

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShortcutsGroup

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ShortcutsGroup

type Parent = Box

impl<OT: ObjectType> PartialEq<OT> for ShortcutsGroup

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ShortcutsGroup

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ShortcutsGroup

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutsGroup

impl IsA<Accessible> for ShortcutsGroup

impl IsA<Box> for ShortcutsGroup

impl IsA<Buildable> for ShortcutsGroup

impl IsA<ConstraintTarget> for ShortcutsGroup

impl IsA<Orientable> for ShortcutsGroup

impl IsA<Widget> for ShortcutsGroup