Accessible

The gtk.Accessible class is the base class for accessible implementations for gtk.Widget 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 gtk.Accessible 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 gtk.WidgetClass

class Accessible : ObjectAtk {

protected

GtkAccessible* gtkAccessible;

GtkAccessible* getAccessibleStruct(bool transferOwnership);

void* getStruct();

this(GtkAccessible* gtkAccessible, bool ownedRef);

static GType getType();

void connectWidgetDestroyed();

Widget getWidget();

void setWidget(Widget widget);

}

Constructors

this this(GtkAccessible* gtkAccessible, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

connectWidgetDestroyed void connectWidgetDestroyed(): This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.
getAccessibleStruct GtkAccessible* getAccessibleStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getWidget Widget getWidget(): Gets the gtk.Widget corresponding to the gtk.Accessible The returned widget does not have a reference added, so you do not need to unref it.
setWidget void setWidget(Widget widget): Sets the gtk.Widget corresponding to the gtk.Accessible

Static functions

getType GType getType()

Variables

gtkAccessible GtkAccessible* gtkAccessible;: the main Gtk struct

Inherited Members

From ObjectAtk

atkObject AtkObject* atkObject;: the main Gtk struct
getObjectAtkStruct AtkObject* getObjectAtkStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
addRelationship bool addRelationship(AtkRelationType relationship, ObjectAtk target): Adds a relationship of the specified type with the specified target.
connectPropertyChangeHandler uint connectPropertyChangeHandler(AtkPropertyChangeHandler* handler): Calls handler on property changes.
getAccessibleId string getAccessibleId(): Gets the accessible id of the accessible.
getAttributes AtkAttributeSet* getAttributes(): Get a list of properties applied to this object as a whole, as an AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" AtkAttributeSet properties.
getDescription string getDescription(): Gets the accessible description of 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 AtkLayer 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 ObjectAtk getParent(): Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), 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_set_parent(), and will return it with this method.
getRole AtkRole 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(AtkState state, bool value): Emits a state-change signal for the specified state.
peekParent ObjectAtk 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 ObjectAtk 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 RelationSet refRelationSet(): Gets the atk.RelationSet associated with the object.
refStateSet 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(AtkRelationType relationship, ObjectAtk target): Removes a relationship of the specified type with the specified target.
setAccessibleId void setAccessibleId(string name): 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 "".
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(ObjectAtk parent): Sets the accessible parent of the accessible. parent can be NULL.
setRole void setRole(AtkRole role): Sets the role of the accessible.
addOnActiveDescendantChanged gulong addOnActiveDescendantChanged(void delegate(ObjectAtk, ObjectAtk) dlg, ConnectFlags connectFlags): The "active-descendant-changed" signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.
addOnChildrenChanged gulong addOnChildrenChanged(void delegate(uint, ObjectAtk, ObjectAtk) dlg, ConnectFlags connectFlags): The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove"
addOnFocus gulong addOnFocus(void delegate(bool, ObjectAtk) dlg, ConnectFlags connectFlags): The signal "focus-event" is emitted when an object gained or lost focus.
addOnPropertyChange gulong addOnPropertyChange(void delegate(void*, ObjectAtk) dlg, ConnectFlags connectFlags): The signal "property-change" is emitted when an object's property value changes. arg1 contains an AtkPropertyValues with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not guarantee that the value of the property has actually changed; it may also be emitted when the setter of the property is called to reinstate the previous value.
addOnStateChange gulong addOnStateChange(void delegate(string, bool, ObjectAtk) dlg, ConnectFlags connectFlags): The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.
addOnVisibleDataChanged gulong addOnVisibleDataChanged(void delegate(ObjectAtk) dlg, ConnectFlags connectFlags): The "visible-data-changed" signal is emitted when the visual appearance of the object changed.
roleForName AtkRole roleForName(string name): Get the AtkRole type corresponding to a rolew name.
roleGetLocalizedName string roleGetLocalizedName(AtkRole role): Gets the localized description string describing the AtkRole role.
roleGetName string roleGetName(AtkRole role): Gets the description string describing the AtkRole role.
roleRegister AtkRole roleRegister(string name): Registers the role specified by name. name must be a meaningful name. So it should not be empty, or consisting on whitespaces.

gtk Accessible classes

Accessible