GI.Gtk.Objects.InfoBar

InfoBar 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 Dialog, which has a action area at the bottom, InfoBar has an action area at the side.

The API of InfoBar is very similar to Dialog, allowing you to add buttons to the action area with infoBarAddButton or gtk_info_bar_new_with_buttons(). The sensitivity of action widgets can be controlled with infoBarSetResponseSensitive. To add widgets to the main content area of a InfoBar, use infoBarGetContentArea and add your widgets to the container.

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

A simple example for using a InfoBar:

C code

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

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.

Exported types

newtype InfoBar

Memory-managed wrapper type.

Constructors

InfoBar (ManagedPtr InfoBar)

Instances

GObject InfoBar

Defined in GI.Gtk.Objects.InfoBar

Methods

gobjectType :: IO GType

HasParentTypes InfoBar

Defined in GI.Gtk.Objects.InfoBar

type ParentTypes InfoBar

Defined in GI.Gtk.Objects.InfoBar

type ParentTypes InfoBar = Box ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (Orientable ': ([] :: [Type])))))))

class (GObject o, IsDescendantOf InfoBar o) => IsInfoBar o

Type class for types which can be safely cast to InfoBar, for instance with toInfoBar.

Instances

(GObject o, IsDescendantOf InfoBar o) => IsInfoBar o

Defined in GI.Gtk.Objects.InfoBar

toInfoBar :: (MonadIO m, IsInfoBar o) => o -> m InfoBar

Cast to InfoBar, for types for which this is known to be safe. For general casts, use castTo.

noInfoBar :: Maybe InfoBar

A convenience alias for Nothing :: Maybe InfoBar.

Methods

addActionWidget

infoBarAddActionWidget

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a, IsWidget b)

=> a

infoBar: a InfoBar

-> b

child: an activatable widget

-> Int32

responseId: response ID for child

-> m ()

Add an activatable widget to the action area of a InfoBar, connecting a signal handler that will emit the InfoBar::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

addButton

infoBarAddButton

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> Text

buttonText: text of button

-> Int32

responseId: response ID for the button

-> m Button

Returns: the Button widget that was added

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

getActionArea

infoBarGetActionArea

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> m Widget

Returns: the action area

Returns the action area of infoBar.

Since: 2.18

getContentArea

infoBarGetContentArea

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> m Widget

Returns: the content area

Returns the content area of infoBar.

Since: 2.18

getMessageType

infoBarGetMessageType

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> m MessageType

Returns: the message type of the message area.

Returns the message type of the message area.

Since: 2.18

getRevealed

infoBarGetRevealed

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> m Bool

Returns: the current value of the GtkInfoBar:revealed property.

No description available in the introspection data.

Since: 3.22.29

getShowCloseButton

infoBarGetShowCloseButton

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> m Bool

Returns: True if the widget displays standard close button

Returns whether the widget will display a standard close button.

Since: 3.10

new

infoBarNew

Arguments

:: (HasCallStack, MonadIO m)

=> m InfoBar

Returns: a new InfoBar object

Creates a new InfoBar object.

Since: 2.18

response

infoBarResponse

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> Int32

responseId: a response ID

-> m ()

Emits the “response” signal with the given responseId.

Since: 2.18

setDefaultResponse

infoBarSetDefaultResponse

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> Int32

responseId: a response ID

-> m ()

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

Since: 2.18

setMessageType

infoBarSetMessageType

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> MessageType

messageType: a MessageType

-> m ()

Sets the message type of the message area.

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

Since: 2.18

setResponseSensitive

infoBarSetResponseSensitive

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> Int32

responseId: a response ID

-> Bool

setting: TRUE for sensitive

-> m ()

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

setRevealed

infoBarSetRevealed

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> Bool

revealed: The new value of the property

-> m ()

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

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

Since: 3.22.29

setShowCloseButton

infoBarSetShowCloseButton

Arguments

:: (HasCallStack, MonadIO m, IsInfoBar a)

=> a

infoBar: a InfoBar

-> Bool

setting: True to include a close button

-> m ()

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

Since: 3.10

Properties

messageType

The type of the message.

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

Since: 2.18

constructInfoBarMessageType :: IsInfoBar o => MessageType -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “message-type” property. This is rarely needed directly, but it is used by new.

getInfoBarMessageType :: (MonadIO m, IsInfoBar o) => o -> m MessageType

Get the value of the “message-type” property. When overloading is enabled, this is equivalent to

get infoBar #messageType

setInfoBarMessageType :: (MonadIO m, IsInfoBar o) => o -> MessageType -> m ()

Set the value of the “message-type” property. When overloading is enabled, this is equivalent to

set infoBar [ #messageType := value ]

revealed

No description available in the introspection data.

constructInfoBarRevealed :: IsInfoBar o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “revealed” property. This is rarely needed directly, but it is used by new.

getInfoBarRevealed :: (MonadIO m, IsInfoBar o) => o -> m Bool

Get the value of the “revealed” property. When overloading is enabled, this is equivalent to

get infoBar #revealed

setInfoBarRevealed :: (MonadIO m, IsInfoBar o) => o -> Bool -> m ()

Set the value of the “revealed” property. When overloading is enabled, this is equivalent to

set infoBar [ #revealed := value ]

showCloseButton

Whether to include a standard close button.

Since: 3.10

constructInfoBarShowCloseButton :: IsInfoBar o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-close-button” property. This is rarely needed directly, but it is used by new.

getInfoBarShowCloseButton :: (MonadIO m, IsInfoBar o) => o -> m Bool

Get the value of the “show-close-button” property. When overloading is enabled, this is equivalent to

get infoBar #showCloseButton

setInfoBarShowCloseButton :: (MonadIO m, IsInfoBar o) => o -> Bool -> m ()

Set the value of the “show-close-button” property. When overloading is enabled, this is equivalent to

set infoBar [ #showCloseButton := value ]

Signals

close

type C_InfoBarCloseCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type InfoBarCloseCallback = IO ()

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

The default binding for this signal is the Escape key.

Since: 2.18

afterInfoBarClose :: (IsInfoBar a, MonadIO m) => a -> InfoBarCloseCallback -> m SignalHandlerId

Connect a signal handler for the “close” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after infoBar #close callback

genClosure_InfoBarClose :: MonadIO m => InfoBarCloseCallback -> m (GClosure C_InfoBarCloseCallback)

Wrap the callback into a GClosure.

mk_InfoBarCloseCallback :: C_InfoBarCloseCallback -> IO (FunPtr C_InfoBarCloseCallback)

Generate a function pointer callable from C code, from a C_InfoBarCloseCallback.

noInfoBarCloseCallback :: Maybe InfoBarCloseCallback

A convenience synonym for Nothing :: Maybe InfoBarCloseCallback.

onInfoBarClose :: (IsInfoBar a, MonadIO m) => a -> InfoBarCloseCallback -> m SignalHandlerId

Connect a signal handler for the “close” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on infoBar #close callback

wrap_InfoBarCloseCallback :: InfoBarCloseCallback -> C_InfoBarCloseCallback

Wrap a InfoBarCloseCallback into a C_InfoBarCloseCallback.

response

type C_InfoBarResponseCallback = Ptr () -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type InfoBarResponseCallback

Arguments

 = Int32

responseId: the response ID

-> IO ()

Emitted when an action widget is clicked or the application programmer calls dialogResponse. The responseId depends on which action widget was clicked.

Since: 2.18

afterInfoBarResponse :: (IsInfoBar a, MonadIO m) => a -> InfoBarResponseCallback -> m SignalHandlerId

Connect a signal handler for the “response” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after infoBar #response callback

genClosure_InfoBarResponse :: MonadIO m => InfoBarResponseCallback -> m (GClosure C_InfoBarResponseCallback)

Wrap the callback into a GClosure.

mk_InfoBarResponseCallback :: C_InfoBarResponseCallback -> IO (FunPtr C_InfoBarResponseCallback)

Generate a function pointer callable from C code, from a C_InfoBarResponseCallback.

noInfoBarResponseCallback :: Maybe InfoBarResponseCallback

A convenience synonym for Nothing :: Maybe InfoBarResponseCallback.

onInfoBarResponse :: (IsInfoBar a, MonadIO m) => a -> InfoBarResponseCallback -> m SignalHandlerId

Connect a signal handler for the “response” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on infoBar #response callback

wrap_InfoBarResponseCallback :: InfoBarResponseCallback -> C_InfoBarResponseCallback

Wrap a InfoBarResponseCallback into a C_InfoBarResponseCallback.