InfoBar

#GtkInfoBar is a widget that can be used to show messages to the user without showing a dialog. It is often temporarily shown at the top or bottom of a document. In contrast to #GtkDialog, which has a action area at the bottom, #GtkInfoBar has an action area at the side.

The API of #GtkInfoBar is very similar to #GtkDialog, allowing you to add buttons to the action area with gtk_info_bar_add_button() or gtk_info_bar_new_with_buttons(). The sensitivity of action widgets can be controlled with gtk_info_bar_set_response_sensitive(). To add widgets to the main content area of a #GtkInfoBar, use gtk_info_bar_get_content_area() and add your widgets to the container.

Similar to #GtkMessageDialog, the contents of a #GtkInfoBar can by classified as error message, warning, informational message, etc, by using gtk_info_bar_set_message_type(). GTK+ may use the message type to determine how the message is displayed.

A simple example for using a #GtkInfoBar: |[ GtkWidget *widget, *message_label, *content_area; GtkWidget *grid; GtkInfoBar *bar;

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

gtk_widget_set_no_show_all (widget, TRUE); message_label = gtk_label_new (""); content_area = gtk_info_bar_get_content_area (bar); gtk_container_add (GTK_CONTAINER (content_area), 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

The GtkInfoBar implementation of the GtkBuildable interface exposes the content area and action area as internal children with the names “content_area” and “action_area”.

GtkInfoBar 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).

CSS nodes

GtkInfoBar 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.

class InfoBar : Box {

protected

GtkInfoBar* gtkInfoBar;

GtkInfoBar* getInfoBarStruct(bool transferOwnership);

void* getStruct();

this(GtkInfoBar* gtkInfoBar, bool ownedRef);

this(string[] buttonsText, ResponseType[] responses);

this(StockID[] stockIDs, ResponseType[] responses);

Button addButton(StockID stockID, int responseId);

void addButtons(string[] buttonsText, ResponseType[] responses);

void addButtons(StockID[] stockIDs, ResponseType[] responses);

VButtonBox getActionArea();

HBox getContentArea();

static GType getType();

this();

void addActionWidget(Widget child, int responseId);

Button addButton(string buttonText, int responseId);

GtkMessageType getMessageType();

bool getRevealed();

bool getShowCloseButton();

void response(int responseId);

void setDefaultResponse(int responseId);

void setMessageType(GtkMessageType messageType);

void setResponseSensitive(int responseId, bool setting);

void setRevealed(bool revealed);

void setShowCloseButton(bool setting);

gulong addOnClose(void delegate(InfoBar) dlg, ConnectFlags connectFlags);

gulong addOnResponse(void delegate(int, InfoBar) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkInfoBar* gtkInfoBar, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string[] buttonsText, ResponseType[] responses)
this this(StockID[] stockIDs, ResponseType[] responses)
this this(): Creates a new #GtkInfoBar object.

Members

Functions

addActionWidget void addActionWidget(Widget child, int responseId): Add an activatable widget to the action area of a #GtkInfoBar, connecting a signal handler that will emit the #GtkInfoBar::response signal on the message area when the widget is activated. The widget is appended to the end of the message areas action area.
addButton Button addButton(StockID stockID, int responseId)
addButton Button addButton(string buttonText, int responseId): Adds a button with the given text and sets things up so that clicking the button will emit the “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.
addButtons void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons void addButtons(StockID[] stockIDs, ResponseType[] responses)
addOnClose gulong addOnClose(void delegate(InfoBar) dlg, ConnectFlags connectFlags): The ::close signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user uses a keybinding to dismiss the info bar.
addOnResponse gulong addOnResponse(void delegate(int, InfoBar) dlg, ConnectFlags connectFlags): Emitted when an action widget is clicked or the application programmer calls gtk_dialog_response(). The @response_id depends on which action widget was clicked.
getActionArea VButtonBox getActionArea(): Returns the action area of info_bar. Since 2.18
getContentArea HBox getContentArea(): Returns the content area of info_bar. Since 2.18
getInfoBarStruct GtkInfoBar* getInfoBarStruct(bool transferOwnership): Get the main Gtk struct
getMessageType GtkMessageType getMessageType(): Returns the message type of the message area.
getRevealed bool getRevealed()
getShowCloseButton bool getShowCloseButton(): Returns whether the widget will display a standard close button.
getStruct void* getStruct(): the main Gtk struct as a void*
response void response(int responseId): Emits the “response” signal with the given @response_id.
setDefaultResponse void setDefaultResponse(int responseId): 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.
setMessageType void setMessageType(GtkMessageType messageType): Sets the message type of the message area.
setResponseSensitive void setResponseSensitive(int responseId, bool setting): 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 dialog buttons.
setRevealed void setRevealed(bool revealed): Sets the GtkInfoBar:revealed property to @revealed. This will cause @info_bar to show up with a slide-in transition.
setShowCloseButton void setShowCloseButton(bool setting): If true, a standard close button is shown. When clicked it emits the response %GTK_RESPONSE_CLOSE.

Static functions

getType GType getType()

Variables

gtkInfoBar GtkInfoBar* gtkInfoBar;: the main Gtk struct

Inherited Members

From Box

gtkBox GtkBox* gtkBox;: the main Gtk struct
getBoxStruct GtkBox* getBoxStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin OrientableT!(GtkBox): Undocumented in source.
getType GType getType()
getBaselinePosition GtkBaselinePosition getBaselinePosition(): Gets the value set by gtk_box_set_baseline_position().
getCenterWidget Widget getCenterWidget(): Retrieves the center widget of the box.
getHomogeneous bool getHomogeneous(): Returns whether the box is homogeneous (all children are the same size). See gtk_box_set_homogeneous().
getSpacing int getSpacing(): Gets the value set by gtk_box_set_spacing().
packEnd void packEnd(Widget child, bool expand, bool fill, uint padding): Adds @child to @box, packed with reference to the end of @box. The @child is packed after (away from end of) any other child packed with reference to the end of @box.
packStart void packStart(Widget child, bool expand, bool fill, uint padding): Adds @child to @box, packed with reference to the start of @box. The @child is packed after any other child packed with reference to the start of @box.
queryChildPacking void queryChildPacking(Widget child, bool expand, bool fill, uint padding, GtkPackType packType): Obtains information about how @child is packed into @box.
reorderChild void reorderChild(Widget child, int position): Moves @child to a new @position in the list of @box children. The list contains widgets packed #GTK_PACK_START as well as widgets packed #GTK_PACK_END, in the order that these widgets were added to @box.
setBaselinePosition void setBaselinePosition(GtkBaselinePosition position): Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then @position is used to allocate the baseline wrt the extra space available.
setCenterWidget void setCenterWidget(Widget widget): Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.
setChildPacking void setChildPacking(Widget child, bool expand, bool fill, uint padding, GtkPackType packType): Sets the way @child is packed into @box.
setHomogeneous void setHomogeneous(bool homogeneous): Sets the #GtkBox:homogeneous property of @box, controlling whether or not all children of @box are given equal space in the box.
setSpacing void setSpacing(int spacing): Sets the #GtkBox:spacing property of @box, which is the number of pixels to place between children of @box.