Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Atk.Structs.Attribute

Contents

Description

AtkAttribute is a string name/value pair representing a generic attribute. This can be used to expose additional information from an accessible object as a whole (see objectGetAttributes) or an document (see documentGetAttributes). In the case of text attributes (see textGetDefaultAttributes), TextAttribute enum defines all the possible text attribute names. You can use textAttributeGetName to get the string name from the enum value. See also textAttributeForName and textAttributeGetValue for more information.

A string name/value pair representing a generic attribute.

Synopsis

Exported types

Memory-managed wrapper type.

Constructors

Instances details

Eq Attribute Source #
Instance details Defined in GI.Atk.Structs.Attribute Methods (==) :: Attribute -> Attribute -> Bool # (/=) :: Attribute -> Attribute -> Bool #
WrappedPtr Attribute Source #
Instance details Defined in GI.Atk.Structs.Attribute Methods wrappedPtrCalloc :: IO (Ptr Attribute) # wrappedPtrCopy :: Attribute -> IO Attribute # wrappedPtrFree :: Maybe (GDestroyNotify Attribute) #
tag ~ 'AttrSet => Constructible Attribute tag Source #
Instance details Defined in GI.Atk.Structs.Attribute Methods new :: MonadIO m => (ManagedPtr Attribute -> Attribute) -> [AttrOp Attribute tag] -> m Attribute #

Construct a Attribute struct initialized to zero.

A convenience alias for Nothing :: Maybe Attribute.

Methods

Arguments

:: (HasCallStack, MonadIO m)
=> [Ptr ()]	`attribSet`: The `AtkAttributeSet` to free
-> m ()

Frees the memory used by an AtkAttributeSet, including all its AtkAttributes.

The attribute name.

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

clear #name

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

get attribute #name

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

set attribute [ #name := value ]

the value of the attribute, represented as a string.

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

clear #value

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

get attribute #value

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

set attribute [ #value := value ]