| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Dazzle.Objects.ShortcutManager
Description
No description available in the introspection data.
Synopsis
- newtype ShortcutManager = ShortcutManager (ManagedPtr ShortcutManager)
- class (GObject o, IsDescendantOf ShortcutManager o) => IsShortcutManager o
- toShortcutManager :: (MonadIO m, IsShortcutManager o) => o -> m ShortcutManager
- shortcutManagerAddAction :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> Text -> Text -> Text -> Text -> m ()
- shortcutManagerAddCommand :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> Text -> Text -> Text -> Text -> m ()
- shortcutManagerAddShortcutEntries :: (HasCallStack, MonadIO m, IsShortcutManager a) => Maybe a -> [ShortcutEntry] -> Maybe Text -> m ()
- shortcutManagerAddShortcutsToWindow :: (HasCallStack, MonadIO m, IsShortcutManager a, IsShortcutsWindow b) => a -> b -> m ()
- shortcutManagerAppendSearchPath :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m ()
- shortcutManagerGetDefault :: (HasCallStack, MonadIO m) => m ShortcutManager
- shortcutManagerGetTheme :: (HasCallStack, MonadIO m, IsShortcutManager a) => Maybe a -> m ShortcutTheme
- shortcutManagerGetThemeByName :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Maybe Text -> m (Maybe ShortcutTheme)
- shortcutManagerGetThemeName :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> m Text
- shortcutManagerGetUserDir :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> m Text
- shortcutManagerHandleEvent :: (HasCallStack, MonadIO m, IsShortcutManager a, IsWidget b) => Maybe a -> EventKey -> b -> m Bool
- shortcutManagerPrependSearchPath :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m ()
- shortcutManagerQueueReload :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> m ()
- shortcutManagerReload :: (HasCallStack, MonadIO m, IsShortcutManager a, IsCancellable b) => a -> Maybe b -> m ()
- shortcutManagerRemoveSearchPath :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m ()
- shortcutManagerSetTheme :: (HasCallStack, MonadIO m, IsShortcutManager a, IsShortcutTheme b) => a -> b -> m ()
- shortcutManagerSetThemeName :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m ()
- shortcutManagerSetUserDir :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m ()
- constructShortcutManagerTheme :: (IsShortcutManager o, MonadIO m, IsShortcutTheme a) => a -> m (GValueConstruct o)
- getShortcutManagerTheme :: (MonadIO m, IsShortcutManager o) => o -> m ShortcutTheme
- setShortcutManagerTheme :: (MonadIO m, IsShortcutManager o, IsShortcutTheme a) => o -> a -> m ()
- constructShortcutManagerThemeName :: (IsShortcutManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutManagerThemeName :: (MonadIO m, IsShortcutManager o) => o -> m Text
- setShortcutManagerThemeName :: (MonadIO m, IsShortcutManager o) => o -> Text -> m ()
- constructShortcutManagerUserDir :: (IsShortcutManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutManagerUserDir :: (MonadIO m, IsShortcutManager o) => o -> m Text
- setShortcutManagerUserDir :: (MonadIO m, IsShortcutManager o) => o -> Text -> m ()
- type ShortcutManagerChangedCallback = IO ()
- afterShortcutManagerChanged :: (IsShortcutManager a, MonadIO m) => a -> ((?self :: a) => ShortcutManagerChangedCallback) -> m SignalHandlerId
- onShortcutManagerChanged :: (IsShortcutManager a, MonadIO m) => a -> ((?self :: a) => ShortcutManagerChangedCallback) -> m SignalHandlerId
Exported types
newtype ShortcutManager Source #
Memory-managed wrapper type.
Constructors
| ShortcutManager (ManagedPtr ShortcutManager) |
Instances
class (GObject o, IsDescendantOf ShortcutManager o) => IsShortcutManager o Source #
Type class for types which can be safely cast to ShortcutManager, for instance with toShortcutManager.
Instances
| (GObject o, IsDescendantOf ShortcutManager o) => IsShortcutManager o Source # | |
Defined in GI.Dazzle.Objects.ShortcutManager | |
toShortcutManager :: (MonadIO m, IsShortcutManager o) => o -> m ShortcutManager Source #
Cast to ShortcutManager, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
addAction, addCommand, addShortcutEntries, addShortcutsToWindow, appendSearchPath, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, handleEvent, init, isFloating, itemsChanged, notify, notifyByPspec, prependSearchPath, queueReload, ref, refSink, reload, removeSearchPath, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getItem, getItemType, getNItems, getProperty, getQdata, getTheme, getThemeByName, getThemeName, getUserDir.
Setters
setData, setDataFull, setProperty, setTheme, setThemeName, setUserDir.
addAction
shortcutManagerAddAction :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> Text -> Text -> Text -> Text -> m () Source #
No description available in the introspection data.
addCommand
shortcutManagerAddCommand :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> Text -> Text -> Text -> Text -> m () Source #
No description available in the introspection data.
addShortcutEntries
shortcutManagerAddShortcutEntries Source #
Arguments
| :: (HasCallStack, MonadIO m, IsShortcutManager a) | |
| => Maybe a |
|
| -> [ShortcutEntry] |
|
| -> Maybe Text |
|
| -> m () |
This method will add shortcuts to the ShortcutManager.
This provides a simple way for widgets to add their shortcuts to the manager so that they may be overriden by themes or the end user.
addShortcutsToWindow
shortcutManagerAddShortcutsToWindow Source #
Arguments
| :: (HasCallStack, MonadIO m, IsShortcutManager a, IsShortcutsWindow b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds shortcuts registered with the ShortcutManager to the
ShortcutsWindow.
appendSearchPath
shortcutManagerAppendSearchPath :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m () Source #
No description available in the introspection data.
getDefault
shortcutManagerGetDefault Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m ShortcutManager | Returns: An |
Gets the singleton ShortcutManager for the process.
getTheme
shortcutManagerGetTheme Source #
Arguments
| :: (HasCallStack, MonadIO m, IsShortcutManager a) | |
| => Maybe a |
|
| -> m ShortcutTheme | Returns: An |
Gets the "theme" property.
getThemeByName
shortcutManagerGetThemeByName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsShortcutManager a) | |
| => a |
|
| -> Maybe Text |
|
| -> m (Maybe ShortcutTheme) | Returns: A |
Locates a theme by the name of the theme.
If themeName is Nothing, then the internal theme is used. You probably dont
need to use that as it is used by various controllers to hook up their
default actions.
getThemeName
shortcutManagerGetThemeName :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> m Text Source #
No description available in the introspection data.
getUserDir
shortcutManagerGetUserDir :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> m Text Source #
No description available in the introspection data.
handleEvent
shortcutManagerHandleEvent Source #
Arguments
| :: (HasCallStack, MonadIO m, IsShortcutManager a, IsWidget b) | |
| => Maybe a |
|
| -> EventKey |
|
| -> b | |
| -> m Bool | Returns: |
This function will try to dispatch event to the proper widget and
ShortcutContext. If the event is handled, then True is returned.
You should call this from Widget::keyPressEvent handler in your
Window toplevel.
prependSearchPath
shortcutManagerPrependSearchPath :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m () Source #
No description available in the introspection data.
queueReload
shortcutManagerQueueReload :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> m () Source #
No description available in the introspection data.
reload
shortcutManagerReload :: (HasCallStack, MonadIO m, IsShortcutManager a, IsCancellable b) => a -> Maybe b -> m () Source #
No description available in the introspection data.
removeSearchPath
shortcutManagerRemoveSearchPath :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m () Source #
No description available in the introspection data.
setTheme
shortcutManagerSetTheme Source #
Arguments
| :: (HasCallStack, MonadIO m, IsShortcutManager a, IsShortcutTheme b) | |
| => a |
|
| -> b |
|
| -> m () |
Sets the theme for the shortcut manager.
setThemeName
shortcutManagerSetThemeName :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m () Source #
No description available in the introspection data.
setUserDir
shortcutManagerSetUserDir :: (HasCallStack, MonadIO m, IsShortcutManager a) => a -> Text -> m () Source #
No description available in the introspection data.
Properties
theme
No description available in the introspection data.
constructShortcutManagerTheme :: (IsShortcutManager o, MonadIO m, IsShortcutTheme a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “theme” property. This is rarely needed directly, but it is used by new.
getShortcutManagerTheme :: (MonadIO m, IsShortcutManager o) => o -> m ShortcutTheme Source #
Get the value of the “theme” property.
When overloading is enabled, this is equivalent to
get shortcutManager #theme
setShortcutManagerTheme :: (MonadIO m, IsShortcutManager o, IsShortcutTheme a) => o -> a -> m () Source #
Set the value of the “theme” property.
When overloading is enabled, this is equivalent to
setshortcutManager [ #theme:=value ]
themeName
No description available in the introspection data.
constructShortcutManagerThemeName :: (IsShortcutManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “theme-name” property. This is rarely needed directly, but it is used by new.
getShortcutManagerThemeName :: (MonadIO m, IsShortcutManager o) => o -> m Text Source #
Get the value of the “theme-name” property.
When overloading is enabled, this is equivalent to
get shortcutManager #themeName
setShortcutManagerThemeName :: (MonadIO m, IsShortcutManager o) => o -> Text -> m () Source #
Set the value of the “theme-name” property.
When overloading is enabled, this is equivalent to
setshortcutManager [ #themeName:=value ]
userDir
No description available in the introspection data.
constructShortcutManagerUserDir :: (IsShortcutManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “user-dir” property. This is rarely needed directly, but it is used by new.
getShortcutManagerUserDir :: (MonadIO m, IsShortcutManager o) => o -> m Text Source #
Get the value of the “user-dir” property.
When overloading is enabled, this is equivalent to
get shortcutManager #userDir
setShortcutManagerUserDir :: (MonadIO m, IsShortcutManager o) => o -> Text -> m () Source #
Set the value of the “user-dir” property.
When overloading is enabled, this is equivalent to
setshortcutManager [ #userDir:=value ]
Signals
changed
type ShortcutManagerChangedCallback = IO () Source #
No description available in the introspection data.
afterShortcutManagerChanged :: (IsShortcutManager a, MonadIO m) => a -> ((?self :: a) => ShortcutManagerChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after shortcutManager #changed callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onShortcutManagerChanged :: (IsShortcutManager a, MonadIO m) => a -> ((?self :: a) => ShortcutManagerChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on shortcutManager #changed callback