Struct gtk4::InfoBar

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

InfoBar can be show messages to the user without a dialog.

It is often temporarily shown at the top or bottom of a document. In contrast to Dialog, which has an action area at the bottom, InfoBar has an action area at the side.

The API of InfoBar is very similar to Dialog, allowing you to add buttons to the action area with add_button() or with_buttons(). The sensitivity of action widgets can be controlled with set_response_sensitive().

To add widgets to the main content area of a InfoBar, use add_child().

Similar to MessageDialog, the contents of a InfoBar can by classified as error message, warning, informational message, etc, by using set_message_type(). GTK may use the message type to determine how the message is displayed.

A simple example for using a InfoBar: ⚠️ The following code is in c ⚠️

GtkWidget *message_label;
GtkWidget *widget;
GtkWidget *grid;
GtkInfoBar *bar;

// set up info bar
widget = gtk_info_bar_new ();
bar = GTK_INFO_BAR (widget);
grid = gtk_grid_new ();

message_label = gtk_label_new ("");
gtk_info_bar_add_child (bar, message_label);
gtk_info_bar_add_button (bar,
                         _("_OK"),
                         GTK_RESPONSE_OK);
g_signal_connect (bar,
                  "response",
                  G_CALLBACK (gtk_widget_hide),
                  NULL);
gtk_grid_attach (GTK_GRID (grid),
                 widget,
                 0, 2, 1, 1);

// ...

// show an error message
gtk_label_set_text (GTK_LABEL (message_label), "An error occurred!");
gtk_info_bar_set_message_type (bar, GTK_MESSAGE_ERROR);
gtk_widget_show (bar);

GtkInfoBar as GtkBuildable

InfoBar supports a custom <action-widgets> element, which can contain multiple <action-widget> elements. The “response” attribute specifies a numeric response, and the content of the element is the id of widget (which should be a child of the dialogs @action_area).

InfoBar supports adding action widgets by specifying “action” as the “type” attribute of a <child> element. The widget will be added either to the action area. The response id has to be associated with the action widget using the <action-widgets> element.

CSS nodes

InfoBar has a single CSS node with name infobar. The node may get one of the style classes .info, .warning, .error or .question, depending on the message type. If the info bar shows a close button, that button will have the .close style class applied.

Implements

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

Implementations

impl InfoBar

pub fn new() -> InfoBar

Creates a new InfoBar object.

Returns

a new InfoBar object

pub fn builder() -> InfoBarBuilder

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

This method returns an instance of InfoBarBuilder which can be used to create InfoBar objects.

pub fn add_action_widget( &self, child: &impl IsA<Widget>, response_id: ResponseType )

Add an activatable widget to the action area of a InfoBar.

This also connects a signal handler that will emit the signal::InfoBar::response signal on the message area when the widget is activated. The widget is appended to the end of the message areas action area.

child

an activatable widget

response_id

response ID for @child

pub fn add_button(&self, button_text: &str, response_id: ResponseType) -> Button

Adds a button with the given text.

Clicking the button will emit the signal::InfoBar::response signal with the given response_id. The button is appended to the end of the info bars’s action area. The button widget is returned, but usually you don’t need it.

button_text

text of button

response_id

response ID for the button

Returns

the Button widget that was added

pub fn add_child(&self, widget: &impl IsA<Widget>)

Adds a widget to the content area of the info bar.

widget

the child to be added

pub fn message_type(&self) -> MessageType

Returns the message type of the message area.

Returns

the message type of the message area.

pub fn is_revealed(&self) -> bool

Returns whether the info bar is currently revealed.

Returns

the current value of the property::InfoBar::revealed property

pub fn shows_close_button(&self) -> bool

Returns whether the widget will display a standard close button.

Returns

true if the widget displays standard close button

pub fn remove_action_widget(&self, widget: &impl IsA<Widget>)

Removes a widget from the action area of @self.

The widget must have been put there by a call to add_action_widget() or add_button().

widget

an action widget to remove

pub fn remove_child(&self, widget: &impl IsA<Widget>)

Removes a widget from the content area of the info bar.

widget

a child that has been added to the content area

pub fn response(&self, response_id: ResponseType)

Emits the “response” signal with the given @response_id.

response_id

a response ID

pub fn set_default_response(&self, response_id: ResponseType)

Sets the last widget in the info bar’s action area with the given response_id as the default widget for the dialog.

Pressing “Enter” normally activates the default widget.

Note that this function currently requires @self to be added to a widget hierarchy.

response_id

a response ID

pub fn set_message_type(&self, message_type: MessageType)

Sets the message type of the message area.

GTK uses this type to determine how the message is displayed.

message_type

a MessageType

pub fn set_response_sensitive(&self, response_id: ResponseType, setting: bool)

Sets the sensitivity of action widgets for @response_id.

Calls gtk_widget_set_sensitive (widget, setting) for each widget in the info bars’s action area with the given @response_id. A convenient way to sensitize/desensitize buttons.

response_id

a response ID

setting

TRUE for sensitive

pub fn set_revealed(&self, revealed: bool)

Sets whether the InfoBar is revealed.

Changing this will make @self reveal or conceal itself via a sliding transition.

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

revealed

The new value of the property

pub fn set_show_close_button(&self, setting: bool)

If true, a standard close button is shown.

When clicked it emits the response ResponseType::Close.

setting

true to include a close button

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

Gets emitted when the user uses a keybinding to dismiss the info bar.

The ::close signal is a keybinding signal.

The default binding for this signal is the Escape key.

pub fn emit_close(&self)

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

Emitted when an action widget is clicked.

The signal is also emitted when the application programmer calls response(). The @response_id depends on which action widget was clicked.

response_id

the response ID

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

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

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

impl InfoBar

pub fn with_buttons(buttons: &[(&str, ResponseType)]) -> Self

Creates a new InfoBar with buttons.

Button text/response ID pairs should be listed, with a None pointer ending the list. A response ID can be any positive number, or one of the values in the ResponseType enumeration. If the user clicks one of these dialog buttons, GtkInfoBar will emit the signal::InfoBar::response signal with the corresponding response ID.

first_button_text

ext to go in first button

Returns

a new InfoBar

pub fn add_buttons(&self, buttons: &[(&str, ResponseType)])

Adds multiple buttons.

This is the same as calling add_button() repeatedly. The variable argument list should be None-terminated as with with_buttons(). Each button must have both text and response ID.

first_button_text

button text

Trait Implementations

impl Clone for InfoBar

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 InfoBar

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

Formats the value using the given formatter.

impl Default for InfoBar

fn default() -> Self

Returns the “default value” for a type.

impl Display for InfoBar

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

Formats the value using the given formatter.

impl Hash for InfoBar

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 InfoBar

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 InfoBar

type Parent = Widget

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

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 InfoBar

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 InfoBar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for InfoBar

impl IsA<Accessible> for InfoBar

impl IsA<Buildable> for InfoBar

impl IsA<ConstraintTarget> for InfoBar

impl IsA<Widget> for InfoBar