| Top | |
|
|
|
| GtkMessageType | message-type | Read / Write / Construct |
| gboolean | revealed | Read / Write |
| gboolean | show-close-button | Read / Write / Construct |
| int | action-area-border | Read |
| int | button-spacing | Read |
| int | content-area-border | Read |
| int | content-area-spacing | Read |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBox ╰── GtkInfoBar
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:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
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); |
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
).
GtkWidget *
gtk_info_bar_new (void);
Creates a new GtkInfoBar object.
Since: 2.18
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.
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
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
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.
info_bar |
||
first_button_text |
button text or stock ID |
|
... |
response ID for first button, then more text-response_id pairs,
ending with |
Since: 2.18
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
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
void gtk_info_bar_response (GtkInfoBar *info_bar,gint response_id);
Emits the “response” signal with the given response_id
.
Since: 2.18
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
GtkMessageType
gtk_info_bar_get_message_type (GtkInfoBar *info_bar);
Returns the message type of the message area.
Since: 2.18
GtkWidget *
gtk_info_bar_get_action_area (GtkInfoBar *info_bar);
Returns the action area of info_bar
.
Since: 2.18
GtkWidget *
gtk_info_bar_get_content_area (GtkInfoBar *info_bar);
Returns the content area of info_bar
.
Since: 2.18
gboolean
gtk_info_bar_get_show_close_button (GtkInfoBar *info_bar);
Returns whether the widget will display a standard close button.
Since: 3.10
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
gboolean
gtk_info_bar_get_revealed (GtkInfoBar *info_bar);
Since: 3.22.29
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
“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
“revealed” property“revealed” gboolean
Controls whether the action bar shows its contents or not.
Owner: GtkInfoBar
Flags: Read / Write
Default value: TRUE
“action-area-border” style property “action-area-border” int
Width of the border around the action area of the info bar.
GtkInfoBar:action-area-border has been deprecated since version 3.6 and should not be used in newly-written code.
Owner: GtkInfoBar
Flags: Read
Allowed values: >= 0
Default value: 5
Since: 2.18
“button-spacing” style property “button-spacing” int
Spacing between buttons in the action area of the info bar.
GtkInfoBar:button-spacing has been deprecated since version 3.6 and should not be used in newly-written code.
Owner: GtkInfoBar
Flags: Read
Allowed values: >= 0
Default value: 6
Since: 2.18
“content-area-border” style property “content-area-border” int
The width of the border around the content content area of the info bar.
GtkInfoBar:content-area-border has been deprecated since version 3.6 and should not be used in newly-written code.
Owner: GtkInfoBar
Flags: Read
Allowed values: >= 0
Default value: 8
Since: 2.18
“content-area-spacing” style property “content-area-spacing” int
The default spacing used between elements of the content area of the info bar.
GtkInfoBar:content-area-spacing has been deprecated since version 3.6 and should not be used in newly-written code.
Owner: GtkInfoBar
Flags: Read
Allowed values: >= 0
Default value: 16
Since: 2.18
“close” signalvoid 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
“response” signalvoid 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.
info_bar |
the object on which the signal is emitted |
|
response_id |
the response ID |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 2.18