GI.Gtk.Objects.AccelGroup

A AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Window (with windowAddAccelGroup). Usually you won’t need to create a AccelGroup directly; instead, when using UIManager, GTK+ automatically sets up the accelerators for your menus in the ui manager’s AccelGroup.

Note that “accelerators” are different from “mnemonics”. Accelerators are shortcuts for activating a menu item; they appear alongside the menu item they’re a shortcut for. For example “Ctrl+Q” might appear alongside the “Quit” menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined characters. See labelNewWithMnemonic. Menu items can have both accelerators and mnemonics, of course.

Exported types

newtype AccelGroup

Constructors

AccelGroup (ManagedPtr AccelGroup)

Instances

GObject AccelGroup

Methods

gobjectType :: AccelGroup -> IO GType

IsObject AccelGroup

IsAccelGroup AccelGroup

((~) * info (ResolveAccelGroupMethod t AccelGroup), MethodInfo * info AccelGroup p) => IsLabel t (AccelGroup -> p)

Methods

fromLabel :: Proxy# Symbol t -> AccelGroup -> p

((~) * info (ResolveAccelGroupMethod t AccelGroup), MethodInfo * info AccelGroup p) => IsLabelProxy t (AccelGroup -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> AccelGroup -> p

HasAttributeList * AccelGroup

type AttributeList AccelGroup

type AttributeList AccelGroup

type SignalList AccelGroup

type SignalList AccelGroup

class GObject o => IsAccelGroup o

Instances

(GObject a, UnknownAncestorError Constraint AccelGroup a) => IsAccelGroup a

IsAccelGroup AccelGroup

toAccelGroup :: IsAccelGroup o => o -> IO AccelGroup

noAccelGroup :: Maybe AccelGroup

Methods

activate

data AccelGroupActivateMethodInfo

Instances

((~) * signature (Word32 -> b -> Word32 -> [ModifierType] -> m Bool), MonadIO m, IsAccelGroup a, IsObject b) => MethodInfo * AccelGroupActivateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupActivateMethodInfo a -> signature -> s

accelGroupActivate

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a, IsObject b)

=> a

accelGroup: a AccelGroup

-> Word32

accelQuark: the quark for the accelerator name

-> b

acceleratable: the Object, usually a Window, on which to activate the accelerator

-> Word32

accelKey: accelerator keyval from a key event

-> [ModifierType]

accelMods: keyboard state mask from a key event

-> m Bool

Returns: True if an accelerator was activated and handled this keypress

Finds the first accelerator in accelGroup that matches accelKey and accelMods, and activates it.

connect

data AccelGroupConnectMethodInfo

Instances

((~) * signature (Word32 -> [ModifierType] -> [AccelFlags] -> Closure -> m ()), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupConnectMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupConnectMethodInfo a -> signature -> s

accelGroupConnect

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: the accelerator group to install an accelerator in

-> Word32

accelKey: key value of the accelerator

-> [ModifierType]

accelMods: modifier combination of the accelerator

-> [AccelFlags]

accelFlags: a flag mask to configure this accelerator

-> Closure

closure: closure to be executed upon accelerator activation

-> m ()

Installs an accelerator in this group. When accelGroup is being activated in response to a call to accelGroupsActivate, closure will be invoked if the accelKey and accelMods from accelGroupsActivate match those of this connection.

The signature used for the closure is that of AccelGroupActivate.

Note that, due to implementation details, a single closure can only be connected to one accelerator group.

connectByPath

data AccelGroupConnectByPathMethodInfo

Instances

((~) * signature (Text -> Closure -> m ()), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupConnectByPathMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupConnectByPathMethodInfo a -> signature -> s

accelGroupConnectByPath

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: the accelerator group to install an accelerator in

-> Text

accelPath: path used for determining key and modifiers

-> Closure

closure: closure to be executed upon accelerator activation

-> m ()

Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers (see accelMapAddEntry). When accelGroup is being activated in response to a call to accelGroupsActivate, closure will be invoked if the accelKey and accelMods from accelGroupsActivate match the key and modifiers for the path.

The signature used for the closure is that of AccelGroupActivate.

Note that accelPath string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with internStaticString.

disconnect

data AccelGroupDisconnectMethodInfo

Instances

((~) * signature (Maybe Closure -> m Bool), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupDisconnectMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupDisconnectMethodInfo a -> signature -> s

accelGroupDisconnect

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: the accelerator group to remove an accelerator from

-> Maybe Closure

closure: the closure to remove from this accelerator group, or Nothing to remove all closures

-> m Bool

Returns: True if the closure was found and got disconnected

Removes an accelerator previously installed through accelGroupConnect.

Since 2.20 closure can be Nothing.

disconnectKey

data AccelGroupDisconnectKeyMethodInfo

Instances

((~) * signature (Word32 -> [ModifierType] -> m Bool), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupDisconnectKeyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupDisconnectKeyMethodInfo a -> signature -> s

accelGroupDisconnectKey

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: the accelerator group to install an accelerator in

-> Word32

accelKey: key value of the accelerator

-> [ModifierType]

accelMods: modifier combination of the accelerator

-> m Bool

Returns: True if there was an accelerator which could be removed, False otherwise

Removes an accelerator previously installed through accelGroupConnect.

find

data AccelGroupFindMethodInfo

Instances

((~) * signature (AccelGroupFindFunc -> m AccelKey), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupFindMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupFindMethodInfo a -> signature -> s

accelGroupFind

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: a AccelGroup

-> AccelGroupFindFunc

findFunc: a function to filter the entries of accelGroup with

-> m AccelKey

Returns: the key of the first entry passing findFunc. The key is owned by GTK+ and must not be freed.

Finds the first entry in an accelerator group for which findFunc returns True and returns its AccelKey.

fromAccelClosure

accelGroupFromAccelClosure

Arguments

:: (HasCallStack, MonadIO m)

=> Closure

closure: a Closure

-> m (Maybe AccelGroup)

Returns: the AccelGroup to which closure is connected, or Nothing

Finds the AccelGroup to which closure is connected; see accelGroupConnect.

getIsLocked

data AccelGroupGetIsLockedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupGetIsLockedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupGetIsLockedMethodInfo a -> signature -> s

accelGroupGetIsLocked

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: a AccelGroup

-> m Bool

Returns: True if there are 1 or more locks on the accelGroup, False otherwise.

Locks are added and removed using accelGroupLock and accelGroupUnlock.

Since: 2.14

getModifierMask

data AccelGroupGetModifierMaskMethodInfo

Instances

((~) * signature (m [ModifierType]), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupGetModifierMaskMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupGetModifierMaskMethodInfo a -> signature -> s

accelGroupGetModifierMask

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: a AccelGroup

-> m [ModifierType]

Returns: the modifier mask for this accel group.

Gets a ModifierType representing the mask for this accelGroup. For example, GDK_CONTROL_MASK, GDK_SHIFT_MASK, etc.

Since: 2.14

lock

data AccelGroupLockMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupLockMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupLockMethodInfo a -> signature -> s

accelGroupLock

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: a AccelGroup

-> m ()

Locks the given accelerator group.

Locking an acelerator group prevents the accelerators contained within it to be changed during runtime. Refer to accelMapChangeEntry about runtime accelerator changes.

If called more than once, accelGroup remains locked until accelGroupUnlock has been called an equivalent number of times.

new

accelGroupNew

Arguments

:: (HasCallStack, MonadIO m)

=> m AccelGroup

Returns: a new AccelGroup object

Creates a new AccelGroup.

query

data AccelGroupQueryMethodInfo

Instances

((~) * signature (Word32 -> [ModifierType] -> m (Maybe [AccelGroupEntry])), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupQueryMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupQueryMethodInfo a -> signature -> s

accelGroupQuery

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: the accelerator group to query

-> Word32

accelKey: key value of the accelerator

-> [ModifierType]

accelMods: modifier combination of the accelerator

-> m (Maybe [AccelGroupEntry])

Returns: an array of nEntries AccelGroupEntry elements, or Nothing. The array is owned by GTK+ and must not be freed.

Queries an accelerator group for all entries matching accelKey and accelMods.

unlock

data AccelGroupUnlockMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsAccelGroup a) => MethodInfo * AccelGroupUnlockMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AccelGroupUnlockMethodInfo a -> signature -> s

accelGroupUnlock

Arguments

:: (HasCallStack, MonadIO m, IsAccelGroup a)

=> a

accelGroup: a AccelGroup

-> m ()

Undoes the last call to accelGroupLock on this accelGroup.

Properties

isLocked

data AccelGroupIsLockedPropertyInfo

Instances

AttrInfo AccelGroupIsLockedPropertyInfo

Associated Types

type AttrAllowedOps AccelGroupIsLockedPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AccelGroupIsLockedPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo :: * -> Constraint

type AttrGetType AccelGroupIsLockedPropertyInfo :: *

type AttrLabel AccelGroupIsLockedPropertyInfo :: Symbol

type AttrOrigin AccelGroupIsLockedPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo o => Proxy * AccelGroupIsLockedPropertyInfo -> o -> IO (AttrGetType AccelGroupIsLockedPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo o, AttrSetTypeConstraint AccelGroupIsLockedPropertyInfo b) => Proxy * AccelGroupIsLockedPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo o => Proxy * AccelGroupIsLockedPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo o, AttrSetTypeConstraint AccelGroupIsLockedPropertyInfo b) => Proxy * AccelGroupIsLockedPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AccelGroupIsLockedPropertyInfo

type AttrOrigin AccelGroupIsLockedPropertyInfo = AccelGroup

type AttrLabel AccelGroupIsLockedPropertyInfo

type AttrLabel AccelGroupIsLockedPropertyInfo = "is-locked"

type AttrGetType AccelGroupIsLockedPropertyInfo

type AttrGetType AccelGroupIsLockedPropertyInfo = Bool

type AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo

type AttrBaseTypeConstraint AccelGroupIsLockedPropertyInfo = IsAccelGroup

type AttrSetTypeConstraint AccelGroupIsLockedPropertyInfo

type AttrSetTypeConstraint AccelGroupIsLockedPropertyInfo = * ~ ()

type AttrAllowedOps AccelGroupIsLockedPropertyInfo

type AttrAllowedOps AccelGroupIsLockedPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

accelGroupIsLocked :: AttrLabelProxy "isLocked"

getAccelGroupIsLocked :: (MonadIO m, IsAccelGroup o) => o -> m Bool

modifierMask

data AccelGroupModifierMaskPropertyInfo

Instances

AttrInfo AccelGroupModifierMaskPropertyInfo

Associated Types

type AttrAllowedOps AccelGroupModifierMaskPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AccelGroupModifierMaskPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo :: * -> Constraint

type AttrGetType AccelGroupModifierMaskPropertyInfo :: *

type AttrLabel AccelGroupModifierMaskPropertyInfo :: Symbol

type AttrOrigin AccelGroupModifierMaskPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo o => Proxy * AccelGroupModifierMaskPropertyInfo -> o -> IO (AttrGetType AccelGroupModifierMaskPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo o, AttrSetTypeConstraint AccelGroupModifierMaskPropertyInfo b) => Proxy * AccelGroupModifierMaskPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo o => Proxy * AccelGroupModifierMaskPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo o, AttrSetTypeConstraint AccelGroupModifierMaskPropertyInfo b) => Proxy * AccelGroupModifierMaskPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AccelGroupModifierMaskPropertyInfo

type AttrOrigin AccelGroupModifierMaskPropertyInfo = AccelGroup

type AttrLabel AccelGroupModifierMaskPropertyInfo

type AttrLabel AccelGroupModifierMaskPropertyInfo = "modifier-mask"

type AttrGetType AccelGroupModifierMaskPropertyInfo

type AttrGetType AccelGroupModifierMaskPropertyInfo = [ModifierType]

type AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo

type AttrBaseTypeConstraint AccelGroupModifierMaskPropertyInfo = IsAccelGroup

type AttrSetTypeConstraint AccelGroupModifierMaskPropertyInfo

type AttrSetTypeConstraint AccelGroupModifierMaskPropertyInfo = * ~ ()

type AttrAllowedOps AccelGroupModifierMaskPropertyInfo

type AttrAllowedOps AccelGroupModifierMaskPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

accelGroupModifierMask :: AttrLabelProxy "modifierMask"

getAccelGroupModifierMask :: (MonadIO m, IsAccelGroup o) => o -> m [ModifierType]

Signals

accelActivate

type AccelGroupAccelActivateCallback = Object -> Word32 -> [ModifierType] -> IO Bool

data AccelGroupAccelActivateSignalInfo

Instances

SignalInfo AccelGroupAccelActivateSignalInfo

Associated Types

type HaskellCallbackType AccelGroupAccelActivateSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o AccelGroupAccelActivateSignalInfo -> o -> HaskellCallbackType AccelGroupAccelActivateSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType AccelGroupAccelActivateSignalInfo

type HaskellCallbackType AccelGroupAccelActivateSignalInfo = AccelGroupAccelActivateCallback

type C_AccelGroupAccelActivateCallback = Ptr () -> Ptr Object -> Word32 -> CUInt -> Ptr () -> IO CInt

afterAccelGroupAccelActivate :: (GObject a, MonadIO m) => a -> AccelGroupAccelActivateCallback -> m SignalHandlerId

genClosure_AccelGroupAccelActivate :: AccelGroupAccelActivateCallback -> IO Closure

mk_AccelGroupAccelActivateCallback :: C_AccelGroupAccelActivateCallback -> IO (FunPtr C_AccelGroupAccelActivateCallback)

noAccelGroupAccelActivateCallback :: Maybe AccelGroupAccelActivateCallback

onAccelGroupAccelActivate :: (GObject a, MonadIO m) => a -> AccelGroupAccelActivateCallback -> m SignalHandlerId

wrap_AccelGroupAccelActivateCallback :: AccelGroupAccelActivateCallback -> Ptr () -> Ptr Object -> Word32 -> CUInt -> Ptr () -> IO CInt

accelChanged

type AccelGroupAccelChangedCallback = Word32 -> [ModifierType] -> Closure -> IO ()

data AccelGroupAccelChangedSignalInfo

Instances

SignalInfo AccelGroupAccelChangedSignalInfo

Associated Types

type HaskellCallbackType AccelGroupAccelChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o AccelGroupAccelChangedSignalInfo -> o -> HaskellCallbackType AccelGroupAccelChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType AccelGroupAccelChangedSignalInfo

type HaskellCallbackType AccelGroupAccelChangedSignalInfo = AccelGroupAccelChangedCallback

type C_AccelGroupAccelChangedCallback = Ptr () -> Word32 -> CUInt -> Ptr Closure -> Ptr () -> IO ()

afterAccelGroupAccelChanged :: (GObject a, MonadIO m) => a -> AccelGroupAccelChangedCallback -> m SignalHandlerId

genClosure_AccelGroupAccelChanged :: AccelGroupAccelChangedCallback -> IO Closure

mk_AccelGroupAccelChangedCallback :: C_AccelGroupAccelChangedCallback -> IO (FunPtr C_AccelGroupAccelChangedCallback)

noAccelGroupAccelChangedCallback :: Maybe AccelGroupAccelChangedCallback

onAccelGroupAccelChanged :: (GObject a, MonadIO m) => a -> AccelGroupAccelChangedCallback -> m SignalHandlerId

wrap_AccelGroupAccelChangedCallback :: AccelGroupAccelChangedCallback -> Ptr () -> Word32 -> CUInt -> Ptr Closure -> Ptr () -> IO ()