Gtk.WindowControls¶

Example¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` (side)
	`get_decoration_layout` ()
	`get_empty` ()
	`get_side` ()
	`get_use_native_controls` ()
	`set_decoration_layout` (layout)
	`set_side` (side)
	`set_use_native_controls` (setting)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Gtk.Widget (35), Gtk.Accessible (1)

Name	Type	Flags
`decoration-layout`	`str`	r/w/en
`empty`	`bool`	r/en
`side`	`Gtk.PackType`	r/w/en
`use-native-controls`	`bool`	r/w/en

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Class Details¶

class Gtk.WindowControls(**kwargs)¶

Bases:: Gtk.Widget
Abstract:: No
Structure:: Gtk.WindowControlsClass

Shows window frame controls.

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

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

```xml <object class=”Gtk.Box"> <child> <object class=”Gtk.WindowControls"> <property name=”side”>start</property> </object> </child>

…

<child> <object class=”Gtk.WindowControls"> <property name=”side”>end</property> </object> </child> </object> ```

CSS nodes

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

A GtkWindowControls’ 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`Gtk`.WindowControls:decoration-layout] value.

When [property`Gtk`.WindowControls:empty] is true, it gets the .empty style class.

Accessibility

GtkWindowControls uses the [enum`Gtk`.AccessibleRole.group] role.

classmethod new(side)[source]¶

Parameters:: side (Gtk.PackType) – the side
Returns:: a new GtkWindowControls
Return type:: Gtk.Widget

Creates a new GtkWindowControls.

get_decoration_layout()[source]¶

Returns:: the decoration layout
Return type:: str or None

Gets the decoration layout of this window controls widget

get_empty()[source]¶

Returns:: true if the widget has window buttons
Return type:: bool

Gets whether the widget has any window buttons.

get_side()[source]¶

Returns:: the side
Return type:: Gtk.PackType

Gets the side to which this window controls widget belongs.

get_use_native_controls()[source]¶

Returns:: true if native window controls are shown
Return type:: bool

Returns whether platform native window controls are shown.

New in version 4.18.

set_decoration_layout(layout)[source]¶

Parameters:: layout (str or None) – a decoration layout, or NULL to unset the layout

Sets the decoration layout for the title buttons.

This overrides the [property`Gtk`.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`Gtk`.WindowControls:side] value is [enum`Gtk`.PackType.start], self will display the part before the colon, otherwise after that.

set_side(side)[source]¶

Parameters:: side (Gtk.PackType) – a side

Determines which part of decoration layout the window controls widget uses.

See [property`Gtk`.WindowControls:decoration-layout].

set_use_native_controls(setting)[source]¶

Parameters:: setting (bool) – true to show native window controls

Sets whether platform native window controls are used.

This option shows the “stoplight” buttons on macOS. For Linux, this option has no effect.

Property Details¶

Gtk.WindowControls.props.decoration_layout¶

Name:: decoration-layout
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The decoration layout for window buttons.

If this property is not set, the [property`Gtk`.Settings:gtk-decoration-layout] setting is used.

Gtk.WindowControls.props.empty¶

Name:: empty
Type:: bool
Default Value:: True
Flags:: READABLE, EXPLICIT_NOTIFY

Whether the widget has any window buttons.

Gtk.WindowControls.props.side¶

Name:: side
Type:: Gtk.PackType
Default Value:: Gtk.PackType.START
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the widget shows start or end side of the decoration layout.

See [property`Gtk`.WindowControls:decoration_layout].

Gtk.WindowControls.props.use_native_controls¶

Name:: use-native-controls
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether to show platform native close/minimize/maximize buttons.

For macOS, the [property`Gtk`.HeaderBar:decoration-layout] property controls the use of native window controls.

On other platforms, this option has no effect.