Panel.ToggleButton

Subclasses:

None

Methods

Inherited:

Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1)

Structs:

Gtk.WidgetClass (18), GObject.ObjectClass (5)

class

new (dock, area)

Virtual Methods

Inherited:

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

Properties

Inherited:

Gtk.Widget (34), Gtk.Accessible (1)

Name	Type	Flags	Short Description
area	Panel.Area	r/w/co
dock	Panel.Dock	r/w

Signals

Inherited:

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

Fields

Inherited:

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

Class Details

class Panel.ToggleButton(**kwargs)

Bases:

Gtk.Widget

Abstract:

No

Structure:

Panel.ToggleButtonClass

The PanelToggleButton is a button used to toggle the visibility of a [class`Panel`.Dock] area.

<picture> <source srcset=”toggle-button-dark.png” media=”(prefers-color-scheme: dark)”> <img src=”toggle-button.png” alt=”toggle-button”> </picture>

It will automatically reveal or hide the specified area from [property`Panel`.ToggleButton:dock].

classmethod new(dock, area)

Parameters:

• dock (Panel.Dock) – [class`Panel`.Dock] the panel to control

• area (Panel.Area) – [enum`Panel`.Area] the panel area. A value of [enum`Panel`.Area.CENTER] is invalid.

Returns:

a newly created [class`Panel`.ToggleButton]

Return type:

Gtk.Widget

Creates a new [class`Panel`.ToggleButton] to hide the dock in the area.

Property Details

Panel.ToggleButton.props.area

Name:

area

Type:

Panel.Area

Default Value:

Panel.Area.START

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The area this button will reveal.

Panel.ToggleButton.props.dock

Name:

dock

Type:

Panel.Dock

Default Value:

None

Flags:

READABLE, WRITABLE

The associated [class`Panel`.Dock]