gi-dazzle-1.0.2: libdazzle bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Dazzle.Objects.ShortcutManager

Description

No description available in the introspection data.

Synopsis

Exported types

newtype ShortcutManager Source #

Memory-managed wrapper type.

Constructors

ShortcutManager (ManagedPtr ShortcutManager) 

Instances

Instances details
Eq ShortcutManager Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

GObject ShortcutManager Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

ManagedPtrNewtype ShortcutManager Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

TypedObject ShortcutManager Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

Methods

glibType :: IO GType

HasParentTypes ShortcutManager Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

IsGValue (Maybe ShortcutManager) Source #

Convert ShortcutManager to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ShortcutManager -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ShortcutManager)

type ParentTypes ShortcutManager Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutManager

type ParentTypes ShortcutManager = '[Object, Initable, ListModel]

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

Instances details
(GObject o, IsDescendantOf ShortcutManager o) => IsShortcutManager o Source # 
Instance details

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

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

self: a ShortcutManager or Nothing for the default

-> [ShortcutEntry]

shortcuts: shortcuts to add

-> Maybe Text

translationDomain: the gettext domain to use for translations

-> 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

self: A ShortcutManager

-> b

window: A ShortcutsWindow

-> 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 ShortcutManager.

Gets the singleton ShortcutManager for the process.

getTheme

shortcutManagerGetTheme Source #

Gets the "theme" property.

getThemeByName

shortcutManagerGetThemeByName Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutManager a) 
=> a

self: a ShortcutManager

-> Maybe Text

themeName: the name of a theme or Nothing of the internal theme

-> m (Maybe ShortcutTheme)

Returns: A ShortcutTheme or Nothing.

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

self: An ShortcutManager

-> EventKey

event: A EventKey event to handle.

-> b

toplevel: A Widget or Nothing.

-> m Bool

Returns: True if the event was handled.

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

self: An ShortcutManager

-> b

theme: An ShortcutTheme

-> 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

set shortcutManager [ #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

set shortcutManager [ #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

set shortcutManager [ #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