GI.Gtk.Interfaces.Accessible

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 AccessibleRole enumeration
• an “attribute”, represented by a set of AccessibleState, AccessibleProperty and AccessibleRelation values

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.

Exported types

newtype Accessible

Memory-managed wrapper type.

Constructors

Accessible (ManagedPtr Accessible)

Instances

Eq Accessible

Defined in GI.Gtk.Interfaces.Accessible

Methods

(==) :: Accessible -> Accessible -> Bool

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

GObject Accessible

Defined in GI.Gtk.Interfaces.Accessible

ManagedPtrNewtype Accessible

Defined in GI.Gtk.Interfaces.Accessible

Methods

toManagedPtr :: Accessible -> ManagedPtr Accessible

TypedObject Accessible

Defined in GI.Gtk.Interfaces.Accessible

Methods

glibType :: IO GType

HasParentTypes Accessible

Defined in GI.Gtk.Interfaces.Accessible

IsGValue (Maybe Accessible)

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

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

Defined in GI.Gtk.Interfaces.Accessible

type ParentTypes Accessible = '[Object]

class (GObject o, IsDescendantOf Accessible o) => IsAccessible o

Type class for types which can be safely cast to Accessible, for instance with toAccessible.

Instances

(GObject o, IsDescendantOf Accessible o) => IsAccessible o

Defined in GI.Gtk.Interfaces.Accessible

toAccessible :: (MonadIO m, IsAccessible o) => o -> m Accessible

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

setData, setDataFull, setProperty.

getAccessibleRole

accessibleGetAccessibleRole

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> m AccessibleRole

Returns: a AccessibleRole

Retrieves the AccessibleRole for the given Accessible.

resetProperty

accessibleResetProperty

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> AccessibleProperty

property: a AccessibleProperty

-> m ()

Resets the accessible property to its default value.

resetRelation

accessibleResetRelation

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> AccessibleRelation

relation: a AccessibleRelation

-> m ()

Resets the accessible relation to its default value.

resetState

accessibleResetState

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> AccessibleState

state: a AccessibleState

-> m ()

Resets the accessible state to its default value.

updateProperty

accessibleUpdateProperty

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> [AccessibleProperty]

properties: an array of AccessibleProperty

-> [GValue]

values: an array of GValues, one for each property

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> [AccessibleRelation]

relations: an array of AccessibleRelation

-> [GValue]

values: an array of GValues, one for each relation

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a)

=> a

self: a Accessible

-> [AccessibleState]

states: an array of AccessibleState

-> [GValue]

values: an array of GValues, one for each state

-> 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)

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

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 ()

Set the value of the “accessible-role” property. When overloading is enabled, this is equivalent to

set accessible [ #accessibleRole := value ]