| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.CellRendererAccel
Description
CellRendererAccel displays a keyboard accelerator (i.e. a key
combination like Control + a). If the cell renderer is editable,
the accelerator can be changed by simply typing the new combination.
The CellRendererAccel cell renderer was added in GTK+ 2.10.
Synopsis
- newtype CellRendererAccel = CellRendererAccel (ManagedPtr CellRendererAccel)
- class (GObject o, IsDescendantOf CellRendererAccel o) => IsCellRendererAccel o
- toCellRendererAccel :: (MonadIO m, IsCellRendererAccel o) => o -> m CellRendererAccel
- cellRendererAccelNew :: (HasCallStack, MonadIO m) => m CellRendererAccel
- constructCellRendererAccelAccelKey :: (IsCellRendererAccel o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCellRendererAccelAccelKey :: (MonadIO m, IsCellRendererAccel o) => o -> m Word32
- setCellRendererAccelAccelKey :: (MonadIO m, IsCellRendererAccel o) => o -> Word32 -> m ()
- constructCellRendererAccelAccelMode :: (IsCellRendererAccel o, MonadIO m) => CellRendererAccelMode -> m (GValueConstruct o)
- getCellRendererAccelAccelMode :: (MonadIO m, IsCellRendererAccel o) => o -> m CellRendererAccelMode
- setCellRendererAccelAccelMode :: (MonadIO m, IsCellRendererAccel o) => o -> CellRendererAccelMode -> m ()
- constructCellRendererAccelAccelMods :: (IsCellRendererAccel o, MonadIO m) => [ModifierType] -> m (GValueConstruct o)
- getCellRendererAccelAccelMods :: (MonadIO m, IsCellRendererAccel o) => o -> m [ModifierType]
- setCellRendererAccelAccelMods :: (MonadIO m, IsCellRendererAccel o) => o -> [ModifierType] -> m ()
- constructCellRendererAccelKeycode :: (IsCellRendererAccel o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCellRendererAccelKeycode :: (MonadIO m, IsCellRendererAccel o) => o -> m Word32
- setCellRendererAccelKeycode :: (MonadIO m, IsCellRendererAccel o) => o -> Word32 -> m ()
- type C_CellRendererAccelAccelClearedCallback = Ptr () -> CString -> Ptr () -> IO ()
- type CellRendererAccelAccelClearedCallback = Text -> IO ()
- afterCellRendererAccelAccelCleared :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelClearedCallback -> m SignalHandlerId
- genClosure_CellRendererAccelAccelCleared :: MonadIO m => CellRendererAccelAccelClearedCallback -> m (GClosure C_CellRendererAccelAccelClearedCallback)
- mk_CellRendererAccelAccelClearedCallback :: C_CellRendererAccelAccelClearedCallback -> IO (FunPtr C_CellRendererAccelAccelClearedCallback)
- noCellRendererAccelAccelClearedCallback :: Maybe CellRendererAccelAccelClearedCallback
- onCellRendererAccelAccelCleared :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelClearedCallback -> m SignalHandlerId
- wrap_CellRendererAccelAccelClearedCallback :: CellRendererAccelAccelClearedCallback -> C_CellRendererAccelAccelClearedCallback
- type C_CellRendererAccelAccelEditedCallback = Ptr () -> CString -> Word32 -> CUInt -> Word32 -> Ptr () -> IO ()
- type CellRendererAccelAccelEditedCallback = Text -> Word32 -> [ModifierType] -> Word32 -> IO ()
- afterCellRendererAccelAccelEdited :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelEditedCallback -> m SignalHandlerId
- genClosure_CellRendererAccelAccelEdited :: MonadIO m => CellRendererAccelAccelEditedCallback -> m (GClosure C_CellRendererAccelAccelEditedCallback)
- mk_CellRendererAccelAccelEditedCallback :: C_CellRendererAccelAccelEditedCallback -> IO (FunPtr C_CellRendererAccelAccelEditedCallback)
- noCellRendererAccelAccelEditedCallback :: Maybe CellRendererAccelAccelEditedCallback
- onCellRendererAccelAccelEdited :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelEditedCallback -> m SignalHandlerId
- wrap_CellRendererAccelAccelEditedCallback :: CellRendererAccelAccelEditedCallback -> C_CellRendererAccelAccelEditedCallback
Exported types
newtype CellRendererAccel Source #
Memory-managed wrapper type.
Constructors
| CellRendererAccel (ManagedPtr CellRendererAccel) |
Instances
class (GObject o, IsDescendantOf CellRendererAccel o) => IsCellRendererAccel o Source #
Type class for types which can be safely cast to CellRendererAccel, for instance with toCellRendererAccel.
Instances
| (GObject o, IsDescendantOf CellRendererAccel o) => IsCellRendererAccel o Source # | |
Defined in GI.Gtk.Objects.CellRendererAccel | |
toCellRendererAccel :: (MonadIO m, IsCellRendererAccel o) => o -> m CellRendererAccel Source #
Cast to CellRendererAccel, 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
activate, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isActivatable, isFloating, notify, notifyByPspec, ref, refSink, render, runDispose, startEditing, stealData, stealQdata, stopEditing, thawNotify, unref, watchClosure.
Getters
getAlignedArea, getAlignment, getData, getFixedSize, getPadding, getPreferredHeight, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRequestMode, getSensitive, getSize, getState, getVisible.
Setters
setAlignment, setData, setDataFull, setFixedHeightFromFont, setFixedSize, setPadding, setProperty, setSensitive, setVisible.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m CellRendererAccel | Returns: the new cell renderer |
Creates a new CellRendererAccel.
Since: 2.10
Properties
accelKey
The keyval of the accelerator.
Since: 2.10
constructCellRendererAccelAccelKey :: (IsCellRendererAccel o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “accel-key” property. This is rarely needed directly, but it is used by new.
getCellRendererAccelAccelKey :: (MonadIO m, IsCellRendererAccel o) => o -> m Word32 Source #
Get the value of the “accel-key” property.
When overloading is enabled, this is equivalent to
get cellRendererAccel #accelKey
setCellRendererAccelAccelKey :: (MonadIO m, IsCellRendererAccel o) => o -> Word32 -> m () Source #
Set the value of the “accel-key” property.
When overloading is enabled, this is equivalent to
setcellRendererAccel [ #accelKey:=value ]
accelMode
Determines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus.
Since: 2.10
constructCellRendererAccelAccelMode :: (IsCellRendererAccel o, MonadIO m) => CellRendererAccelMode -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “accel-mode” property. This is rarely needed directly, but it is used by new.
getCellRendererAccelAccelMode :: (MonadIO m, IsCellRendererAccel o) => o -> m CellRendererAccelMode Source #
Get the value of the “accel-mode” property.
When overloading is enabled, this is equivalent to
get cellRendererAccel #accelMode
setCellRendererAccelAccelMode :: (MonadIO m, IsCellRendererAccel o) => o -> CellRendererAccelMode -> m () Source #
Set the value of the “accel-mode” property.
When overloading is enabled, this is equivalent to
setcellRendererAccel [ #accelMode:=value ]
accelMods
The modifier mask of the accelerator.
Since: 2.10
constructCellRendererAccelAccelMods :: (IsCellRendererAccel o, MonadIO m) => [ModifierType] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “accel-mods” property. This is rarely needed directly, but it is used by new.
getCellRendererAccelAccelMods :: (MonadIO m, IsCellRendererAccel o) => o -> m [ModifierType] Source #
Get the value of the “accel-mods” property.
When overloading is enabled, this is equivalent to
get cellRendererAccel #accelMods
setCellRendererAccelAccelMods :: (MonadIO m, IsCellRendererAccel o) => o -> [ModifierType] -> m () Source #
Set the value of the “accel-mods” property.
When overloading is enabled, this is equivalent to
setcellRendererAccel [ #accelMods:=value ]
keycode
The hardware keycode of the accelerator. Note that the hardware keycode is only relevant if the key does not have a keyval. Normally, the keyboard configuration should assign keyvals to all keys.
Since: 2.10
constructCellRendererAccelKeycode :: (IsCellRendererAccel o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “keycode” property. This is rarely needed directly, but it is used by new.
getCellRendererAccelKeycode :: (MonadIO m, IsCellRendererAccel o) => o -> m Word32 Source #
Get the value of the “keycode” property.
When overloading is enabled, this is equivalent to
get cellRendererAccel #keycode
setCellRendererAccelKeycode :: (MonadIO m, IsCellRendererAccel o) => o -> Word32 -> m () Source #
Set the value of the “keycode” property.
When overloading is enabled, this is equivalent to
setcellRendererAccel [ #keycode:=value ]
Signals
accelCleared
type C_CellRendererAccelAccelClearedCallback = Ptr () -> CString -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CellRendererAccelAccelClearedCallback Source #
Gets emitted when the user has removed the accelerator.
Since: 2.10
afterCellRendererAccelAccelCleared :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelClearedCallback -> m SignalHandlerId Source #
Connect a signal handler for the accelCleared signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after cellRendererAccel #accelCleared callback
genClosure_CellRendererAccelAccelCleared :: MonadIO m => CellRendererAccelAccelClearedCallback -> m (GClosure C_CellRendererAccelAccelClearedCallback) Source #
Wrap the callback into a GClosure.
mk_CellRendererAccelAccelClearedCallback :: C_CellRendererAccelAccelClearedCallback -> IO (FunPtr C_CellRendererAccelAccelClearedCallback) Source #
Generate a function pointer callable from C code, from a C_CellRendererAccelAccelClearedCallback.
noCellRendererAccelAccelClearedCallback :: Maybe CellRendererAccelAccelClearedCallback Source #
A convenience synonym for Nothing :: Maybe CellRendererAccelAccelClearedCallback
onCellRendererAccelAccelCleared :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelClearedCallback -> m SignalHandlerId Source #
Connect a signal handler for the accelCleared signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on cellRendererAccel #accelCleared callback
wrap_CellRendererAccelAccelClearedCallback :: CellRendererAccelAccelClearedCallback -> C_CellRendererAccelAccelClearedCallback Source #
accelEdited
type C_CellRendererAccelAccelEditedCallback = Ptr () -> CString -> Word32 -> CUInt -> Word32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CellRendererAccelAccelEditedCallback Source #
Arguments
| = Text |
|
| -> Word32 |
|
| -> [ModifierType] |
|
| -> Word32 |
|
| -> IO () |
Gets emitted when the user has selected a new accelerator.
Since: 2.10
afterCellRendererAccelAccelEdited :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelEditedCallback -> m SignalHandlerId Source #
Connect a signal handler for the accelEdited signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after cellRendererAccel #accelEdited callback
genClosure_CellRendererAccelAccelEdited :: MonadIO m => CellRendererAccelAccelEditedCallback -> m (GClosure C_CellRendererAccelAccelEditedCallback) Source #
Wrap the callback into a GClosure.
mk_CellRendererAccelAccelEditedCallback :: C_CellRendererAccelAccelEditedCallback -> IO (FunPtr C_CellRendererAccelAccelEditedCallback) Source #
Generate a function pointer callable from C code, from a C_CellRendererAccelAccelEditedCallback.
noCellRendererAccelAccelEditedCallback :: Maybe CellRendererAccelAccelEditedCallback Source #
A convenience synonym for Nothing :: Maybe CellRendererAccelAccelEditedCallback
onCellRendererAccelAccelEdited :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelEditedCallback -> m SignalHandlerId Source #
Connect a signal handler for the accelEdited signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on cellRendererAccel #accelEdited callback