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.

gtk_info_bar_new ()

GtkWidget *
gtk_info_bar_new (void);

Creates a new GtkInfoBar object.

Since: 2.18

gtk_info_bar_new_with_buttons ()

GtkWidget *
gtk_info_bar_new_with_buttons (const gchar *first_button_text,
                               ...);

Creates a new GtkInfoBar with buttons. Button text/response ID pairs should be listed, with a NULL pointer ending the list. Button text can be either a stock ID such as GTK_STOCK_OK, or some arbitrary text. A response ID can be any positive number, or one of the values in the GtkResponseType enumeration. If the user clicks one of these dialog buttons, GtkInfoBar will emit the “response” signal with the corresponding response ID.

gtk_info_bar_add_action_widget ()

void
gtk_info_bar_add_action_widget (GtkInfoBar *info_bar,
                                GtkWidget *child,
                                gint response_id);

Add an activatable widget to the action area of a GtkInfoBar, connecting a signal handler that will emit the “response” signal on the message area when the widget is activated. The widget is appended to the end of the message areas action area.

Since: 2.18

gtk_info_bar_add_button ()

GtkWidget *
gtk_info_bar_add_button (GtkInfoBar *info_bar,
                         const gchar *button_text,
                         gint response_id);

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.

Since: 2.18

gtk_info_bar_add_buttons ()

void
gtk_info_bar_add_buttons (GtkInfoBar *info_bar,
                          const gchar *first_button_text,
                          ...);

Adds more buttons, same as calling gtk_info_bar_add_button() repeatedly. The variable argument list should be NULL-terminated as with gtk_info_bar_new_with_buttons(). Each button must have both text and response ID.

Since: 2.18

gtk_info_bar_set_response_sensitive ()

void
gtk_info_bar_set_response_sensitive (GtkInfoBar *info_bar,
                                     gint response_id,
                                     gboolean 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.

Since: 2.18

gtk_info_bar_set_default_response ()

void
gtk_info_bar_set_default_response (GtkInfoBar *info_bar,
                                   gint response_id);

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 info_bar to be added to a widget hierarchy.

Since: 2.18

gtk_info_bar_response ()

void
gtk_info_bar_response (GtkInfoBar *info_bar,
                       gint response_id);

Emits the “response” signal with the given response_id .

Since: 2.18

gtk_info_bar_set_message_type ()

void
gtk_info_bar_set_message_type (GtkInfoBar *info_bar,
                               GtkMessageType message_type);

Sets the message type of the message area.

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

Since: 2.18

gtk_info_bar_get_message_type ()

GtkMessageType
gtk_info_bar_get_message_type (GtkInfoBar *info_bar);

Returns the message type of the message area.

Since: 2.18

gtk_info_bar_get_action_area ()

GtkWidget *
gtk_info_bar_get_action_area (GtkInfoBar *info_bar);

Returns the action area of info_bar .

Since: 2.18

gtk_info_bar_get_content_area ()

GtkWidget *
gtk_info_bar_get_content_area (GtkInfoBar *info_bar);

Returns the content area of info_bar .

Since: 2.18

gtk_info_bar_get_show_close_button ()

gboolean
gtk_info_bar_get_show_close_button (GtkInfoBar *info_bar);

Returns whether the widget will display a standard close button.

Since: 3.10

gtk_info_bar_set_show_close_button ()

void
gtk_info_bar_set_show_close_button (GtkInfoBar *info_bar,
                                    gboolean setting);

If true, a standard close button is shown. When clicked it emits the response GTK_RESPONSE_CLOSE.

Since: 3.10

gtk_info_bar_get_revealed ()

gboolean
gtk_info_bar_get_revealed (GtkInfoBar *info_bar);

Since: 3.22.29

gtk_info_bar_set_revealed ()

void
gtk_info_bar_set_revealed (GtkInfoBar *info_bar,
                           gboolean revealed);

Sets the GtkInfoBar:revealed property to revealed . This will cause info_bar to show up with a slide-in transition.

Note that this property does not automatically show info_bar and thus won’t have any effect if it is invisible.

Since: 3.22.29

struct GtkInfoBar

struct GtkInfoBar;

The “message-type” property

  “message-type”             GtkMessageType

The type of the message.

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

Owner: GtkInfoBar

Flags: Read / Write / Construct

Default value: GTK_MESSAGE_INFO

Since: 2.18

The “revealed” property

  “revealed”                 gboolean

Controls whether the action bar shows its contents or not.

Owner: GtkInfoBar

Flags: Read / Write

Default value: TRUE

The “show-close-button” property

  “show-close-button”        gboolean

Whether to include a standard close button.

Owner: GtkInfoBar

Flags: Read / Write / Construct

Default value: FALSE

Since: 3.10

The “action-area-border” style property

  “action-area-border”       int

Width of the border around the action area of the info bar.

Owner: GtkInfoBar

Flags: Read

Allowed values: >= 0

Default value: 5

Since: 2.18

The “button-spacing” style property

  “button-spacing”           int

Spacing between buttons in the action area of the info bar.

Owner: GtkInfoBar

Flags: Read

Allowed values: >= 0

Default value: 6

Since: 2.18

The “content-area-border” style property

  “content-area-border”      int

The width of the border around the content content area of the info bar.

Owner: GtkInfoBar

Flags: Read

Allowed values: >= 0

Default value: 8

Since: 2.18

The “content-area-spacing” style property

  “content-area-spacing”     int

The default spacing used between elements of the content area of the info bar.

Owner: GtkInfoBar

Flags: Read

Allowed values: >= 0

Default value: 16

Since: 2.18

The “close” signal

void
user_function (GtkInfoBar *infobar,
               gpointer    user_data)

The ::close signal is a keybinding signal which gets emitted when the user uses a keybinding to dismiss the info bar.

The default binding for this signal is the Escape key.

Flags: Action

Since: 2.18

The “response” signal

void
user_function (GtkInfoBar *info_bar,
               int         response_id,
               gpointer    user_data)

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.

Flags: Run Last

Since: 2.18