gi-ibus-1.5.2: IBus bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.IBus.Objects.UnicodeData

Description

Unicode data likes code, name, alias, block-name. You can get extended values with g_object_get_properties.

Synopsis

Exported types

newtype UnicodeData Source #

Memory-managed wrapper type.

Constructors

UnicodeData (ManagedPtr UnicodeData) 

Instances

Instances details
Eq UnicodeData Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

Methods

(==) :: UnicodeData -> UnicodeData -> Bool

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

GObject UnicodeData Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

ManagedPtrNewtype UnicodeData Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

Methods

toManagedPtr :: UnicodeData -> ManagedPtr UnicodeData

TypedObject UnicodeData Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

Methods

glibType :: IO GType

IsGValue UnicodeData Source #

Convert UnicodeData to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.IBus.Objects.UnicodeData

Methods

toGValue :: UnicodeData -> IO GValue

fromGValue :: GValue -> IO UnicodeData

HasParentTypes UnicodeData Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

type ParentTypes UnicodeData Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

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

class (GObject o, IsDescendantOf UnicodeData o) => IsUnicodeData o Source #

Type class for types which can be safely cast to UnicodeData, for instance with toUnicodeData.

Instances

Instances details
(GObject o, IsDescendantOf UnicodeData o) => IsUnicodeData o Source # 
Instance details

Defined in GI.IBus.Objects.UnicodeData

toUnicodeData :: (MonadIO m, IsUnicodeData o) => o -> m UnicodeData Source #

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

Methods

Overloaded methods

getAlias

unicodeDataGetAlias Source #

Arguments

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

unicode: An UnicodeData

-> m Text

Returns: alias property in UnicodeData

Gets the alias in UnicodeData. It should not be freed.

getBlockName

unicodeDataGetBlockName Source #

Arguments

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

unicode: An UnicodeData

-> m Text

Returns: block-name property in UnicodeData

Gets the block name in UnicodeData. It should not be freed.

getCode

unicodeDataGetCode Source #

Arguments

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

unicode: An UnicodeData

-> m Char

Returns: code property in UnicodeData

Gets the code point in UnicodeData.

getName

unicodeDataGetName Source #

Arguments

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

unicode: An UnicodeData

-> m Text

Returns: name property in UnicodeData

Gets the name in UnicodeData. It should not be freed.

load

unicodeDataLoad Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> Text

path: A path of the saved dictionary file.

-> Maybe a

object: If the Object has "unicode-deserialize-progress" signal, this function will emit (the number of desrialized UnicodeData, * the total number of UnicodeData) of uint values with that signal by 100 times. Otherwise Nothing.

-> m [UnicodeData]

Returns: An UnicodeData list loaded from the saved cache file.

No description available in the introspection data.

save

unicodeDataSave Source #

Arguments

:: (HasCallStack, MonadIO m, IsUnicodeData a) 
=> Text

path: A path of the saved Unicode data.

-> [a]

list: A list of unicode data.

-> m () 

Save the list of UnicodeData to the cache file.

setBlockName

unicodeDataSetBlockName Source #

Arguments

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

unicode: An UnicodeData

-> Text

blockName: A block name

-> m () 

Sets the block name in UnicodeData.

Properties

alias

The Uniode alias name

clearUnicodeDataAlias :: (MonadIO m, IsUnicodeData o) => o -> m () Source #

Set the value of the “alias” property to Nothing. When overloading is enabled, this is equivalent to

clear #alias

constructUnicodeDataAlias :: (IsUnicodeData o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getUnicodeDataAlias :: (MonadIO m, IsUnicodeData o) => o -> m Text Source #

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

get unicodeData #alias

setUnicodeDataAlias :: (MonadIO m, IsUnicodeData o) => o -> Text -> m () Source #

Set the value of the “alias” property. When overloading is enabled, this is equivalent to

set unicodeData [ #alias := value ]

blockName

The Uniode block name

constructUnicodeDataBlockName :: (IsUnicodeData o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getUnicodeDataBlockName :: (MonadIO m, IsUnicodeData o) => o -> m Text Source #

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

get unicodeData #blockName

setUnicodeDataBlockName :: (MonadIO m, IsUnicodeData o) => o -> Text -> m () Source #

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

set unicodeData [ #blockName := value ]

code

The Uniode code point

constructUnicodeDataCode :: (IsUnicodeData o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getUnicodeDataCode :: (MonadIO m, IsUnicodeData o) => o -> m Word32 Source #

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

get unicodeData #code

name

The Uniode name

clearUnicodeDataName :: (MonadIO m, IsUnicodeData o) => o -> m () Source #

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

clear #name

constructUnicodeDataName :: (IsUnicodeData 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.

getUnicodeDataName :: (MonadIO m, IsUnicodeData o) => o -> m Text Source #

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

get unicodeData #name

setUnicodeDataName :: (MonadIO m, IsUnicodeData o) => o -> Text -> m () Source #

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

set unicodeData [ #name := value ]