Struct libhandy::HeaderGroup

pub struct HeaderGroup { /* private fields */ }

An object handling composite title bars.

The HeaderGroup object handles the header bars of a composite title bar. It splits the window decoration across the header bars, giving the left side of the decorations to the leftmost header bar, and the right side of the decorations to the rightmost header bar. See HdyHeaderBarExt::set_decoration_layout().

The decorate-all property can be used in conjunction with folded when the title bar is split across the pages of a Leaflet to automatically display the decorations on all the pages when the leaflet is folded.

You can nest header groups, which is convenient when you nest leaflets too:

<object class="HdyHeaderGroup" id="inner_header_group">
  <property name="decorate-all" bind-source="inner_leaflet" bind-property="folded" bind-flags="sync-create"/>
  <headerbars>
    <headerbar name="inner_header_bar_1"/>
    <headerbar name="inner_header_bar_2"/>
  </headerbars>
</object>
<object class="HdyHeaderGroup" id="outer_header_group">
  <property name="decorate-all" bind-source="outer_leaflet" bind-property="folded" bind-flags="sync-create"/>
  <headerbars>
    <headerbar name="inner_header_group"/>
    <headerbar name="outer_header_bar"/>
  </headerbars>
</object>

Properties

decorate-all

Whether the elements of the group should all receive the full decoration.

This is useful in conjunction with folded when the leaflet contains the header bars of the group, as you want them all to display the complete decoration when the leaflet is folded.

Readable | Writeable

Signals

update-decoration-layouts

This signal is emitted before updating the decoration layouts.

Implements

glib::ObjectExt, gtk::prelude::BuildableExt

Implementations

impl HeaderGroup

pub fn new() -> HeaderGroup

Creates a new HeaderGroup.

Returns

the newly created HeaderGroup

pub fn builder() -> HeaderGroupBuilder

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

This method returns an instance of HeaderGroupBuilder which can be used to create HeaderGroup objects.

pub fn add_gtk_header_bar(&self, header_bar: &impl IsA<HeaderBar>)

Adds @header_bar to @self.

When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

header_bar

the header bar to add

pub fn add_header_bar(&self, header_bar: &impl IsA<HeaderBar>)

Adds @header_bar to @self.

When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

header_bar

the header bar to add

pub fn add_header_group(&self, header_group: &HeaderGroup)

Adds @header_group to @self.

When the nested group is no longer referenced elsewhere, it will be removed from the header group.

header_group

the header group to add

pub fn children(&self) -> Vec<HeaderGroupChild>

Returns the list of children associated with @self.

Returns

the list of children

pub fn is_decorate_all(&self) -> bool

Gets whether the elements of the group should all receive the full decoration.

Returns

whether the elements of the group should all receive the full decoration

pub fn remove_child(&self, child: &HeaderGroupChild)

Removes @child from @self.

child

the header group child to remove

pub fn remove_gtk_header_bar(&self, header_bar: &impl IsA<HeaderBar>)

Removes @header_bar from @self.

header_bar

the header bar to remove

pub fn remove_header_bar(&self, header_bar: &impl IsA<HeaderBar>)

Removes @header_bar from @self.

header_bar

the header bar to remove

pub fn remove_header_group(&self, header_group: &HeaderGroup)

Removes a nested HeaderGroup from @self.

header_group

the header group to remove

pub fn set_decorate_all(&self, decorate_all: bool)

Sets whether the elements of the group should all receive the full decoration.

decorate_all

whether the elements of the group should all receive the full decoration

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

This signal is emitted before updating the decoration layouts.

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

Trait Implementations

impl Clone for HeaderGroup

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 HeaderGroup

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

Formats the value using the given formatter.

impl Default for HeaderGroup

fn default() -> Self

Returns the “default value” for a type.

impl Display for HeaderGroup

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

Formats the value using the given formatter.

impl HasParamSpec for HeaderGroup

type ParamSpec = ParamSpecObject

type SetValue = HeaderGroup

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, HeaderGroup>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for HeaderGroup

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 HeaderGroup

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for HeaderGroup

type Parent = Object

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

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 HeaderGroup

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 HeaderGroup

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for HeaderGroup

impl IsA<Buildable> for HeaderGroup