Struct gtk4::ActionBar

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

ActionBar is designed to present contextual actions.

It 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.

GtkActionBar as GtkBuildable

The ActionBar implementation of the Buildable 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 ActionBar’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.

Implements

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

Implementations

impl ActionBar

pub fn new() -> ActionBar

Creates a new ActionBar widget.

Returns

a new ActionBar

pub fn builder() -> ActionBarBuilder

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

This method returns an instance of ActionBarBuilder which can be used to create ActionBar objects.

pub fn center_widget(&self) -> Option<Widget>

Retrieves the center bar widget of the bar.

Returns

the center Widget

pub fn is_revealed(&self) -> bool

Gets whether the contents of the action bar are revealed.

Returns

the current value of the property::ActionBar::revealed property

pub fn pack_end(&self, child: &impl IsA<Widget>)

Adds @child to @self, packed with reference to the end of the @self.

child

the Widget to be added to @self

pub fn pack_start(&self, child: &impl IsA<Widget>)

Adds @child to @self, packed with reference to the start of the @self.

child

the Widget to be added to @self

pub fn remove(&self, child: &impl IsA<Widget>)

Removes a child from @self.

child

the Widget to be removed

pub fn set_center_widget(&self, center_widget: Option<&impl IsA<Widget>>)

Sets the center widget for the ActionBar.

center_widget

a widget to use for the center

pub fn set_revealed(&self, revealed: bool)

Reveals or conceals the content of the action bar.

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

revealed

The new value of the property

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

Trait Implementations

impl Clone for ActionBar

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 ActionBar

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

Formats the value using the given formatter.

impl Default for ActionBar

fn default() -> Self

Returns the “default value” for a type.

impl Display for ActionBar

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

Formats the value using the given formatter.

impl Hash for ActionBar

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 ActionBar

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 ActionBar

type Parent = Widget

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

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 ActionBar

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 ActionBar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ActionBar

impl IsA<Accessible> for ActionBar

impl IsA<Buildable> for ActionBar

impl IsA<ConstraintTarget> for ActionBar

impl IsA<Widget> for ActionBar