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.Structs.ShortcutEntry
Description
The ShortcutEntry
structure can be used to bulk register shortcuts
for a particular widget. It can also do the necessary hooks of registering
commands that can be changed using the keytheme components.
Synopsis
- newtype ShortcutEntry = ShortcutEntry (ManagedPtr ShortcutEntry)
- newZeroShortcutEntry :: MonadIO m => m ShortcutEntry
- clearShortcutEntryCommand :: MonadIO m => ShortcutEntry -> m ()
- getShortcutEntryCommand :: MonadIO m => ShortcutEntry -> m (Maybe Text)
- setShortcutEntryCommand :: MonadIO m => ShortcutEntry -> CString -> m ()
- clearShortcutEntryDefaultAccel :: MonadIO m => ShortcutEntry -> m ()
- getShortcutEntryDefaultAccel :: MonadIO m => ShortcutEntry -> m (Maybe Text)
- setShortcutEntryDefaultAccel :: MonadIO m => ShortcutEntry -> CString -> m ()
- clearShortcutEntryGroup :: MonadIO m => ShortcutEntry -> m ()
- getShortcutEntryGroup :: MonadIO m => ShortcutEntry -> m (Maybe Text)
- setShortcutEntryGroup :: MonadIO m => ShortcutEntry -> CString -> m ()
- getShortcutEntryPhase :: MonadIO m => ShortcutEntry -> m [ShortcutPhase]
- setShortcutEntryPhase :: MonadIO m => ShortcutEntry -> [ShortcutPhase] -> m ()
- clearShortcutEntrySection :: MonadIO m => ShortcutEntry -> m ()
- getShortcutEntrySection :: MonadIO m => ShortcutEntry -> m (Maybe Text)
- setShortcutEntrySection :: MonadIO m => ShortcutEntry -> CString -> m ()
- clearShortcutEntrySubtitle :: MonadIO m => ShortcutEntry -> m ()
- getShortcutEntrySubtitle :: MonadIO m => ShortcutEntry -> m (Maybe Text)
- setShortcutEntrySubtitle :: MonadIO m => ShortcutEntry -> CString -> m ()
- clearShortcutEntryTitle :: MonadIO m => ShortcutEntry -> m ()
- getShortcutEntryTitle :: MonadIO m => ShortcutEntry -> m (Maybe Text)
- setShortcutEntryTitle :: MonadIO m => ShortcutEntry -> CString -> m ()
Exported types
newtype ShortcutEntry Source #
Memory-managed wrapper type.
Constructors
ShortcutEntry (ManagedPtr ShortcutEntry) |
Instances
Eq ShortcutEntry Source # | |
Defined in GI.Dazzle.Structs.ShortcutEntry Methods (==) :: ShortcutEntry -> ShortcutEntry -> Bool # (/=) :: ShortcutEntry -> ShortcutEntry -> Bool # | |
BoxedPtr ShortcutEntry Source # | |
Defined in GI.Dazzle.Structs.ShortcutEntry | |
CallocPtr ShortcutEntry Source # | |
Defined in GI.Dazzle.Structs.ShortcutEntry Methods boxedPtrCalloc :: IO (Ptr ShortcutEntry) | |
ManagedPtrNewtype ShortcutEntry Source # | |
Defined in GI.Dazzle.Structs.ShortcutEntry Methods toManagedPtr :: ShortcutEntry -> ManagedPtr ShortcutEntry | |
tag ~ 'AttrSet => Constructible ShortcutEntry tag Source # | |
Defined in GI.Dazzle.Structs.ShortcutEntry Methods new :: MonadIO m => (ManagedPtr ShortcutEntry -> ShortcutEntry) -> [AttrOp ShortcutEntry tag] -> m ShortcutEntry |
newZeroShortcutEntry :: MonadIO m => m ShortcutEntry Source #
Construct a ShortcutEntry
struct initialized to zero.
Methods
Properties
command
the command identifier
clearShortcutEntryCommand :: MonadIO m => ShortcutEntry -> m () Source #
Set the value of the “command
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#command
getShortcutEntryCommand :: MonadIO m => ShortcutEntry -> m (Maybe Text) Source #
Get the value of the “command
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #command
setShortcutEntryCommand :: MonadIO m => ShortcutEntry -> CString -> m () Source #
Set the value of the “command
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #command:=
value ]
defaultAccel
the default accelerator for the command, if any
clearShortcutEntryDefaultAccel :: MonadIO m => ShortcutEntry -> m () Source #
Set the value of the “default_accel
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#defaultAccel
getShortcutEntryDefaultAccel :: MonadIO m => ShortcutEntry -> m (Maybe Text) Source #
Get the value of the “default_accel
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #defaultAccel
setShortcutEntryDefaultAccel :: MonadIO m => ShortcutEntry -> CString -> m () Source #
Set the value of the “default_accel
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #defaultAccel:=
value ]
group
the group for the shortcuts window
clearShortcutEntryGroup :: MonadIO m => ShortcutEntry -> m () Source #
Set the value of the “group
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#group
getShortcutEntryGroup :: MonadIO m => ShortcutEntry -> m (Maybe Text) Source #
Get the value of the “group
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #group
setShortcutEntryGroup :: MonadIO m => ShortcutEntry -> CString -> m () Source #
Set the value of the “group
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #group:=
value ]
phase
the phase for activation, or 0 for the default
getShortcutEntryPhase :: MonadIO m => ShortcutEntry -> m [ShortcutPhase] Source #
Get the value of the “phase
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #phase
setShortcutEntryPhase :: MonadIO m => ShortcutEntry -> [ShortcutPhase] -> m () Source #
Set the value of the “phase
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #phase:=
value ]
section
the section for the shortcuts window
clearShortcutEntrySection :: MonadIO m => ShortcutEntry -> m () Source #
Set the value of the “section
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#section
getShortcutEntrySection :: MonadIO m => ShortcutEntry -> m (Maybe Text) Source #
Get the value of the “section
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #section
setShortcutEntrySection :: MonadIO m => ShortcutEntry -> CString -> m () Source #
Set the value of the “section
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #section:=
value ]
subtitle
the subtitle for the shortcuts window, if any
clearShortcutEntrySubtitle :: MonadIO m => ShortcutEntry -> m () Source #
Set the value of the “subtitle
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#subtitle
getShortcutEntrySubtitle :: MonadIO m => ShortcutEntry -> m (Maybe Text) Source #
Get the value of the “subtitle
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #subtitle
setShortcutEntrySubtitle :: MonadIO m => ShortcutEntry -> CString -> m () Source #
Set the value of the “subtitle
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #subtitle:=
value ]
title
the title for the shortcuts window
clearShortcutEntryTitle :: MonadIO m => ShortcutEntry -> m () Source #
Set the value of the “title
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#title
getShortcutEntryTitle :: MonadIO m => ShortcutEntry -> m (Maybe Text) Source #
Get the value of the “title
” field.
When overloading is enabled, this is equivalent to
get
shortcutEntry #title
setShortcutEntryTitle :: MonadIO m => ShortcutEntry -> CString -> m () Source #
Set the value of the “title
” field.
When overloading is enabled, this is equivalent to
set
shortcutEntry [ #title:=
value ]