gi-ibus-1.5.7: 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.EmojiData

Description

Emoji data likes emoji unicode, annotations, description, category. You can get extended values with g_object_get_properties.

Synopsis

Exported types

newtype EmojiData Source #

Memory-managed wrapper type.

Constructors

EmojiData (ManagedPtr EmojiData) 

Instances

Instances details
Eq EmojiData Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

GObject EmojiData Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

ManagedPtrNewtype EmojiData Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

Methods

toManagedPtr :: EmojiData -> ManagedPtr EmojiData

TypedObject EmojiData Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

Methods

glibType :: IO GType

HasParentTypes EmojiData Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

IsGValue (Maybe EmojiData) Source #

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

Instance details

Defined in GI.IBus.Objects.EmojiData

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes EmojiData Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

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

class (GObject o, IsDescendantOf EmojiData o) => IsEmojiData o Source #

Type class for types which can be safely cast to EmojiData, for instance with toEmojiData.

Instances

Instances details
(GObject o, IsDescendantOf EmojiData o) => IsEmojiData o Source # 
Instance details

Defined in GI.IBus.Objects.EmojiData

toEmojiData :: (MonadIO m, IsEmojiData o) => o -> m EmojiData Source #

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

Methods

getAnnotations

emojiDataGetAnnotations Source #

Arguments

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

emoji: An EmojiData

-> m [Text]

Returns: annotation list property in EmojiData

Gets the annotation list in EmojiData. It should not be freed.

getCategory

emojiDataGetCategory Source #

Arguments

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

emoji: An EmojiData

-> m Text

Returns: category property in EmojiData

Gets the emoji category in EmojiData. It should not be freed.

getDescription

emojiDataGetDescription Source #

Arguments

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

emoji: An EmojiData

-> m Text

Returns: description property in EmojiData

Gets the emoji description in EmojiData. It should not be freed.

getEmoji

emojiDataGetEmoji Source #

Arguments

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

emoji: An EmojiData

-> m Text

Returns: emoji property in EmojiData

Gets the emoji character in EmojiData. It should not be freed.

load

emojiDataLoad Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

path: A path of the saved dictionary file.

-> m [EmojiData]

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

No description available in the introspection data.

save

emojiDataSave Source #

Arguments

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

path: A path of the saved emoji data.

-> [a]

list: A list of emoji data.

-> m () 

Save the list of EmojiData to the cache file.

setAnnotations

emojiDataSetAnnotations Source #

Arguments

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

emoji: An EmojiData

-> [Text]

annotations: List of emoji annotations

-> m () 

Sets the annotation list in EmojiData.

setDescription

emojiDataSetDescription Source #

Arguments

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

emoji: An EmojiData

-> Text

description: An emoji description

-> m () 

Sets the description in EmojiData.

Properties

annotations

category

The emoji category

constructEmojiDataCategory :: (IsEmojiData o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEmojiDataCategory :: (MonadIO m, IsEmojiData o) => o -> m Text Source #

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

get emojiData #category

description

The emoji description

constructEmojiDataDescription :: (IsEmojiData o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEmojiDataDescription :: (MonadIO m, IsEmojiData o) => o -> m Text Source #

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

get emojiData #description

setEmojiDataDescription :: (MonadIO m, IsEmojiData o) => o -> Text -> m () Source #

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

set emojiData [ #description := value ]

emoji

The emoji character

constructEmojiDataEmoji :: (IsEmojiData o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEmojiDataEmoji :: (MonadIO m, IsEmojiData o) => o -> m Text Source #

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

get emojiData #emoji