GI.IBus.Objects.Text

An IBusText is the main text object in IBus. The text is decorated according to associated IBusAttribute, e.g. the foreground/background color, underline, and applied scope.

see_also: Attribute

Exported types

newtype Text

Memory-managed wrapper type.

Constructors

Text (ManagedPtr Text)

Instances

Eq Text

Defined in GI.IBus.Objects.Text

Methods

(==) :: Text -> Text -> Bool

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

GObject Text

Defined in GI.IBus.Objects.Text

ManagedPtrNewtype Text

Defined in GI.IBus.Objects.Text

Methods

toManagedPtr :: Text -> ManagedPtr Text

TypedObject Text

Defined in GI.IBus.Objects.Text

Methods

glibType :: IO GType

HasParentTypes Text

Defined in GI.IBus.Objects.Text

IsGValue (Maybe Text)

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

Defined in GI.IBus.Objects.Text

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Text

Defined in GI.IBus.Objects.Text

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

class (GObject o, IsDescendantOf Text o) => IsText o

Type class for types which can be safely cast to Text, for instance with toText.

Instances

(GObject o, IsDescendantOf Text o) => IsText o

Defined in GI.IBus.Objects.Text

toText :: (MonadIO m, IsText o) => o -> m Text

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

appendAttribute, bindProperty, bindPropertyFull, copy, destroy, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, removeQattachment, runDispose, serializeObject, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAttributes, getData, getLength, getProperty, getQattachment, getQdata, getText.

Setters

setAttributes, setData, setDataFull, setProperty, setQattachment.

appendAttribute

textAppendAttribute

Arguments

:: (HasCallStack, MonadIO m, IsText a)

=> a

text: an IBusText

-> Word32

type: IBusAttributeType for text.

-> Word32

value: Value for the type.

-> Word32

startIndex: The starting index, inclusive.

-> Int32

endIndex: The ending index, exclusive.

-> m ()

Append an IBusAttribute for IBusText.

getAttributes

textGetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsText a)

=> a

text: An Text.

-> m AttrList

Returns: the attrs in text.

Return the attributes in an Text. Should not be freed.

getLength

textGetLength

Arguments

:: (HasCallStack, MonadIO m, IsText a)

=> a

text: An Text.

-> m Word32

Returns: Number of character in text, not counted by bytes.

Return number of characters in an Text. This function is based on utf8Strlen, so unlike strlen(), it does not count by bytes but characters instead.

getText

textGetText

Arguments

:: (HasCallStack, MonadIO m, IsText a)

=> a

text: An Text.

-> m Text

Returns: the text in text.

Return the text in an Text. Should not be freed.

newFromString

textNewFromString

Arguments

:: (HasCallStack, MonadIO m)

=> Text

str: An text string to be set.

-> m Text

Returns: A newly allocated Text.

Creates a new Text from a string. str will be duplicated in Text, so feel free to free str after this function.

newFromUcs4

textNewFromUcs4

Arguments

:: (HasCallStack, MonadIO m)

=> Char

str: An text string to be set.

-> m Text

Returns: A newly allocated Text.

Creates a new Text from an UCS-4 encoded string. str will be duplicated in IBusText, so feel free to free str after this function.

newFromUnichar

textNewFromUnichar

Arguments

:: (HasCallStack, MonadIO m)

=> Char

c: A single UCS4-encoded character.

-> m Text

Returns: A newly allocated Text.

Creates a new Text from a single UCS4-encoded character.

setAttributes

textSetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsText a, IsAttrList b)

=> a

text: An IBusText.

-> b

attrs: An IBusAttrList

-> m ()

No description available in the introspection data.