Accessible

The #GtkAccessible class is the base class for accessible implementations for #GtkWidget subclasses. It is a thin wrapper around #AtkObject, which adds facilities for associating a widget with its accessible object.

An accessible implementation for a third-party widget should derive from #GtkAccessible and implement the suitable interfaces from ATK, such as #AtkText or #AtkSelection. To establish the connection between the widget class and its corresponding acccessible implementation, override the get_accessible vfunc in #GtkWidgetClass.

class Accessible : ObjectWrap {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

Accessible self();

static AccessibleGidBuilder builder();

gtk.widget.Widget widget [@property getter];

gtk.widget.Widget widget [@property setter];

void connectWidgetDestroyed();

gtk.widget.Widget getWidget();

void setWidget(gtk.widget.Widget widget);

}

Constructors

this this(void* ptr, Flag!"Take" take)

Members

Functions

connectWidgetDestroyed void connectWidgetDestroyed(): This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.
getWidget gtk.widget.Widget getWidget(): Gets the #GtkWidget corresponding to the #GtkAccessible. The returned widget does not have a reference added, so you do not need to unref it.
self Accessible self(): Returns this, for use in with statements.
setWidget void setWidget(gtk.widget.Widget widget): Sets the #GtkWidget corresponding to the #GtkAccessible.

Properties

_gType GType _gType [@property getter]
widget gtk.widget.Widget widget [@property getter]
widget gtk.widget.Widget widget [@property setter]

Static functions

_getGType GType _getGType()
builder AccessibleGidBuilder builder(): Get builder for gtk.accessible.Accessible

Inherited Members

From ObjectWrap

_getGType GType _getGType()
_gType GType _gType [@property getter]
self ObjectWrap self(): Returns this, for use in with statements.
builder ObjectWrapGidBuilder builder(): Get builder for atk.object.ObjectWrap
accessibleComponentLayer int accessibleComponentLayer [@property getter]
accessibleComponentMdiZorder int accessibleComponentMdiZorder [@property getter]
accessibleDescription string accessibleDescription [@property getter]
accessibleDescription string accessibleDescription [@property setter]
accessibleHelpText string accessibleHelpText [@property getter]
accessibleHelpText string accessibleHelpText [@property setter]
accessibleHypertextNlinks int accessibleHypertextNlinks [@property getter]
accessibleId string accessibleId [@property getter]
accessibleId string accessibleId [@property setter]
accessibleName string accessibleName [@property getter]
accessibleName string accessibleName [@property setter]
accessibleParent atk.object.ObjectWrap accessibleParent [@property getter]
accessibleParent atk.object.ObjectWrap accessibleParent [@property setter]
accessibleRole atk.types.Role accessibleRole [@property getter]
accessibleRole atk.types.Role accessibleRole [@property setter]
accessibleTableCaption string accessibleTableCaption [@property getter]: Get accessibleTableCaption property.
accessibleTableCaption string accessibleTableCaption [@property setter]: Set accessibleTableCaption property.
accessibleTableCaptionObject atk.object.ObjectWrap accessibleTableCaptionObject [@property getter]
accessibleTableCaptionObject atk.object.ObjectWrap accessibleTableCaptionObject [@property setter]
accessibleTableColumnDescription string accessibleTableColumnDescription [@property getter]: Get accessibleTableColumnDescription property.
accessibleTableColumnDescription string accessibleTableColumnDescription [@property setter]: Set accessibleTableColumnDescription property.
accessibleTableColumnHeader atk.object.ObjectWrap accessibleTableColumnHeader [@property getter]: Get accessibleTableColumnHeader property.
accessibleTableColumnHeader atk.object.ObjectWrap accessibleTableColumnHeader [@property setter]: Set accessibleTableColumnHeader property.
accessibleTableRowDescription string accessibleTableRowDescription [@property getter]: Get accessibleTableRowDescription property.
accessibleTableRowDescription string accessibleTableRowDescription [@property setter]: Set accessibleTableRowDescription property.
accessibleTableRowHeader atk.object.ObjectWrap accessibleTableRowHeader [@property getter]: Get accessibleTableRowHeader property.
accessibleTableRowHeader atk.object.ObjectWrap accessibleTableRowHeader [@property setter]: Set accessibleTableRowHeader property.
accessibleTableSummary atk.object.ObjectWrap accessibleTableSummary [@property getter]
accessibleTableSummary atk.object.ObjectWrap accessibleTableSummary [@property setter]
accessibleValue double accessibleValue [@property getter]: Get accessibleValue property.
accessibleValue double accessibleValue [@property setter]: Set accessibleValue property.
addRelationship bool addRelationship(atk.types.RelationType relationship, atk.object.ObjectWrap target): Adds a relationship of the specified type with the specified target.
getAccessibleId string getAccessibleId(): Gets the accessible id of the accessible.
getDescription string getDescription(): Gets the accessible description of the accessible.
getHelpText string getHelpText(): Gets the help text associated with the accessible.
getIndexInParent int getIndexInParent(): Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
getLayer atk.types.Layer getLayer(): Gets the layer of the accessible.
getMdiZorder int getMdiZorder(): Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.
getNAccessibleChildren int getNAccessibleChildren(): Gets the number of accessible children of the accessible.
getName string getName(): Gets the accessible name of the accessible.
getObjectLocale string getObjectLocale(): Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.
getParent atk.object.ObjectWrap getParent(): Gets the accessible parent of the accessible. By default this is the one assigned with atk.object.ObjectWrap.setParent, but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk.object.ObjectWrap.setParent, and will return it with this method.
getRole atk.types.Role getRole(): Gets the role of the accessible.
initialize void initialize(void* data): This function is called when implementing subclasses of #AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of #AtkObject
notifyStateChange void notifyStateChange(atk.types.State state, bool value): Emits a state-change signal for the specified state.
peekParent atk.object.ObjectWrap peekParent(): Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns null.
refAccessibleChild atk.object.ObjectWrap refAccessibleChild(int i): Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.
refRelationSet atk.relation_set.RelationSet refRelationSet(): Gets the #AtkRelationSet associated with the object.
refStateSet atk.state_set.StateSet refStateSet(): Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
removePropertyChangeHandler void removePropertyChangeHandler(uint handlerId): Removes a property change handler.
removeRelationship bool removeRelationship(atk.types.RelationType relationship, atk.object.ObjectWrap target): Removes a relationship of the specified type with the specified target.
setAccessibleId void setAccessibleId(string id): Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.
setDescription void setDescription(string description): Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
setHelpText void setHelpText(string helpText): Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object.
setName void setName(string name): Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
setParent void setParent(atk.object.ObjectWrap parent): Sets the accessible parent of the accessible. parent can be NULL.
setRole void setRole(atk.types.Role role): Sets the role of the accessible.
connectActiveDescendantChanged gulong connectActiveDescendantChanged(string detail, T callback, Flag!"After" after): Connect to ActiveDescendantChanged signal.
connectAnnouncement gulong connectAnnouncement(T callback, Flag!"After" after): Connect to Announcement signal.
connectAttributeChanged gulong connectAttributeChanged(T callback, Flag!"After" after): Connect to AttributeChanged signal.
connectChildrenChanged gulong connectChildrenChanged(string detail, T callback, Flag!"After" after): Connect to ChildrenChanged signal.
connectFocusEvent gulong connectFocusEvent(T callback, Flag!"After" after): Connect to FocusEvent signal.
connectNotification gulong connectNotification(T callback, Flag!"After" after): Connect to Notification signal.
connectPropertyChange gulong connectPropertyChange(string detail, T callback, Flag!"After" after): Connect to PropertyChange signal.
connectStateChange gulong connectStateChange(string detail, T callback, Flag!"After" after): Connect to StateChange signal.
connectVisibleDataChanged gulong connectVisibleDataChanged(T callback, Flag!"After" after): Connect to VisibleDataChanged signal.

gtk accessible classes