Struct gtk4::WindowControls

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

WindowControls shows window frame controls.

Typical window frame controls are minimize, maximize and close buttons, and the window icon.

WindowControls only displays start or end side of the controls (see property::WindowControls::side), so it’s intended to be always used in pair with another WindowControls for the opposite side, for example:

<object class="GtkBox">
  <child>
    <object class="GtkWindowControls">
      <property name="side">start</property>
    </object>
  </child>

  ...

  <child>
    <object class="GtkWindowControls">
      <property name="side">end</property>
    </object>
  </child>
</object>

CSS nodes

windowcontrols
├── [image.icon]
├── [button.minimize]
├── [button.maximize]
╰── [button.close]

A WindowControls’ CSS node is called windowcontrols. It contains subnodes corresponding to each title button. Which of the title buttons exist and where they are placed exactly depends on the desktop environment and property::WindowControls::decoration-layout value.

When property::WindowControls::empty is true, it gets the .empty style class.

Accessibility

WindowControls uses the AccessibleRole::Group role.

Implements

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

Implementations

impl WindowControls

pub fn new(side: PackType) -> WindowControls

Creates a new WindowControls.

side

the side

Returns

a new WindowControls.

pub fn builder() -> WindowControlsBuilder

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

This method returns an instance of WindowControlsBuilder which can be used to create WindowControls objects.

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

Gets the decoration layout of this WindowControls.

Returns

the decoration layout or None if it is unset

pub fn is_empty(&self) -> bool

Gets whether the widget has any window buttons.

Returns

true if the widget has window buttons, otherwise false

pub fn side(&self) -> PackType

Gets the side to which this WindowControls instance belongs.

Returns

the side

pub fn set_decoration_layout(&self, layout: Option<&str>)

Sets the decoration layout for the title buttons.

This overrides the property::Settings::gtk-decoration-layout setting.

The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the left from those on the right. Recognized button names are minimize, maximize, close and icon (the window icon).

For example, “icon:minimize,maximize,close” specifies a icon on the left, and minimize, maximize and close buttons on the right.

If property::WindowControls::side value is @GTK_PACK_START, @self will display the part before the colon, otherwise after that.

layout

a decoration layout, or None to unset the layout

pub fn set_side(&self, side: PackType)

Determines which part of decoration layout the WindowControls uses.

See property::WindowControls::decoration-layout.

side

a side

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

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

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

Trait Implementations

impl Clone for WindowControls

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 WindowControls

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

Formats the value using the given formatter.

impl Default for WindowControls

fn default() -> Self

Returns the “default value” for a type.

impl Display for WindowControls

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

Formats the value using the given formatter.

impl Hash for WindowControls

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 WindowControls

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 WindowControls

type Parent = Widget

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

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 WindowControls

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 WindowControls

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WindowControls

impl IsA<Accessible> for WindowControls

impl IsA<Buildable> for WindowControls

impl IsA<ConstraintTarget> for WindowControls

impl IsA<Widget> for WindowControls