Class: Atk::Object

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Direct Known Subclasses

GObjectAccessible, NoOpObject, Plug, Socket

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ nil

This function is called when implementing subclasses of Atk::Object. 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 Atk::Object

Parameters:

  • data (GObject) —

    a #gpointer which identifies the object for which the AtkObject was created.

Instance Method Details

#accessible_component_layer ⇒ Integer

Returns accessible-component-layer.

Returns:

  • (Integer) —

    accessible-component-layer

#accessible_component_layer=(accessible_component_layer) ⇒ Integer

Parameters:

  • accessible_component_layer (Integer)

Returns:

  • (Integer) —

    accessible-component-layer

  • (Integer) —

    accessible-component-layer

#accessible_component_mdi_zorder ⇒ Integer

Returns accessible-component-mdi-zorder.

Returns:

  • (Integer) —

    accessible-component-mdi-zorder

#accessible_component_mdi_zorder=(accessible_component_mdi_zorder) ⇒ Integer

Parameters:

  • accessible_component_mdi_zorder (Integer)

Returns:

  • (Integer) —

    accessible-component-mdi-zorder

  • (Integer) —

    accessible-component-mdi-zorder

#accessible_description ⇒ String

Returns accessible-description.

Returns:

  • (String) —

    accessible-description

#accessible_description=(accessible_description) ⇒ String

Parameters:

  • accessible_description (String)

Returns:

  • (String) —

    accessible-description

  • (String) —

    accessible-description

#accessible_help_text ⇒ String

Returns accessible-help-text.

Returns:

  • (String) —

    accessible-help-text

#accessible_help_text=(accessible_help_text) ⇒ String

Parameters:

  • accessible_help_text (String)

Returns:

  • (String) —

    accessible-help-text

  • (String) —

    accessible-help-text

#accessible_hypertext_nlinks ⇒ Integer

Returns accessible-hypertext-nlinks.

Returns:

  • (Integer) —

    accessible-hypertext-nlinks

#accessible_hypertext_nlinks=(accessible_hypertext_nlinks) ⇒ Integer

Parameters:

  • accessible_hypertext_nlinks (Integer)

Returns:

  • (Integer) —

    accessible-hypertext-nlinks

  • (Integer) —

    accessible-hypertext-nlinks

#accessible_id ⇒ String

Returns accessible-id.

Returns:

  • (String) —

    accessible-id

#accessible_id=(accessible_id) ⇒ String

Parameters:

  • accessible_id (String)

Returns:

  • (String) —

    accessible-id

  • (String) —

    accessible-id

#accessible_name ⇒ String

Returns accessible-name.

Returns:

  • (String) —

    accessible-name

#accessible_name=(accessible_name) ⇒ String

Parameters:

  • accessible_name (String)

Returns:

  • (String) —

    accessible-name

  • (String) —

    accessible-name

#accessible_parent ⇒ Atk::Object

Returns accessible-parent.

Returns:

#accessible_parent=(accessible_parent) ⇒ Atk::Object

Parameters:

Returns:

#accessible_role ⇒ Atk::Role

Returns accessible-role.

Returns:

#accessible_role=(accessible_role) ⇒ Atk::Role

Parameters:

Returns:

#accessible_table_caption ⇒ String

Table caption.

Returns:

  • (String) —

    accessible-table-caption

#accessible_table_caption=(accessible_table_caption) ⇒ String

Table caption.

Parameters:

  • accessible_table_caption (String)

Returns:

  • (String) —

    accessible-table-caption

  • (String) —

    accessible-table-caption

#accessible_table_caption_object ⇒ Atk::Object

Returns accessible-table-caption-object.

Returns:

#accessible_table_caption_object=(accessible_table_caption_object) ⇒ Atk::Object

Parameters:

Returns:

#accessible_table_column_description ⇒ String

Accessible table column description.

Returns:

  • (String) —

    accessible-table-column-description

#accessible_table_column_description=(accessible_table_column_description) ⇒ String

Accessible table column description.

Parameters:

  • accessible_table_column_description (String)

Returns:

  • (String) —

    accessible-table-column-description

  • (String) —

    accessible-table-column-description

#accessible_table_column_header ⇒ Atk::Object

Accessible table column header.

Returns:

#accessible_table_column_header=(accessible_table_column_header) ⇒ Atk::Object

Accessible table column header.

Parameters:

Returns:

#accessible_table_row_description ⇒ String

Accessible table row description.

Returns:

  • (String) —

    accessible-table-row-description

#accessible_table_row_description=(accessible_table_row_description) ⇒ String

Accessible table row description.

Parameters:

  • accessible_table_row_description (String)

Returns:

  • (String) —

    accessible-table-row-description

  • (String) —

    accessible-table-row-description

#accessible_table_row_header ⇒ Atk::Object

Accessible table row header.

Returns:

#accessible_table_row_header=(accessible_table_row_header) ⇒ Atk::Object

Accessible table row header.

Parameters:

Returns:

#accessible_table_summary ⇒ Atk::Object

Returns accessible-table-summary.

Returns:

#accessible_table_summary=(accessible_table_summary) ⇒ Atk::Object

Parameters:

Returns:

#accessible_value ⇒ Float

Numeric value of this object, in case being and AtkValue.

Returns:

  • (Float) —

    accessible-value

#accessible_value=(accessible_value) ⇒ Float

Numeric value of this object, in case being and AtkValue.

Parameters:

  • accessible_value (Float)

Returns:

  • (Float) —

    accessible-value

  • (Float) —

    accessible-value

#add_relationship(relationship, target) ⇒ Boolean

Adds a relationship of the specified type with the specified target.

Parameters:

  • relationship (Atk::RelationType) —

    The Atk::RelationType of the relation

  • target (Atk::Object) —

    The Atk::Object which is to be the target of the relation.

Returns:

  • (Boolean) —

    TRUE if the relationship is added.

#attributes ⇒ Atk::AttributeSet

Get a list of properties applied to this object as a whole, as an Atk::AttributeSet 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" Atk::AttributeSet properties. explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to atk_attribute_set_free().

Returns:

  • (Atk::AttributeSet) —

    an Atk::AttributeSet consisting of all

#connect_property_change_handler(handler) ⇒ Integer

Calls handler on property changes.

Parameters:

  • handler (Atk::PropertyChangeHandler) —

    a function to be called when a property changes its value

Returns:

  • (Integer) —

    a #guint which is the handler id used in atk_object_remove_property_change_handler()

#description ⇒ String

Gets the accessible description of the accessible. of the accessible.

Returns:

  • (String) —

    a character string representing the accessible description

#description=(description) ⇒ nil

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

Parameters:

  • description (String) —

    a character string to be set as the accessible description

Returns:

  • (nil)

#help_text ⇒ String

Gets the help text associated with the accessible. NULL if no such string was set.

Returns:

  • (String) —

    a character string representing the help text or the object, or

#help_text=(help_text) ⇒ nil

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.

Parameters:

  • help_text (String) —

    a character string to be set as the accessible's help text

Returns:

  • (nil)

#index_in_parent ⇒ Integer

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

Returns:

  • (Integer) —

    an integer which is the index of the accessible in its parent

#layer ⇒ Atk::Layer

Gets the layer of the accessible.

Returns:

  • (Atk::Layer) —

    an Atk::Layer which is the layer of the accessible

#mdi_zorder ⇒ Integer

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI. which the component is shown in relation to other components in the same container.

Returns:

  • (Integer) —

    a gint which is the zorder of the accessible, i.e. the depth at

#n_accessible_children ⇒ Integer

Gets the number of accessible children of the accessible. of the accessible.

Returns:

  • (Integer) —

    an integer representing the number of accessible children

#name ⇒ String

Gets the accessible name of the accessible.

Returns:

  • (String) —

    a character string representing the accessible name of the object.

#name=(name) ⇒ nil

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

Parameters:

  • name (String) —

    a character string to be set as the accessible name

Returns:

  • (nil)

#notify_state_change(state, value) ⇒ nil

Emits a state-change signal for the specified state.

Note that as a general rule when the state of an existing object changes, emitting a notification is expected.

Parameters:

  • state (Atk::State) —

    an Atk::State whose state is changed

  • value (Boolean) —

    a gboolean which indicates whether the state is being set on or off

Returns:

  • (nil)

#object_locale ⇒ String

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

Returns:

  • (String) —

    a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

#parent ⇒ Atk::Object

Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), 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_set_parent(), and will return it with this method.

If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent(). parent of the accessible

Returns:

  • (Atk::Object) —

    an Atk::Object representing the accessible

#parent=(parent) ⇒ nil

Sets the accessible parent of the accessible. parent can be NULL.

Parameters:

  • parent (Atk::Object) —

    an Atk::Object to be set as the accessible parent

Returns:

  • (nil)

#peek_parent ⇒ Atk::Object

Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns nil.

This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See atk_object_get_parent() for further reference. parent of the accessible if assigned

Returns:

  • (Atk::Object) —

    an Atk::Object representing the accessible

#ref_accessible_child(i) ⇒ Atk::Object

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 child of the accessible.

Parameters:

  • i (Integer) —

    a gint representing the position of the child, starting from 0

Returns:

  • (Atk::Object) —

    an Atk::Object representing the specified

#ref_relation_set ⇒ Atk::RelationSet

Gets the Atk::RelationSet associated with the object. of the object.

Returns:

#ref_state_set ⇒ Atk::StateSet

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. set of the accessible

Returns:

  • (Atk::StateSet) —

    a reference to an Atk::StateSet which is the state

#remove_property_change_handler(handler_id) ⇒ nil

Removes a property change handler.

Parameters:

  • handler_id (Integer) —

    a guint which identifies the handler to be removed.

Returns:

  • (nil)

#remove_relationship(relationship, target) ⇒ Boolean

Removes a relationship of the specified type with the specified target.

Parameters:

  • relationship (Atk::RelationType) —

    The Atk::RelationType of the relation

  • target (Atk::Object) —

    The Atk::Object which is the target of the relation to be removed.

Returns:

  • (Boolean) —

    TRUE if the relationship is removed.

#role ⇒ Atk::Role

Gets the role of the accessible.

Returns:

  • (Atk::Role) —

    an Atk::Role which is the role of the accessible

#role=(role) ⇒ nil

Sets the role of the accessible.

Parameters:

  • role (Atk::Role) —

    an Atk::Role to be set as the role

Returns:

  • (nil)