GI.IBus.Objects.HotkeyProfile

An opaque data type representing an IBusHotkeyProfile.

Exported types

newtype HotkeyProfile

Memory-managed wrapper type.

Constructors

HotkeyProfile (ManagedPtr HotkeyProfile)

Instances

Eq HotkeyProfile

Defined in GI.IBus.Objects.HotkeyProfile

Methods

(==) :: HotkeyProfile -> HotkeyProfile -> Bool

(/=) :: HotkeyProfile -> HotkeyProfile -> Bool

GObject HotkeyProfile

Defined in GI.IBus.Objects.HotkeyProfile

ManagedPtrNewtype HotkeyProfile

Defined in GI.IBus.Objects.HotkeyProfile

Methods

toManagedPtr :: HotkeyProfile -> ManagedPtr HotkeyProfile

TypedObject HotkeyProfile

Defined in GI.IBus.Objects.HotkeyProfile

Methods

glibType :: IO GType

HasParentTypes HotkeyProfile

Defined in GI.IBus.Objects.HotkeyProfile

IsGValue (Maybe HotkeyProfile)

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

Defined in GI.IBus.Objects.HotkeyProfile

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes HotkeyProfile

Defined in GI.IBus.Objects.HotkeyProfile

type ParentTypes HotkeyProfile = '[Serializable, Object, Object]

class (GObject o, IsDescendantOf HotkeyProfile o) => IsHotkeyProfile o

Type class for types which can be safely cast to HotkeyProfile, for instance with toHotkeyProfile.

Instances

(GObject o, IsDescendantOf HotkeyProfile o) => IsHotkeyProfile o

Defined in GI.IBus.Objects.HotkeyProfile

toHotkeyProfile :: (MonadIO m, IsHotkeyProfile o) => o -> m HotkeyProfile

Cast to HotkeyProfile, 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

addHotkey, addHotkeyFromString, bindProperty, bindPropertyFull, copy, destroy, filterKeyEvent, forceFloating, freezeNotify, getv, isFloating, lookupHotkey, notify, notifyByPspec, ref, refSink, removeHotkey, removeHotkeyByEvent, removeQattachment, runDispose, serializeObject, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQattachment, getQdata.

Setters

setData, setDataFull, setProperty, setQattachment.

addHotkey

hotkeyProfileAddHotkey

Arguments

:: (HasCallStack, MonadIO m, IsHotkeyProfile a)

=> a

profile: An IBusHotkeyProfile.

-> Word32

keyval: Keycode of the hotkey.

-> Word32

modifiers: Modifiers of the hotkey.

-> Word32

event: The event to be associated.

-> m Bool

Returns: Always True.

Adds a hotkey and its associated event to an HotkeyProfile.

addHotkeyFromString

hotkeyProfileAddHotkeyFromString

Arguments

:: (HasCallStack, MonadIO m, IsHotkeyProfile a)

=> a

profile: An IBusHotkeyProfile.

-> Text

str: Key in string representation. '+' is the separator.

-> Word32

event: The event to be associated.

-> m Bool

Returns: FALSE if str contains invalid symbol; TRUE otherwise.

Adds a hotkey and its associated event to an HotkeyProfile. The hotkey is in string format, such like <constant>Control+Shift+A</constant>.

filterKeyEvent

hotkeyProfileFilterKeyEvent

Arguments

:: (HasCallStack, MonadIO m, IsHotkeyProfile a)

=> a

profile: An IBusHotkeyProfile.

-> Word32

keyval: Keycode of the hotkey.

-> Word32

modifiers: Modifiers of the hotkey.

-> Word32

prevKeyval: Keycode of the hotkey.

-> Word32

prevModifiers: Modifiers of the hotkey.

-> Ptr ()

userData: user data for signal "trigger".

-> m Word32

Returns: 0 if releasing a hotkey and the hotkey is not in the profile; an associated event otherwise.

See also: trigger

Emits a <constant>trigger</constant> signal when a hotkey is in a profile.

lookupHotkey

hotkeyProfileLookupHotkey

Arguments

:: (HasCallStack, MonadIO m, IsHotkeyProfile a)

=> a

profile: An IBusHotkeyProfile.

-> Word32

keyval: Keycode of the hotkey.

-> Word32

modifiers: Modifiers of the hotkey.

-> m Word32

Returns: The event associated to the hotkey or 0 if the hotkey is not in the profile.

No description available in the introspection data.

new

hotkeyProfileNew

Arguments

:: (HasCallStack, MonadIO m)

=> m HotkeyProfile

Returns: A newly allocated HotkeyProfile.

Creates a new HotkeyProfile.

removeHotkey

hotkeyProfileRemoveHotkey

Arguments

:: (HasCallStack, MonadIO m, IsHotkeyProfile a)

=> a

profile: An IBusHotkeyProfile.

-> Word32

keyval: Keycode of the hotkey.

-> Word32

modifiers: Modifiers of the hotkey.

-> m Bool

Returns: False if the key is not in profile, True otherwise.

Removes the hotkey for an HotkeyProfile.

removeHotkeyByEvent

hotkeyProfileRemoveHotkeyByEvent

Arguments

:: (HasCallStack, MonadIO m, IsHotkeyProfile a)

=> a

profile: An IBusHotkeyProfile.

-> Word32

event: The associated event.

-> m Bool

Returns: False if no such event in profile, True otherwise.

Removes the hotkey for an HotkeyProfile by event.

Signals

trigger

type HotkeyProfileTriggerCallback

Arguments

 = Word32

event: An event in GQuark.

-> Ptr ()

userData: User data for callback.

-> IO ()

Emitted when a hotkey is pressed and the hotkey is in profile. Implement the member function trigger() in extended class to receive this signal.

<note><para>The last parameter, user_data is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note>

afterHotkeyProfileTrigger :: (IsHotkeyProfile a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => HotkeyProfileTriggerCallback) -> m SignalHandlerId

Connect a signal handler for the trigger signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after hotkeyProfile #trigger callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “trigger::detail” instead.

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.

onHotkeyProfileTrigger :: (IsHotkeyProfile a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => HotkeyProfileTriggerCallback) -> m SignalHandlerId

Connect a signal handler for the trigger signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on hotkeyProfile #trigger callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “trigger::detail” instead.