gi-gtk-3.0.19: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.Accessible

Contents

Description

The Accessible class is the base class for accessible implementations for Widget subclasses. It is a thin wrapper around Object, which adds facilities for associating a widget with its accessible object.

An accessible implementation for a third-party widget should derive from Accessible and implement the suitable interfaces from ATK, such as Text or Selection. To establish the connection between the widget class and its corresponding acccessible implementation, override the get_accessible vfunc in WidgetClass.

Synopsis

Exported types

class GObject o => IsAccessible o Source #

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

Instances

(GObject a, UnknownAncestorError Constraint Accessible a) => IsAccessible a Source # 
IsAccessible WidgetAccessible Source # 
IsAccessible ToggleButtonAccessible Source # 
IsAccessible RendererCellAccessible Source # 
IsAccessible RangeAccessible Source # 
IsAccessible NotebookAccessible Source # 
IsAccessible MenuShellAccessible Source # 
IsAccessible MenuItemAccessible Source # 
IsAccessible EntryAccessible Source # 
IsAccessible ContainerAccessible Source # 
IsAccessible CheckMenuItemAccessible Source # 
IsAccessible CellAccessible Source # 
IsAccessible ButtonAccessible Source # 
IsAccessible Accessible Source # 
IsAccessible ArrowAccessible Source # 
IsAccessible BooleanCellAccessible Source # 
IsAccessible ComboBoxAccessible Source # 
IsAccessible ContainerCellAccessible Source # 
IsAccessible ExpanderAccessible Source # 
IsAccessible FlowBoxAccessible Source # 
IsAccessible FlowBoxChildAccessible Source # 
IsAccessible FrameAccessible Source # 
IsAccessible IconViewAccessible Source # 
IsAccessible ImageAccessible Source # 
IsAccessible ImageCellAccessible Source # 
IsAccessible LabelAccessible Source # 
IsAccessible LevelBarAccessible Source # 
IsAccessible LinkButtonAccessible Source # 
IsAccessible ListBoxAccessible Source # 
IsAccessible ListBoxRowAccessible Source # 
IsAccessible LockButtonAccessible Source # 
IsAccessible MenuAccessible Source # 
IsAccessible MenuButtonAccessible Source # 
IsAccessible PanedAccessible Source # 
IsAccessible PopoverAccessible Source # 
IsAccessible ProgressBarAccessible Source # 
IsAccessible RadioButtonAccessible Source # 
IsAccessible RadioMenuItemAccessible Source # 
IsAccessible ScaleAccessible Source # 
IsAccessible ScaleButtonAccessible Source # 
IsAccessible ScrolledWindowAccessible Source # 
IsAccessible SpinButtonAccessible Source # 
IsAccessible SpinnerAccessible Source # 
IsAccessible StackAccessible Source # 
IsAccessible StatusbarAccessible Source # 
IsAccessible SwitchAccessible Source # 
IsAccessible TextCellAccessible Source # 
IsAccessible TextViewAccessible Source # 
IsAccessible WindowAccessible Source # 
IsAccessible TreeViewAccessible Source # 

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

connectWidgetDestroyed

accessibleConnectWidgetDestroyed Source #

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a) 
=> a

accessible: a Accessible

-> m () 

Deprecated: (Since version 3.4)Use accessibleSetWidget and its vfuncs.

This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.

getWidget

accessibleGetWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a) 
=> a

accessible: a Accessible

-> m (Maybe Widget)

Returns: pointer to the Widget corresponding to the Accessible, or Nothing.

Gets the Widget corresponding to the Accessible. The returned widget does not have a reference added, so you do not need to unref it.

Since: 2.22

setWidget

accessibleSetWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsAccessible a, IsWidget b) 
=> a

accessible: a Accessible

-> Maybe b

widget: a Widget or Nothing to unset

-> m () 

Sets the Widget corresponding to the Accessible.

accessible will not hold a reference to widget. It is the caller’s responsibility to ensure that when widget is destroyed, the widget is unset by calling this function again with widget set to Nothing.

Since: 2.22

Properties

widget

No description available in the introspection data.

clearAccessibleWidget :: (MonadIO m, IsAccessible o) => o -> m () Source #

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

clear #widget

constructAccessibleWidget :: (IsAccessible o, IsWidget a) => a -> IO (GValueConstruct o) Source #

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

getAccessibleWidget :: (MonadIO m, IsAccessible o) => o -> m (Maybe Widget) Source #

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

get accessible #widget

setAccessibleWidget :: (MonadIO m, IsAccessible o, IsWidget a) => o -> a -> m () Source #

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

set accessible [ #widget := value ]