Struct gtk4::Statusbar

source ·

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

👎Deprecated: Since 4.10

Expand description

This widget will be removed in GTK 5 A Statusbar widget is usually placed along the bottom of an application’s main Window.

An example GtkStatusbar

A GtkStatusBar may provide a regular commentary of the application’s status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example).

Status bars in GTK maintain a stack of messages. The message at the top of the each bar’s stack is the one that will currently be displayed.

Any messages added to a statusbar’s stack must specify a context id that is used to uniquely identify the source of a message. This context id can be generated by context_id(), given a message and the statusbar that it will be added to. Note that messages are stored in a stack, and when choosing which message to display, the stack structure is adhered to, regardless of the context identifier of a message.

One could say that a statusbar maintains one stack of messages for display purposes, but allows multiple message producers to maintain sub-stacks of the messages they produced (via context ids).

Status bars are created using new().

Messages are added to the bar’s stack with push().

The message at the top of the stack can be removed using pop(). A message can be removed from anywhere in the stack if its message id was recorded at the time it was added. This is done using remove().

CSS node

Statusbar has a single CSS node with name statusbar.

Signals

`text-popped`

Emitted whenever a new message is popped off a statusbar’s stack.

`text-pushed`

Emitted whenever a new message gets pushed onto a statusbar’s stack.

Widget

`destroy`

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

`direction-changed`

Emitted when the text direction of a widget changes.

`hide`

Emitted when @widget is hidden.

`keynav-failed`

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

`map`

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

`mnemonic-activate`

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

`move-focus`

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

`realize`

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

`show`

Emitted when @widget is shown.

`state-flags-changed`

Emitted when the widget state changes.

See WidgetExt::state_flags().

`unmap`

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

`unrealize`

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

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

Struct gtk4::Statusbar

Widget

Implementations§

impl Statusbar

pub fn new() -> Statusbar

pub fn builder() -> StatusbarBuilder

pub fn context_id(&self, context_description: &str) -> u32

pub fn pop(&self, context_id: u32)

pub fn push(&self, context_id: u32, text: &str) -> u32

pub fn remove(&self, context_id: u32, message_id: u32)

pub fn remove_all(&self, context_id: u32)

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

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

Trait Implementations§

impl Clone for Statusbar

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl Debug for Statusbar

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

impl Default for Statusbar

fn default() -> Self

impl Display for Statusbar

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

impl HasParamSpec for Statusbar

type ParamSpec = ParamSpecObject

type SetValue = Statusbar

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Statusbar

fn hash<H>(&self, state: &mut H)where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl Ord for Statusbar

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

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl ParentClassIs for Statusbar

type Parent = Widget

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

fn eq(&self, other: &OT) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<OT: ObjectType> PartialOrd<OT> for Statusbar

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

fn gt(&self, other: &Rhs) -> bool

fn ge(&self, other: &Rhs) -> bool

impl StaticType for Statusbar

fn static_type() -> Type

impl Eq for Statusbar

impl IsA<Accessible> for Statusbar

impl IsA<Buildable> for Statusbar

impl IsA<ConstraintTarget> for Statusbar

impl IsA<Widget> for Statusbar

Auto Trait Implementations§

impl RefUnwindSafe for Statusbar

impl !Send for Statusbar

impl !Sync for Statusbar

impl Unpin for Statusbar

impl UnwindSafe for Statusbar

Blanket Implementations§

impl<O> AccessibleExt for Owhere O: IsA<Accessible>,

fn accessible_parent(&self) -> Option<Accessible>

fn accessible_role(&self) -> AccessibleRole

fn at_context(&self) -> ATContext

fn bounds(&self) -> Option<(i32, i32, i32, i32)>

fn first_accessible_child(&self) -> Option<Accessible>

fn next_accessible_sibling(&self) -> Option<Accessible>

fn platform_state(&self, state: AccessiblePlatformState) -> bool

fn reset_property(&self, property: AccessibleProperty)

fn reset_relation(&self, relation: AccessibleRelation)

fn reset_state(&self, state: AccessibleState)

fn set_accessible_parent( &self, parent: Option<&impl IsA<Accessible>>, next_sibling: Option<&impl IsA<Accessible>> )

fn update_next_accessible_sibling( &self, new_sibling: Option<&impl IsA<Accessible>> )

fn set_accessible_role(&self, accessible_role: AccessibleRole)

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

impl<O> AccessibleExtManual for Owhere O: IsA<Accessible>,

fn update_property(&self, properties: &[Property<'_>])

fn update_relation(&self, relations: &[Relation<'_>])

fn update_state(&self, states: &[State])