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.InfoBar.addButton or gtk.info_bar.InfoBar.newWithButtons. The sensitivity of action widgets can be controlled with gtk.info_bar.InfoBar.setResponseSensitive. To add widgets to the main content area of a #GtkInfoBar, use gtk.info_bar.InfoBar.getContentArea 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.InfoBar.setMessageType. 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 {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

InfoBar self();

static InfoBarGidBuilder builder();

gtk.types.MessageType messageType [@property getter];

gtk.types.MessageType messageType [@property setter];

bool revealed [@property getter];

bool revealed [@property setter];

bool showCloseButton [@property getter];

bool showCloseButton [@property setter];

this();

void addActionWidget(gtk.widget.Widget child, int responseId);

gtk.button.Button addButton(string buttonText, int responseId);

gtk.box.Box getActionArea();

gtk.box.Box getContentArea();

gtk.types.MessageType getMessageType();

bool getRevealed();

bool getShowCloseButton();

void response(int responseId);

void setDefaultResponse(int responseId);

void setMessageType(gtk.types.MessageType messageType);

void setResponseSensitive(int responseId, bool setting);

void setRevealed(bool revealed);

void setShowCloseButton(bool setting);

gulong connectClose(T callback, Flag!"After" after);

gulong connectResponse(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkInfoBar object.

Members

Functions

addActionWidget void addActionWidget(gtk.widget.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 gtk.button.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.
connectClose gulong connectClose(T callback, Flag!"After" after): Connect to Close signal.
connectResponse gulong connectResponse(T callback, Flag!"After" after): Connect to Response signal.
getActionArea gtk.box.Box getActionArea(): Returns the action area of info_bar.
getContentArea gtk.box.Box getContentArea(): Returns the content area of info_bar.
getMessageType gtk.types.MessageType 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.
response void response(int responseId): Emits the “response” signal with the given response_id.
self InfoBar self(): Returns this, for use in with statements.
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(gtk.types.MessageType 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.types.ResponseType.Close.

Properties

_gType GType _gType [@property getter]
messageType gtk.types.MessageType messageType [@property getter]: Get messageType property.
messageType gtk.types.MessageType messageType [@property setter]: Set messageType property.
revealed bool revealed [@property getter]
revealed bool revealed [@property setter]
showCloseButton bool showCloseButton [@property getter]: Get showCloseButton property.
showCloseButton bool showCloseButton [@property setter]: Set showCloseButton property.

Static functions

_getGType GType _getGType()
builder InfoBarGidBuilder builder(): Get builder for gtk.info_bar.InfoBar

Inherited Members

From Box

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Box self(): Returns this, for use in with statements.
builder BoxGidBuilder builder(): Get builder for gtk.box.Box
baselinePosition gtk.types.BaselinePosition baselinePosition [@property getter]
baselinePosition gtk.types.BaselinePosition baselinePosition [@property setter]
homogeneous bool homogeneous [@property getter]
homogeneous bool homogeneous [@property setter]
spacing int spacing [@property getter]
spacing int spacing [@property setter]
getBaselinePosition gtk.types.BaselinePosition getBaselinePosition(): Gets the value set by gtk.box.Box.setBaselinePosition.
getCenterWidget gtk.widget.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.Box.setHomogeneous.
getSpacing int getSpacing(): Gets the value set by gtk.box.Box.setSpacing.
packEnd void packEnd(gtk.widget.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(gtk.widget.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(gtk.widget.Widget child, bool expand, bool fill, uint padding, gtk.types.PackType packType): Obtains information about how child is packed into box.
reorderChild void reorderChild(gtk.widget.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(gtk.types.BaselinePosition 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(gtk.widget.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(gtk.widget.Widget child, bool expand, bool fill, uint padding, gtk.types.PackType 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.

gtk info_bar classes