| 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.Objects.ATContext
Description
GtkATContext is an abstract class provided by GTK to communicate to platform-specific assistive technologies API.
Each platform supported by GTK implements a ATContext subclass, and
is responsible for updating the accessible state in response to state
changes in Accessible.
Synopsis
- newtype ATContext = ATContext (ManagedPtr ATContext)
- class (GObject o, IsDescendantOf ATContext o) => IsATContext o
- toATContext :: (MonadIO m, IsATContext o) => o -> m ATContext
- aTContextCreate :: (HasCallStack, MonadIO m, IsAccessible a, IsDisplay b) => AccessibleRole -> a -> b -> m (Maybe ATContext)
- aTContextGetAccessible :: (HasCallStack, MonadIO m, IsATContext a) => a -> m Accessible
- aTContextGetAccessibleRole :: (HasCallStack, MonadIO m, IsATContext a) => a -> m AccessibleRole
- constructATContextAccessible :: (IsATContext o, MonadIO m, IsAccessible a) => a -> m (GValueConstruct o)
- getATContextAccessible :: (MonadIO m, IsATContext o) => o -> m Accessible
- constructATContextAccessibleRole :: (IsATContext o, MonadIO m) => AccessibleRole -> m (GValueConstruct o)
- getATContextAccessibleRole :: (MonadIO m, IsATContext o) => o -> m AccessibleRole
- setATContextAccessibleRole :: (MonadIO m, IsATContext o) => o -> AccessibleRole -> m ()
- clearATContextDisplay :: (MonadIO m, IsATContext o) => o -> m ()
- constructATContextDisplay :: (IsATContext o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)
- getATContextDisplay :: (MonadIO m, IsATContext o) => o -> m (Maybe Display)
- setATContextDisplay :: (MonadIO m, IsATContext o, IsDisplay a) => o -> a -> m ()
- type ATContextStateChangeCallback = IO ()
- type C_ATContextStateChangeCallback = Ptr () -> Ptr () -> IO ()
- afterATContextStateChange :: (IsATContext a, MonadIO m) => a -> ATContextStateChangeCallback -> m SignalHandlerId
- genClosure_ATContextStateChange :: MonadIO m => ATContextStateChangeCallback -> m (GClosure C_ATContextStateChangeCallback)
- mk_ATContextStateChangeCallback :: C_ATContextStateChangeCallback -> IO (FunPtr C_ATContextStateChangeCallback)
- noATContextStateChangeCallback :: Maybe ATContextStateChangeCallback
- onATContextStateChange :: (IsATContext a, MonadIO m) => a -> ATContextStateChangeCallback -> m SignalHandlerId
- wrap_ATContextStateChangeCallback :: ATContextStateChangeCallback -> C_ATContextStateChangeCallback
Exported types
Memory-managed wrapper type.
Instances
| Eq ATContext Source # | |
| GObject ATContext Source # | |
Defined in GI.Gtk.Objects.ATContext | |
| ManagedPtrNewtype ATContext Source # | |
Defined in GI.Gtk.Objects.ATContext Methods toManagedPtr :: ATContext -> ManagedPtr ATContext | |
| TypedObject ATContext Source # | |
Defined in GI.Gtk.Objects.ATContext | |
| HasParentTypes ATContext Source # | |
Defined in GI.Gtk.Objects.ATContext | |
| IsGValue (Maybe ATContext) Source # | Convert |
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 Source # | |
Defined in GI.Gtk.Objects.ATContext | |
class (GObject o, IsDescendantOf ATContext o) => IsATContext o Source #
Type class for types which can be safely cast to ATContext, for instance with toATContext.
Instances
| (GObject o, IsDescendantOf ATContext o) => IsATContext o Source # | |
Defined in GI.Gtk.Objects.ATContext | |
toATContext :: (MonadIO m, IsATContext o) => o -> m ATContext Source #
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
create
Arguments
| :: (HasCallStack, MonadIO m, IsAccessible a, IsDisplay b) | |
| => AccessibleRole |
|
| -> a |
|
| -> b | |
| -> m (Maybe ATContext) | Returns: the |
getAccessible
aTContextGetAccessible Source #
Arguments
| :: (HasCallStack, MonadIO m, IsATContext a) | |
| => a |
|
| -> m Accessible | Returns: a |
Retrieves the Accessible using this context.
getAccessibleRole
aTContextGetAccessibleRole Source #
Arguments
| :: (HasCallStack, MonadIO m, IsATContext a) | |
| => a |
|
| -> m AccessibleRole | Returns: a |
Retrieves the accessible role of this context.
Properties
accessible
The Accessible that created the ATContext instance.
constructATContextAccessible :: (IsATContext o, MonadIO m, IsAccessible a) => a -> m (GValueConstruct o) Source #
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 Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “accessible-role” property.
When overloading is enabled, this is equivalent to
setaTContext [ #accessibleRole:=value ]
display
clearATContextDisplay :: (MonadIO m, IsATContext o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
Set the value of the “display” property.
When overloading is enabled, this is equivalent to
setaTContext [ #display:=value ]
Signals
stateChange
type ATContextStateChangeCallback = IO () Source #
Emitted when the attributes of the accessible for the
ATContext instance change.
type C_ATContextStateChangeCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
afterATContextStateChange :: (IsATContext a, MonadIO m) => a -> ATContextStateChangeCallback -> m SignalHandlerId Source #
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
genClosure_ATContextStateChange :: MonadIO m => ATContextStateChangeCallback -> m (GClosure C_ATContextStateChangeCallback) Source #
Wrap the callback into a GClosure.
mk_ATContextStateChangeCallback :: C_ATContextStateChangeCallback -> IO (FunPtr C_ATContextStateChangeCallback) Source #
Generate a function pointer callable from C code, from a C_ATContextStateChangeCallback.
noATContextStateChangeCallback :: Maybe ATContextStateChangeCallback Source #
A convenience synonym for Nothing :: Maybe ATContextStateChangeCallback
onATContextStateChange :: (IsATContext a, MonadIO m) => a -> ATContextStateChangeCallback -> m SignalHandlerId Source #
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