class Gtk::InfoBar

• Gtk::InfoBar
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

Gtk::InfoBar can be show messages to the user without a dialog.

It is often temporarily shown at the top or bottom of a document. In contrast to Gtk::Dialog, which has an action area at the bottom, Gtk::InfoBar has an action area at the side.

The API of Gtk::InfoBar is very similar to Gtk::Dialog, allowing you to add buttons to the action area with Gtk::InfoBar#add_button or Gtk::InfoBar#new_with_buttons. The sensitivity of action widgets can be controlled with Gtk::InfoBar#response_sensitive=.

To add widgets to the main content area of a Gtk::InfoBar, use Gtk::InfoBar#add_child.

Similar to Gtk::MessageDialog, the contents of a Gtk::InfoBar can by classified as error message, warning, informational message, etc, by using Gtk::InfoBar#message_type=. GTK may use the message type to determine how the message is displayed.

A simple example for using a Gtk::InfoBar:

WARNING ⚠️ The following code is in c ⚠️

Gtk::Widget *message_label;
Gtk::Widget *widget;
Gtk::Widget *grid;
Gtk::InfoBar *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);

Gtk::InfoBar as Gtk::Buildable

Gtk::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).

Gtk::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

Gtk::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.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget

Defined in:

Constructors

• .new : self

  Creates a new Gtk::InfoBar object.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, focus_on_click : Bool | Nil = nil, focusable : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, message_type : Gtk::MessageType | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, revealed : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, show_close_button : Bool | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #add_action_widget(child : Gtk::Widget, response_id : Int32) : Nil

  Add an activatable widget to the action area of a Gtk::InfoBar.

• #add_button(button_text : String, response_id : Int32) : Gtk::Button

  Adds a button with the given text.

• #add_child(widget : Gtk::Widget) : Nil

  Adds a widget to the content area of the info bar.

• #close_signal
• #default_response=(response_id : Int32) : Nil

  Sets the last widget in the info bar’s action area with the given response_id as the default widget for the dialog.

• #hash(hasher)

  See Object#hash(hasher)

• #message_type : Gtk::MessageType

  Returns the message type of the message area.

• #message_type=(message_type : Gtk::MessageType) : Nil

  Sets the message type of the message area.

• #remove_action_widget(widget : Gtk::Widget) : Nil

  Removes a widget from the action area of info_bar.

• #remove_child(widget : Gtk::Widget) : Nil

  Removes a widget from the content area of the info bar.

• #response(response_id : Int32) : Nil

  Emits the “response” signal with the given response_id.

• #response_signal
• #revealed : Bool

  Returns whether the info bar is currently revealed.

• #revealed=(revealed : Bool) : Nil

  Sets whether the Gtk::InfoBar is revealed.

• #revealed? : Bool
• #set_response_sensitive(response_id : Int32, setting : Bool) : Nil

  Sets the sensitivity of action widgets for response_id.

• #show_close_button : Bool

  Returns whether the widget will display a standard close button.

• #show_close_button=(setting : Bool) : Nil

  If true, a standard close button is shown.

• #show_close_button? : Bool

Constructor Detail

Class Method Detail

Instance Method Detail