Trait libhandy::prelude::HdyHeaderBarExt

pub trait HdyHeaderBarExt: IsA<HeaderBar> + Sealed + 'static {
    // Provided methods
    fn centering_policy(&self) -> CenteringPolicy { ... }
    fn custom_title(&self) -> Option<Widget> { ... }
    fn decoration_layout(&self) -> Option<GString> { ... }
    fn has_subtitle(&self) -> bool { ... }
    fn is_interpolate_size(&self) -> bool { ... }
    fn shows_close_button(&self) -> bool { ... }
    fn subtitle(&self) -> Option<GString> { ... }
    fn title(&self) -> Option<GString> { ... }
    fn transition_duration(&self) -> u32 { ... }
    fn is_transition_running(&self) -> bool { ... }
    fn pack_end(&self, child: &impl IsA<Widget>) { ... }
    fn pack_start(&self, child: &impl IsA<Widget>) { ... }
    fn set_centering_policy(&self, centering_policy: CenteringPolicy) { ... }
    fn set_custom_title(&self, title_widget: Option<&impl IsA<Widget>>) { ... }
    fn set_decoration_layout(&self, layout: Option<&str>) { ... }
    fn set_has_subtitle(&self, setting: bool) { ... }
    fn set_interpolate_size(&self, interpolate_size: bool) { ... }
    fn set_show_close_button(&self, setting: bool) { ... }
    fn set_subtitle(&self, subtitle: Option<&str>) { ... }
    fn set_title(&self, title: Option<&str>) { ... }
    fn set_transition_duration(&self, duration: u32) { ... }
    fn is_decoration_layout_set(&self) -> bool { ... }
    fn set_decoration_layout_set(&self, decoration_layout_set: bool) { ... }
    fn spacing(&self) -> i32 { ... }
    fn set_spacing(&self, spacing: i32) { ... }
    fn connect_centering_policy_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_custom_title_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_decoration_layout_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_decoration_layout_set_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_has_subtitle_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_interpolate_size_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_show_close_button_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_spacing_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_subtitle_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_title_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_transition_duration_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
    fn connect_transition_running_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId { ... }
}

Trait containing all HeaderBar methods.

Implementors

HeaderBar

Provided Methods

fn centering_policy(&self) -> CenteringPolicy

Gets the policy @self follows to horizontally align its center widget.

Returns

the centering policy

fn custom_title(&self) -> Option<Widget>

Retrieves the custom title widget of the header.

Returns

the custom title widget of the header

fn decoration_layout(&self) -> Option<GString>

Gets the decoration layout.

Returns

the decoration layout

fn has_subtitle(&self) -> bool

Gets whether space is reserved for a subtitle, regardless if one is currently set or not.

Returns

TRUE if the header bar reserves space for a subtitle

fn is_interpolate_size(&self) -> bool

Gets whether @self should interpolate its size on visible child change.

Returns

whether @self interpolates its size on visible child change

fn shows_close_button(&self) -> bool

Gets whether this header bar shows the standard window decorations.

Returns

whether decorations are shown

fn subtitle(&self) -> Option<GString>

Gets the subtitle of the header.

Returns

the subtitle of the header

fn title(&self) -> Option<GString>

Retrieves the title of the header.

Returns

the title of the header.

fn transition_duration(&self) -> u32

Gets the amount of time that transitions between pages will take.

Returns

the transition duration, in milliseconds

fn is_transition_running(&self) -> bool

Gets whether the @self is currently in a transition from one page to another.

Returns

whether the transition is currently running

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

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

fn set_centering_policy(&self, centering_policy: CenteringPolicy)

Sets the policy @self must follow to horizontally align its center widget.

centering_policy

the centering policy

fn set_custom_title(&self, title_widget: Option<&impl IsA<Widget>>)

Sets a custom title for the header bar.

The title should help a user identify the current view. This supersedes any title set by set_title() or set_subtitle(). To achieve the same style as the builtin title and subtitle, use the .title and .subtitle style classes.

You should set the custom title to NULL, for the header title label to be visible again.

title_widget

a custom widget to use for a title

fn set_decoration_layout(&self, layout: Option<&str>)

Sets the decoration layout for this header bar.

layout

a decoration layout

fn set_has_subtitle(&self, setting: bool)

Sets whether space is reserved for a subtitle, even if none is currently set.

setting

TRUE to reserve space for a subtitle

fn set_interpolate_size(&self, interpolate_size: bool)

Sets whether @self should interpolate its size on visible child change.

interpolate_size

TRUE to interpolate the size

fn set_show_close_button(&self, setting: bool)

Sets whether this header bar shows the standard window decorations.

setting

TRUE to show standard window decorations

fn set_subtitle(&self, subtitle: Option<&str>)

Sets the subtitle of the header bar.

The title should give a user an additional detail to help them identify the current view.

Note that HeaderBar by default reserves room for the subtitle, even if none is currently set. If this is not desired, set the has-subtitle property to FALSE.

subtitle

a subtitle

fn set_title(&self, title: Option<&str>)

Sets the title of the HeaderBar.

The title should help a user identify the current view. A good title should not include the application name.

title

a title

fn set_transition_duration(&self, duration: u32)

Sets the duration that transitions between pages will take.

duration

the new duration, in milliseconds

fn is_decoration_layout_set(&self) -> bool

Whether decoration-layout is set.

fn set_decoration_layout_set(&self, decoration_layout_set: bool)

Whether decoration-layout is set.

fn spacing(&self) -> i32

The amount of space between children.

fn set_spacing(&self, spacing: i32)

The amount of space between children.

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

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

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

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

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

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

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

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

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

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

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

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

Object Safety

This trait is not object safe.

Implementors

impl<O: IsA<HeaderBar>> HdyHeaderBarExt for O