Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- newtype Attribute = Attribute (ManagedPtr Attribute)
- newZeroAttribute :: MonadIO m => m Attribute
- attributeSetFree :: (HasCallStack, MonadIO m) => [Ptr ()] -> m ()
- clearAttributeName :: MonadIO m => Attribute -> m ()
- getAttributeName :: MonadIO m => Attribute -> m (Maybe Text)
- setAttributeName :: MonadIO m => Attribute -> CString -> m ()
- clearAttributeValue :: MonadIO m => Attribute -> m ()
- getAttributeValue :: MonadIO m => Attribute -> m (Maybe Text)
- setAttributeValue :: MonadIO m => Attribute -> CString -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Attribute Source # | |
BoxedPtr Attribute Source # | |
Defined in GI.Atk.Structs.Attribute boxedPtrCopy :: Attribute -> IO Attribute boxedPtrFree :: Attribute -> IO () | |
CallocPtr Attribute Source # | |
Defined in GI.Atk.Structs.Attribute boxedPtrCalloc :: IO (Ptr Attribute) | |
ManagedPtrNewtype Attribute Source # | |
Defined in GI.Atk.Structs.Attribute toManagedPtr :: Attribute -> ManagedPtr Attribute | |
tag ~ 'AttrSet => Constructible Attribute tag Source # | |
newZeroAttribute :: MonadIO m => m Attribute Source #
Construct a Attribute
struct initialized to zero.
Methods
setFree
:: (HasCallStack, MonadIO m) | |
=> [Ptr ()] |
|
-> m () |
Frees the memory used by an AtkAttributeSet
, including all its
AtkAttributes
.
Properties
name
The attribute name.
clearAttributeName :: MonadIO m => Attribute -> m () Source #
Set the value of the “name
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#name
getAttributeName :: MonadIO m => Attribute -> m (Maybe Text) Source #
Get the value of the “name
” field.
When overloading is enabled, this is equivalent to
get
attribute #name
setAttributeName :: MonadIO m => Attribute -> CString -> m () Source #
Set the value of the “name
” field.
When overloading is enabled, this is equivalent to
set
attribute [ #name:=
value ]
value
the value of the attribute, represented as a string.
clearAttributeValue :: MonadIO m => Attribute -> m () Source #
Set the value of the “value
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#value
getAttributeValue :: MonadIO m => Attribute -> m (Maybe Text) Source #
Get the value of the “value
” field.
When overloading is enabled, this is equivalent to
get
attribute #value
setAttributeValue :: MonadIO m => Attribute -> CString -> m () Source #
Set the value of the “value
” field.
When overloading is enabled, this is equivalent to
set
attribute [ #value:=
value ]