atk.object

Module for [ObjectWrap] class

class ObjectWrap ObjectWrapGidBuilder ObjectWrapGidBuilderImpl

Types 3

classObjectWrap : gobject.object.ObjectWrap

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).

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

ObjectWrap self() nothrowReturns `this`, for use in `with` statements.

ObjectWrapGidBuilder builder() static nothrowGet builder for [atk.object.ObjectWrap] Returns: New builder object

int accessibleComponentLayer() @property nothrow

int accessibleComponentMdiZorder() @property nothrow

string accessibleDescription() @property nothrow

void accessibleDescription(string propval) @property nothrow

string accessibleHelpText() @property nothrow

void accessibleHelpText(string propval) @property nothrow

int accessibleHypertextNlinks() @property nothrow

string accessibleId() @property nothrow

void accessibleId(string propval) @property nothrow

string accessibleName() @property nothrow

void accessibleName(string propval) @property nothrow

atk.object.ObjectWrap accessibleParent() @property nothrow

void accessibleParent(atk.object.ObjectWrap propval) @property nothrow

atk.types.Role accessibleRole() @property nothrow

void accessibleRole(atk.types.Role propval) @property nothrow

string accessibleTableCaption() @property nothrowGet `accessibleTableCaption` property. Returns: Table caption.

void accessibleTableCaption(string propval) @property nothrowSet `accessibleTableCaption` property. Params: propval = Table caption.

atk.object.ObjectWrap accessibleTableCaptionObject() @property nothrow

void accessibleTableCaptionObject(atk.object.ObjectWrap propval) @property nothrow

string accessibleTableColumnDescription() @property nothrowGet `accessibleTableColumnDescription` property. Returns: Accessible table column description.

void accessibleTableColumnDescription(string propval) @property nothrowSet `accessibleTableColumnDescription` property. Params: propval = Accessible table column description.

atk.object.ObjectWrap accessibleTableColumnHeader() @property nothrowGet `accessibleTableColumnHeader` property. Returns: Accessible table column header.

void accessibleTableColumnHeader(atk.object.ObjectWrap propval) @property nothrowSet `accessibleTableColumnHeader` property. Params: propval = Accessible table column header.

string accessibleTableRowDescription() @property nothrowGet `accessibleTableRowDescription` property. Returns: Accessible table row description.

void accessibleTableRowDescription(string propval) @property nothrowSet `accessibleTableRowDescription` property. Params: propval = Accessible table row description.

atk.object.ObjectWrap accessibleTableRowHeader() @property nothrowGet `accessibleTableRowHeader` property. Returns: Accessible table row header.

void accessibleTableRowHeader(atk.object.ObjectWrap propval) @property nothrowSet `accessibleTableRowHeader` property. Params: propval = Accessible table row header.

atk.object.ObjectWrap accessibleTableSummary() @property nothrow

void accessibleTableSummary(atk.object.ObjectWrap propval) @property nothrow

double accessibleValue() @property nothrowGet `accessibleValue` property. Returns: Numeric value of this object, in case being and AtkValue.

void accessibleValue(double propval) @property nothrowSet `accessibleValue` property. Params: propval = Numeric value of this object, in case being and AtkValue.

bool addRelationship(atk.types.RelationType relationship, atk.object.ObjectWrap target) nothrowAdds a relationship of the specified type with the specified target.

string getAccessibleId() nothrowGets the accessible id of the accessible. Returns: a character string representing the accessible id of the object, or NULL if no such string was set.

string getDescription() nothrowGets the accessible description of the accessible. Returns: a character string representing the accessible description of the accessible.

string getHelpText() nothrowGets the help text associated with the accessible. Returns: a character string representing the help text or the object, or NULL if no such string was set.

int getIndexInParent() nothrowGets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. Returns: an integer which is the index of the accessible in its parent

atk.types.Layer getLayer() nothrowGets the layer of the accessible. Returns: an #AtkLayer which is the layer of the accessible

int getMdiZorder() nothrowGets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI. Returns: a gint which is the zorder of the accessible, i.e. the depth at ...

int getNAccessibleChildren() nothrowGets the number of accessible children of the accessible. Returns: an integer representing the number of accessible children of the accessible.

string getName() nothrowGets the accessible name of the accessible. Returns: a character string representing the accessible name of the object.

string getObjectLocale() nothrowGets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible. Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

atk.object.ObjectWrap getParent() nothrowGets 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 ...

atk.types.Role getRole() nothrowGets the role of the accessible. Returns: an #AtkRole which is the role of the accessible

void initialize(void * data = null) nothrowThis 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() function...

void notifyStateChange(atk.types.State state, bool value) nothrowEmits a state-change signal for the specified state.

atk.object.ObjectWrap peekParent() nothrowGets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns null.

atk.object.ObjectWrap refAccessibleChild(int i) nothrowGets 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.

atk.relation_set.RelationSet refRelationSet() nothrowGets the #AtkRelationSet associated with the object. Returns: an #AtkRelationSet representing the relation set of the object.

atk.state_set.StateSet refStateSet() nothrowGets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. Returns: a reference to an #AtkStateSet which is the state set of the accessible

void removePropertyChangeHandler(uint handlerId) nothrowRemoves a property change handler.

bool removeRelationship(atk.types.RelationType relationship, atk.object.ObjectWrap target) nothrowRemoves a relationship of the specified type with the specified target.

void setAccessibleId(string id) nothrowSets 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...

void setDescription(string description) nothrowSets 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 ...

void setHelpText(string helpText) nothrowSets 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.

void setName(string name) nothrowSets 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 t...

void setParent(atk.object.ObjectWrap parent) nothrowSets the accessible parent of the accessible. parent can be NULL.

void setRole(atk.types.Role role) nothrowSets the role of the accessible.

gulong connectActiveDescendantChanged(T)(string detail =  null,  T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  atk.object.ObjectWrap)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  3)

nothrowConnect to `ActiveDescendantChanged` signal.

gulong connectAnnouncement(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  3)

nothrowConnect to `Announcement` signal.

gulong connectAttributeChanged(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  string)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  4)

nothrowConnect to `AttributeChanged` signal.

gulong connectChildrenChanged(T)(string detail =  null,  T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  uint)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  atk.object.ObjectWrap)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  4)

nothrowConnect to `ChildrenChanged` signal.

gulong connectFocusEvent(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  bool)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  3)

nothrowConnect to `FocusEvent` signal.

gulong connectNotification(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  4)

nothrowConnect to `Notification` signal.

gulong connectPropertyChange(T)(string detail =  null,  T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  atk.property_values.PropertyValues)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  3)

nothrowConnect to `PropertyChange` signal.

gulong connectStateChange(T)(string detail =  null,  T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  bool)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  4)

nothrowConnect to `StateChange` signal.

gulong connectVisibleDataChanged(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  atk.object.ObjectWrap)))
   &&  Parameters!T.length <  2)

nothrowConnect to `VisibleDataChanged` signal.

Constructors

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

classObjectWrapGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for atk.object.ObjectWrap

Methods

T accessibleDescription(string propval) nothrow

T accessibleHelpText(string propval) nothrow

T accessibleId(string propval) nothrow

T accessibleName(string propval) nothrow

T accessibleParent(atk.object.ObjectWrap propval) nothrow

T accessibleRole(atk.types.Role propval) nothrow

T accessibleTableCaption(string propval) nothrowSet `accessibleTableCaption` property. Params: propval = Table caption. Returns: Builder instance for fluent chaining

T accessibleTableCaptionObject(atk.object.ObjectWrap propval) nothrow

T accessibleTableColumnDescription(string propval) nothrowSet `accessibleTableColumnDescription` property. Params: propval = Accessible table column description. Returns: Builder instance for fluent chaining

T accessibleTableColumnHeader(atk.object.ObjectWrap propval) nothrowSet `accessibleTableColumnHeader` property. Params: propval = Accessible table column header. Returns: Builder instance for fluent chaining

T accessibleTableRowDescription(string propval) nothrowSet `accessibleTableRowDescription` property. Params: propval = Accessible table row description. Returns: Builder instance for fluent chaining

T accessibleTableRowHeader(atk.object.ObjectWrap propval) nothrowSet `accessibleTableRowHeader` property. Params: propval = Accessible table row header. Returns: Builder instance for fluent chaining

T accessibleTableSummary(atk.object.ObjectWrap propval) nothrow

T accessibleValue(double propval) nothrowSet `accessibleValue` property. Params: propval = Numeric value of this object, in case being and AtkValue. Returns: Builder instance for fluent chaining

classObjectWrapGidBuilder : ObjectWrapGidBuilderImpl!ObjectWrapGidBuilder

Fluent builder for atk.object.ObjectWrap

Methods

ObjectWrap build() nothrowCreate object from builder. Returns: New object