Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
Application
is a class that handles many important aspects
of a GTK+ application in a convenient fashion, without enforcing
a one-size-fits-all application model.
Currently, GtkApplication handles GTK+ initialization, application uniqueness, session management, provides some basic scriptability and desktop shell integration by exporting actions and menus and manages a list of toplevel windows whose life-cycle is automatically tied to the life-cycle of your application.
While GtkApplication works fine with plain GtkWindows
, it is recommended
to use it together with ApplicationWindow
.
When GDK threads are enabled, GtkApplication will acquire the GDK
lock when invoking actions that arrive from other processes. The GDK
lock is not touched for local action invocations. In order to have
actions invoked in a predictable context it is therefore recommended
that the GDK lock be held while invoking actions locally with
actionGroupActivateAction
. The same applies to actions
associated with ApplicationWindow
and to the “activate” and
“open” Application
methods.
Application
will automatically load menus from the Builder
resource located at "gtk/menus.ui", relative to the application's
resource base path (see applicationSetResourceBasePath
). The
menu with the ID "app-menu" is taken as the application's app menu
and the menu with the ID "menubar" is taken as the application's
menubar. Additional menus (most interesting submenus) can be named
and accessed via applicationGetMenuById
which allows for
dynamic population of a part of the menu structure.
If the resources "gtk/menus-appmenu.ui" or "gtk/menus-traditional.ui" are
present then these files will be used in preference, depending on the value
of applicationPrefersAppMenu
. If the resource "gtk/menus-common.ui"
is present it will be loaded as well. This is useful for storing items that
are referenced from both "gtk/menus-appmenu.ui" and
"gtk/menus-traditional.ui".
It is also possible to provide the menus manually using
applicationSetAppMenu
and applicationSetMenubar
.
Application
will also automatically setup an icon search path for
the default icon theme by appending "icons" to the resource base
path. This allows your application to easily store its icons as
resources. See iconThemeAddResourcePath
for more
information.
If there is a resource located at "gtk/help-overlay.ui" which
defines a ShortcutsWindow
with ID "help_overlay" then GtkApplication
associates an instance of this shortcuts window with each
ApplicationWindow
and sets up keyboard accelerators (Control-F1
and Control-?) to open it. To create a menu item that displays the
shortcuts window, associate the item with the action win.show-help-overlay.
GtkApplication optionally registers with a session manager
of the users session (if you set the Application
:register-session
property) and offers various functionality related to the session
life-cycle.
An application can block various ways to end the session with
the applicationInhibit
function. Typical use cases for
this kind of inhibiting are long-running, uninterruptible operations,
such as burning a CD or performing a disk backup. The session
manager may not honor the inhibitor, but it can be expected to
inform the user about the negative consequences of ending the
session while inhibitors are present.
## {seealso
}
HowDoI: Using GtkApplication,
Getting Started with GTK+: Basics
- newtype Application = Application (ManagedPtr Application)
- class GObject o => IsApplication o
- toApplication :: IsApplication o => o -> IO Application
- noApplication :: Maybe Application
- data ApplicationAddAcceleratorMethodInfo
- applicationAddAccelerator :: (HasCallStack, MonadIO m, IsApplication a) => a -> Text -> Text -> Maybe GVariant -> m ()
- data ApplicationAddWindowMethodInfo
- applicationAddWindow :: (HasCallStack, MonadIO m, IsApplication a, IsWindow b) => a -> b -> m ()
- data ApplicationGetAccelsForActionMethodInfo
- applicationGetAccelsForAction :: (HasCallStack, MonadIO m, IsApplication a) => a -> Text -> m [Text]
- data ApplicationGetActionsForAccelMethodInfo
- applicationGetActionsForAccel :: (HasCallStack, MonadIO m, IsApplication a) => a -> Text -> m [Text]
- data ApplicationGetActiveWindowMethodInfo
- applicationGetActiveWindow :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Window
- data ApplicationGetAppMenuMethodInfo
- applicationGetAppMenu :: (HasCallStack, MonadIO m, IsApplication a) => a -> m (Maybe MenuModel)
- data ApplicationGetMenuByIdMethodInfo
- applicationGetMenuById :: (HasCallStack, MonadIO m, IsApplication a) => a -> Text -> m Menu
- data ApplicationGetMenubarMethodInfo
- applicationGetMenubar :: (HasCallStack, MonadIO m, IsApplication a) => a -> m MenuModel
- data ApplicationGetWindowByIdMethodInfo
- applicationGetWindowById :: (HasCallStack, MonadIO m, IsApplication a) => a -> Word32 -> m (Maybe Window)
- data ApplicationGetWindowsMethodInfo
- applicationGetWindows :: (HasCallStack, MonadIO m, IsApplication a) => a -> m [Window]
- data ApplicationInhibitMethodInfo
- applicationInhibit :: (HasCallStack, MonadIO m, IsApplication a, IsWindow b) => a -> Maybe b -> [ApplicationInhibitFlags] -> Maybe Text -> m Word32
- data ApplicationIsInhibitedMethodInfo
- applicationIsInhibited :: (HasCallStack, MonadIO m, IsApplication a) => a -> [ApplicationInhibitFlags] -> m Bool
- data ApplicationListActionDescriptionsMethodInfo
- applicationListActionDescriptions :: (HasCallStack, MonadIO m, IsApplication a) => a -> m [Text]
- applicationNew :: (HasCallStack, MonadIO m) => Maybe Text -> [ApplicationFlags] -> m Application
- data ApplicationPrefersAppMenuMethodInfo
- applicationPrefersAppMenu :: (HasCallStack, MonadIO m, IsApplication a) => a -> m Bool
- data ApplicationRemoveAcceleratorMethodInfo
- applicationRemoveAccelerator :: (HasCallStack, MonadIO m, IsApplication a) => a -> Text -> Maybe GVariant -> m ()
- data ApplicationRemoveWindowMethodInfo
- applicationRemoveWindow :: (HasCallStack, MonadIO m, IsApplication a, IsWindow b) => a -> b -> m ()
- data ApplicationSetAccelsForActionMethodInfo
- applicationSetAccelsForAction :: (HasCallStack, MonadIO m, IsApplication a) => a -> Text -> [Text] -> m ()
- data ApplicationSetAppMenuMethodInfo
- applicationSetAppMenu :: (HasCallStack, MonadIO m, IsApplication a, IsMenuModel b) => a -> Maybe b -> m ()
- data ApplicationSetMenubarMethodInfo
- applicationSetMenubar :: (HasCallStack, MonadIO m, IsApplication a, IsMenuModel b) => a -> Maybe b -> m ()
- data ApplicationUninhibitMethodInfo
- applicationUninhibit :: (HasCallStack, MonadIO m, IsApplication a) => a -> Word32 -> m ()
- data ApplicationActiveWindowPropertyInfo
- applicationActiveWindow :: AttrLabelProxy "activeWindow"
- getApplicationActiveWindow :: (MonadIO m, IsApplication o) => o -> m Window
- data ApplicationAppMenuPropertyInfo
- applicationAppMenu :: AttrLabelProxy "appMenu"
- clearApplicationAppMenu :: (MonadIO m, IsApplication o) => o -> m ()
- constructApplicationAppMenu :: (IsApplication o, IsMenuModel a) => a -> IO (GValueConstruct o)
- getApplicationAppMenu :: (MonadIO m, IsApplication o) => o -> m (Maybe MenuModel)
- setApplicationAppMenu :: (MonadIO m, IsApplication o, IsMenuModel a) => o -> a -> m ()
- data ApplicationMenubarPropertyInfo
- applicationMenubar :: AttrLabelProxy "menubar"
- clearApplicationMenubar :: (MonadIO m, IsApplication o) => o -> m ()
- constructApplicationMenubar :: (IsApplication o, IsMenuModel a) => a -> IO (GValueConstruct o)
- getApplicationMenubar :: (MonadIO m, IsApplication o) => o -> m MenuModel
- setApplicationMenubar :: (MonadIO m, IsApplication o, IsMenuModel a) => o -> a -> m ()
- data ApplicationRegisterSessionPropertyInfo
- applicationRegisterSession :: AttrLabelProxy "registerSession"
- constructApplicationRegisterSession :: IsApplication o => Bool -> IO (GValueConstruct o)
- getApplicationRegisterSession :: (MonadIO m, IsApplication o) => o -> m Bool
- setApplicationRegisterSession :: (MonadIO m, IsApplication o) => o -> Bool -> m ()
- type ApplicationWindowAddedCallback = Window -> IO ()
- data ApplicationWindowAddedSignalInfo
- type C_ApplicationWindowAddedCallback = Ptr () -> Ptr Window -> Ptr () -> IO ()
- afterApplicationWindowAdded :: (GObject a, MonadIO m) => a -> ApplicationWindowAddedCallback -> m SignalHandlerId
- genClosure_ApplicationWindowAdded :: ApplicationWindowAddedCallback -> IO Closure
- mk_ApplicationWindowAddedCallback :: C_ApplicationWindowAddedCallback -> IO (FunPtr C_ApplicationWindowAddedCallback)
- noApplicationWindowAddedCallback :: Maybe ApplicationWindowAddedCallback
- onApplicationWindowAdded :: (GObject a, MonadIO m) => a -> ApplicationWindowAddedCallback -> m SignalHandlerId
- wrap_ApplicationWindowAddedCallback :: ApplicationWindowAddedCallback -> Ptr () -> Ptr Window -> Ptr () -> IO ()
- type ApplicationWindowRemovedCallback = Window -> IO ()
- data ApplicationWindowRemovedSignalInfo
- type C_ApplicationWindowRemovedCallback = Ptr () -> Ptr Window -> Ptr () -> IO ()
- afterApplicationWindowRemoved :: (GObject a, MonadIO m) => a -> ApplicationWindowRemovedCallback -> m SignalHandlerId
- genClosure_ApplicationWindowRemoved :: ApplicationWindowRemovedCallback -> IO Closure
- mk_ApplicationWindowRemovedCallback :: C_ApplicationWindowRemovedCallback -> IO (FunPtr C_ApplicationWindowRemovedCallback)
- noApplicationWindowRemovedCallback :: Maybe ApplicationWindowRemovedCallback
- onApplicationWindowRemoved :: (GObject a, MonadIO m) => a -> ApplicationWindowRemovedCallback -> m SignalHandlerId
- wrap_ApplicationWindowRemovedCallback :: ApplicationWindowRemovedCallback -> Ptr () -> Ptr Window -> Ptr () -> IO ()
Exported types
newtype Application Source #
GObject Application Source # | |
IsApplication Application Source # | |
IsActionGroup Application Source # | |
IsActionMap Application Source # | |
IsObject Application Source # | |
IsApplication Application Source # | |
((~) * info (ResolveApplicationMethod t Application), MethodInfo * info Application p) => IsLabel t (Application -> p) Source # | |
((~) * info (ResolveApplicationMethod t Application), MethodInfo * info Application p) => IsLabelProxy t (Application -> p) Source # | |
HasAttributeList * Application Source # | |
type AttributeList Application Source # | |
type SignalList Application Source # | |
class GObject o => IsApplication o Source #
toApplication :: IsApplication o => o -> IO Application Source #
Methods
addAccelerator
data ApplicationAddAcceleratorMethodInfo Source #
((~) * signature (Text -> Text -> Maybe GVariant -> m ()), MonadIO m, IsApplication a) => MethodInfo * ApplicationAddAcceleratorMethodInfo a signature Source # | |
applicationAddAccelerator Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Text |
|
-> Text |
|
-> Maybe GVariant |
|
-> m () |
Deprecated: (Since version 3.14)Use applicationSetAccelsForAction
instead
Installs an accelerator that will cause the named action
to be activated when the key combination specificed by accelerator
is pressed.
accelerator
must be a string that can be parsed by acceleratorParse
,
e.g. "<Primary>q" or “<Control><Alt>p”.
actionName
must be the name of an action as it would be used
in the app menu, i.e. actions that have been added to the application
are referred to with an “app.” prefix, and window-specific actions
with a “win.” prefix.
GtkApplication also extracts accelerators out of “accel” attributes
in the GMenuModels
passed to applicationSetAppMenu
and
applicationSetMenubar
, which is usually more convenient
than calling this function for each accelerator.
Since: 3.4
addWindow
data ApplicationAddWindowMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsApplication a, IsWindow b) => MethodInfo * ApplicationAddWindowMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsApplication a, IsWindow b) | |
=> a |
|
-> b |
|
-> m () |
Adds a window to application
.
This call can only happen after the application
has started;
typically, you should add new application windows in response
to the emission of the Application
::activate
signal.
This call is equivalent to setting the Window
:application
property of window
to application
.
Normally, the connection between the application and the window
will remain until the window is destroyed, but you can explicitly
remove it with applicationRemoveWindow
.
GTK+ will keep the application
running as long as it has
any windows.
Since: 3.0
getAccelsForAction
data ApplicationGetAccelsForActionMethodInfo Source #
((~) * signature (Text -> m [Text]), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetAccelsForActionMethodInfo a signature Source # | |
applicationGetAccelsForAction Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Text |
|
-> m [Text] | Returns: accelerators for |
Gets the accelerators that are currently associated with the given action.
Since: 3.12
getActionsForAccel
data ApplicationGetActionsForAccelMethodInfo Source #
((~) * signature (Text -> m [Text]), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetActionsForAccelMethodInfo a signature Source # | |
applicationGetActionsForAccel Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Text |
|
-> m [Text] | Returns: a |
Returns the list of actions (possibly empty) that accel
maps to.
Each item in the list is a detailed action name in the usual form.
This might be useful to discover if an accel already exists in order to prevent installation of a conflicting accelerator (from an accelerator editor or a plugin system, for example). Note that having more than one action per accelerator may not be a bad thing and might make sense in cases where the actions never appear in the same context.
In case there are no actions for a given accelerator, an empty array
is returned. Nothing
is never returned.
It is a programmer error to pass an invalid accelerator string.
If you are unsure, check it with acceleratorParse
first.
Since: 3.14
getActiveWindow
data ApplicationGetActiveWindowMethodInfo Source #
((~) * signature (m Window), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetActiveWindowMethodInfo a signature Source # | |
applicationGetActiveWindow Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m Window | Returns: the active window |
Gets the “active” window for the application.
The active window is the one that was most recently focused (within the application). This window may not have the focus at the moment if another application has it — this is just the most recently-focused window within this application.
Since: 3.6
getAppMenu
data ApplicationGetAppMenuMethodInfo Source #
((~) * signature (m (Maybe MenuModel)), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetAppMenuMethodInfo a signature Source # | |
applicationGetAppMenu Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m (Maybe MenuModel) | Returns: the application menu of |
Returns the menu model that has been set with
applicationSetAppMenu
.
Since: 3.4
getMenuById
data ApplicationGetMenuByIdMethodInfo Source #
((~) * signature (Text -> m Menu), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetMenuByIdMethodInfo a signature Source # | |
applicationGetMenuById Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Text |
|
-> m Menu | Returns: Gets the menu with the given id from the automatically loaded resources |
Gets a menu from automatically loaded resources. See [Automatic resources][automatic-resources] for more information.
Since: 3.14
getMenubar
data ApplicationGetMenubarMethodInfo Source #
((~) * signature (m MenuModel), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetMenubarMethodInfo a signature Source # | |
applicationGetMenubar Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m MenuModel | Returns: the menubar for windows of |
Returns the menu model that has been set with
applicationSetMenubar
.
Since: 3.4
getWindowById
data ApplicationGetWindowByIdMethodInfo Source #
((~) * signature (Word32 -> m (Maybe Window)), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetWindowByIdMethodInfo a signature Source # | |
applicationGetWindowById Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Word32 |
|
-> m (Maybe Window) | Returns: the window with ID |
Returns the ApplicationWindow
with the given ID.
The ID of a ApplicationWindow
can be retrieved with
applicationWindowGetId
.
Since: 3.6
getWindows
data ApplicationGetWindowsMethodInfo Source #
((~) * signature (m [Window]), MonadIO m, IsApplication a) => MethodInfo * ApplicationGetWindowsMethodInfo a signature Source # | |
applicationGetWindows Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m [Window] |
Gets a list of the GtkWindows
associated with application
.
The list is sorted by most recently focused window, such that the first element is the currently focused window. (Useful for choosing a parent for a transient window.)
The list that is returned should not be modified in any way. It will only remain valid until the next focus change or window creation or deletion.
Since: 3.0
inhibit
data ApplicationInhibitMethodInfo Source #
((~) * signature (Maybe b -> [ApplicationInhibitFlags] -> Maybe Text -> m Word32), MonadIO m, IsApplication a, IsWindow b) => MethodInfo * ApplicationInhibitMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsApplication a, IsWindow b) | |
=> a |
|
-> Maybe b | |
-> [ApplicationInhibitFlags] |
|
-> Maybe Text |
|
-> m Word32 | Returns: A non-zero cookie that is used to uniquely identify this
request. It should be used as an argument to |
Inform the session manager that certain types of actions should be inhibited. This is not guaranteed to work on all platforms and for all types of actions.
Applications should invoke this method when they begin an operation
that should not be interrupted, such as creating a CD or DVD. The
types of actions that may be blocked are specified by the flags
parameter. When the application completes the operation it should
call applicationUninhibit
to remove the inhibitor. Note that
an application can have multiple inhibitors, and all of them must
be individually removed. Inhibitors are also cleared when the
application exits.
Applications should not expect that they will always be able to block the action. In most cases, users will be given the option to force the action to take place.
Reasons should be short and to the point.
If window
is given, the session manager may point the user to
this window to find out more about why the action is inhibited.
Since: 3.4
isInhibited
data ApplicationIsInhibitedMethodInfo Source #
((~) * signature ([ApplicationInhibitFlags] -> m Bool), MonadIO m, IsApplication a) => MethodInfo * ApplicationIsInhibitedMethodInfo a signature Source # | |
applicationIsInhibited Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> [ApplicationInhibitFlags] |
|
-> m Bool | Returns: |
Determines if any of the actions specified in flags
are
currently inhibited (possibly by another application).
Since: 3.4
listActionDescriptions
data ApplicationListActionDescriptionsMethodInfo Source #
((~) * signature (m [Text]), MonadIO m, IsApplication a) => MethodInfo * ApplicationListActionDescriptionsMethodInfo a signature Source # | |
applicationListActionDescriptions Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m [Text] | Returns: a |
Lists the detailed action names which have associated accelerators.
See applicationSetAccelsForAction
.
Since: 3.12
new
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> [ApplicationFlags] |
|
-> m Application | Returns: a new |
Creates a new Application
instance.
When using Application
, it is not necessary to call init
manually. It is called as soon as the application gets registered as
the primary instance.
Concretely, init
is called in the default handler for the
Application
::startup
signal. Therefore, Application
subclasses should
chain up in their Application
::startup
handler before using any GTK+ API.
Note that commandline arguments are not passed to init
.
All GTK+ functionality that is available via commandline arguments
can also be achieved by setting suitable environment variables
such as G_DEBUG
, so this should not be a big
problem. If you absolutely must support GTK+ commandline arguments,
you can explicitly call init
before creating the application
instance.
If non-Nothing
, the application ID must be valid. See
applicationIdIsValid
.
If no application ID is given then some features (most notably application uniqueness) will be disabled. A null application ID is only allowed with GTK+ 3.6 or later.
Since: 3.0
prefersAppMenu
data ApplicationPrefersAppMenuMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsApplication a) => MethodInfo * ApplicationPrefersAppMenuMethodInfo a signature Source # | |
applicationPrefersAppMenu Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m Bool | Returns: |
Determines if the desktop environment in which the application is running would prefer an application menu be shown.
If this function returns True
then the application should call
applicationSetAppMenu
with the contents of an application
menu, which will be shown by the desktop environment. If it returns
False
then you should consider using an alternate approach, such as
a menubar.
The value returned by this function is purely advisory and you are
free to ignore it. If you call applicationSetAppMenu
even
if the desktop environment doesn't support app menus, then a fallback
will be provided.
Applications are similarly free not to set an app menu even if the desktop environment wants to show one. In that case, a fallback will also be created by the desktop environment (GNOME, for example, uses a menu with only a "Quit" item in it).
The value returned by this function never changes. Once it returns a particular value, it is guaranteed to always return the same value.
You may only call this function after the application has been registered and after the base startup handler has run. You're most likely to want to use this from your own startup handler. It may also make sense to consult this function while constructing UI (in activate, open or an action activation handler) in order to determine if you should show a gear menu or not.
This function will return False
on Mac OS and a default app menu
will be created automatically with the "usual" contents of that menu
typical to most Mac OS applications. If you call
applicationSetAppMenu
anyway, then this menu will be
replaced with your own.
Since: 3.14
removeAccelerator
data ApplicationRemoveAcceleratorMethodInfo Source #
((~) * signature (Text -> Maybe GVariant -> m ()), MonadIO m, IsApplication a) => MethodInfo * ApplicationRemoveAcceleratorMethodInfo a signature Source # | |
applicationRemoveAccelerator Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Text |
|
-> Maybe GVariant |
|
-> m () |
Deprecated: (Since version 3.14)Use applicationSetAccelsForAction
instead
Removes an accelerator that has been previously added
with applicationAddAccelerator
.
Since: 3.4
removeWindow
data ApplicationRemoveWindowMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsApplication a, IsWindow b) => MethodInfo * ApplicationRemoveWindowMethodInfo a signature Source # | |
applicationRemoveWindow Source #
:: (HasCallStack, MonadIO m, IsApplication a, IsWindow b) | |
=> a |
|
-> b |
|
-> m () |
setAccelsForAction
data ApplicationSetAccelsForActionMethodInfo Source #
((~) * signature (Text -> [Text] -> m ()), MonadIO m, IsApplication a) => MethodInfo * ApplicationSetAccelsForActionMethodInfo a signature Source # | |
applicationSetAccelsForAction Source #
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Text |
|
-> [Text] |
|
-> m () |
Sets zero or more keyboard accelerators that will trigger the
given action. The first item in accels
will be the primary
accelerator, which may be displayed in the UI.
To remove all accelerators for an action, use an empty, zero-terminated
array for accels
.
For the detailedActionName
, see actionParseDetailedName
and
actionPrintDetailedName
.
Since: 3.12
setAppMenu
data ApplicationSetAppMenuMethodInfo Source #
((~) * signature (Maybe b -> m ()), MonadIO m, IsApplication a, IsMenuModel b) => MethodInfo * ApplicationSetAppMenuMethodInfo a signature Source # | |
applicationSetAppMenu Source #
:: (HasCallStack, MonadIO m, IsApplication a, IsMenuModel b) | |
=> a |
|
-> Maybe b | |
-> m () |
Sets or unsets the application menu for application
.
This can only be done in the primary instance of the application,
after it has been registered. Application
::startup
is a good place
to call this.
The application menu is a single menu containing items that typically impact the application as a whole, rather than acting on a specific window or document. For example, you would expect to see “Preferences” or “Quit” in an application menu, but not “Save” or “Print”.
If supported, the application menu will be rendered by the desktop environment.
Use the base ActionMap
interface to add actions, to respond to the user
selecting these menu items.
Since: 3.4
setMenubar
data ApplicationSetMenubarMethodInfo Source #
((~) * signature (Maybe b -> m ()), MonadIO m, IsApplication a, IsMenuModel b) => MethodInfo * ApplicationSetMenubarMethodInfo a signature Source # | |
applicationSetMenubar Source #
:: (HasCallStack, MonadIO m, IsApplication a, IsMenuModel b) | |
=> a |
|
-> Maybe b | |
-> m () |
Sets or unsets the menubar for windows of application
.
This is a menubar in the traditional sense.
This can only be done in the primary instance of the application,
after it has been registered. Application
::startup
is a good place
to call this.
Depending on the desktop environment, this may appear at the top of each window, or at the top of the screen. In some environments, if both the application menu and the menubar are set, the application menu will be presented as if it were the first item of the menubar. Other environments treat the two as completely separate — for example, the application menu may be rendered by the desktop shell while the menubar (if set) remains in each individual window.
Use the base ActionMap
interface to add actions, to respond to the
user selecting these menu items.
Since: 3.4
uninhibit
data ApplicationUninhibitMethodInfo Source #
((~) * signature (Word32 -> m ()), MonadIO m, IsApplication a) => MethodInfo * ApplicationUninhibitMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> Word32 |
|
-> m () |
Removes an inhibitor that has been established with applicationInhibit
.
Inhibitors are also cleared when the application exits.
Since: 3.4
Properties
activeWindow
data ApplicationActiveWindowPropertyInfo Source #
applicationActiveWindow :: AttrLabelProxy "activeWindow" Source #
getApplicationActiveWindow :: (MonadIO m, IsApplication o) => o -> m Window Source #
appMenu
data ApplicationAppMenuPropertyInfo Source #
applicationAppMenu :: AttrLabelProxy "appMenu" Source #
clearApplicationAppMenu :: (MonadIO m, IsApplication o) => o -> m () Source #
constructApplicationAppMenu :: (IsApplication o, IsMenuModel a) => a -> IO (GValueConstruct o) Source #
getApplicationAppMenu :: (MonadIO m, IsApplication o) => o -> m (Maybe MenuModel) Source #
setApplicationAppMenu :: (MonadIO m, IsApplication o, IsMenuModel a) => o -> a -> m () Source #
menubar
data ApplicationMenubarPropertyInfo Source #
applicationMenubar :: AttrLabelProxy "menubar" Source #
clearApplicationMenubar :: (MonadIO m, IsApplication o) => o -> m () Source #
constructApplicationMenubar :: (IsApplication o, IsMenuModel a) => a -> IO (GValueConstruct o) Source #
getApplicationMenubar :: (MonadIO m, IsApplication o) => o -> m MenuModel Source #
setApplicationMenubar :: (MonadIO m, IsApplication o, IsMenuModel a) => o -> a -> m () Source #
registerSession
data ApplicationRegisterSessionPropertyInfo Source #
applicationRegisterSession :: AttrLabelProxy "registerSession" Source #
constructApplicationRegisterSession :: IsApplication o => Bool -> IO (GValueConstruct o) Source #
getApplicationRegisterSession :: (MonadIO m, IsApplication o) => o -> m Bool Source #
setApplicationRegisterSession :: (MonadIO m, IsApplication o) => o -> Bool -> m () Source #
Signals
windowAdded
type ApplicationWindowAddedCallback = Window -> IO () Source #
afterApplicationWindowAdded :: (GObject a, MonadIO m) => a -> ApplicationWindowAddedCallback -> m SignalHandlerId Source #
mk_ApplicationWindowAddedCallback :: C_ApplicationWindowAddedCallback -> IO (FunPtr C_ApplicationWindowAddedCallback) Source #
onApplicationWindowAdded :: (GObject a, MonadIO m) => a -> ApplicationWindowAddedCallback -> m SignalHandlerId Source #
wrap_ApplicationWindowAddedCallback :: ApplicationWindowAddedCallback -> Ptr () -> Ptr Window -> Ptr () -> IO () Source #
windowRemoved
type ApplicationWindowRemovedCallback = Window -> IO () Source #
afterApplicationWindowRemoved :: (GObject a, MonadIO m) => a -> ApplicationWindowRemovedCallback -> m SignalHandlerId Source #
mk_ApplicationWindowRemovedCallback :: C_ApplicationWindowRemovedCallback -> IO (FunPtr C_ApplicationWindowRemovedCallback) Source #
onApplicationWindowRemoved :: (GObject a, MonadIO m) => a -> ApplicationWindowRemovedCallback -> m SignalHandlerId Source #
wrap_ApplicationWindowRemovedCallback :: ApplicationWindowRemovedCallback -> Ptr () -> Ptr Window -> Ptr () -> IO () Source #