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 |
ApplicationWindow
is a Window
subclass that offers some
extra functionality for better integration with Application
features. Notably, it can handle both the application menu as well
as the menubar. See applicationSetAppMenu
and
applicationSetMenubar
.
This class implements the ActionGroup
and ActionMap
interfaces,
to let you add window-specific actions that will be exported by the
associated Application
, together with its application-wide
actions. Window-specific actions are prefixed with the “win.”
prefix and application-wide actions are prefixed with the “app.”
prefix. Actions must be addressed with the prefixed name when
referring to them from a MenuModel
.
Note that widgets that are placed inside a ApplicationWindow
can also activate these actions, if they implement the
Actionable
interface.
As with Application
, the GDK lock will be acquired when
processing actions arriving from other processes and should therefore
be held when activating actions locally (if GDK threads are enabled).
The settings Settings
:gtk-shell-shows-app-menu
and
Settings
:gtk-shell-shows-menubar
tell GTK+ whether the
desktop environment is showing the application menu and menubar
models outside the application as part of the desktop shell.
For instance, on OS X, both menus will be displayed remotely;
on Windows neither will be. gnome-shell (starting with version 3.4)
will display the application menu, but not the menubar.
If the desktop environment does not display the menubar, then
ApplicationWindow
will automatically show a MenuBar
for it.
This behaviour can be overridden with the ApplicationWindow
:show-menubar
property. If the desktop environment does not display the application
menu, then it will automatically be included in the menubar or in the
windows client-side decorations.
A GtkApplicationWindow with a menubar
C code
app = gtk_application_new (); builder = gtk_builder_new_from_string ( "<interface>" " <menu id='menubar'>" " <submenu label='_Edit'>" " <item label='_Copy' action='win.copy'/>" " <item label='_Paste' action='win.paste'/>" " </submenu>" " </menu>" "</interface>", -1); menubar = G_MENU_MODEL (gtk_builder_get_object (builder, "menubar")); gtk_application_set_menubar (G_APPLICATION (app), menubar); g_object_unref (builder); ... window = gtk_application_window_new (app);
Handling fallback yourself
The XML format understood by Builder
for MenuModel
consists
of a toplevel <menu>
element, which contains one or more <item>
elements. Each <item>
element contains <attribute>
and <link>
elements with a mandatory name attribute. <link>
elements have the
same content model as <menu>
. Instead of <link name="submenu>
or
<link name="section">
, you can use <submenu>
or <section>
elements.
Attribute values can be translated using gettext, like other Builder
content. <attribute>
elements can be marked for translation with a
translatable="yes"
attribute. It is also possible to specify message
context and translator comments, using the context and comments attributes.
To make use of this, the Builder
must have been given the gettext
domain to use.
The following attributes are used when constructing menu items:
- "label": a user-visible string to display
- "action": the prefixed name of the action to trigger
- "target": the parameter to use when activating the action
- "icon" and "verb-icon": names of icons that may be displayed
- "submenu-action": name of an action that may be used to determine if a submenu can be opened
- "hidden-when": a string used to determine when the item will be hidden. Possible values include "action-disabled", "action-missing", "macos-menubar".
The following attributes are used when constructing sections:
- "label": a user-visible string to use as section heading
- "display-hint": a string used to determine special formatting for the section. Possible values include "horizontal-buttons".
- "text-direction": a string used to determine the
TextDirection
to use when "display-hint" is set to "horizontal-buttons". Possible values include "rtl", "ltr", and "none".
The following attributes are used when constructing submenus:
- "label": a user-visible string to display
- "icon": icon name to display
- newtype ApplicationWindow = ApplicationWindow (ManagedPtr ApplicationWindow)
- class GObject o => IsApplicationWindow o
- toApplicationWindow :: IsApplicationWindow o => o -> IO ApplicationWindow
- noApplicationWindow :: Maybe ApplicationWindow
- data ApplicationWindowGetHelpOverlayMethodInfo
- applicationWindowGetHelpOverlay :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> m (Maybe ShortcutsWindow)
- data ApplicationWindowGetIdMethodInfo
- applicationWindowGetId :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> m Word32
- data ApplicationWindowGetShowMenubarMethodInfo
- applicationWindowGetShowMenubar :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> m Bool
- applicationWindowNew :: (HasCallStack, MonadIO m, IsApplication a) => a -> m ApplicationWindow
- data ApplicationWindowSetHelpOverlayMethodInfo
- applicationWindowSetHelpOverlay :: (HasCallStack, MonadIO m, IsApplicationWindow a, IsShortcutsWindow b) => a -> Maybe b -> m ()
- data ApplicationWindowSetShowMenubarMethodInfo
- applicationWindowSetShowMenubar :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> Bool -> m ()
- data ApplicationWindowShowMenubarPropertyInfo
- applicationWindowShowMenubar :: AttrLabelProxy "showMenubar"
- constructApplicationWindowShowMenubar :: IsApplicationWindow o => Bool -> IO (GValueConstruct o)
- getApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> m Bool
- setApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> Bool -> m ()
Exported types
newtype ApplicationWindow Source #
GObject ApplicationWindow Source # | |
IsImplementorIface ApplicationWindow Source # | |
IsActionGroup ApplicationWindow Source # | |
IsActionMap ApplicationWindow Source # | |
IsObject ApplicationWindow Source # | |
IsWindow ApplicationWindow Source # | |
IsWidget ApplicationWindow Source # | |
IsContainer ApplicationWindow Source # | |
IsBin ApplicationWindow Source # | |
IsBuildable ApplicationWindow Source # | |
IsApplicationWindow ApplicationWindow Source # | |
((~) * info (ResolveApplicationWindowMethod t ApplicationWindow), MethodInfo * info ApplicationWindow p) => IsLabel t (ApplicationWindow -> p) Source # | |
((~) * info (ResolveApplicationWindowMethod t ApplicationWindow), MethodInfo * info ApplicationWindow p) => IsLabelProxy t (ApplicationWindow -> p) Source # | |
HasAttributeList * ApplicationWindow Source # | |
type AttributeList ApplicationWindow Source # | |
type SignalList ApplicationWindow Source # | |
class GObject o => IsApplicationWindow o Source #
toApplicationWindow :: IsApplicationWindow o => o -> IO ApplicationWindow Source #
Methods
getHelpOverlay
data ApplicationWindowGetHelpOverlayMethodInfo Source #
((~) * signature (m (Maybe ShortcutsWindow)), MonadIO m, IsApplicationWindow a) => MethodInfo * ApplicationWindowGetHelpOverlayMethodInfo a signature Source # | |
applicationWindowGetHelpOverlay Source #
:: (HasCallStack, MonadIO m, IsApplicationWindow a) | |
=> a |
|
-> m (Maybe ShortcutsWindow) | Returns: the help overlay associated with |
Gets the ShortcutsWindow
that has been set up with
a prior call to applicationWindowSetHelpOverlay
.
Since: 3.20
getId
data ApplicationWindowGetIdMethodInfo Source #
((~) * signature (m Word32), MonadIO m, IsApplicationWindow a) => MethodInfo * ApplicationWindowGetIdMethodInfo a signature Source # | |
applicationWindowGetId Source #
:: (HasCallStack, MonadIO m, IsApplicationWindow a) | |
=> a |
|
-> m Word32 | Returns: the unique ID for |
Returns the unique ID of the window. If the window has not yet been added to
a Application
, returns 0
.
Since: 3.6
getShowMenubar
data ApplicationWindowGetShowMenubarMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsApplicationWindow a) => MethodInfo * ApplicationWindowGetShowMenubarMethodInfo a signature Source # | |
applicationWindowGetShowMenubar Source #
:: (HasCallStack, MonadIO m, IsApplicationWindow a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the window will display a menubar for the app menu and menubar as needed.
Since: 3.4
new
:: (HasCallStack, MonadIO m, IsApplication a) | |
=> a |
|
-> m ApplicationWindow | Returns: a newly created |
Creates a new ApplicationWindow
.
Since: 3.4
setHelpOverlay
data ApplicationWindowSetHelpOverlayMethodInfo Source #
((~) * signature (Maybe b -> m ()), MonadIO m, IsApplicationWindow a, IsShortcutsWindow b) => MethodInfo * ApplicationWindowSetHelpOverlayMethodInfo a signature Source # | |
applicationWindowSetHelpOverlay Source #
:: (HasCallStack, MonadIO m, IsApplicationWindow a, IsShortcutsWindow b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Associates a shortcuts window with the application window, and sets up an action with the name win.show-help-overlay to present it.
window
takes resposibility for destroying helpOverlay
.
Since: 3.20
setShowMenubar
data ApplicationWindowSetShowMenubarMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsApplicationWindow a) => MethodInfo * ApplicationWindowSetShowMenubarMethodInfo a signature Source # | |
applicationWindowSetShowMenubar Source #
:: (HasCallStack, MonadIO m, IsApplicationWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the window will display a menubar for the app menu and menubar as needed.
Since: 3.4
Properties
showMenubar
data ApplicationWindowShowMenubarPropertyInfo Source #
applicationWindowShowMenubar :: AttrLabelProxy "showMenubar" Source #
constructApplicationWindowShowMenubar :: IsApplicationWindow o => Bool -> IO (GValueConstruct o) Source #
getApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> m Bool Source #
setApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> Bool -> m () Source #