gi-gtk-3.0.24: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.CellRendererAccel

Contents

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

Exported types

class GObject o => IsCellRendererAccel o Source #

Type class for types which can be safely cast to CellRendererAccel, for instance with toCellRendererAccel.

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

new

cellRendererAccelNew Source #

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 => Word32 -> IO (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

set cellRendererAccel [ #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 => CellRendererAccelMode -> IO (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

set cellRendererAccel [ #accelMode := value ]

accelMods

The modifier mask of the accelerator.

Since: 2.10

constructCellRendererAccelAccelMods :: IsCellRendererAccel o => [ModifierType] -> IO (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

set cellRendererAccel [ #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 => Word32 -> IO (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

set cellRendererAccel [ #keycode := value ]

Signals

accelCleared

type C_CellRendererAccelAccelClearedCallback = Ptr () -> CString -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type CellRendererAccelAccelClearedCallback Source #

Arguments

 = Text

pathString: the path identifying the row of the edited cell

-> IO () 

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 “accel-cleared” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellRendererAccel #accelCleared callback

onCellRendererAccelAccelCleared :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelClearedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “accel-cleared” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellRendererAccel #accelCleared callback

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

pathString: the path identifying the row of the edited cell

-> Word32

accelKey: the new accelerator keyval

-> [ModifierType]

accelMods: the new acclerator modifier mask

-> Word32

hardwareKeycode: the keycode of the new accelerator

-> 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 “accel-edited” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellRendererAccel #accelEdited callback

onCellRendererAccelAccelEdited :: (IsCellRendererAccel a, MonadIO m) => a -> CellRendererAccelAccelEditedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “accel-edited” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellRendererAccel #accelEdited callback