ObjectAtk

The base object class for the Accessibility Toolkit API.

This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of #AtkObject (or instances of AtkObject-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of #AtkObject may also be queried as to whether they implement other ATK interfaces (e.g. #AtkAction, #AtkComponent, etc.), as appropriate to the role which a given UI component plays in a user interface.

All UI components in an application which provide useful information or services to the user must provide corresponding #AtkObject instances on request (in GTK+, for instance, usually on a call to #gtk_widget_get_accessible ()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited #AtkObject implementation is insufficient, via instances of a new #AtkObject subclass.

See class@AtkObjectFactory, class@AtkRegistry. (GTK+ users see also #GtkAccessible).

class ObjectAtk : ObjectG {

bool addRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target);

string getAccessibleId();

string getDescription();

string getHelpText();

int getIndexInParent();

atk.types.Layer getLayer();

int getMdiZorder();

int getNAccessibleChildren();

string getName();

string getObjectLocale();

atk.object.ObjectAtk getParent();

atk.types.Role getRole();

void initialize(void* data);

void notifyStateChange(atk.types.State state, bool value);

atk.object.ObjectAtk peekParent();

atk.object.ObjectAtk refAccessibleChild(int i);

atk.relation_set.RelationSet refRelationSet();

atk.state_set.StateSet refStateSet();

void removePropertyChangeHandler(uint handlerId);

bool removeRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target);

void setAccessibleId(string id);

void setDescription(string description);

void setHelpText(string helpText);

void setName(string name);

void setParent(atk.object.ObjectAtk parent);

void setRole(atk.types.Role role);

ulong connectActiveDescendantChanged(string detail, T callback, Flag!"After" after);

ulong connectAnnouncement(T callback, Flag!"After" after);

ulong connectAttributeChanged(T callback, Flag!"After" after);

ulong connectChildrenChanged(string detail, T callback, Flag!"After" after);

ulong connectFocusEvent(T callback, Flag!"After" after);

ulong connectNotification(T callback, Flag!"After" after);

ulong connectPropertyChange(string detail, T callback, Flag!"After" after);

ulong connectStateChange(string detail, T callback, Flag!"After" after);

ulong connectVisibleDataChanged(T callback, Flag!"After" after);

}

Members

Functions

addRelationship bool addRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target): Adds a relationship of the specified type with the specified target.
connectActiveDescendantChanged ulong connectActiveDescendantChanged(string detail, T callback, Flag!"After" after): Connect to ActiveDescendantChanged signal.
connectAnnouncement ulong connectAnnouncement(T callback, Flag!"After" after): Connect to Announcement signal.
connectAttributeChanged ulong connectAttributeChanged(T callback, Flag!"After" after): Connect to AttributeChanged signal.
connectChildrenChanged ulong connectChildrenChanged(string detail, T callback, Flag!"After" after): Connect to ChildrenChanged signal.
connectFocusEvent ulong connectFocusEvent(T callback, Flag!"After" after): Connect to FocusEvent signal.
connectNotification ulong connectNotification(T callback, Flag!"After" after): Connect to Notification signal.
connectPropertyChange ulong connectPropertyChange(string detail, T callback, Flag!"After" after): Connect to PropertyChange signal.
connectStateChange ulong connectStateChange(string detail, T callback, Flag!"After" after): Connect to StateChange signal.
connectVisibleDataChanged ulong connectVisibleDataChanged(T callback, Flag!"After" after): Connect to VisibleDataChanged signal.
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.ObjectAtk getParent(): Gets the accessible parent of the accessible. By default this is the one assigned with atk.object.ObjectAtk.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.ObjectAtk.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.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 atk.object.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 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.ObjectAtk 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.ObjectAtk 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.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

atk object classes

ObjectAtk