gi-gtk3-3.0.44: Gtk 3.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.UIManager

Contents

- Exported types
- Methods
  - addUi
  - addUiFromFile
  - addUiFromResource
  - addUiFromString
  - ensureUpdate
  - getAccelGroup
  - getAction
  - getActionGroups
  - getAddTearoffs
  - getToplevels
  - getUi
  - getWidget
  - insertActionGroup
  - new
  - newMergeId
  - removeActionGroup
  - removeUi
  - setAddTearoffs
- Properties
  - addTearoffs
  - ui
- Signals
  - actionsChanged
  - addWidget
  - connectProxy
  - disconnectProxy
  - postActivate
  - preActivate

Description

A `UIManager` constructs a user interface (menus and toolbars) from one or more UI definitions, which reference actions from one or more action groups.

    GtkUIManager is deprecated since GTK+ 3.10. To construct user interfaces
    from XML definitions, you should use t'GI.Gtk.Objects.Builder.Builder', t'GI.Gio.Objects.MenuModel.MenuModel', et al. To
    work with actions, use t'GI.Gio.Interfaces.Action.Action', t'GI.Gtk.Interfaces.Actionable.Actionable' et al. These newer classes
    support richer functionality and integration with various desktop shells.
    It should be possible to migrate most\/all functionality from GtkUIManager.

# UI Definitions # {`XML`-UI}

The UI definitions are specified in an XML format which can be roughly described by the following DTD.

    Do not confuse the GtkUIManager UI Definitions described here with
    the similarly named [GtkBuilder UI Definitions][BUILDER-UI].

    <!ELEMENT ui          (menubar|toolbar|popup|accelerator)* >
    <!ELEMENT menubar     (menuitem|separator|placeholder|menu)* >
    <!ELEMENT menu        (menuitem|separator|placeholder|menu)* >
    <!ELEMENT popup       (menuitem|separator|placeholder|menu)* >
    <!ELEMENT toolbar     (toolitem|separator|placeholder)* >
    <!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* >
    <!ELEMENT menuitem     EMPTY >
    <!ELEMENT toolitem     (menu?) >
    <!ELEMENT separator    EMPTY >
    <!ELEMENT accelerator  EMPTY >
    <!ATTLIST menubar      name                      #IMPLIED
                           action                    #IMPLIED >
    <!ATTLIST toolbar      name                      #IMPLIED
                           action                    #IMPLIED >
    <!ATTLIST popup        name                      #IMPLIED
                           action                    #IMPLIED
                           accelerators (true|false) #IMPLIED >
    <!ATTLIST placeholder  name                      #IMPLIED
                           action                    #IMPLIED >
    <!ATTLIST separator    name                      #IMPLIED
                           action                    #IMPLIED
                           expand       (true|false) #IMPLIED >
    <!ATTLIST menu         name                      #IMPLIED
                           action                    #REQUIRED
                           position     (top|bot)    #IMPLIED >
    <!ATTLIST menuitem     name                      #IMPLIED
                           action                    #REQUIRED
                           position     (top|bot)    #IMPLIED
                           always-show-image (true|false) #IMPLIED >
    <!ATTLIST toolitem     name                      #IMPLIED
                           action                    #REQUIRED
                           position     (top|bot)    #IMPLIED >
    <!ATTLIST accelerator  name                      #IMPLIED
                           action                    #REQUIRED >

There are some additional restrictions beyond those specified in the DTD, e.g. every toolitem must have a toolbar in its anchestry and every menuitem must have a menubar or popup in its anchestry. Since a `MarkupParser` is used to parse the UI description, it must not only be valid XML, but valid markup.

If a name is not specified, it defaults to the action. If an action is not specified either, the element name is used. The name and action attributes must not contain “/” characters after parsing (since that would mess up path lookup) and must be usable as XML attributes when enclosed in doublequotes, thus they must not “"” characters or references to the &quot; entity.

# A UI definition

### xml code

    <ui>
      <menubar>
        <menu name="FileMenu" action="FileMenuAction">
          <menuitem name="New" action="New2Action" />
          <placeholder name="FileMenuAdditions" />
        </menu>
        <menu name="JustifyMenu" action="JustifyMenuAction">
          <menuitem name="Left" action="justify-left"/>
          <menuitem name="Centre" action="justify-center"/>
          <menuitem name="Right" action="justify-right"/>
          <menuitem name="Fill" action="justify-fill"/>
        </menu>
      </menubar>
      <toolbar action="toolbar1">
        <placeholder name="JustifyToolItems">
          <separator/>
          <toolitem name="Left" action="justify-left"/>
          <toolitem name="Centre" action="justify-center"/>
          <toolitem name="Right" action="justify-right"/>
          <toolitem name="Fill" action="justify-fill"/>
          <separator/>
        </placeholder>
      </toolbar>
    </ui>

The constructed widget hierarchy is very similar to the element tree of the XML, with the exception that placeholders are merged into their parents. The correspondence of XML elements to widgets should be almost obvious:

- menubar

a `MenuBar`

- toolbar

a `Toolbar`

- popup

a toplevel `Menu`

- menu

a `Menu` attached to a menuitem

- menuitem

a `MenuItem` subclass, the exact type depends on the action

- toolitem

a `ToolItem` subclass, the exact type depends on the action. Note that toolitem elements may contain a menu element, but only if their associated action specifies a `MenuToolButton` as proxy.

- separator

a `SeparatorMenuItem` or `SeparatorToolItem`

- accelerator

a keyboard accelerator

The “position” attribute determines where a constructed widget is positioned wrt. to its siblings in the partially constructed tree. If it is “top”, the widget is prepended, otherwise it is appended.

# UI Merging # {`UI`-Merging}

The most remarkable feature of `UIManager` is that it can overlay a set of menuitems and toolitems over another one, and demerge them later.

Merging is done based on the names of the XML elements. Each element is identified by a path which consists of the names of its anchestors, separated by slashes. For example, the menuitem named “Left” in the example above has the path `/ui/menubar/JustifyMenu/Left` and the toolitem with the same name has path `/ui/toolbar1/JustifyToolItems/Left`.

# Accelerators

Every action has an accelerator path. Accelerators are installed together with menuitem proxies, but they can also be explicitly added with `<accelerator>` elements in the UI definition. This makes it possible to have accelerators for actions even if they have no visible proxies.

# Smart Separators # {`Smart`-Separators}

The separators created by `UIManager` are “smart”, i.e. they do not show up in the UI unless they end up between two visible menu or tool items. Separators which are located at the very beginning or end of the menu or toolbar containing them, or multiple separators next to each other, are hidden. This is a useful feature, since the merging of UI elements from multiple sources can make it hard or impossible to determine in advance whether a separator will end up in such an unfortunate position.

For separators in toolbars, you can set `expand="true"` to turn them from a small, visible separator to an expanding, invisible one. Toolitems following an expanding separator are effectively right-aligned.

# Empty Menus

Submenus pose similar problems to separators inconnection with merging. It is impossible to know in advance whether they will end up empty after merging. `UIManager` offers two ways to treat empty submenus:

- make them disappear by hiding the menu item they’re attached to
- add an insensitive “Empty” item

The behaviour is chosen based on the “hide_if_empty” property of the action to which the submenu is associated.

# GtkUIManager as GtkBuildable # {t`UIManager`-BUILDER-UI}

The GtkUIManager implementation of the GtkBuildable interface accepts GtkActionGroup objects as `<child>` elements in UI definitions.

A GtkUIManager UI definition as described above can be embedded in an GtkUIManager `<object>` element in a GtkBuilder UI definition.

The widgets that are constructed by a GtkUIManager can be embedded in other parts of the constructed user interface with the help of the “constructor” attribute. See the example below.

## An embedded GtkUIManager UI definition

### xml code

    <object class="GtkUIManager" id="uiman">
      <child>
        <object class="GtkActionGroup" id="actiongroup">
          <child>
            <object class="GtkAction" id="file">
              <property name="label">_File</property>
            </object>
          </child>
        </object>
      </child>
      <ui>
        <menubar name="menubar1">
          <menu action="file">
          </menu>
        </menubar>
      </ui>
    </object>
    <object class="GtkWindow" id="main-window">
      <child>
        <object class="GtkMenuBar" id="menubar1" constructor="uiman"/>
      </child>
    </object>

Synopsis

- newtype UIManager = UIManager (ManagedPtr UIManager)
- class (GObject o, IsDescendantOf UIManager o) => IsUIManager o
- toUIManager :: (MonadIO m, IsUIManager o) => o -> m UIManager
- uIManagerAddUi :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Word32 -> Text -> Text -> Maybe Text -> [UIManagerItemType] -> Bool -> m ()
- uIManagerAddUiFromFile :: (HasCallStack, MonadIO m, IsUIManager a) => a -> [Char] -> m Word32
- uIManagerAddUiFromResource :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Text -> m Word32
- uIManagerAddUiFromString :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Text -> Int64 -> m Word32
- uIManagerEnsureUpdate :: (HasCallStack, MonadIO m, IsUIManager a) => a -> m ()
- uIManagerGetAccelGroup :: (HasCallStack, MonadIO m, IsUIManager a) => a -> m AccelGroup
- uIManagerGetAction :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Text -> m (Maybe Action)
- uIManagerGetActionGroups :: (HasCallStack, MonadIO m, IsUIManager a) => a -> m [ActionGroup]
- uIManagerGetAddTearoffs :: (HasCallStack, MonadIO m, IsUIManager a) => a -> m Bool
- uIManagerGetToplevels :: (HasCallStack, MonadIO m, IsUIManager a) => a -> [UIManagerItemType] -> m [Widget]
- uIManagerGetUi :: (HasCallStack, MonadIO m, IsUIManager a) => a -> m Text
- uIManagerGetWidget :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Text -> m (Maybe Widget)
- uIManagerInsertActionGroup :: (HasCallStack, MonadIO m, IsUIManager a, IsActionGroup b) => a -> b -> Int32 -> m ()
- uIManagerNew :: (HasCallStack, MonadIO m) => m UIManager
- uIManagerNewMergeId :: (HasCallStack, MonadIO m, IsUIManager a) => a -> m Word32
- uIManagerRemoveActionGroup :: (HasCallStack, MonadIO m, IsUIManager a, IsActionGroup b) => a -> b -> m ()
- uIManagerRemoveUi :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Word32 -> m ()
- uIManagerSetAddTearoffs :: (HasCallStack, MonadIO m, IsUIManager a) => a -> Bool -> m ()
- constructUIManagerAddTearoffs :: (IsUIManager o, MonadIO m) => Bool -> m (GValueConstruct o)
- getUIManagerAddTearoffs :: (MonadIO m, IsUIManager o) => o -> m Bool
- setUIManagerAddTearoffs :: (MonadIO m, IsUIManager o) => o -> Bool -> m ()
- getUIManagerUi :: (MonadIO m, IsUIManager o) => o -> m (Maybe Text)
- type UIManagerActionsChangedCallback = IO ()
- afterUIManagerActionsChanged :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerActionsChangedCallback) -> m SignalHandlerId
- onUIManagerActionsChanged :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerActionsChangedCallback) -> m SignalHandlerId
- type UIManagerAddWidgetCallback = Widget -> IO ()
- afterUIManagerAddWidget :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerAddWidgetCallback) -> m SignalHandlerId
- onUIManagerAddWidget :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerAddWidgetCallback) -> m SignalHandlerId
- type UIManagerConnectProxyCallback = Action -> Widget -> IO ()
- afterUIManagerConnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerConnectProxyCallback) -> m SignalHandlerId
- onUIManagerConnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerConnectProxyCallback) -> m SignalHandlerId
- type UIManagerDisconnectProxyCallback = Action -> Widget -> IO ()
- afterUIManagerDisconnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerDisconnectProxyCallback) -> m SignalHandlerId
- onUIManagerDisconnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerDisconnectProxyCallback) -> m SignalHandlerId
- type UIManagerPostActivateCallback = Action -> IO ()
- afterUIManagerPostActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPostActivateCallback) -> m SignalHandlerId
- onUIManagerPostActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPostActivateCallback) -> m SignalHandlerId
- type UIManagerPreActivateCallback = Action -> IO ()
- afterUIManagerPreActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPreActivateCallback) -> m SignalHandlerId
- onUIManagerPreActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPreActivateCallback) -> m SignalHandlerId

# Exported types

newtype UIManager Source #

Memory-managed wrapper type.

Constructors

UIManager (ManagedPtr UIManager) |

#### Instances

Instances details

Eq UIManager Source # |
Instance details Defined in GI.Gtk.Objects.UIManager Methods (==) :: UIManager -> UIManager -> Bool Source # (/=) :: UIManager -> UIManager -> Bool Source #
GObject UIManager Source # |
Instance details Defined in GI.Gtk.Objects.UIManager
ManagedPtrNewtype UIManager Source # |
Instance details Defined in GI.Gtk.Objects.UIManager Methods toManagedPtr :: UIManager -> ManagedPtr UIManager Source #
TypedObject UIManager Source # |
Instance details Defined in GI.Gtk.Objects.UIManager Methods glibType :: IO GType Source #
HasParentTypes UIManager Source # |
Instance details Defined in GI.Gtk.Objects.UIManager
IsGValue (Maybe UIManager) Source # | Convert `UIManager` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.UIManager Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe UIManager -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe UIManager) Source #
type ParentTypes UIManager Source # |
Instance details Defined in GI.Gtk.Objects.UIManager type ParentTypes UIManager = '[Object, Buildable]

class (GObject o, IsDescendantOf UIManager o) => IsUIManager o Source #

Type class for types which can be safely cast to `UIManager`, for instance with `toUIManager`.

#### Instances

Instances details

(GObject o, IsDescendantOf UIManager o) => IsUIManager o Source # |
Instance details Defined in GI.Gtk.Objects.UIManager

toUIManager :: (MonadIO m, IsUIManager o) => o -> m UIManager Source #

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

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

addChild, addUi, addUiFromFile, addUiFromResource, addUiFromString, bindProperty, bindPropertyFull, constructChild, customFinished, customTagEnd, customTagStart, ensureUpdate, forceFloating, freezeNotify, getv, insertActionGroup, isFloating, newMergeId, notify, notifyByPspec, parserFinished, ref, refSink, removeActionGroup, removeUi, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

#### Getters

getAccelGroup, getAction, getActionGroups, getAddTearoffs, getData, getInternalChild, getName, getProperty, getQdata, getToplevels, getUi, getWidget.

#### Setters

setAddTearoffs, setBuildableProperty, setData, setDataFull, setName, setProperty.

## addUi

uIManagerAddUi Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> Word32 | `mergeId`: the merge id for the merged UI, see `uIManagerNewMergeId`
-> Text | `path`: a path
-> Text | `name`: the name for the added UI element
-> Maybe Text | `action`: the name of the action to be proxied, or `Nothing` to add a separator
-> [UIManagerItemType] | `type`: the type of UI element to add.
-> Bool | `top`: if `True`, the UI element is added before its siblings, otherwise it is added after its siblings.
-> m () |

Deprecated: (Since version 3.10)

Adds a UI element to the current contents of `manager`.

If `type` is `UIManagerItemTypeAuto`, GTK+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by `path`. Otherwise `type` must indicate an element that can be inserted at the place determined by `path`.

If `path` points to a menuitem or toolitem, the new element will be inserted before or after this item, depending on `top`.

Since: 2.4

## addUiFromFile

uIManagerAddUiFromFile Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager` object
-> [Char] | `filename`: the name of the file to parse
-> m Word32 | Returns: The merge id for the merged UI. The merge id can be used to unmerge the UI with `uIManagerRemoveUi`. If an error occurred, the return value is 0. (Can throw `GError`)

Deprecated: (Since version 3.10)

Parses a file containing a [UI definition][XML-UI] and merges it with the current contents of `manager`.

Since: 2.4

## addUiFromResource

uIManagerAddUiFromResource Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager` object
-> Text | `resourcePath`: the resource path of the file to parse
-> m Word32 | Returns: The merge id for the merged UI. The merge id can be used to unmerge the UI with `uIManagerRemoveUi`. If an error occurred, the return value is 0. (Can throw `GError`)

Deprecated: (Since version 3.10)

Parses a resource file containing a [UI definition][XML-UI] and merges it with the current contents of `manager`.

Since: 3.4

## addUiFromString

uIManagerAddUiFromString Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager` object
-> Text | `buffer`: the string to parse
-> Int64 | `length`: the length of `buffer` (may be -1 if `buffer` is nul-terminated)
-> m Word32 | Returns: The merge id for the merged UI. The merge id can be used to unmerge the UI with `uIManagerRemoveUi`. If an error occurred, the return value is 0. (Can throw `GError`)

Deprecated: (Since version 3.10)

Parses a string containing a [UI definition][XML-UI] and merges it with the current contents of `manager`. An enclosing `<ui>` element is added if it is missing.

Since: 2.4

## ensureUpdate

uIManagerEnsureUpdate Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> m () |

Deprecated: (Since version 3.10)

Makes sure that all pending updates to the UI have been completed.

This may occasionally be necessary, since `UIManager` updates the UI in an idle function. A typical example where this function is useful is to enforce that the menubar and toolbar have been added to the main window before showing it:

### C code

    gtk_container_add (GTK_CONTAINER (window), vbox);
    g_signal_connect (merge, "add-widget",
                      G_CALLBACK (add_widget), vbox);
    gtk_ui_manager_add_ui_from_file (merge, "my-menus");
    gtk_ui_manager_add_ui_from_file (merge, "my-toolbars");
    gtk_ui_manager_ensure_update (merge);
    gtk_widget_show (window);

Since: 2.4

## getAccelGroup

uIManagerGetAccelGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager` object
-> m AccelGroup | Returns: the `AccelGroup`.

Deprecated: (Since version 3.10)

Returns the `AccelGroup` associated with `manager`.

Since: 2.4

## getAction

uIManagerGetAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> Text | `path`: a path
-> m (Maybe Action) | Returns: the action whose proxy widget is found by following the path, or `Nothing` if no widget was found.

Deprecated: (Since version 3.10)

Looks up an action by following a path. See `uIManagerGetWidget` for more information about paths.

Since: 2.4

## getActionGroups

uIManagerGetActionGroups Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager` object
-> m [ActionGroup] | Returns: a `List` of action groups. The list is owned by GTK+ and should not be modified.

Deprecated: (Since version 3.10)

Returns the list of action groups associated with `manager`.

Since: 2.4

## getAddTearoffs

uIManagerGetAddTearoffs Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> m Bool | Returns: whether tearoff menu items are added

Deprecated: (Since version 3.4)Tearoff menus are deprecated and should notbe used in newly written code.

Returns whether menus generated by this `UIManager` will have tearoff menu items.

Since: 2.4

## getToplevels

uIManagerGetToplevels Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> [UIManagerItemType] | `types`: specifies the types of toplevel widgets to include. Allowed types are `GTK_UI_MANAGER_MENUBAR`, `GTK_UI_MANAGER_TOOLBAR` and `GTK_UI_MANAGER_POPUP`.
-> m [Widget] | Returns: a newly-allocated `SList` of all toplevel widgets of the requested types. Free the returned list with `g_slist_free()`.

Deprecated: (Since version 3.10)

Obtains a list of all toplevel widgets of the requested types.

Since: 2.4

## getUi

uIManagerGetUi Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> m Text | Returns: A newly allocated string containing an XML representation of the merged UI.

Deprecated: (Since version 3.10)

Creates a [UI definition][XML-UI] of the merged UI.

Since: 2.4

## getWidget

uIManagerGetWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> Text | `path`: a path
-> m (Maybe Widget) | Returns: the widget found by following the path, or `Nothing` if no widget was found

Deprecated: (Since version 3.10)

Looks up a widget by following a path. The path consists of the names specified in the XML description of the UI. separated by “/”. Elements which don’t have a name or action attribute in the XML (e.g. `<popup>`) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.

Note that the widget found by following a path that ends in a `<menu>`; element is the menuitem to which the menu is attached, not the menu it manages.

Also note that the widgets constructed by a ui manager are not tied to the lifecycle of the ui manager. If you add the widgets returned by this function to some container or explicitly ref them, they will survive the destruction of the ui manager.

Since: 2.4

## insertActionGroup

uIManagerInsertActionGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a, IsActionGroup b) |
=> a | `manager`: a `UIManager` object
-> b | `actionGroup`: the action group to be inserted
-> Int32 | `pos`: the position at which the group will be inserted.
-> m () |

Deprecated: (Since version 3.10)

Inserts an action group into the list of action groups associated with `manager`. Actions in earlier groups hide actions with the same name in later groups.

If `pos` is larger than the number of action groups in `manager`, or negative, `actionGroup` will be inserted at the end of the internal list.

Since: 2.4

## new

uIManagerNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m UIManager | Returns: a new ui manager object.

Deprecated: (Since version 3.10)

Creates a new ui manager object.

Since: 2.4

## newMergeId

uIManagerNewMergeId Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> m Word32 | Returns: an unused merge id.

Deprecated: (Since version 3.10)

Returns an unused merge id, suitable for use with `uIManagerAddUi`.

Since: 2.4

## removeActionGroup

uIManagerRemoveActionGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a, IsActionGroup b) |
=> a | `manager`: a `UIManager` object
-> b | `actionGroup`: the action group to be removed
-> m () |

Deprecated: (Since version 3.10)

Removes an action group from the list of action groups associated with `manager`.

Since: 2.4

## removeUi

uIManagerRemoveUi Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager` object
-> Word32 | `mergeId`: a merge id as returned by `uIManagerAddUiFromString`
-> m () |

Deprecated: (Since version 3.10)

Unmerges the part of `manager`'s content identified by `mergeId`.

Since: 2.4

## setAddTearoffs

uIManagerSetAddTearoffs Source #

Arguments

:: (HasCallStack, MonadIO m, IsUIManager a) |
=> a | `manager`: a `UIManager`
-> Bool | `addTearoffs`: whether tearoff menu items are added
-> m () |

Deprecated: (Since version 3.4)Tearoff menus are deprecated and should notbe used in newly written code.

Sets the “add_tearoffs” property, which controls whether menus generated by this `UIManager` will have tearoff menu items.

Note that this only affects regular menus. Generated popup menus never have tearoff menu items.

Since: 2.4

# Properties

## addTearoffs

The "add-tearoffs" property controls whether generated menus have tearoff menu items.

Note that this only affects regular menus. Generated popup menus never have tearoff menu items.

Since: 2.4

constructUIManagerAddTearoffs :: (IsUIManager o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getUIManagerAddTearoffs :: (MonadIO m, IsUIManager o) => o -> m Bool Source #

Get the value of the “`add-tearoffs`” property. When overloading is enabled, this is equivalent to

    get uIManager #addTearoffs

setUIManagerAddTearoffs :: (MonadIO m, IsUIManager o) => o -> Bool -> m () Source #

Set the value of the “`add-tearoffs`” property. When overloading is enabled, this is equivalent to

    set uIManager [ #addTearoffs := value ]

## ui

No description available in the introspection data.

getUIManagerUi :: (MonadIO m, IsUIManager o) => o -> m (Maybe Text) Source #

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

    get uIManager #ui

# Signals

## actionsChanged

type UIManagerActionsChangedCallback = IO () Source #

Deprecated: (Since version 3.10)

The actionsChanged signal is emitted whenever the set of actions changes.

Since: 2.4

afterUIManagerActionsChanged :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerActionsChangedCallback) -> m SignalHandlerId Source #

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

    after uIManager #actionsChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onUIManagerActionsChanged :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerActionsChangedCallback) -> m SignalHandlerId Source #

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

    on uIManager #actionsChanged callback

## addWidget

type UIManagerAddWidgetCallback Source #

Arguments

= Widget | `widget`: the added widget
-> IO () |

Deprecated: (Since version 3.10)

The addWidget signal is emitted for each generated menubar and toolbar. It is not emitted for generated popup menus, which can be obtained by `uIManagerGetWidget`.

Since: 2.4

afterUIManagerAddWidget :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerAddWidgetCallback) -> m SignalHandlerId Source #

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

    after uIManager #addWidget callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onUIManagerAddWidget :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerAddWidgetCallback) -> m SignalHandlerId Source #

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

    on uIManager #addWidget callback

## connectProxy

type UIManagerConnectProxyCallback Source #

Arguments

= Action | `action`: the action
-> Widget | `proxy`: the proxy
-> IO () |

Deprecated: (Since version 3.10)

The connectProxy signal is emitted after connecting a proxy to an action in the group.

This is intended for simple customizations for which a custom action class would be too clumsy, e.g. showing tooltips for menuitems in the statusbar.

Since: 2.4

afterUIManagerConnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerConnectProxyCallback) -> m SignalHandlerId Source #

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

    after uIManager #connectProxy callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onUIManagerConnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerConnectProxyCallback) -> m SignalHandlerId Source #

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

    on uIManager #connectProxy callback

## disconnectProxy

type UIManagerDisconnectProxyCallback Source #

Arguments

= Action | `action`: the action
-> Widget | `proxy`: the proxy
-> IO () |

Deprecated: (Since version 3.10)

The disconnectProxy signal is emitted after disconnecting a proxy from an action in the group.

Since: 2.4

afterUIManagerDisconnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerDisconnectProxyCallback) -> m SignalHandlerId Source #

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

    after uIManager #disconnectProxy callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onUIManagerDisconnectProxy :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerDisconnectProxyCallback) -> m SignalHandlerId Source #

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

    on uIManager #disconnectProxy callback

## postActivate

type UIManagerPostActivateCallback Source #

Arguments

= Action | `action`: the action
-> IO () |

Deprecated: (Since version 3.10)

The postActivate signal is emitted just after the `action` is activated.

This is intended for applications to get notification just after any action is activated.

Since: 2.4

afterUIManagerPostActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPostActivateCallback) -> m SignalHandlerId Source #

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

    after uIManager #postActivate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onUIManagerPostActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPostActivateCallback) -> m SignalHandlerId Source #

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

    on uIManager #postActivate callback

## preActivate

type UIManagerPreActivateCallback Source #

Arguments

= Action | `action`: the action
-> IO () |

Deprecated: (Since version 3.10)

The preActivate signal is emitted just before the `action` is activated.

This is intended for applications to get notification just before any action is activated.

Since: 2.4

afterUIManagerPreActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPreActivateCallback) -> m SignalHandlerId Source #

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

    after uIManager #preActivate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onUIManagerPreActivate :: (IsUIManager a, MonadIO m) => a -> ((?self :: a) => UIManagerPreActivateCallback) -> m SignalHandlerId Source #

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

    on uIManager #preActivate callback