AtkObject               package:RGtk2               R Documentation

_A_t_k_O_b_j_e_c_t

_D_e_s_c_r_i_p_t_i_o_n:

     The base object class for the Accessibility Toolkit API.

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'atkRoleRegister(name)'
      'atkImplementorRefAccessible(object)'
      'atkObjectGetName(object)'
      'atkObjectGetDescription(object)'
      'atkObjectGetParent(object)'
      'atkObjectGetNAccessibleChildren(object)'
      'atkObjectRefAccessibleChild(object, i)'
      'atkObjectRefRelationSet(object)'
      'atkObjectGetLayer(object)'
      'atkObjectGetMdiZorder(object)'
      'atkObjectGetRole(object)'
      'atkObjectRefStateSet(object)'
      'atkObjectGetIndexInParent(object)'
      'atkObjectSetName(object, name)'
      'atkObjectSetDescription(object, description)'
      'atkObjectSetParent(object, parent)'
      'atkObjectSetRole(object, role)'
      'atkObjectConnectPropertyChangeHandler(object, handler)'
      'atkObjectRemovePropertyChangeHandler(object, handler.id)'
      'atkObjectNotifyStateChange(object, state, value)'
      'atkObjectInitialize(object, data)'
      'atkObjectAddRelationship(object, relationship, target)'
      'atkObjectRemoveRelationship(object, relationship, target)'
      'atkObjectGetAttributes(object)'
      'atkRoleGetName(role)'
      'atkRoleGetLocalizedName(role)'
      'atkRoleForName(name)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----AtkObject
              +----AtkGObjectAccessible
              +----AtkNoOpObject 

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     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 #'gtkWidgetGetAccessible'), 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.

_S_t_r_u_c_t_u_r_e_s:


     '_A_t_k_O_b_j_e_c_t' The AtkObject structure should not be accessed
          directly.


     '_A_t_k_I_m_p_l_e_m_e_n_t_o_r' The AtkImplementor interface is implemented by
          objects for which AtkObject peers may be obtained via calls
          to iface->(ref_accessible)(implementor);


_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_A_t_k_R_o_l_e' Describes the role of an object

          These are the built-in enumerated roles that UI components
          can have in ATK.  Other roles may be added at runtime, so an
          AtkRole >= ATK_ROLE_LAST_DEFINED is not necessarily an error.            

          '_i_n_v_a_l_i_d' Invalid role

          '_a_c_c_e_l-_l_a_b_e_l' A label which represents an accelerator

          '_a_l_e_r_t' An object which is an alert to the user. Assistive
               Technologies typically respond to ATK_ROLE_ALERT by
               reading the entire onscreen contents of containers
               advertising this role.  Should be used for warning
               dialogs, etc.

          '_a_n_i_m_a_t_i_o_n' An object which is an animated image

          '_a_r_r_o_w' An arrow in one of the four cardinal directions

          '_c_a_l_e_n_d_a_r' An object that displays a calendar and allows the
               user to select a date

          '_c_a_n_v_a_s' An object that can be drawn into and is used to trap
               events

          '_c_h_e_c_k-_b_o_x' A choice that can be checked or unchecked and
               provides a separate indicator for the current state

          '_c_h_e_c_k-_m_e_n_u-_i_t_e_m' A menu item with a check box

          '_c_o_l_o_r-_c_h_o_o_s_e_r' A specialized dialog that lets the user
               choose a color

          '_c_o_l_u_m_n-_h_e_a_d_e_r' The header for a column of data

          '_c_o_m_b_o-_b_o_x' A list of choices the user can select from

          '_d_a_t_e-_e_d_i_t_o_r' An object whose purpose is to allow a user to
               edit a date

          '_d_e_s_k_t_o_p-_i_c_o_n' An inconifed internal frame within a
               DESKTOP_PANE

          '_d_e_s_k_t_o_p-_f_r_a_m_e' A pane that supports internal frames and
               iconified versions of those internal frames

          '_d_i_a_l' An object whose purpose is to allow a user to set a
               value

          '_d_i_a_l_o_g' A top level window with title bar and a border

          '_d_i_r_e_c_t_o_r_y-_p_a_n_e' A pane that allows the user to navigate
               through and select the contents of a directory

          '_d_r_a_w_i_n_g-_a_r_e_a' An object used for drawing custom user
               interface elements

          '_f_i_l_e-_c_h_o_o_s_e_r' A specialized dialog that lets the user choose
               a file

          '_f_i_l_l_e_r' A object that fills up space in a user interface

          '_f_o_n_t-_c_h_o_o_s_e_r' A specialized dialog that lets the user choose
               a font

          '_f_r_a_m_e' A top level window with a title bar, border, menubar,
               etc.

          '_g_l_a_s_s-_p_a_n_e' A pane that is guaranteed to be painted on top
               of all panes beneath it

          '_h_t_m_l-_c_o_n_t_a_i_n_e_r' A document container for HTML, whose
               children represent the document content

          '_i_c_o_n' A small fixed size picture, typically used to decorate
               components

          '_i_m_a_g_e' An object whose primary purpose is to display an
               image

          '_i_n_t_e_r_n_a_l-_f_r_a_m_e' A frame-like object that is clipped by a
               desktop pane

          '_l_a_b_e_l' An object used to present an icon or short string in
               an interface

          '_l_a_y_e_r_e_d-_p_a_n_e' A specialized pane that allows its children to
               be drawn in layers, providing a form of stacking order

          '_l_i_s_t' An object that presents a list of objects to the user
               and allows the user to select one or more of them 

          '_l_i_s_t-_i_t_e_m' An object that represents an element of a list 

          '_m_e_n_u' An object usually found inside a menu bar that
               contains a list of actions the user can choose from

          '_m_e_n_u-_b_a_r' An object usually drawn at the top of the primary
               dialog box of an application that contains a list of
               menus the user can choose from 

          '_m_e_n_u-_i_t_e_m' An object usually contained in a menu that
               presents an action the user can choose

          '_o_p_t_i_o_n-_p_a_n_e' A specialized pane whose primary use is inside
               a DIALOG

          '_p_a_g_e-_t_a_b' An object that is a child of a page tab list

          '_p_a_g_e-_t_a_b-_l_i_s_t' An object that presents a series of panels
               (or page tabs), one at a time, through some mechanism
               provided by the object 

          '_p_a_n_e_l' A generic container that is often used to group
               objects

          '_p_a_s_s_w_o_r_d-_t_e_x_t' A text object uses for passwords, or other
               places where the text content is not shown visibly to
               the user

          '_p_o_p_u_p-_m_e_n_u' A temporary window that is usually used to offer
               the user a list of choices, and then hides when the user
               selects one of those choices

          '_p_r_o_g_r_e_s_s-_b_a_r' An object used to indicate how much of a task
               has been completed

          '_p_u_s_h-_b_u_t_t_o_n' An object the user can manipulate to tell the
               application to do something

          '_r_a_d_i_o-_b_u_t_t_o_n' A specialized check box that will cause other
               radio buttons in the same group to become unchecked when
               this one is checked

          '_r_a_d_i_o-_m_e_n_u-_i_t_e_m' A check menu item which belongs to a group.
               At each instant exactly one of the radio menu items from
               a group is selected

          '_r_o_o_t-_p_a_n_e' A specialized pane that has a glass pane and a
               layered pane as its children

          '_r_o_w-_h_e_a_d_e_r' The header for a row of data

          '_s_c_r_o_l_l-_b_a_r' An object usually used to allow a user to
               incrementally view a large amount of data.

          '_s_c_r_o_l_l-_p_a_n_e' An object that allows a user to incrementally
               view a large amount of information

          '_s_e_p_a_r_a_t_o_r' An object usually contained in a menu to provide
               a visible and logical separation of the contents in a
               menu

          '_s_l_i_d_e_r' An object that allows the user to select from a
               bounded range

          '_s_p_l_i_t-_p_a_n_e' A specialized panel that presents two other
               panels at the same time

          '_s_p_i_n-_b_u_t_t_o_n' An object used to get an integer or floating
               point number from the user

          '_s_t_a_t_u_s_b_a_r' An object which reports messages of minor
               importance to the user

          '_t_a_b_l_e' An object used to represent information in terms of
               rows and columns

          '_t_a_b_l_e-_c_e_l_l' A cell in a table

          '_t_a_b_l_e-_c_o_l_u_m_n-_h_e_a_d_e_r' The header for a column of a table

          '_t_a_b_l_e-_r_o_w-_h_e_a_d_e_r' The header for a row of a table

          '_t_e_a_r-_o_f_f-_m_e_n_u-_i_t_e_m' A menu item used to tear off and
               reattach its menu

          '_t_e_r_m_i_n_a_l' An object that represents an accessible terminal. 
               'Since': ATK-0.6

          '_t_e_x_t' An object that presents text to the user

          '_t_o_g_g_l_e-_b_u_t_t_o_n' A specialized push button that can be checked
               or unchecked, but does not provide a separate indicator
               for the current state

          '_t_o_o_l-_b_a_r' A bar or palette usually composed of push buttons
               or toggle buttons

          '_t_o_o_l-_t_i_p' An object that provides information about another
               object

          '_t_r_e_e' An object used to represent hierarchical information
               to the user

          '_t_r_e_e-_t_a_b_l_e' An object capable of expanding and collapsing
               rows as well as showing multiple columns of data.  
               'Since': ATK-0.7

          '_u_n_k_n_o_w_n' The object contains some Accessible information,
               but its role is not known

          '_v_i_e_w_p_o_r_t' An object usually used in a scroll pane

          '_w_i_n_d_o_w' A top level window with no title or border.

          '_h_e_a_d_e_r' An object that serves as a document header.
               'Since':ATK 1.1.1

          '_f_o_o_t_e_r' An object that serves as a document footer. 
               'Since': ATK-1.1.1

          '_p_a_r_a_g_r_a_p_h' An object which is contains a paragraph of text
               content.   'Since': ATK-1.1.1

          '_r_u_l_e_r' An object which describes margins and tab stops, etc.
               for text objects which it controls (should have
               CONTROLLER_FOR relation to such).   'Since': ATK-1.1.1

          '_a_p_p_l_i_c_a_t_i_o_n' The object is an application object, which may
               contain 'ATK.ROLE.FRAME' objects or other types of
               accessibles.  The root accessible of any application's
               ATK hierarchy should have ATK_ROLE_APPLICATION.  
               'Since': ATK-1.1.4

          '_a_u_t_o_c_o_m_p_l_e_t_e' The object is a dialog or list containing
               items for insertion into an entry widget, for instance a
               list of words for completion of a text entry.   'Since':
               ATK-1.3

          '_e_d_i_t_b_a_r' The object is an editable text object in a toolbar.
                'Since': ATK-1.5

          '_e_m_b_e_d_d_e_d' The object is an embedded container within a
               document or panel.  This role is a grouping "hint"
               indicating that the contained objects share a context. 
               'Since': ATK-1.7.2

          '_f_o_r_m' The object is a component whose textual content may be
               entered or modified by the user, provided
               'ATK.STATE.EDITABLE' is present.   'Since': ATK-1.11

          '_l_a_s_t-_d_e_f_i_n_e_d' The object is a graphical depiction of
               quantitative data. It may contain multiple subelements
               whose attributes and/or description may be queried to
               obtain both the quantitative data and information about
               how the data is being presented. The LABELLED_BY
               relation is particularly important in interpreting
               objects of this type, as is the accessible-description
               property.  'Since': ATK-1.11


     '_A_t_k_L_a_y_e_r' Describes the layer of a component

          These enumerated "layer values" are used when determining
          which UI rendering layer a component is drawn into, which can
          help in making determinations of when components occlude one
          another.  

          '_i_n_v_a_l_i_d' The object does not have a layer

          '_b_a_c_k_g_r_o_u_n_d' This layer is reserved for the desktop
               background

          '_c_a_n_v_a_s' This layer is used for Canvas components

          '_w_i_d_g_e_t' This layer is normally used for components

          '_m_d_i' This layer is used for layered components

          '_p_o_p_u_p' This layer is used for popup components, such as
               menus

          '_o_v_e_r_l_a_y' This layer is reserved for future use.

          '_w_i_n_d_o_w' This layer is used for toplevel windows.


_U_s_e_r _F_u_n_c_t_i_o_n_s:


     '_A_t_k_F_u_n_c_t_i_o_n(_d_a_t_a)' An AtkFunction is a function definition used
          for padding which has been added  to class and interface
          structures to allow for expansion in the future.

          '_d_a_t_a' [R object] a gpointer to parameter data.

          _Returns:_ [logical] Nothing useful, this is only a dummy
          prototype.


     '_A_t_k_P_r_o_p_e_r_t_y_C_h_a_n_g_e_H_a_n_d_l_e_r(_P_a_r_a_m_1, _P_a_r_a_m_2)' An
          AtkPropertyChangeHandler is a function which is executed when
          an AtkObject's property changes value. It is specified in a
          call to  'atkObjectConnectPropertyChangeHandler'.

          '_P_a_r_a_m_1' ['AtkObject']  an 'AtkObject'

          '_P_a_r_a_m_2' [AtkPropertyValues]  an 'AtkPropertyValues'


_S_i_g_n_a_l_s:


     '_a_c_t_i_v_e-_d_e_s_c_e_n_d_a_n_t-_c_h_a_n_g_e_d(_a_t_k_o_b_j_e_c_t, _a_r_g_1, _u_s_e_r._d_a_t_a)' The
          "active-descendant-changed" signal is emitted by an object
          which has the state ATK_STATE_MANAGES_DESCENDANTS when the
          focus object in the object changes. For instance, a table
          will emit the signal when the cell in the table which has
          focus changes.

          '_a_t_k_o_b_j_e_c_t' ['AtkObject'] the object which received the
               signal.

          '_a_r_g_1' [R object] the newly focused object.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_c_h_i_l_d_r_e_n-_c_h_a_n_g_e_d(_a_t_k_o_b_j_e_c_t, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' The signal
          "children-changed" is emitted when a child is added or
          removed form an object. It supports two details: "add" and
          "remove"

          '_a_t_k_o_b_j_e_c_t' ['AtkObject'] the object which received the
               signal.

          '_a_r_g_1' [numeric] The index of the added or removed child

          '_a_r_g_2' [R object] A gpointer to the child AtkObject which was
               added or removed

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_f_o_c_u_s-_e_v_e_n_t(_a_t_k_o_b_j_e_c_t, _a_r_g_1, _u_s_e_r._d_a_t_a)' The signal "focus-event"
          is emitted when an object gains or loses focus.

          '_a_t_k_o_b_j_e_c_t' ['AtkObject'] the object which received the
               signal.

          '_a_r_g_1' [logical] A boolean value which indicates whether the
               object gained or lost focus.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_r_o_p_e_r_t_y-_c_h_a_n_g_e(_a_t_k_o_b_j_e_c_t, _a_r_g_1, _u_s_e_r._d_a_t_a)' The signal
          "property-change" is emitted when an object's property value
          changes. The detail identifies the name of the property whose
          value has changed.

          '_a_t_k_o_b_j_e_c_t' ['AtkObject'] the object which received the
               signal.

          '_a_r_g_1' [R object] The new value of the property which
               changed.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_t_a_t_e-_c_h_a_n_g_e(_a_t_k_o_b_j_e_c_t, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' The
          "state-change" signal is emitted  when an object's state
          changes. The detail value identifies the state type which has
          changed.

          '_a_t_k_o_b_j_e_c_t' ['AtkObject'] the object which received the
               signal.

          '_a_r_g_1' [character] The name of the state which has changed

          '_a_r_g_2' [logical] A boolean which indicates whether the state
               has been set or unset.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_v_i_s_i_b_l_e-_d_a_t_a-_c_h_a_n_g_e_d(_a_t_k_o_b_j_e_c_t, _u_s_e_r._d_a_t_a)' The
          "visible-data-changed" signal is emitted when the visual
          appearance of  the object changed.

          '_a_t_k_o_b_j_e_c_t' ['AtkObject'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_a_c_c_e_s_s_i_b_l_e-_c_o_m_p_o_n_e_n_t-_l_a_y_e_r' [_i_n_t_e_g_e_r : _R_e_a_d] The accessible layer
          of this object.  Allowed values: >= 0  Default value: 0


     '_a_c_c_e_s_s_i_b_l_e-_c_o_m_p_o_n_e_n_t-_m_d_i-_z_o_r_d_e_r' [_i_n_t_e_g_e_r : _R_e_a_d] The accessible
          MDI value of this object.  Default value: -2147483648


     '_a_c_c_e_s_s_i_b_l_e-_d_e_s_c_r_i_p_t_i_o_n' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Description of
          an object, formatted for assistive technology access. 
          Default value: NULL


     '_a_c_c_e_s_s_i_b_l_e-_h_y_p_e_r_t_e_x_t-_n_l_i_n_k_s' [_i_n_t_e_g_e_r : _R_e_a_d] The number of links
          which the current AtkHypertext has.  Allowed values: >= 0 
          Default value: 0


     '_a_c_c_e_s_s_i_b_l_e-_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Object instance's
          name formatted for assistive technology access.  Default
          value: NULL


     '_a_c_c_e_s_s_i_b_l_e-_p_a_r_e_n_t' ['_A_t_k_O_b_j_e_c_t' : _R_e_a_d / _W_r_i_t_e] Is used to notify
          that the parent has changed.


     '_a_c_c_e_s_s_i_b_l_e-_r_o_l_e' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The accessible role of
          this object.  Allowed values: >= 0  Default value: 0


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_c_a_p_t_i_o_n' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Is used to
          notify that the table caption has changed; this property
          should not be used. accessible-table-caption-object should be
          used instead.  Default value: NULL


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_c_a_p_t_i_o_n-_o_b_j_e_c_t' ['_A_t_k_O_b_j_e_c_t' : _R_e_a_d / _W_r_i_t_e] Is
          used to notify that the table caption has changed.


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_c_o_l_u_m_n-_d_e_s_c_r_i_p_t_i_o_n' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] 
          Is used to notify that the table column description has
          changed.  Default value: NULL


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_c_o_l_u_m_n-_h_e_a_d_e_r' ['_A_t_k_O_b_j_e_c_t' : _R_e_a_d / _W_r_i_t_e] Is
          used to notify that the table column header has changed.


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_r_o_w-_d_e_s_c_r_i_p_t_i_o_n' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Is
          used to notify that the table row description has changed. 
          Default value: NULL


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_r_o_w-_h_e_a_d_e_r' ['_A_t_k_O_b_j_e_c_t' : _R_e_a_d / _W_r_i_t_e] Is used
          to notify that the table row header has changed.


     '_a_c_c_e_s_s_i_b_l_e-_t_a_b_l_e-_s_u_m_m_a_r_y' ['_A_t_k_O_b_j_e_c_t' : _R_e_a_d / _W_r_i_t_e] Is used to
          notify that the table summary has changed.


     '_a_c_c_e_s_s_i_b_l_e-_v_a_l_u_e' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] Is used to notify that
          the value has changed.  Allowed values: >= 0  Default value:
          0


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://developer.gnome.org/doc/API/2.0/atk/AtkObject.html>

_S_e_e _A_l_s_o:

     'AtkObjectFactory' 'AtkRegistry' 'GtkAccessible'

