gi-ibus-1.5.5: IBus bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.IBus.Objects.ExtensionEvent

Description

IBusExtensionEvent properties.

Synopsis

Exported types

newtype ExtensionEvent Source #

Memory-managed wrapper type.

Constructors

ExtensionEvent (ManagedPtr ExtensionEvent) 

Instances

Instances details
Eq ExtensionEvent Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

GObject ExtensionEvent Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

ManagedPtrNewtype ExtensionEvent Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

TypedObject ExtensionEvent Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

Methods

glibType :: IO GType

HasParentTypes ExtensionEvent Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

IsGValue (Maybe ExtensionEvent) Source #

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

Instance details

Defined in GI.IBus.Objects.ExtensionEvent

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ExtensionEvent Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

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

class (GObject o, IsDescendantOf ExtensionEvent o) => IsExtensionEvent o Source #

Type class for types which can be safely cast to ExtensionEvent, for instance with toExtensionEvent.

Instances

Instances details
(GObject o, IsDescendantOf ExtensionEvent o) => IsExtensionEvent o Source # 
Instance details

Defined in GI.IBus.Objects.ExtensionEvent

toExtensionEvent :: (MonadIO m, IsExtensionEvent o) => o -> m ExtensionEvent Source #

Cast to ExtensionEvent, for types for which this is known to be safe. For general casts, use castTo.

Methods

getName

extensionEventGetName :: (HasCallStack, MonadIO m, IsExtensionEvent a) => a -> m Text Source #

No description available in the introspection data.

getParams

extensionEventGetParams Source #

Arguments

:: (HasCallStack, MonadIO m, IsExtensionEvent a) 
=> a

event: An ExtensionEvent.

-> m Text

Returns: Parameters to enable the extension for XEvent

No description available in the introspection data.

getVersion

extensionEventGetVersion Source #

Arguments

:: (HasCallStack, MonadIO m, IsExtensionEvent a) 
=> a

event: An ExtensionEvent.

-> m Word32

Returns: Version of ExtensionEvent

No description available in the introspection data.

isEnabled

extensionEventIsEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsExtensionEvent a) 
=> a

event: An ExtensionEvent.

-> m Bool

Returns: True if the extension is enabled for ExtensionEvent

No description available in the introspection data.

isExtension

extensionEventIsExtension Source #

Arguments

:: (HasCallStack, MonadIO m, IsExtensionEvent a) 
=> a

event: An ExtensionEvent.

-> m Bool

Returns: True if the ExtensionEvent is called by an extension. False if the ExtensionEvent is called by an active engine or panel. If this value is True, the event is send to ibus-daemon, an active engine. If it's False, the event is sned to ibus-daemon, panels.

No description available in the introspection data.

Properties

isEnabled

True if the extension is enabled in the ExtensionEvent.

constructExtensionEventIsEnabled :: (IsExtensionEvent o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “is-enabled” property. This is rarely needed directly, but it is used by new.

getExtensionEventIsEnabled :: (MonadIO m, IsExtensionEvent o) => o -> m Bool Source #

Get the value of the “is-enabled” property. When overloading is enabled, this is equivalent to

get extensionEvent #isEnabled

isExtension

True if the ExtensionEvent is called by an extension. False if the ExtensionEvent is called by an active engine or panel. If this value is True, the event is send to ibus-daemon, an active engine. If it's False, the event is sned to ibus-daemon, panels.

constructExtensionEventIsExtension :: (IsExtensionEvent o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “is-extension” property. This is rarely needed directly, but it is used by new.

getExtensionEventIsExtension :: (MonadIO m, IsExtensionEvent o) => o -> m Bool Source #

Get the value of the “is-extension” property. When overloading is enabled, this is equivalent to

get extensionEvent #isExtension

name

Name of the extension in the ExtensionEvent.

constructExtensionEventName :: (IsExtensionEvent o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.

getExtensionEventName :: (MonadIO m, IsExtensionEvent o) => o -> m Text Source #

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get extensionEvent #name

params

Parameters to enable the extension in the ExtensionEvent.

constructExtensionEventParams :: (IsExtensionEvent o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “params” property. This is rarely needed directly, but it is used by new.

getExtensionEventParams :: (MonadIO m, IsExtensionEvent o) => o -> m Text Source #

Get the value of the “params” property. When overloading is enabled, this is equivalent to

get extensionEvent #params

version

Version of the ExtensionEvent.

getExtensionEventVersion :: (MonadIO m, IsExtensionEvent o) => o -> m Word32 Source #

Get the value of the “version” property. When overloading is enabled, this is equivalent to

get extensionEvent #version