GI.IBus.Objects.EmojiData

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

Exported types

newtype EmojiData

Memory-managed wrapper type.

Constructors

EmojiData (ManagedPtr EmojiData)

Instances

Eq EmojiData

Defined in GI.IBus.Objects.EmojiData

Methods

(==) :: EmojiData -> EmojiData -> Bool

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

GObject EmojiData

Defined in GI.IBus.Objects.EmojiData

ManagedPtrNewtype EmojiData

Defined in GI.IBus.Objects.EmojiData

Methods

toManagedPtr :: EmojiData -> ManagedPtr EmojiData

TypedObject EmojiData

Defined in GI.IBus.Objects.EmojiData

Methods

glibType :: IO GType

IsGValue EmojiData

Convert EmojiData to and from GValue with toGValue and fromGValue.

Defined in GI.IBus.Objects.EmojiData

Methods

toGValue :: EmojiData -> IO GValue

fromGValue :: GValue -> IO EmojiData

HasParentTypes EmojiData

Defined in GI.IBus.Objects.EmojiData

type ParentTypes EmojiData

Defined in GI.IBus.Objects.EmojiData

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

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

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

Instances

(GObject o, IsDescendantOf EmojiData o) => IsEmojiData o

Defined in GI.IBus.Objects.EmojiData

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

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

Methods

Overloaded methods

getAnnotations

emojiDataGetAnnotations

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

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

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

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

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

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

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

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)

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

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)

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

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 ()

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)

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

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

get emojiData #emoji