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

GType _gType() @property

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

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

int accessibleComponentLayer() @property

int accessibleComponentMdiZorder() @property

string accessibleDescription() @property

void accessibleDescription(string propval) @property

string accessibleHelpText() @property

void accessibleHelpText(string propval) @property

int accessibleHypertextNlinks() @property

string accessibleId() @property

void accessibleId(string propval) @property

string accessibleName() @property

void accessibleName(string propval) @property

atk.object.ObjectWrap accessibleParent() @property

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

atk.types.Role accessibleRole() @property

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

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

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

atk.object.ObjectWrap accessibleTableCaptionObject() @property

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

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

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

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

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

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

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

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

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

atk.object.ObjectWrap accessibleTableSummary() @property

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

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

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

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

string getAccessibleId()Gets 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()Gets the accessible description of the accessible. Returns: a character string representing the accessible description of the accessible.

string getHelpText()Gets 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()Gets 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()Gets the layer of the accessible. Returns: an #AtkLayer which is the layer of the accessible

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

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

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

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

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

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

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

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

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

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.

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

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. Returns: a reference to an #AtkStateSet which is the state set of the accessible

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

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

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

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 ATKROLEUNKNOWN. If you want to se...

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.

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 ATKROLEUNKNOWN. If you want to set the name to ...

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

void setRole(atk.types.Role role)Sets 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)

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

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

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

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

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

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

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

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

Connect to `VisibleDataChanged` signal.

Constructors

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

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

Methods

T accessibleDescription(string propval)

T accessibleHelpText(string propval)

T accessibleId(string propval)

T accessibleName(string propval)

T accessibleParent(atk.object.ObjectWrap propval)

T accessibleRole(atk.types.Role propval)

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

T accessibleTableCaptionObject(atk.object.ObjectWrap propval)

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

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

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

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

T accessibleTableSummary(atk.object.ObjectWrap propval)

T accessibleValue(double propval)Set `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()