| 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 |
GI.Gtk.Interfaces.AccessibleText
Description
An interface for accessible objects containing formatted text.
The GtkAccessibleText interfaces is meant to be implemented by accessible
objects that have text formatted with attributes, or non-trivial text contents.
You should use the [enumgtk.AccessibleProperty.LABEL] or the
[enumgtk.AccessibleProperty.DESCRIPTION] properties for accessible
objects containing simple, unformatted text.
Since: 4.14
Synopsis
- newtype AccessibleText = AccessibleText (ManagedPtr AccessibleText)
- class (GObject o, IsDescendantOf AccessibleText o) => IsAccessibleText o
- toAccessibleText :: (MonadIO m, IsAccessibleText o) => o -> m AccessibleText
- accessibleTextUpdateCaretPosition :: (HasCallStack, MonadIO m, IsAccessibleText a) => a -> m ()
- accessibleTextUpdateContents :: (HasCallStack, MonadIO m, IsAccessibleText a) => a -> AccessibleTextContentChange -> Word32 -> Word32 -> m ()
- accessibleTextUpdateSelectionBound :: (HasCallStack, MonadIO m, IsAccessibleText a) => a -> m ()
Exported types
newtype AccessibleText Source #
Memory-managed wrapper type.
Constructors
| AccessibleText (ManagedPtr AccessibleText) |
Instances
| Eq AccessibleText Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText Methods (==) :: AccessibleText -> AccessibleText -> Bool # (/=) :: AccessibleText -> AccessibleText -> Bool # | |
| GObject AccessibleText Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText | |
| ManagedPtrNewtype AccessibleText Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText Methods toManagedPtr :: AccessibleText -> ManagedPtr AccessibleText | |
| TypedObject AccessibleText Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText | |
| HasParentTypes AccessibleText Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText | |
| IsGValue (Maybe AccessibleText) Source # | Convert |
Defined in GI.Gtk.Interfaces.AccessibleText Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe AccessibleText -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe AccessibleText) | |
| type ParentTypes AccessibleText Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText | |
class (GObject o, IsDescendantOf AccessibleText o) => IsAccessibleText o Source #
Type class for types which can be safely cast to AccessibleText, for instance with toAccessibleText.
Instances
| (GObject o, IsDescendantOf AccessibleText o) => IsAccessibleText o Source # | |
Defined in GI.Gtk.Interfaces.AccessibleText | |
toAccessibleText :: (MonadIO m, IsAccessibleText o) => o -> m AccessibleText Source #
Cast to AccessibleText, 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
announce, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, resetProperty, resetRelation, resetState, runDispose, stealData, stealQdata, thawNotify, unref, updateCaretPosition, updateContents, updateNextAccessibleSibling, updateProperty, updateRelation, updateSelectionBound, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getData, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, getProperty, getQdata.
Setters
updateCaretPosition
accessibleTextUpdateCaretPosition Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessibleText a) | |
| => a |
|
| -> m () |
Updates the position of the caret.
Implementations of the GtkAccessibleText interface should call this
function every time the caret has moved, in order to notify assistive
technologies.
Since: 4.14
updateContents
accessibleTextUpdateContents Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessibleText a) | |
| => a |
|
| -> AccessibleTextContentChange |
|
| -> Word32 |
|
| -> Word32 |
|
| -> m () |
Notifies assistive technologies of a change in contents.
Implementations of the GtkAccessibleText interface should call this
function every time their contents change as the result of an operation,
like an insertion or a removal.
Note: If the change is a deletion, this function must be called *before* removing the contents, if it is an insertion, it must be called *after* inserting the new contents.
Since: 4.14
updateSelectionBound
accessibleTextUpdateSelectionBound Source #
Arguments
| :: (HasCallStack, MonadIO m, IsAccessibleText a) | |
| => a |
|
| -> m () |
Updates the boundary of the selection.
Implementations of the GtkAccessibleText interface should call this
function every time the selection has moved, in order to notify assistive
technologies.
Since: 4.14