Wrapl, The Programming Language
Home
About
Documentation
Download
Links
DiscussLibraries:Gtk:Atk:Object
Types
T
Inherits from:This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of T (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 T may also be queried as to whether they implement other ATK interfaces (e.g. Gtk.Atk.Action.T, Gtk.Atk.Component.T, 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 T 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 T implementation is insufficient, via instances of a new T subclass.
Constants
Nil : T
Functions
GetType() : Gtk.GObject.Type.T
Methods
:AccessibleParent(self @ T) : Gtk.Atk.Object.T
:AddRelationship(self @ T, relationship @ Gtk.Atk.RelationType.T, target @ Gtk.Atk.Object.T) : Std.Symbol.T
Adds a relationship of the specified type with the specified target.
| object | The T to which an AtkRelation is to be added. |
| relationship | The Gtk.Atk.RelationType.T of the relation |
| target | The T which is to be the target of the relation. |
| Returns | TRUE if the relationship is added. |
:ConnectPropertyChangeHandler(self @ T, handler @ Std.Object.T) : Std.Integer.SmallT
Specifies a function to be called when a property changes value.
| accessible | an T |
| handler | a function to be called when a property changes its value |
| Returns | a guint which is the handler id used in RemovePropertyChangeHandler |
:Description(self @ T) : Std.String.T
:GetAttributes(self @ T) : Std.Object.T
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.
| accessible | An T. |
| Returns | an AtkAttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. [transfer none] |
:GetDescription(self @ T) : Std.String.T
Gets the accessible description of the accessible.
| accessible | an T |
| Returns | a character string representing the accessible description of the accessible. |
:GetIndexInParent(self @ T) : Std.Integer.SmallT
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
| accessible | an T |
| Returns | an integer which is the index of the accessible in its parent |
:GetLayer(self @ T) : Gtk.Atk.Layer.T
Warning
GetLayer is deprecated and should not be used in newly-written code. Use atk_component_get_layer instead.
:GetMdiZorder(self @ T) : Std.Integer.SmallT
Warning
GetMdiZorder is deprecated and should not be used in newly-written code. Use atk_component_get_mdi_zorder instead.
:GetNAccessibleChildren(self @ T) : Std.Integer.SmallT
Gets the number of accessible children of the accessible.
| accessible | an T |
| Returns | an integer representing the number of accessible children of the accessible. |
:GetName(self @ T) : Std.String.T
Gets the accessible name of the accessible.
| accessible | an T |
| Returns | a character string representing the accessible name of the object. |
:GetParent(self @ T) : Gtk.Atk.Object.T
Gets the accessible parent of the accessible.
| accessible | an T |
| Returns | a T representing the accessible parent of the accessible. [transfer none] |
:GetRole(self @ T) : Gtk.Atk.Role.T
Gets the role of the accessible.
| accessible | an T |
| Returns | an Gtk.Atk.Role.T which is the role of the accessible |
:Initialize(self @ T, data @ Std.Address.T) : Std.Object.T
This function is called when implementing subclasses of T. 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 T
:Layer(self @ T) : Gtk.Atk.Layer.T
:Name(self @ T) : Std.String.T
:NotifyStateChange(self @ T, state @ Std.Integer.T, value @ Std.Symbol.T) : Std.Object.T
Emits a state-change signal for the specified state.
| accessible | an T |
| state | an AtkState whose state is changed |
| value | a gboolean which indicates whether the state is being set on or off |
:RefAccessibleChild(self @ T, i @ Std.Integer.SmallT) : Gtk.Atk.Object.T
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.
| accessible | an T |
| i | a gint representing the position of the child, starting from 0 |
| Returns | an T representing the specified accessible child of the accessible. [transfer full] |
:RefRelationSet(self @ T) : Gtk.Atk.RelationSet.T
Gets the Gtk.Atk.RelationSet.T associated with the object.
| accessible | an T |
| Returns | an Gtk.Atk.RelationSet.T representing the relation set of the object. [transfer full] |
:RefStateSet(self @ T) : Gtk.Atk.StateSet.T
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
| accessible | an T |
| Returns | a reference to an Gtk.Atk.StateSet.T which is the state set of the accessible. [transfer full] |
:RelationSet(self @ T) : Gtk.Atk.RelationSet.T
:RemovePropertyChangeHandler(self @ T, handler_id @ Std.Integer.SmallT) : Std.Object.T
Removes a property change handler.
| accessible | an T |
| handler_id | a guint which identifies the handler to be removed. |
:RemoveRelationship(self @ T, relationship @ Gtk.Atk.RelationType.T, target @ Gtk.Atk.Object.T) : Std.Symbol.T
Removes a relationship of the specified type with the specified target.
| object | The T from which an AtkRelation is to be removed. |
| relationship | The Gtk.Atk.RelationType.T of the relation |
| target | The T which is the target of the relation to be removed. |
| Returns | TRUE if the relationship is removed. |
:Role(self @ T) : Gtk.Atk.Role.T
:SetDescription(self @ T, description @ Std.String.T) : Std.Object.T
Sets the accessible description of the accessible.
| accessible | an T |
| description | a character string to be set as the accessible description |
:SetName(self @ T, name @ Std.String.T) : Std.Object.T
Sets the accessible name of the accessible.
| accessible | an T |
| name | a character string to be set as the accessible name |
:SetParent(self @ T, parent @ Gtk.Atk.Object.T) : Std.Object.T
Sets the accessible parent of the accessible.