{- |
Copyright : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License : LGPL-2.1
Maintainer : Iñaki García Etxebarria (inaki@blueleaf.cc)
> GtkUIManager is deprecated since GTK+ 3.10. To construct user interfaces
> from XML definitions, you should use 'GI.Gtk.Objects.Builder.Builder', 'GI.Gio.Objects.MenuModel.MenuModel', et al. To
> work with actions, use 'GI.Gio.Interfaces.Action.Action', '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.
A 'GI.Gtk.Objects.UIManager.UIManager' constructs a user interface (menus and toolbars) from
one or more UI definitions, which reference actions from one or more
action groups.
# 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].
>
>
>
>
>
>
>
>
>
>
>
> action #IMPLIED >
> action #IMPLIED >
> action #IMPLIED
> accelerators (true|false) #IMPLIED >
> action #IMPLIED >
> action #IMPLIED
> expand (true|false) #IMPLIED >
> action #REQUIRED
> position (top|bot) #IMPLIED >
> action #REQUIRED
> position (top|bot) #IMPLIED
> always-show-image (true|false) #IMPLIED >
> action #REQUIRED
> position (top|bot) #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 'GI.GLib.Structs.MarkupParser.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 " entity.
= A UI definition
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
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 'GI.Gtk.Objects.MenuBar.MenuBar'
* toolbar
a 'GI.Gtk.Objects.Toolbar.Toolbar'
* popup
a toplevel 'GI.Gtk.Objects.Menu.Menu'
* menu
a 'GI.Gtk.Objects.Menu.Menu' attached to a menuitem
* menuitem
a 'GI.Gtk.Objects.MenuItem.MenuItem' subclass, the exact type depends on the action
* toolitem
a 'GI.Gtk.Objects.ToolItem.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
'GI.Gtk.Objects.MenuToolButton.MenuToolButton' as proxy.
* separator
a 'GI.Gtk.Objects.SeparatorMenuItem.SeparatorMenuItem' or 'GI.Gtk.Objects.SeparatorToolItem.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 'GI.Gtk.Objects.UIManager.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
\ 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 'GI.Gtk.Objects.UIManager.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.
'GI.Gtk.Objects.UIManager.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 # {'GI.Gtk.Objects.UIManager.UIManager'-BUILDER-UI}
The GtkUIManager implementation of the GtkBuildable interface accepts
GtkActionGroup objects as \ elements in UI definitions.
A GtkUIManager UI definition as described above can be embedded in
an GtkUIManager \ 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
>
>
>
>
>
>
> _File
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
-}
#define ENABLE_OVERLOADING (MIN_VERSION_haskell_gi_overloading(1,0,0) \
&& !defined(__HADDOCK_VERSION__))
module GI.Gtk.Objects.UIManager
(
-- * Exported types
UIManager(..) ,
IsUIManager ,
toUIManager ,
noUIManager ,
-- * Methods
-- ** addUi #method:addUi#
#if ENABLE_OVERLOADING
UIManagerAddUiMethodInfo ,
#endif
uIManagerAddUi ,
-- ** addUiFromFile #method:addUiFromFile#
#if ENABLE_OVERLOADING
UIManagerAddUiFromFileMethodInfo ,
#endif
uIManagerAddUiFromFile ,
-- ** addUiFromResource #method:addUiFromResource#
#if ENABLE_OVERLOADING
UIManagerAddUiFromResourceMethodInfo ,
#endif
uIManagerAddUiFromResource ,
-- ** addUiFromString #method:addUiFromString#
#if ENABLE_OVERLOADING
UIManagerAddUiFromStringMethodInfo ,
#endif
uIManagerAddUiFromString ,
-- ** ensureUpdate #method:ensureUpdate#
#if ENABLE_OVERLOADING
UIManagerEnsureUpdateMethodInfo ,
#endif
uIManagerEnsureUpdate ,
-- ** getAccelGroup #method:getAccelGroup#
#if ENABLE_OVERLOADING
UIManagerGetAccelGroupMethodInfo ,
#endif
uIManagerGetAccelGroup ,
-- ** getAction #method:getAction#
#if ENABLE_OVERLOADING
UIManagerGetActionMethodInfo ,
#endif
uIManagerGetAction ,
-- ** getActionGroups #method:getActionGroups#
#if ENABLE_OVERLOADING
UIManagerGetActionGroupsMethodInfo ,
#endif
uIManagerGetActionGroups ,
-- ** getAddTearoffs #method:getAddTearoffs#
#if ENABLE_OVERLOADING
UIManagerGetAddTearoffsMethodInfo ,
#endif
uIManagerGetAddTearoffs ,
-- ** getToplevels #method:getToplevels#
#if ENABLE_OVERLOADING
UIManagerGetToplevelsMethodInfo ,
#endif
uIManagerGetToplevels ,
-- ** getUi #method:getUi#
#if ENABLE_OVERLOADING
UIManagerGetUiMethodInfo ,
#endif
uIManagerGetUi ,
-- ** getWidget #method:getWidget#
#if ENABLE_OVERLOADING
UIManagerGetWidgetMethodInfo ,
#endif
uIManagerGetWidget ,
-- ** insertActionGroup #method:insertActionGroup#
#if ENABLE_OVERLOADING
UIManagerInsertActionGroupMethodInfo ,
#endif
uIManagerInsertActionGroup ,
-- ** new #method:new#
uIManagerNew ,
-- ** newMergeId #method:newMergeId#
#if ENABLE_OVERLOADING
UIManagerNewMergeIdMethodInfo ,
#endif
uIManagerNewMergeId ,
-- ** removeActionGroup #method:removeActionGroup#
#if ENABLE_OVERLOADING
UIManagerRemoveActionGroupMethodInfo ,
#endif
uIManagerRemoveActionGroup ,
-- ** removeUi #method:removeUi#
#if ENABLE_OVERLOADING
UIManagerRemoveUiMethodInfo ,
#endif
uIManagerRemoveUi ,
-- ** setAddTearoffs #method:setAddTearoffs#
#if ENABLE_OVERLOADING
UIManagerSetAddTearoffsMethodInfo ,
#endif
uIManagerSetAddTearoffs ,
-- * Properties
-- ** addTearoffs #attr: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/
-}
#if ENABLE_OVERLOADING
UIManagerAddTearoffsPropertyInfo ,
#endif
constructUIManagerAddTearoffs ,
getUIManagerAddTearoffs ,
setUIManagerAddTearoffs ,
#if ENABLE_OVERLOADING
uIManagerAddTearoffs ,
#endif
-- ** ui #attr:ui#
{- | /No description available in the introspection data./
-}
#if ENABLE_OVERLOADING
UIManagerUiPropertyInfo ,
#endif
getUIManagerUi ,
#if ENABLE_OVERLOADING
uIManagerUi ,
#endif
-- * Signals
-- ** actionsChanged #signal:actionsChanged#
C_UIManagerActionsChangedCallback ,
UIManagerActionsChangedCallback ,
#if ENABLE_OVERLOADING
UIManagerActionsChangedSignalInfo ,
#endif
afterUIManagerActionsChanged ,
genClosure_UIManagerActionsChanged ,
mk_UIManagerActionsChangedCallback ,
noUIManagerActionsChangedCallback ,
onUIManagerActionsChanged ,
wrap_UIManagerActionsChangedCallback ,
-- ** addWidget #signal:addWidget#
C_UIManagerAddWidgetCallback ,
UIManagerAddWidgetCallback ,
#if ENABLE_OVERLOADING
UIManagerAddWidgetSignalInfo ,
#endif
afterUIManagerAddWidget ,
genClosure_UIManagerAddWidget ,
mk_UIManagerAddWidgetCallback ,
noUIManagerAddWidgetCallback ,
onUIManagerAddWidget ,
wrap_UIManagerAddWidgetCallback ,
-- ** connectProxy #signal:connectProxy#
C_UIManagerConnectProxyCallback ,
UIManagerConnectProxyCallback ,
#if ENABLE_OVERLOADING
UIManagerConnectProxySignalInfo ,
#endif
afterUIManagerConnectProxy ,
genClosure_UIManagerConnectProxy ,
mk_UIManagerConnectProxyCallback ,
noUIManagerConnectProxyCallback ,
onUIManagerConnectProxy ,
wrap_UIManagerConnectProxyCallback ,
-- ** disconnectProxy #signal:disconnectProxy#
C_UIManagerDisconnectProxyCallback ,
UIManagerDisconnectProxyCallback ,
#if ENABLE_OVERLOADING
UIManagerDisconnectProxySignalInfo ,
#endif
afterUIManagerDisconnectProxy ,
genClosure_UIManagerDisconnectProxy ,
mk_UIManagerDisconnectProxyCallback ,
noUIManagerDisconnectProxyCallback ,
onUIManagerDisconnectProxy ,
wrap_UIManagerDisconnectProxyCallback ,
-- ** postActivate #signal:postActivate#
C_UIManagerPostActivateCallback ,
UIManagerPostActivateCallback ,
#if ENABLE_OVERLOADING
UIManagerPostActivateSignalInfo ,
#endif
afterUIManagerPostActivate ,
genClosure_UIManagerPostActivate ,
mk_UIManagerPostActivateCallback ,
noUIManagerPostActivateCallback ,
onUIManagerPostActivate ,
wrap_UIManagerPostActivateCallback ,
-- ** preActivate #signal:preActivate#
C_UIManagerPreActivateCallback ,
UIManagerPreActivateCallback ,
#if ENABLE_OVERLOADING
UIManagerPreActivateSignalInfo ,
#endif
afterUIManagerPreActivate ,
genClosure_UIManagerPreActivate ,
mk_UIManagerPreActivateCallback ,
noUIManagerPreActivateCallback ,
onUIManagerPreActivate ,
wrap_UIManagerPreActivateCallback ,
) where
import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P
import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL
import qualified GI.GObject.Objects.Object as GObject.Object
import {-# SOURCE #-} qualified GI.Gtk.Flags as Gtk.Flags
import {-# SOURCE #-} qualified GI.Gtk.Interfaces.Buildable as Gtk.Buildable
import {-# SOURCE #-} qualified GI.Gtk.Objects.AccelGroup as Gtk.AccelGroup
import {-# SOURCE #-} qualified GI.Gtk.Objects.Action as Gtk.Action
import {-# SOURCE #-} qualified GI.Gtk.Objects.ActionGroup as Gtk.ActionGroup
import {-# SOURCE #-} qualified GI.Gtk.Objects.Widget as Gtk.Widget
-- | Memory-managed wrapper type.
newtype UIManager = UIManager (ManagedPtr UIManager)
foreign import ccall "gtk_ui_manager_get_type"
c_gtk_ui_manager_get_type :: IO GType
instance GObject UIManager where
gobjectType = c_gtk_ui_manager_get_type
-- | Type class for types which can be safely cast to `UIManager`, for instance with `toUIManager`.
class (GObject o, O.IsDescendantOf UIManager o) => IsUIManager o
instance (GObject o, O.IsDescendantOf UIManager o) => IsUIManager o
instance O.HasParentTypes UIManager
type instance O.ParentTypes UIManager = '[GObject.Object.Object, Gtk.Buildable.Buildable]
-- | Cast to `UIManager`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toUIManager :: (MonadIO m, IsUIManager o) => o -> m UIManager
toUIManager = liftIO . unsafeCastTo UIManager
-- | A convenience alias for `Nothing` :: `Maybe` `UIManager`.
noUIManager :: Maybe UIManager
noUIManager = Nothing
#if ENABLE_OVERLOADING
type family ResolveUIManagerMethod (t :: Symbol) (o :: *) :: * where
ResolveUIManagerMethod "addChild" o = Gtk.Buildable.BuildableAddChildMethodInfo
ResolveUIManagerMethod "addUi" o = UIManagerAddUiMethodInfo
ResolveUIManagerMethod "addUiFromFile" o = UIManagerAddUiFromFileMethodInfo
ResolveUIManagerMethod "addUiFromResource" o = UIManagerAddUiFromResourceMethodInfo
ResolveUIManagerMethod "addUiFromString" o = UIManagerAddUiFromStringMethodInfo
ResolveUIManagerMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
ResolveUIManagerMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
ResolveUIManagerMethod "constructChild" o = Gtk.Buildable.BuildableConstructChildMethodInfo
ResolveUIManagerMethod "customFinished" o = Gtk.Buildable.BuildableCustomFinishedMethodInfo
ResolveUIManagerMethod "customTagEnd" o = Gtk.Buildable.BuildableCustomTagEndMethodInfo
ResolveUIManagerMethod "customTagStart" o = Gtk.Buildable.BuildableCustomTagStartMethodInfo
ResolveUIManagerMethod "ensureUpdate" o = UIManagerEnsureUpdateMethodInfo
ResolveUIManagerMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
ResolveUIManagerMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
ResolveUIManagerMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
ResolveUIManagerMethod "insertActionGroup" o = UIManagerInsertActionGroupMethodInfo
ResolveUIManagerMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
ResolveUIManagerMethod "newMergeId" o = UIManagerNewMergeIdMethodInfo
ResolveUIManagerMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
ResolveUIManagerMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
ResolveUIManagerMethod "parserFinished" o = Gtk.Buildable.BuildableParserFinishedMethodInfo
ResolveUIManagerMethod "ref" o = GObject.Object.ObjectRefMethodInfo
ResolveUIManagerMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
ResolveUIManagerMethod "removeActionGroup" o = UIManagerRemoveActionGroupMethodInfo
ResolveUIManagerMethod "removeUi" o = UIManagerRemoveUiMethodInfo
ResolveUIManagerMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
ResolveUIManagerMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
ResolveUIManagerMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
ResolveUIManagerMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
ResolveUIManagerMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
ResolveUIManagerMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
ResolveUIManagerMethod "getAccelGroup" o = UIManagerGetAccelGroupMethodInfo
ResolveUIManagerMethod "getAction" o = UIManagerGetActionMethodInfo
ResolveUIManagerMethod "getActionGroups" o = UIManagerGetActionGroupsMethodInfo
ResolveUIManagerMethod "getAddTearoffs" o = UIManagerGetAddTearoffsMethodInfo
ResolveUIManagerMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
ResolveUIManagerMethod "getInternalChild" o = Gtk.Buildable.BuildableGetInternalChildMethodInfo
ResolveUIManagerMethod "getName" o = Gtk.Buildable.BuildableGetNameMethodInfo
ResolveUIManagerMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
ResolveUIManagerMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
ResolveUIManagerMethod "getToplevels" o = UIManagerGetToplevelsMethodInfo
ResolveUIManagerMethod "getUi" o = UIManagerGetUiMethodInfo
ResolveUIManagerMethod "getWidget" o = UIManagerGetWidgetMethodInfo
ResolveUIManagerMethod "setAddTearoffs" o = UIManagerSetAddTearoffsMethodInfo
ResolveUIManagerMethod "setBuildableProperty" o = Gtk.Buildable.BuildableSetBuildablePropertyMethodInfo
ResolveUIManagerMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
ResolveUIManagerMethod "setName" o = Gtk.Buildable.BuildableSetNameMethodInfo
ResolveUIManagerMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
ResolveUIManagerMethod l o = O.MethodResolutionFailed l o
instance (info ~ ResolveUIManagerMethod t UIManager, O.MethodInfo info UIManager p) => OL.IsLabel t (UIManager -> p) where
#if MIN_VERSION_base(4,10,0)
fromLabel = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#else
fromLabel _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#endif
#endif
-- signal UIManager::actions-changed
{-# DEPRECATED UIManagerActionsChangedCallback ["(Since version 3.10)"] #-}
{- |
The ::actions-changed signal is emitted whenever the set of actions
changes.
/Since: 2.4/
-}
type UIManagerActionsChangedCallback =
IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `UIManagerActionsChangedCallback`@.
noUIManagerActionsChangedCallback :: Maybe UIManagerActionsChangedCallback
noUIManagerActionsChangedCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_UIManagerActionsChangedCallback =
Ptr () -> -- object
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_UIManagerActionsChangedCallback`.
foreign import ccall "wrapper"
mk_UIManagerActionsChangedCallback :: C_UIManagerActionsChangedCallback -> IO (FunPtr C_UIManagerActionsChangedCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_UIManagerActionsChanged :: MonadIO m => UIManagerActionsChangedCallback -> m (GClosure C_UIManagerActionsChangedCallback)
genClosure_UIManagerActionsChanged cb = liftIO $ do
let cb' = wrap_UIManagerActionsChangedCallback cb
mk_UIManagerActionsChangedCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `UIManagerActionsChangedCallback` into a `C_UIManagerActionsChangedCallback`.
wrap_UIManagerActionsChangedCallback ::
UIManagerActionsChangedCallback ->
C_UIManagerActionsChangedCallback
wrap_UIManagerActionsChangedCallback _cb _ _ = do
_cb
{- |
Connect a signal handler for the “@actions-changed@” signal, to be run before the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' uIManager #actionsChanged callback
@
-}
onUIManagerActionsChanged :: (IsUIManager a, MonadIO m) => a -> UIManagerActionsChangedCallback -> m SignalHandlerId
onUIManagerActionsChanged obj cb = liftIO $ do
let cb' = wrap_UIManagerActionsChangedCallback cb
cb'' <- mk_UIManagerActionsChangedCallback cb'
connectSignalFunPtr obj "actions-changed" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@actions-changed@” signal, to be run after the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' uIManager #actionsChanged callback
@
-}
afterUIManagerActionsChanged :: (IsUIManager a, MonadIO m) => a -> UIManagerActionsChangedCallback -> m SignalHandlerId
afterUIManagerActionsChanged obj cb = liftIO $ do
let cb' = wrap_UIManagerActionsChangedCallback cb
cb'' <- mk_UIManagerActionsChangedCallback cb'
connectSignalFunPtr obj "actions-changed" cb'' SignalConnectAfter
-- signal UIManager::add-widget
{-# DEPRECATED UIManagerAddWidgetCallback ["(Since version 3.10)"] #-}
{- |
The ::add-widget signal is emitted for each generated menubar and toolbar.
It is not emitted for generated popup menus, which can be obtained by
'GI.Gtk.Objects.UIManager.uIManagerGetWidget'.
/Since: 2.4/
-}
type UIManagerAddWidgetCallback =
Gtk.Widget.Widget
{- ^ /@widget@/: the added widget -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `UIManagerAddWidgetCallback`@.
noUIManagerAddWidgetCallback :: Maybe UIManagerAddWidgetCallback
noUIManagerAddWidgetCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_UIManagerAddWidgetCallback =
Ptr () -> -- object
Ptr Gtk.Widget.Widget ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_UIManagerAddWidgetCallback`.
foreign import ccall "wrapper"
mk_UIManagerAddWidgetCallback :: C_UIManagerAddWidgetCallback -> IO (FunPtr C_UIManagerAddWidgetCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_UIManagerAddWidget :: MonadIO m => UIManagerAddWidgetCallback -> m (GClosure C_UIManagerAddWidgetCallback)
genClosure_UIManagerAddWidget cb = liftIO $ do
let cb' = wrap_UIManagerAddWidgetCallback cb
mk_UIManagerAddWidgetCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `UIManagerAddWidgetCallback` into a `C_UIManagerAddWidgetCallback`.
wrap_UIManagerAddWidgetCallback ::
UIManagerAddWidgetCallback ->
C_UIManagerAddWidgetCallback
wrap_UIManagerAddWidgetCallback _cb _ widget _ = do
widget' <- (newObject Gtk.Widget.Widget) widget
_cb widget'
{- |
Connect a signal handler for the “@add-widget@” signal, to be run before the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' uIManager #addWidget callback
@
-}
onUIManagerAddWidget :: (IsUIManager a, MonadIO m) => a -> UIManagerAddWidgetCallback -> m SignalHandlerId
onUIManagerAddWidget obj cb = liftIO $ do
let cb' = wrap_UIManagerAddWidgetCallback cb
cb'' <- mk_UIManagerAddWidgetCallback cb'
connectSignalFunPtr obj "add-widget" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@add-widget@” signal, to be run after the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' uIManager #addWidget callback
@
-}
afterUIManagerAddWidget :: (IsUIManager a, MonadIO m) => a -> UIManagerAddWidgetCallback -> m SignalHandlerId
afterUIManagerAddWidget obj cb = liftIO $ do
let cb' = wrap_UIManagerAddWidgetCallback cb
cb'' <- mk_UIManagerAddWidgetCallback cb'
connectSignalFunPtr obj "add-widget" cb'' SignalConnectAfter
-- signal UIManager::connect-proxy
{-# DEPRECATED UIManagerConnectProxyCallback ["(Since version 3.10)"] #-}
{- |
The ::connect-proxy 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/
-}
type UIManagerConnectProxyCallback =
Gtk.Action.Action
{- ^ /@action@/: the action -}
-> Gtk.Widget.Widget
{- ^ /@proxy@/: the proxy -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `UIManagerConnectProxyCallback`@.
noUIManagerConnectProxyCallback :: Maybe UIManagerConnectProxyCallback
noUIManagerConnectProxyCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_UIManagerConnectProxyCallback =
Ptr () -> -- object
Ptr Gtk.Action.Action ->
Ptr Gtk.Widget.Widget ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_UIManagerConnectProxyCallback`.
foreign import ccall "wrapper"
mk_UIManagerConnectProxyCallback :: C_UIManagerConnectProxyCallback -> IO (FunPtr C_UIManagerConnectProxyCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_UIManagerConnectProxy :: MonadIO m => UIManagerConnectProxyCallback -> m (GClosure C_UIManagerConnectProxyCallback)
genClosure_UIManagerConnectProxy cb = liftIO $ do
let cb' = wrap_UIManagerConnectProxyCallback cb
mk_UIManagerConnectProxyCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `UIManagerConnectProxyCallback` into a `C_UIManagerConnectProxyCallback`.
wrap_UIManagerConnectProxyCallback ::
UIManagerConnectProxyCallback ->
C_UIManagerConnectProxyCallback
wrap_UIManagerConnectProxyCallback _cb _ action proxy _ = do
action' <- (newObject Gtk.Action.Action) action
proxy' <- (newObject Gtk.Widget.Widget) proxy
_cb action' proxy'
{- |
Connect a signal handler for the “@connect-proxy@” signal, to be run before the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' uIManager #connectProxy callback
@
-}
onUIManagerConnectProxy :: (IsUIManager a, MonadIO m) => a -> UIManagerConnectProxyCallback -> m SignalHandlerId
onUIManagerConnectProxy obj cb = liftIO $ do
let cb' = wrap_UIManagerConnectProxyCallback cb
cb'' <- mk_UIManagerConnectProxyCallback cb'
connectSignalFunPtr obj "connect-proxy" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@connect-proxy@” signal, to be run after the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' uIManager #connectProxy callback
@
-}
afterUIManagerConnectProxy :: (IsUIManager a, MonadIO m) => a -> UIManagerConnectProxyCallback -> m SignalHandlerId
afterUIManagerConnectProxy obj cb = liftIO $ do
let cb' = wrap_UIManagerConnectProxyCallback cb
cb'' <- mk_UIManagerConnectProxyCallback cb'
connectSignalFunPtr obj "connect-proxy" cb'' SignalConnectAfter
-- signal UIManager::disconnect-proxy
{-# DEPRECATED UIManagerDisconnectProxyCallback ["(Since version 3.10)"] #-}
{- |
The ::disconnect-proxy signal is emitted after disconnecting a proxy
from an action in the group.
/Since: 2.4/
-}
type UIManagerDisconnectProxyCallback =
Gtk.Action.Action
{- ^ /@action@/: the action -}
-> Gtk.Widget.Widget
{- ^ /@proxy@/: the proxy -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `UIManagerDisconnectProxyCallback`@.
noUIManagerDisconnectProxyCallback :: Maybe UIManagerDisconnectProxyCallback
noUIManagerDisconnectProxyCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_UIManagerDisconnectProxyCallback =
Ptr () -> -- object
Ptr Gtk.Action.Action ->
Ptr Gtk.Widget.Widget ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_UIManagerDisconnectProxyCallback`.
foreign import ccall "wrapper"
mk_UIManagerDisconnectProxyCallback :: C_UIManagerDisconnectProxyCallback -> IO (FunPtr C_UIManagerDisconnectProxyCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_UIManagerDisconnectProxy :: MonadIO m => UIManagerDisconnectProxyCallback -> m (GClosure C_UIManagerDisconnectProxyCallback)
genClosure_UIManagerDisconnectProxy cb = liftIO $ do
let cb' = wrap_UIManagerDisconnectProxyCallback cb
mk_UIManagerDisconnectProxyCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `UIManagerDisconnectProxyCallback` into a `C_UIManagerDisconnectProxyCallback`.
wrap_UIManagerDisconnectProxyCallback ::
UIManagerDisconnectProxyCallback ->
C_UIManagerDisconnectProxyCallback
wrap_UIManagerDisconnectProxyCallback _cb _ action proxy _ = do
action' <- (newObject Gtk.Action.Action) action
proxy' <- (newObject Gtk.Widget.Widget) proxy
_cb action' proxy'
{- |
Connect a signal handler for the “@disconnect-proxy@” signal, to be run before the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' uIManager #disconnectProxy callback
@
-}
onUIManagerDisconnectProxy :: (IsUIManager a, MonadIO m) => a -> UIManagerDisconnectProxyCallback -> m SignalHandlerId
onUIManagerDisconnectProxy obj cb = liftIO $ do
let cb' = wrap_UIManagerDisconnectProxyCallback cb
cb'' <- mk_UIManagerDisconnectProxyCallback cb'
connectSignalFunPtr obj "disconnect-proxy" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@disconnect-proxy@” signal, to be run after the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' uIManager #disconnectProxy callback
@
-}
afterUIManagerDisconnectProxy :: (IsUIManager a, MonadIO m) => a -> UIManagerDisconnectProxyCallback -> m SignalHandlerId
afterUIManagerDisconnectProxy obj cb = liftIO $ do
let cb' = wrap_UIManagerDisconnectProxyCallback cb
cb'' <- mk_UIManagerDisconnectProxyCallback cb'
connectSignalFunPtr obj "disconnect-proxy" cb'' SignalConnectAfter
-- signal UIManager::post-activate
{-# DEPRECATED UIManagerPostActivateCallback ["(Since version 3.10)"] #-}
{- |
The ::post-activate 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/
-}
type UIManagerPostActivateCallback =
Gtk.Action.Action
{- ^ /@action@/: the action -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `UIManagerPostActivateCallback`@.
noUIManagerPostActivateCallback :: Maybe UIManagerPostActivateCallback
noUIManagerPostActivateCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_UIManagerPostActivateCallback =
Ptr () -> -- object
Ptr Gtk.Action.Action ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_UIManagerPostActivateCallback`.
foreign import ccall "wrapper"
mk_UIManagerPostActivateCallback :: C_UIManagerPostActivateCallback -> IO (FunPtr C_UIManagerPostActivateCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_UIManagerPostActivate :: MonadIO m => UIManagerPostActivateCallback -> m (GClosure C_UIManagerPostActivateCallback)
genClosure_UIManagerPostActivate cb = liftIO $ do
let cb' = wrap_UIManagerPostActivateCallback cb
mk_UIManagerPostActivateCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `UIManagerPostActivateCallback` into a `C_UIManagerPostActivateCallback`.
wrap_UIManagerPostActivateCallback ::
UIManagerPostActivateCallback ->
C_UIManagerPostActivateCallback
wrap_UIManagerPostActivateCallback _cb _ action _ = do
action' <- (newObject Gtk.Action.Action) action
_cb action'
{- |
Connect a signal handler for the “@post-activate@” signal, to be run before the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' uIManager #postActivate callback
@
-}
onUIManagerPostActivate :: (IsUIManager a, MonadIO m) => a -> UIManagerPostActivateCallback -> m SignalHandlerId
onUIManagerPostActivate obj cb = liftIO $ do
let cb' = wrap_UIManagerPostActivateCallback cb
cb'' <- mk_UIManagerPostActivateCallback cb'
connectSignalFunPtr obj "post-activate" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@post-activate@” signal, to be run after the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' uIManager #postActivate callback
@
-}
afterUIManagerPostActivate :: (IsUIManager a, MonadIO m) => a -> UIManagerPostActivateCallback -> m SignalHandlerId
afterUIManagerPostActivate obj cb = liftIO $ do
let cb' = wrap_UIManagerPostActivateCallback cb
cb'' <- mk_UIManagerPostActivateCallback cb'
connectSignalFunPtr obj "post-activate" cb'' SignalConnectAfter
-- signal UIManager::pre-activate
{-# DEPRECATED UIManagerPreActivateCallback ["(Since version 3.10)"] #-}
{- |
The ::pre-activate 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/
-}
type UIManagerPreActivateCallback =
Gtk.Action.Action
{- ^ /@action@/: the action -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `UIManagerPreActivateCallback`@.
noUIManagerPreActivateCallback :: Maybe UIManagerPreActivateCallback
noUIManagerPreActivateCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_UIManagerPreActivateCallback =
Ptr () -> -- object
Ptr Gtk.Action.Action ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_UIManagerPreActivateCallback`.
foreign import ccall "wrapper"
mk_UIManagerPreActivateCallback :: C_UIManagerPreActivateCallback -> IO (FunPtr C_UIManagerPreActivateCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_UIManagerPreActivate :: MonadIO m => UIManagerPreActivateCallback -> m (GClosure C_UIManagerPreActivateCallback)
genClosure_UIManagerPreActivate cb = liftIO $ do
let cb' = wrap_UIManagerPreActivateCallback cb
mk_UIManagerPreActivateCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `UIManagerPreActivateCallback` into a `C_UIManagerPreActivateCallback`.
wrap_UIManagerPreActivateCallback ::
UIManagerPreActivateCallback ->
C_UIManagerPreActivateCallback
wrap_UIManagerPreActivateCallback _cb _ action _ = do
action' <- (newObject Gtk.Action.Action) action
_cb action'
{- |
Connect a signal handler for the “@pre-activate@” signal, to be run before the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' uIManager #preActivate callback
@
-}
onUIManagerPreActivate :: (IsUIManager a, MonadIO m) => a -> UIManagerPreActivateCallback -> m SignalHandlerId
onUIManagerPreActivate obj cb = liftIO $ do
let cb' = wrap_UIManagerPreActivateCallback cb
cb'' <- mk_UIManagerPreActivateCallback cb'
connectSignalFunPtr obj "pre-activate" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@pre-activate@” signal, to be run after the default handler.
When is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' uIManager #preActivate callback
@
-}
afterUIManagerPreActivate :: (IsUIManager a, MonadIO m) => a -> UIManagerPreActivateCallback -> m SignalHandlerId
afterUIManagerPreActivate obj cb = liftIO $ do
let cb' = wrap_UIManagerPreActivateCallback cb
cb'' <- mk_UIManagerPreActivateCallback cb'
connectSignalFunPtr obj "pre-activate" cb'' SignalConnectAfter
-- VVV Prop "add-tearoffs"
-- Type: TBasicType TBoolean
-- Flags: [PropertyReadable,PropertyWritable]
-- Nullable: (Just False,Just False)
{- |
Get the value of the “@add-tearoffs@” property.
When is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' uIManager #addTearoffs
@
-}
getUIManagerAddTearoffs :: (MonadIO m, IsUIManager o) => o -> m Bool
getUIManagerAddTearoffs obj = liftIO $ B.Properties.getObjectPropertyBool obj "add-tearoffs"
{- |
Set the value of the “@add-tearoffs@” property.
When is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.set' uIManager [ #addTearoffs 'Data.GI.Base.Attributes.:=' value ]
@
-}
setUIManagerAddTearoffs :: (MonadIO m, IsUIManager o) => o -> Bool -> m ()
setUIManagerAddTearoffs obj val = liftIO $ B.Properties.setObjectPropertyBool obj "add-tearoffs" val
{- |
Construct a `GValueConstruct` with valid value for the “@add-tearoffs@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
-}
constructUIManagerAddTearoffs :: (IsUIManager o) => Bool -> IO (GValueConstruct o)
constructUIManagerAddTearoffs val = B.Properties.constructObjectPropertyBool "add-tearoffs" val
#if ENABLE_OVERLOADING
data UIManagerAddTearoffsPropertyInfo
instance AttrInfo UIManagerAddTearoffsPropertyInfo where
type AttrAllowedOps UIManagerAddTearoffsPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet]
type AttrSetTypeConstraint UIManagerAddTearoffsPropertyInfo = (~) Bool
type AttrBaseTypeConstraint UIManagerAddTearoffsPropertyInfo = IsUIManager
type AttrGetType UIManagerAddTearoffsPropertyInfo = Bool
type AttrLabel UIManagerAddTearoffsPropertyInfo = "add-tearoffs"
type AttrOrigin UIManagerAddTearoffsPropertyInfo = UIManager
attrGet _ = getUIManagerAddTearoffs
attrSet _ = setUIManagerAddTearoffs
attrConstruct _ = constructUIManagerAddTearoffs
attrClear _ = undefined
#endif
-- VVV Prop "ui"
-- Type: TBasicType TUTF8
-- Flags: [PropertyReadable]
-- Nullable: (Nothing,Nothing)
{- |
Get the value of the “@ui@” property.
When is enabled, this is equivalent to
@
'Data.GI.Base.Attributes.get' uIManager #ui
@
-}
getUIManagerUi :: (MonadIO m, IsUIManager o) => o -> m (Maybe T.Text)
getUIManagerUi obj = liftIO $ B.Properties.getObjectPropertyString obj "ui"
#if ENABLE_OVERLOADING
data UIManagerUiPropertyInfo
instance AttrInfo UIManagerUiPropertyInfo where
type AttrAllowedOps UIManagerUiPropertyInfo = '[ 'AttrGet, 'AttrClear]
type AttrSetTypeConstraint UIManagerUiPropertyInfo = (~) ()
type AttrBaseTypeConstraint UIManagerUiPropertyInfo = IsUIManager
type AttrGetType UIManagerUiPropertyInfo = (Maybe T.Text)
type AttrLabel UIManagerUiPropertyInfo = "ui"
type AttrOrigin UIManagerUiPropertyInfo = UIManager
attrGet _ = getUIManagerUi
attrSet _ = undefined
attrConstruct _ = undefined
attrClear _ = undefined
#endif
#if ENABLE_OVERLOADING
instance O.HasAttributeList UIManager
type instance O.AttributeList UIManager = UIManagerAttributeList
type UIManagerAttributeList = ('[ '("addTearoffs", UIManagerAddTearoffsPropertyInfo), '("ui", UIManagerUiPropertyInfo)] :: [(Symbol, *)])
#endif
#if ENABLE_OVERLOADING
uIManagerAddTearoffs :: AttrLabelProxy "addTearoffs"
uIManagerAddTearoffs = AttrLabelProxy
uIManagerUi :: AttrLabelProxy "ui"
uIManagerUi = AttrLabelProxy
#endif
#if ENABLE_OVERLOADING
data UIManagerActionsChangedSignalInfo
instance SignalInfo UIManagerActionsChangedSignalInfo where
type HaskellCallbackType UIManagerActionsChangedSignalInfo = UIManagerActionsChangedCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_UIManagerActionsChangedCallback cb
cb'' <- mk_UIManagerActionsChangedCallback cb'
connectSignalFunPtr obj "actions-changed" cb'' connectMode
data UIManagerAddWidgetSignalInfo
instance SignalInfo UIManagerAddWidgetSignalInfo where
type HaskellCallbackType UIManagerAddWidgetSignalInfo = UIManagerAddWidgetCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_UIManagerAddWidgetCallback cb
cb'' <- mk_UIManagerAddWidgetCallback cb'
connectSignalFunPtr obj "add-widget" cb'' connectMode
data UIManagerConnectProxySignalInfo
instance SignalInfo UIManagerConnectProxySignalInfo where
type HaskellCallbackType UIManagerConnectProxySignalInfo = UIManagerConnectProxyCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_UIManagerConnectProxyCallback cb
cb'' <- mk_UIManagerConnectProxyCallback cb'
connectSignalFunPtr obj "connect-proxy" cb'' connectMode
data UIManagerDisconnectProxySignalInfo
instance SignalInfo UIManagerDisconnectProxySignalInfo where
type HaskellCallbackType UIManagerDisconnectProxySignalInfo = UIManagerDisconnectProxyCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_UIManagerDisconnectProxyCallback cb
cb'' <- mk_UIManagerDisconnectProxyCallback cb'
connectSignalFunPtr obj "disconnect-proxy" cb'' connectMode
data UIManagerPostActivateSignalInfo
instance SignalInfo UIManagerPostActivateSignalInfo where
type HaskellCallbackType UIManagerPostActivateSignalInfo = UIManagerPostActivateCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_UIManagerPostActivateCallback cb
cb'' <- mk_UIManagerPostActivateCallback cb'
connectSignalFunPtr obj "post-activate" cb'' connectMode
data UIManagerPreActivateSignalInfo
instance SignalInfo UIManagerPreActivateSignalInfo where
type HaskellCallbackType UIManagerPreActivateSignalInfo = UIManagerPreActivateCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_UIManagerPreActivateCallback cb
cb'' <- mk_UIManagerPreActivateCallback cb'
connectSignalFunPtr obj "pre-activate" cb'' connectMode
type instance O.SignalList UIManager = UIManagerSignalList
type UIManagerSignalList = ('[ '("actionsChanged", UIManagerActionsChangedSignalInfo), '("addWidget", UIManagerAddWidgetSignalInfo), '("connectProxy", UIManagerConnectProxySignalInfo), '("disconnectProxy", UIManagerDisconnectProxySignalInfo), '("notify", GObject.Object.ObjectNotifySignalInfo), '("postActivate", UIManagerPostActivateSignalInfo), '("preActivate", UIManagerPreActivateSignalInfo)] :: [(Symbol, *)])
#endif
-- method UIManager::new
-- method type : Constructor
-- Args : []
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "UIManager"}))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_new" gtk_ui_manager_new ::
IO (Ptr UIManager)
{-# DEPRECATED uIManagerNew ["(Since version 3.10)"] #-}
{- |
Creates a new ui manager object.
/Since: 2.4/
-}
uIManagerNew ::
(B.CallStack.HasCallStack, MonadIO m) =>
m UIManager
{- ^ __Returns:__ a new ui manager object. -}
uIManagerNew = liftIO $ do
result <- gtk_ui_manager_new
checkUnexpectedReturnNULL "uIManagerNew" result
result' <- (wrapObject UIManager) result
return result'
#if ENABLE_OVERLOADING
#endif
-- method UIManager::add_ui
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "merge_id", argType = TBasicType TUInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the merge id for the merged UI, see gtk_ui_manager_new_merge_id()", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "path", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a path", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the name for the added UI element", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "action", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "the name of the action to be proxied, or %NULL to add a separator", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "type", argType = TInterface (Name {namespace = "Gtk", name = "UIManagerItemType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the type of UI element to add.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "top", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "if %TRUE, the UI element is added before its siblings, otherwise it\n is added after its siblings.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_add_ui" gtk_ui_manager_add_ui ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
Word32 -> -- merge_id : TBasicType TUInt
CString -> -- path : TBasicType TUTF8
CString -> -- name : TBasicType TUTF8
CString -> -- action : TBasicType TUTF8
CUInt -> -- type : TInterface (Name {namespace = "Gtk", name = "UIManagerItemType"})
CInt -> -- top : TBasicType TBoolean
IO ()
{-# DEPRECATED uIManagerAddUi ["(Since version 3.10)"] #-}
{- |
Adds a UI element to the current contents of /@manager@/.
If /@type@/ is 'GI.Gtk.Flags.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/
-}
uIManagerAddUi ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> Word32
{- ^ /@mergeId@/: the merge id for the merged UI, see 'GI.Gtk.Objects.UIManager.uIManagerNewMergeId' -}
-> T.Text
{- ^ /@path@/: a path -}
-> T.Text
{- ^ /@name@/: the name for the added UI element -}
-> Maybe (T.Text)
{- ^ /@action@/: the name of the action to be proxied, or 'Nothing' to add a separator -}
-> [Gtk.Flags.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 ()
uIManagerAddUi manager mergeId path name action type_ top = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
path' <- textToCString path
name' <- textToCString name
maybeAction <- case action of
Nothing -> return nullPtr
Just jAction -> do
jAction' <- textToCString jAction
return jAction'
let type_' = gflagsToWord type_
let top' = (fromIntegral . fromEnum) top
gtk_ui_manager_add_ui manager' mergeId path' name' maybeAction type_' top'
touchManagedPtr manager
freeMem path'
freeMem name'
freeMem maybeAction
return ()
#if ENABLE_OVERLOADING
data UIManagerAddUiMethodInfo
instance (signature ~ (Word32 -> T.Text -> T.Text -> Maybe (T.Text) -> [Gtk.Flags.UIManagerItemType] -> Bool -> m ()), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerAddUiMethodInfo a signature where
overloadedMethod _ = uIManagerAddUi
#endif
-- method UIManager::add_ui_from_file
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "filename", argType = TBasicType TFileName, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the name of the file to parse", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : True
-- Skip return : False
foreign import ccall "gtk_ui_manager_add_ui_from_file" gtk_ui_manager_add_ui_from_file ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CString -> -- filename : TBasicType TFileName
Ptr (Ptr GError) -> -- error
IO Word32
{-# DEPRECATED uIManagerAddUiFromFile ["(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/
-}
uIManagerAddUiFromFile ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.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 'GI.Gtk.Objects.UIManager.uIManagerRemoveUi'. If an error occurred,
the return value is 0. /(Can throw 'Data.GI.Base.GError.GError')/ -}
uIManagerAddUiFromFile manager filename = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
filename' <- stringToCString filename
onException (do
result <- propagateGError $ gtk_ui_manager_add_ui_from_file manager' filename'
touchManagedPtr manager
freeMem filename'
return result
) (do
freeMem filename'
)
#if ENABLE_OVERLOADING
data UIManagerAddUiFromFileMethodInfo
instance (signature ~ ([Char] -> m Word32), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerAddUiFromFileMethodInfo a signature where
overloadedMethod _ = uIManagerAddUiFromFile
#endif
-- method UIManager::add_ui_from_resource
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "resource_path", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the resource path of the file to parse", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : True
-- Skip return : False
foreign import ccall "gtk_ui_manager_add_ui_from_resource" gtk_ui_manager_add_ui_from_resource ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CString -> -- resource_path : TBasicType TUTF8
Ptr (Ptr GError) -> -- error
IO Word32
{-# DEPRECATED uIManagerAddUiFromResource ["(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/
-}
uIManagerAddUiFromResource ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> T.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 'GI.Gtk.Objects.UIManager.uIManagerRemoveUi'. If an error occurred,
the return value is 0. /(Can throw 'Data.GI.Base.GError.GError')/ -}
uIManagerAddUiFromResource manager resourcePath = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
resourcePath' <- textToCString resourcePath
onException (do
result <- propagateGError $ gtk_ui_manager_add_ui_from_resource manager' resourcePath'
touchManagedPtr manager
freeMem resourcePath'
return result
) (do
freeMem resourcePath'
)
#if ENABLE_OVERLOADING
data UIManagerAddUiFromResourceMethodInfo
instance (signature ~ (T.Text -> m Word32), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerAddUiFromResourceMethodInfo a signature where
overloadedMethod _ = uIManagerAddUiFromResource
#endif
-- method UIManager::add_ui_from_string
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "buffer", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the string to parse", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "length", argType = TBasicType TInt64, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the length of @buffer (may be -1 if @buffer is nul-terminated)", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : True
-- Skip return : False
foreign import ccall "gtk_ui_manager_add_ui_from_string" gtk_ui_manager_add_ui_from_string ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CString -> -- buffer : TBasicType TUTF8
Int64 -> -- length : TBasicType TInt64
Ptr (Ptr GError) -> -- error
IO Word32
{-# DEPRECATED uIManagerAddUiFromString ["(Since version 3.10)"] #-}
{- |
Parses a string containing a [UI definition][XML-UI] and merges it with
the current contents of /@manager@/. An enclosing \ element is added if
it is missing.
/Since: 2.4/
-}
uIManagerAddUiFromString ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> T.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 'GI.Gtk.Objects.UIManager.uIManagerRemoveUi'. If an error occurred,
the return value is 0. /(Can throw 'Data.GI.Base.GError.GError')/ -}
uIManagerAddUiFromString manager buffer length_ = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
buffer' <- textToCString buffer
onException (do
result <- propagateGError $ gtk_ui_manager_add_ui_from_string manager' buffer' length_
touchManagedPtr manager
freeMem buffer'
return result
) (do
freeMem buffer'
)
#if ENABLE_OVERLOADING
data UIManagerAddUiFromStringMethodInfo
instance (signature ~ (T.Text -> Int64 -> m Word32), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerAddUiFromStringMethodInfo a signature where
overloadedMethod _ = uIManagerAddUiFromString
#endif
-- method UIManager::ensure_update
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_ensure_update" gtk_ui_manager_ensure_update ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
IO ()
{-# DEPRECATED uIManagerEnsureUpdate ["(Since version 3.10)"] #-}
{- |
Makes sure that all pending updates to the UI have been completed.
This may occasionally be necessary, since 'GI.Gtk.Objects.UIManager.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/
-}
uIManagerEnsureUpdate ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> m ()
uIManagerEnsureUpdate manager = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
gtk_ui_manager_ensure_update manager'
touchManagedPtr manager
return ()
#if ENABLE_OVERLOADING
data UIManagerEnsureUpdateMethodInfo
instance (signature ~ (m ()), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerEnsureUpdateMethodInfo a signature where
overloadedMethod _ = uIManagerEnsureUpdate
#endif
-- method UIManager::get_accel_group
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "AccelGroup"}))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_accel_group" gtk_ui_manager_get_accel_group ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
IO (Ptr Gtk.AccelGroup.AccelGroup)
{-# DEPRECATED uIManagerGetAccelGroup ["(Since version 3.10)"] #-}
{- |
Returns the 'GI.Gtk.Objects.AccelGroup.AccelGroup' associated with /@manager@/.
/Since: 2.4/
-}
uIManagerGetAccelGroup ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> m Gtk.AccelGroup.AccelGroup
{- ^ __Returns:__ the 'GI.Gtk.Objects.AccelGroup.AccelGroup'. -}
uIManagerGetAccelGroup manager = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
result <- gtk_ui_manager_get_accel_group manager'
checkUnexpectedReturnNULL "uIManagerGetAccelGroup" result
result' <- (newObject Gtk.AccelGroup.AccelGroup) result
touchManagedPtr manager
return result'
#if ENABLE_OVERLOADING
data UIManagerGetAccelGroupMethodInfo
instance (signature ~ (m Gtk.AccelGroup.AccelGroup), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetAccelGroupMethodInfo a signature where
overloadedMethod _ = uIManagerGetAccelGroup
#endif
-- method UIManager::get_action
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "path", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a path", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "Action"}))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_action" gtk_ui_manager_get_action ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CString -> -- path : TBasicType TUTF8
IO (Ptr Gtk.Action.Action)
{-# DEPRECATED uIManagerGetAction ["(Since version 3.10)"] #-}
{- |
Looks up an action by following a path. See 'GI.Gtk.Objects.UIManager.uIManagerGetWidget'
for more information about paths.
/Since: 2.4/
-}
uIManagerGetAction ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> T.Text
{- ^ /@path@/: a path -}
-> m (Maybe Gtk.Action.Action)
{- ^ __Returns:__ the action whose proxy widget is found by following the path,
or 'Nothing' if no widget was found. -}
uIManagerGetAction manager path = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
path' <- textToCString path
result <- gtk_ui_manager_get_action manager' path'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (newObject Gtk.Action.Action) result'
return result''
touchManagedPtr manager
freeMem path'
return maybeResult
#if ENABLE_OVERLOADING
data UIManagerGetActionMethodInfo
instance (signature ~ (T.Text -> m (Maybe Gtk.Action.Action)), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetActionMethodInfo a signature where
overloadedMethod _ = uIManagerGetAction
#endif
-- method UIManager::get_action_groups
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TGList (TInterface (Name {namespace = "Gtk", name = "ActionGroup"})))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_action_groups" gtk_ui_manager_get_action_groups ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
IO (Ptr (GList (Ptr Gtk.ActionGroup.ActionGroup)))
{-# DEPRECATED uIManagerGetActionGroups ["(Since version 3.10)"] #-}
{- |
Returns the list of action groups associated with /@manager@/.
/Since: 2.4/
-}
uIManagerGetActionGroups ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> m [Gtk.ActionGroup.ActionGroup]
{- ^ __Returns:__ a 'GI.GLib.Structs.List.List' of
action groups. The list is owned by GTK+
and should not be modified. -}
uIManagerGetActionGroups manager = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
result <- gtk_ui_manager_get_action_groups manager'
result' <- unpackGList result
result'' <- mapM (newObject Gtk.ActionGroup.ActionGroup) result'
touchManagedPtr manager
return result''
#if ENABLE_OVERLOADING
data UIManagerGetActionGroupsMethodInfo
instance (signature ~ (m [Gtk.ActionGroup.ActionGroup]), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetActionGroupsMethodInfo a signature where
overloadedMethod _ = uIManagerGetActionGroups
#endif
-- method UIManager::get_add_tearoffs
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_add_tearoffs" gtk_ui_manager_get_add_tearoffs ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
IO CInt
{-# DEPRECATED uIManagerGetAddTearoffs ["(Since version 3.4)","Tearoff menus are deprecated and should not"," be used in newly written code."] #-}
{- |
Returns whether menus generated by this 'GI.Gtk.Objects.UIManager.UIManager'
will have tearoff menu items.
/Since: 2.4/
-}
uIManagerGetAddTearoffs ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> m Bool
{- ^ __Returns:__ whether tearoff menu items are added -}
uIManagerGetAddTearoffs manager = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
result <- gtk_ui_manager_get_add_tearoffs manager'
let result' = (/= 0) result
touchManagedPtr manager
return result'
#if ENABLE_OVERLOADING
data UIManagerGetAddTearoffsMethodInfo
instance (signature ~ (m Bool), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetAddTearoffsMethodInfo a signature where
overloadedMethod _ = uIManagerGetAddTearoffs
#endif
-- method UIManager::get_toplevels
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "types", argType = TInterface (Name {namespace = "Gtk", name = "UIManagerItemType"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "specifies the types of toplevel widgets to include. Allowed\n types are #GTK_UI_MANAGER_MENUBAR, #GTK_UI_MANAGER_TOOLBAR and\n #GTK_UI_MANAGER_POPUP.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TGSList (TInterface (Name {namespace = "Gtk", name = "Widget"})))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_toplevels" gtk_ui_manager_get_toplevels ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CUInt -> -- types : TInterface (Name {namespace = "Gtk", name = "UIManagerItemType"})
IO (Ptr (GSList (Ptr Gtk.Widget.Widget)))
{-# DEPRECATED uIManagerGetToplevels ["(Since version 3.10)"] #-}
{- |
Obtains a list of all toplevel widgets of the requested types.
/Since: 2.4/
-}
uIManagerGetToplevels ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> [Gtk.Flags.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 [Gtk.Widget.Widget]
{- ^ __Returns:__ a newly-allocated 'GI.GLib.Structs.SList.SList' of
all toplevel widgets of the requested types. Free the returned list with @/g_slist_free()/@. -}
uIManagerGetToplevels manager types = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
let types' = gflagsToWord types
result <- gtk_ui_manager_get_toplevels manager' types'
result' <- unpackGSList result
result'' <- mapM (newObject Gtk.Widget.Widget) result'
g_slist_free result
touchManagedPtr manager
return result''
#if ENABLE_OVERLOADING
data UIManagerGetToplevelsMethodInfo
instance (signature ~ ([Gtk.Flags.UIManagerItemType] -> m [Gtk.Widget.Widget]), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetToplevelsMethodInfo a signature where
overloadedMethod _ = uIManagerGetToplevels
#endif
-- method UIManager::get_ui
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_ui" gtk_ui_manager_get_ui ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
IO CString
{-# DEPRECATED uIManagerGetUi ["(Since version 3.10)"] #-}
{- |
Creates a [UI definition][XML-UI] of the merged UI.
/Since: 2.4/
-}
uIManagerGetUi ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> m T.Text
{- ^ __Returns:__ A newly allocated string containing an XML representation of
the merged UI. -}
uIManagerGetUi manager = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
result <- gtk_ui_manager_get_ui manager'
checkUnexpectedReturnNULL "uIManagerGetUi" result
result' <- cstringToText result
freeMem result
touchManagedPtr manager
return result'
#if ENABLE_OVERLOADING
data UIManagerGetUiMethodInfo
instance (signature ~ (m T.Text), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetUiMethodInfo a signature where
overloadedMethod _ = uIManagerGetUi
#endif
-- method UIManager::get_widget
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "path", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a path", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "Widget"}))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_get_widget" gtk_ui_manager_get_widget ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CString -> -- path : TBasicType TUTF8
IO (Ptr Gtk.Widget.Widget)
{-# DEPRECATED uIManagerGetWidget ["(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. \) 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 \;
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/
-}
uIManagerGetWidget ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> T.Text
{- ^ /@path@/: a path -}
-> m (Maybe Gtk.Widget.Widget)
{- ^ __Returns:__ the widget found by following the path,
or 'Nothing' if no widget was found -}
uIManagerGetWidget manager path = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
path' <- textToCString path
result <- gtk_ui_manager_get_widget manager' path'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (newObject Gtk.Widget.Widget) result'
return result''
touchManagedPtr manager
freeMem path'
return maybeResult
#if ENABLE_OVERLOADING
data UIManagerGetWidgetMethodInfo
instance (signature ~ (T.Text -> m (Maybe Gtk.Widget.Widget)), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerGetWidgetMethodInfo a signature where
overloadedMethod _ = uIManagerGetWidget
#endif
-- method UIManager::insert_action_group
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "action_group", argType = TInterface (Name {namespace = "Gtk", name = "ActionGroup"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the action group to be inserted", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "pos", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the position at which the group will be inserted.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_insert_action_group" gtk_ui_manager_insert_action_group ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
Ptr Gtk.ActionGroup.ActionGroup -> -- action_group : TInterface (Name {namespace = "Gtk", name = "ActionGroup"})
Int32 -> -- pos : TBasicType TInt
IO ()
{-# DEPRECATED uIManagerInsertActionGroup ["(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/
-}
uIManagerInsertActionGroup ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a, Gtk.ActionGroup.IsActionGroup b) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> b
{- ^ /@actionGroup@/: the action group to be inserted -}
-> Int32
{- ^ /@pos@/: the position at which the group will be inserted. -}
-> m ()
uIManagerInsertActionGroup manager actionGroup pos = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
actionGroup' <- unsafeManagedPtrCastPtr actionGroup
gtk_ui_manager_insert_action_group manager' actionGroup' pos
touchManagedPtr manager
touchManagedPtr actionGroup
return ()
#if ENABLE_OVERLOADING
data UIManagerInsertActionGroupMethodInfo
instance (signature ~ (b -> Int32 -> m ()), MonadIO m, IsUIManager a, Gtk.ActionGroup.IsActionGroup b) => O.MethodInfo UIManagerInsertActionGroupMethodInfo a signature where
overloadedMethod _ = uIManagerInsertActionGroup
#endif
-- method UIManager::new_merge_id
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_new_merge_id" gtk_ui_manager_new_merge_id ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
IO Word32
{-# DEPRECATED uIManagerNewMergeId ["(Since version 3.10)"] #-}
{- |
Returns an unused merge id, suitable for use with
'GI.Gtk.Objects.UIManager.uIManagerAddUi'.
/Since: 2.4/
-}
uIManagerNewMergeId ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> m Word32
{- ^ __Returns:__ an unused merge id. -}
uIManagerNewMergeId manager = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
result <- gtk_ui_manager_new_merge_id manager'
touchManagedPtr manager
return result
#if ENABLE_OVERLOADING
data UIManagerNewMergeIdMethodInfo
instance (signature ~ (m Word32), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerNewMergeIdMethodInfo a signature where
overloadedMethod _ = uIManagerNewMergeId
#endif
-- method UIManager::remove_action_group
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "action_group", argType = TInterface (Name {namespace = "Gtk", name = "ActionGroup"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the action group to be removed", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_remove_action_group" gtk_ui_manager_remove_action_group ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
Ptr Gtk.ActionGroup.ActionGroup -> -- action_group : TInterface (Name {namespace = "Gtk", name = "ActionGroup"})
IO ()
{-# DEPRECATED uIManagerRemoveActionGroup ["(Since version 3.10)"] #-}
{- |
Removes an action group from the list of action groups associated
with /@manager@/.
/Since: 2.4/
-}
uIManagerRemoveActionGroup ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a, Gtk.ActionGroup.IsActionGroup b) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> b
{- ^ /@actionGroup@/: the action group to be removed -}
-> m ()
uIManagerRemoveActionGroup manager actionGroup = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
actionGroup' <- unsafeManagedPtrCastPtr actionGroup
gtk_ui_manager_remove_action_group manager' actionGroup'
touchManagedPtr manager
touchManagedPtr actionGroup
return ()
#if ENABLE_OVERLOADING
data UIManagerRemoveActionGroupMethodInfo
instance (signature ~ (b -> m ()), MonadIO m, IsUIManager a, Gtk.ActionGroup.IsActionGroup b) => O.MethodInfo UIManagerRemoveActionGroupMethodInfo a signature where
overloadedMethod _ = uIManagerRemoveActionGroup
#endif
-- method UIManager::remove_ui
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager object", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "merge_id", argType = TBasicType TUInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a merge id as returned by gtk_ui_manager_add_ui_from_string()", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_remove_ui" gtk_ui_manager_remove_ui ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
Word32 -> -- merge_id : TBasicType TUInt
IO ()
{-# DEPRECATED uIManagerRemoveUi ["(Since version 3.10)"] #-}
{- |
Unmerges the part of /@manager@/\'s content identified by /@mergeId@/.
/Since: 2.4/
-}
uIManagerRemoveUi ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' object -}
-> Word32
{- ^ /@mergeId@/: a merge id as returned by 'GI.Gtk.Objects.UIManager.uIManagerAddUiFromString' -}
-> m ()
uIManagerRemoveUi manager mergeId = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
gtk_ui_manager_remove_ui manager' mergeId
touchManagedPtr manager
return ()
#if ENABLE_OVERLOADING
data UIManagerRemoveUiMethodInfo
instance (signature ~ (Word32 -> m ()), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerRemoveUiMethodInfo a signature where
overloadedMethod _ = uIManagerRemoveUi
#endif
-- method UIManager::set_add_tearoffs
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "manager", argType = TInterface (Name {namespace = "Gtk", name = "UIManager"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkUIManager", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "add_tearoffs", argType = TBasicType TBoolean, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "whether tearoff menu items are added", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_ui_manager_set_add_tearoffs" gtk_ui_manager_set_add_tearoffs ::
Ptr UIManager -> -- manager : TInterface (Name {namespace = "Gtk", name = "UIManager"})
CInt -> -- add_tearoffs : TBasicType TBoolean
IO ()
{-# DEPRECATED uIManagerSetAddTearoffs ["(Since version 3.4)","Tearoff menus are deprecated and should not"," be used in newly written code."] #-}
{- |
Sets the “add_tearoffs” property, which controls whether menus
generated by this 'GI.Gtk.Objects.UIManager.UIManager' will have tearoff menu items.
Note that this only affects regular menus. Generated popup
menus never have tearoff menu items.
/Since: 2.4/
-}
uIManagerSetAddTearoffs ::
(B.CallStack.HasCallStack, MonadIO m, IsUIManager a) =>
a
{- ^ /@manager@/: a 'GI.Gtk.Objects.UIManager.UIManager' -}
-> Bool
{- ^ /@addTearoffs@/: whether tearoff menu items are added -}
-> m ()
uIManagerSetAddTearoffs manager addTearoffs = liftIO $ do
manager' <- unsafeManagedPtrCastPtr manager
let addTearoffs' = (fromIntegral . fromEnum) addTearoffs
gtk_ui_manager_set_add_tearoffs manager' addTearoffs'
touchManagedPtr manager
return ()
#if ENABLE_OVERLOADING
data UIManagerSetAddTearoffsMethodInfo
instance (signature ~ (Bool -> m ()), MonadIO m, IsUIManager a) => O.MethodInfo UIManagerSetAddTearoffsMethodInfo a signature where
overloadedMethod _ = uIManagerSetAddTearoffs
#endif