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 : ObjectAtk {

protected

GtkAccessible* gtkAccessible;

GtkAccessible* getAccessibleStruct();

void* getStruct();

this(GtkAccessible* gtkAccessible);

void setStruct(GObject* obj);

void connectWidgetDestroyed();

Widget getWidget();

void setWidget(Widget widget);

}

Constructors

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

Members

Functions

connectWidgetDestroyed void connectWidgetDestroyed(): Warning gtk_accessible_connect_widget_destroyed has been deprecated since version 3.4 and should not be used in newly-written code. Use gtk_accessible_set_widget() and its vfuncs. This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.
getAccessibleStruct GtkAccessible* getAccessibleStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
getWidget 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. Since 2.22
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
setWidget void setWidget(Widget widget): Sets the GtkWidget corresponding to the GtkAccessible. Note 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 NULL. Since 2.22

Variables

gtkAccessible GtkAccessible* gtkAccessible;: the main Gtk struct

Inherited Members

From ObjectAtk

atkObject AtkObject* atkObject;: the main Gtk struct
getObjectAtkStruct AtkObject* getObjectAtkStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals int[string] connectedSignals;
onActiveDescendantChangedListeners void delegate(void*, ObjectAtk)[] onActiveDescendantChangedListeners;: Undocumented in source.
addOnActiveDescendantChanged void addOnActiveDescendantChanged(void delegate(void*, 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.
callBackActiveDescendantChanged void callBackActiveDescendantChanged(AtkObject* atkobjectStruct, void* arg1, ObjectAtk _objectAtk): Undocumented in source. Be warned that the author may not have intended to support it.
onChildrenChangedListeners void delegate(guint, void*, ObjectAtk)[] onChildrenChangedListeners;: Undocumented in source.
addOnChildrenChanged void addOnChildrenChanged(void delegate(guint, void*, 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"
callBackChildrenChanged void callBackChildrenChanged(AtkObject* atkobjectStruct, guint arg1, void* arg2, ObjectAtk _objectAtk): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusListeners void delegate(gboolean, ObjectAtk)[] onFocusListeners;: Undocumented in source.
addOnFocus void addOnFocus(void delegate(gboolean, ObjectAtk) dlg, ConnectFlags connectFlags): Warning AtkObject::focus-event is deprecated and should not be used in newly-written code. Since 2.9.4. Use "state-change" signal instead. The signal "focus-event" is emitted when an object gained or lost focus.
callBackFocus void callBackFocus(AtkObject* atkobjectStruct, gboolean arg1, ObjectAtk _objectAtk): Undocumented in source. Be warned that the author may not have intended to support it.
onPropertyChangeListeners void delegate(void*, ObjectAtk)[] onPropertyChangeListeners;: Undocumented in source.
addOnPropertyChange void addOnPropertyChange(void delegate(void*, ObjectAtk) dlg, ConnectFlags connectFlags): The signal "property-change" is emitted when an object's property value changes. The detail identifies the name of the property whose value has changed.
callBackPropertyChange void callBackPropertyChange(AtkObject* atkobjectStruct, void* arg1, ObjectAtk _objectAtk): Undocumented in source. Be warned that the author may not have intended to support it.
onStateChangeListeners void delegate(string, gboolean, ObjectAtk)[] onStateChangeListeners;: Undocumented in source.
addOnStateChange void addOnStateChange(void delegate(string, gboolean, 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.
callBackStateChange void callBackStateChange(AtkObject* atkobjectStruct, gchar* arg1, gboolean arg2, ObjectAtk _objectAtk): Undocumented in source. Be warned that the author may not have intended to support it.
onVisibleDataChangedListeners void delegate(ObjectAtk)[] onVisibleDataChangedListeners;: Undocumented in source.
addOnVisibleDataChanged void addOnVisibleDataChanged(void delegate(ObjectAtk) dlg, ConnectFlags connectFlags): The "visible-data-changed" signal is emitted when the visual appearance of the object changed.
callBackVisibleDataChanged void callBackVisibleDataChanged(AtkObject* atkobjectStruct, ObjectAtk _objectAtk): Undocumented in source. Be warned that the author may not have intended to support it.
roleRegister AtkRole roleRegister(string name): Registers the role specified by name.
implementorRefAccessible ObjectAtk implementorRefAccessible(AtkImplementor* implementor): Gets a reference to an object's AtkObject implementation, if the object implements AtkObjectIface
getName string getName(): Gets the accessible name of the accessible.
getDescription string getDescription(): Gets the accessible description of the accessible.
getParent ObjectAtk getParent(): Gets the accessible parent of the accessible.
getNAccessibleChildren int getNAccessibleChildren(): Gets the number of accessible children of the accessible.
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 AtkRelationSet associated with the object.
getLayer AtkLayer getLayer(): Warning atk_object_get_layer is deprecated and should not be used in newly-written code. Use atk_component_get_layer instead. Gets the layer of the accessible.
getMdiZorder int getMdiZorder(): Warning atk_object_get_mdi_zorder is deprecated and should not be used in newly-written code. Use atk_component_get_mdi_zorder instead. Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.
getRole AtkRole getRole(): Gets the role of the accessible.
refStateSet StateSet refStateSet(): Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
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.
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 "".
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 "".
setParent void setParent(ObjectAtk parent): Sets the accessible parent of the accessible.
setRole void setRole(AtkRole role): Sets the role of the accessible.
connectPropertyChangeHandler uint connectPropertyChangeHandler(AtkPropertyChangeHandler* handler): Specifies a function to be called when a property changes value.
removePropertyChangeHandler void removePropertyChangeHandler(uint handlerId): Removes a property change handler.
notifyStateChange void notifyStateChange(AtkState state, int value): Emits a state-change signal for the specified state.
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
addRelationship int addRelationship(AtkRelationType relationship, ObjectAtk target): Adds a relationship of the specified type with the specified target.
removeRelationship int removeRelationship(AtkRelationType relationship, ObjectAtk target): Removes a relationship of the specified type with the specified target.
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. Since 1.12
getObjectLocale string getObjectLocale(): Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible. Since 2.7.90
roleGetName string roleGetName(AtkRole role): Gets the description string describing the AtkRole role.
roleGetLocalizedName string roleGetLocalizedName(AtkRole role): Gets the localized description string describing the AtkRole role.
roleForName AtkRole roleForName(string name): Get the AtkRole type corresponding to a rolew name.