GI.Pango.Structs.Attribute

The Attribute structure represents the common portions of all attributes. Particular types of attributes include this structure as their initial portion. The common portion of the attribute holds the range to which the value in the type-specific part of the attribute applies and should be initialized using attributeInit. By default an attribute will have an all-inclusive range of [0,G_MAXUINT].

Exported types

newtype Attribute

Memory-managed wrapper type.

Constructors

Attribute (ManagedPtr Attribute)

Instances

Eq Attribute

Defined in GI.Pango.Structs.Attribute

Methods

(==) :: Attribute -> Attribute -> Bool

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

WrappedPtr Attribute

Defined in GI.Pango.Structs.Attribute

Methods

wrappedPtrCalloc :: IO (Ptr Attribute)

wrappedPtrCopy :: Attribute -> IO Attribute

wrappedPtrFree :: Maybe (GDestroyNotify Attribute)

noAttribute :: Maybe Attribute

A convenience alias for Nothing :: Maybe Attribute.

Methods

Overloaded methods

destroy

attributeDestroy

Arguments

:: (HasCallStack, MonadIO m)

=> Attribute

attr: a Attribute.

-> m ()

Destroy a Attribute and free all associated memory.

equal

attributeEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Attribute

attr1: a Attribute

-> Attribute

attr2: another Attribute

-> m Bool

Returns: True if the two attributes have the same value.

Compare two attributes for equality. This compares only the actual value of the two attributes and not the ranges that the attributes apply to.

init

attributeInit

Arguments

:: (HasCallStack, MonadIO m)

=> Attribute

attr: a Attribute

-> AttrClass

klass: a AttrClass

-> m ()

Initializes attr's klass to klass, it's start_index to ATTR_INDEX_FROM_TEXT_BEGINNING and end_index to PANGO_ATTR_INDEX_TO_TEXT_END such that the attribute applies to the entire text by default.

Since: 1.20

Properties

endIndex

end index of the range (in bytes). The character at this index is not included in the range.

getAttributeEndIndex :: MonadIO m => Attribute -> m Word32

Get the value of the “end_index” field. When overloading is enabled, this is equivalent to

get attribute #endIndex

setAttributeEndIndex :: MonadIO m => Attribute -> Word32 -> m ()

Set the value of the “end_index” field. When overloading is enabled, this is equivalent to

set attribute [ #endIndex := value ]

klass

the class structure holding information about the type of the attribute

clearAttributeKlass :: MonadIO m => Attribute -> m ()

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

clear #klass

getAttributeKlass :: MonadIO m => Attribute -> m (Maybe AttrClass)

Get the value of the “klass” field. When overloading is enabled, this is equivalent to

get attribute #klass

setAttributeKlass :: MonadIO m => Attribute -> Ptr AttrClass -> m ()

Set the value of the “klass” field. When overloading is enabled, this is equivalent to

set attribute [ #klass := value ]

startIndex

the start index of the range (in bytes).

getAttributeStartIndex :: MonadIO m => Attribute -> m Word32

Get the value of the “start_index” field. When overloading is enabled, this is equivalent to

get attribute #startIndex

setAttributeStartIndex :: MonadIO m => Attribute -> Word32 -> m ()

Set the value of the “start_index” field. When overloading is enabled, this is equivalent to

set attribute [ #startIndex := value ]