| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Interfaces.Accessible
Description
GtkAccessible provides an interface for describing a UI element, like a
Widget, in a way that can be consumed by Assistive Technologies, or
“AT”. Every accessible implementation has:
- a “role”, represented by a value of the
AccessibleRoleenumeration - an “attribute”, represented by a set of
AccessibleState,AccessiblePropertyandAccessibleRelationvalues
The role cannot be changed after instantiating a Accessible
implementation.
The attributes are updated every time a UI element's state changes in a way that
should be reflected by assistive technologies. For instance, if a Widget
visibility changes, the AccessibleStateHidden state will also change
to reflect the Widget:visible property.
Synopsis
- newtype Accessible = Accessible (ManagedPtr Accessible)
- class (GObject o, IsDescendantOf Accessible o) => IsAccessible o
- toAccessible :: (MonadIO m, IsAccessible o) => o -> m Accessible
- accessibleGetAccessibleRole :: (HasCallStack, MonadIO m, IsAccessible a) => a -> m AccessibleRole
- accessibleResetProperty :: (HasCallStack, MonadIO m, IsAccessible a) => a -> AccessibleProperty -> m ()
- accessibleResetRelation :: (HasCallStack, MonadIO m, IsAccessible a) => a -> AccessibleRelation -> m ()
- accessibleResetState :: (HasCallStack, MonadIO m, IsAccessible a) => a -> AccessibleState -> m ()
- accessibleUpdateProperty :: (HasCallStack, MonadIO m, IsAccessible a) => a -> [AccessibleProperty] -> [GValue] -> m ()
- accessibleUpdateRelation :: (HasCallStack, MonadIO m, IsAccessible a) => a -> [AccessibleRelation] -> [GValue] -> m ()
- accessibleUpdateState :: (HasCallStack, MonadIO m, IsAccessible a) => a -> [AccessibleState] -> [GValue] -> m ()
- constructAccessibleAccessibleRole :: (IsAccessible o, MonadIO m) => AccessibleRole -> m (GValueConstruct o)
- getAccessibleAccessibleRole :: (MonadIO m, IsAccessible o) => o -> m AccessibleRole
- setAccessibleAccessibleRole :: (MonadIO m, IsAccessible o) => o -> AccessibleRole -> m ()
Exported types
newtype Accessible Source #
Memory-managed wrapper type.
Constructors
| Accessible (ManagedPtr Accessible) |
Instances
| Eq Accessible Source # | |
Defined in GI.Gtk.Interfaces.Accessible | |
| GObject Accessible Source # | |
Defined in GI.Gtk.Interfaces.Accessible | |
| ManagedPtrNewtype Accessible Source # | |
Defined in GI.Gtk.Interfaces.Accessible Methods toManagedPtr :: Accessible -> ManagedPtr Accessible | |
| TypedObject Accessible Source # | |
Defined in GI.Gtk.Interfaces.Accessible | |
| HasParentTypes Accessible Source # | |
Defined in GI.Gtk.Interfaces.Accessible | |
| IsGValue (Maybe Accessible) Source # | Convert |
Defined in GI.Gtk.Interfaces.Accessible Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Accessible -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Accessible) | |
| type ParentTypes Accessible Source # | |
Defined in GI.Gtk.Interfaces.Accessible | |
class (GObject o, IsDescendantOf Accessible o) => IsAccessible o Source #
Type class for types which can be safely cast to Accessible, for instance with toAccessible.
Instances
| (GObject o, IsDescendantOf Accessible o) => IsAccessible o Source # | |
Defined in GI.Gtk.Interfaces.Accessible | |
toAccessible :: (MonadIO m, IsAccessible o) => o -> m Accessible Source #
Cast to Accessible, 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
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, resetProperty, resetRelation, resetState, runDispose, stealData, stealQdata, thawNotify, unref, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleRole, getData, getProperty, getQdata.
Setters
getAccessibleRole
accessibleGetAccessibleRole Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> m AccessibleRole | Returns: a |
Retrieves the AccessibleRole for the given Accessible.
resetProperty
accessibleResetProperty Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> AccessibleProperty |
|
| -> m () |
Resets the accessible property to its default value.
resetRelation
accessibleResetRelation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> AccessibleRelation |
|
| -> m () |
Resets the accessible relation to its default value.
resetState
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> AccessibleState |
|
| -> m () |
Resets the accessible state to its default value.
updateProperty
accessibleUpdateProperty Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> [AccessibleProperty] |
|
| -> [GValue] |
|
| -> m () |
Updates an array of accessible properties.
This function should be called by Widget types whenever an accessible
property change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
updateRelation
accessibleUpdateRelation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> [AccessibleRelation] |
|
| -> [GValue] |
|
| -> m () |
Updates an array of accessible relations.
This function should be called by Widget types whenever an accessible
relation change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
updateState
accessibleUpdateState Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a) | |
| => a |
|
| -> [AccessibleState] |
|
| -> [GValue] |
|
| -> m () |
Updates an array of accessible states.
This function should be called by Widget types whenever an accessible
state change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
Properties
accessibleRole
The accessible role of the given Accessible implementation.
The accessible role cannot be changed once set.
constructAccessibleAccessibleRole :: (IsAccessible o, MonadIO m) => AccessibleRole -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “accessible-role” property. This is rarely needed directly, but it is used by new.
getAccessibleAccessibleRole :: (MonadIO m, IsAccessible o) => o -> m AccessibleRole Source #
Get the value of the “accessible-role” property.
When overloading is enabled, this is equivalent to
get accessible #accessibleRole
setAccessibleAccessibleRole :: (MonadIO m, IsAccessible o) => o -> AccessibleRole -> m () Source #
Set the value of the “accessible-role” property.
When overloading is enabled, this is equivalent to
setaccessible [ #accessibleRole:=value ]