GI.Gtk.Objects.ATContext

GtkATContext is an abstract class provided by GTK to communicate to platform-specific assistive technologies API.

Each platform supported by GTK implements a GtkATContext subclass, and is responsible for updating the accessible state in response to state changes in GtkAccessible.

Exported types

newtype ATContext

Memory-managed wrapper type.

Constructors

ATContext (ManagedPtr ATContext)

Instances

Eq ATContext

Defined in GI.Gtk.Objects.ATContext

Methods

(==) :: ATContext -> ATContext -> Bool

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

GObject ATContext

Defined in GI.Gtk.Objects.ATContext

ManagedPtrNewtype ATContext

Defined in GI.Gtk.Objects.ATContext

Methods

toManagedPtr :: ATContext -> ManagedPtr ATContext

TypedObject ATContext

Defined in GI.Gtk.Objects.ATContext

Methods

glibType :: IO GType

HasParentTypes ATContext

Defined in GI.Gtk.Objects.ATContext

IsGValue (Maybe ATContext)

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

Defined in GI.Gtk.Objects.ATContext

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ATContext -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ATContext)

type ParentTypes ATContext

Defined in GI.Gtk.Objects.ATContext

type ParentTypes ATContext = '[Object]

class (GObject o, IsDescendantOf ATContext o) => IsATContext o

Type class for types which can be safely cast to ATContext, for instance with toATContext.

Instances

(GObject o, IsDescendantOf ATContext o) => IsATContext o

Defined in GI.Gtk.Objects.ATContext

toATContext :: (MonadIO m, IsATContext o) => o -> m ATContext

Cast to ATContext, 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, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAccessible, getAccessibleRole, getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

create

aTContextCreate

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a, IsDisplay b)

=> AccessibleRole

accessibleRole: the accessible role used by the GtkATContext

-> a

accessible: the GtkAccessible implementation using the GtkATContext

-> b

display: the GdkDisplay used by the GtkATContext

-> m (Maybe ATContext)

Returns: the GtkATContext

Creates a new GtkATContext instance for the given accessible role, accessible instance, and display connection.

The GtkATContext implementation being instantiated will depend on the platform.

getAccessible

aTContextGetAccessible

Arguments

:: (HasCallStack, MonadIO m, IsATContext a)

=> a

self: a GtkATContext

-> m Accessible

Returns: a GtkAccessible

Retrieves the GtkAccessible using this context.

getAccessibleRole

aTContextGetAccessibleRole

Arguments

:: (HasCallStack, MonadIO m, IsATContext a)

=> a

self: a GtkATContext

-> m AccessibleRole

Returns: a GtkAccessibleRole

Retrieves the accessible role of this context.

Properties

accessible

The GtkAccessible that created the GtkATContext instance.

constructATContextAccessible :: (IsATContext o, MonadIO m, IsAccessible a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “accessible” property. This is rarely needed directly, but it is used by new.

getATContextAccessible :: (MonadIO m, IsATContext o) => o -> m Accessible

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

get aTContext #accessible

accessibleRole

The accessible role used by the AT context.

Depending on the given role, different states and properties can be set or retrieved.

constructATContextAccessibleRole :: (IsATContext 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.

getATContextAccessibleRole :: (MonadIO m, IsATContext o) => o -> m AccessibleRole

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

get aTContext #accessibleRole

setATContextAccessibleRole :: (MonadIO m, IsATContext o) => o -> AccessibleRole -> m ()

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

set aTContext [ #accessibleRole := value ]

display

The GdkDisplay for the GtkATContext.

clearATContextDisplay :: (MonadIO m, IsATContext o) => o -> m ()

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

clear #display

constructATContextDisplay :: (IsATContext o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “display” property. This is rarely needed directly, but it is used by new.

getATContextDisplay :: (MonadIO m, IsATContext o) => o -> m (Maybe Display)

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

get aTContext #display

setATContextDisplay :: (MonadIO m, IsATContext o, IsDisplay a) => o -> a -> m ()

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

set aTContext [ #display := value ]

Signals

stateChange

type ATContextStateChangeCallback = IO ()

Emitted when the attributes of the accessible for the GtkATContext instance change.

afterATContextStateChange :: (IsATContext a, MonadIO m) => a -> ((?self :: a) => ATContextStateChangeCallback) -> m SignalHandlerId

Connect a signal handler for the stateChange signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after aTContext #stateChange callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onATContextStateChange :: (IsATContext a, MonadIO m) => a -> ((?self :: a) => ATContextStateChangeCallback) -> m SignalHandlerId

Connect a signal handler for the stateChange signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on aTContext #stateChange callback