AtkObject Class

The AtkObject class is the base class for obtaining accessibility information on a widget. You should NOT instantiate this class directly, instead you should obtain it by calling the GtkWidget access method.

This class subclasses the Object REXX Object class so all of its methods are also available to this class.

The class heirarchy

   Object
      +---AtkObject

The methods for the AtkObject class are documented below.

AtkObject Method Table of Contents

description - Retrieve the accessible description
description = - Sets the accessible description
layer - Retrieve the accessiblelayer description
localizedroledescription - Retrieve the accessible localized role description
name - Retrieve the accessible name
name = - Set the accessible name
pointer - Retrieve the accessible pointer
role - Retrieve the accessible role
roledescription - Retrieve the accessible role description

Method: description

This method retrieves the accessible description.

Example

This is a example of retrieve the accessible description.

mydesc = mtatkobj~description()

Method Parameters

None.

Method Results

mydesc: The description of the accessible.

Method: description =

This method sets the accessible description.

Example

This is a example of setting the accessible description.

mydesc = 'New description'
mtatkobj~description = mydesc

Method Parameters

mydesc: The new description of the accessible.

Method Results

None.

Method: layer

This method retrieves the accessible layer description.

Example

This is a example of retrieve the accessible layer description.

mylayer = mtatkobj~layer()

Method Parameters

None.

Method Results

mylayer: The layer description of the accessible.

Method: localizedroledescription

This method retrieves the accessible localized role description.

Example

This is a example of retrieve the accessible localized role description.

mylocalroledesc = mtatkobj~localizedroledescription()

Method Parameters

None.

Method Results

mylocalroledesc: The localized role description of the accessible.

Method: name

This method retrieves the accessible name.

Example

This is a example of retrieve the accessible name.

myname = mtatkobj~name()

Method Parameters

None.

Method Results

myname: The name of the accessible.

Method: name =

This method sets the accessible name.

Example

This is a example of setting the accessible name.

myname = 'MyNewName'
mtatkobj~name = myname

Method Parameters

myname: The new name of the accessible.

Method Results

None.

Method: pointer

Returns the pointer to the internal object data structure. You probably will never use this method but it is here for debugging.

Example

This is a example of how to retrieve the internal pointer.

ptr = myatkobj~pointer()

Method Parameters

None.

Method Results

ptr: The pointer to the internal object structure. This can be used for debugging purposes.

Method: role

This method retrieves the accessible role.

Example

This is a example of retrieve the accessible role.

myrole = mtatkobj~role()

Method Parameters

None.

Method Results

myrole: The role of the accessible.

Method: roledescription

This method retrieves the accessible role description.

Example

This is a example of retrieve the accessible role description.

myroledesc = mtatkobj~roledescription()

Method Parameters

None.

Method Results

myroledesc: The role description of the accessible.