Gtk.ActionBar

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 ()
	get_center_widget ()
	get_revealed ()
	pack_end (child)
	pack_start (child)
	remove (child)
	set_center_widget (center_widget)
	set_revealed (revealed)

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	Short Description
revealed	bool	r/w/en

Signals

Inherited:

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

Fields

Inherited:

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

Class Details

class Gtk.ActionBar(**kwargs)

Bases:

Gtk.Widget

Abstract:

No

Presents contextual actions.

<picture> <source srcset=”action-bar-dark.png” media=”(prefers-color-scheme: dark)”> <img alt=”An example Gtk.ActionBar" src=”action-bar.png”> </picture>

GtkActionBar is expected to be displayed below the content and expand horizontally to fill the area.

It allows placing children at the start or the end. In addition, it contains an internal centered box which is centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

Gtk.ActionBar as Gtk.Buildable

The GtkActionBar implementation of the GtkBuildable interface supports adding children at the start or end sides by specifying “start” or “end” as the “type” attribute of a <child> element, or setting the center widget by specifying “center” value.

CSS nodes

`` actionbar ╰── revealer

╰── box

├── box.start │ ╰── [start children] ├── [center widget] ╰── box.end

╰── [end children]

``

A GtkActionBar’s CSS node is called actionbar. It contains a revealer subnode, which contains a box subnode, which contains two box subnodes at the start and end of the action bar, with start and end style classes respectively, as well as a center node that represents the center child.

Each of the boxes contains children packed for that side.

classmethod new()

Returns:

a new GtkActionBar

Return type:

Gtk.Widget

Creates a new action bar widget.

get_center_widget()

Returns:

the center widget

Return type:

Gtk.Widget or None

Retrieves the center bar widget of the bar.

get_revealed()

Returns:

the current value of the [property`Gtk`.ActionBar:revealed] property

Return type:

bool

Gets whether the contents of the action bar are revealed.

pack_end(child)

Parameters:

child (Gtk.Widget) – the widget to be added

Adds a child to the action bar, packed with reference to the end of the action bar.

pack_start(child)

Parameters:

child (Gtk.Widget) – the widget to be added

Adds a child to the action, packed with reference to the start of the action bar.

remove(child)

Parameters:

child (Gtk.Widget) – the widget to be removed

Removes a child from the action bar.

set_center_widget(center_widget)

Parameters:

center_widget (Gtk.Widget or None) – a widget to use for the center

Sets the center widget for the action bar.

set_revealed(revealed)

Parameters:

revealed (bool) – the new value for the property

Reveals or conceals the content of the action bar.

Note: this does not show or hide the action bar in the [property`Gtk`.Widget:visible] sense, so revealing has no effect if the action bar is hidden.

Property Details

Gtk.ActionBar.props.revealed

Name:

revealed

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Controls whether the action bar shows its contents.