Struct gtk4::InfoBar

source ·

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

Expand description

There is no replacement in GTK for an “info bar” widget; you can use Revealer with a Box containing a Label and an optional Button, according to your application’s design. InfoBar can be show messages to the user without a dialog.

An example GtkInfoBar

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.

Properties

`message-type`

The type of the message.

The type may be used to determine the appearance of the info bar.

Readable | Writeable | Construct

`revealed`

Whether the info bar shows its contents.

Readable | Writeable

`show-close-button`

Whether to include a standard close button.

Readable | Writeable | Construct

Widget

`can-focus`

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

`can-target`

Whether the widget can receive pointer events.

Readable | Writeable

`css-classes`

A list of css classes applied to this widget.

Readable | Writeable

`css-name`

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

`cursor`

The cursor used by @widget.

Readable | Writeable

`focus-on-click`

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

`focusable`

Whether this widget itself will accept the input focus.

Readable | Writeable

`halign`

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

`has-default`

Whether the widget is the default widget.

Readable

`has-focus`

Whether the widget has the input focus.

Readable

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

`height-request`

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

`hexpand`

Whether to expand horizontally.

Readable | Writeable

`hexpand-set`

Whether to use the hexpand property.

Readable | Writeable

`layout-manager`

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

`margin-bottom`

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`margin-end`

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`margin-start`

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`margin-top`

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

`name`

The name of the widget.

Readable | Writeable

`opacity`

The requested opacity of the widget.

Readable | Writeable

`overflow`

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

`parent`

The parent widget of this widget.

Readable

`receives-default`

Whether the widget will receive the default action when it is focused.

Readable | Writeable

`root`

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

`scale-factor`

The scale factor of the widget.

Readable

`sensitive`

Whether the widget responds to input.

Readable | Writeable

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

`valign`

How to distribute vertical space if widget gets extra space.

Readable | Writeable

`vexpand`

Whether to expand vertically.

Readable | Writeable

`vexpand-set`

Whether to use the vexpand property.

Readable | Writeable

`visible`

Whether the widget is visible.

Readable | Writeable

`width-request`

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

`accessible-role`

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

`close`

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.

Action

`response`

Emitted when an action widget is clicked.

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

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.

Action

Emitted when the widgets 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::InfoBar

Widget

Accessible

Widget

Implementations§

impl InfoBar

pub fn new() -> InfoBar

pub fn builder() -> InfoBarBuilder

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

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

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

pub fn message_type(&self) -> MessageType

pub fn is_revealed(&self) -> bool

pub fn shows_close_button(&self) -> bool

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

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

pub fn response(&self, response_id: ResponseType)

pub fn set_default_response(&self, response_id: ResponseType)

pub fn set_message_type(&self, message_type: MessageType)

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

pub fn set_revealed(&self, revealed: bool)

pub fn set_show_close_button(&self, setting: bool)

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

pub fn emit_close(&self)

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

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

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

Trait Implementations§

impl Clone for InfoBar

fn clone(&self) -> Self

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

impl Debug for InfoBar

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

impl Default for InfoBar

fn default() -> Self

impl Display for InfoBar

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

impl HasParamSpec for InfoBar

type ParamSpec = ParamSpecObject

type SetValue = InfoBar

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