atk-AtkState           package:RGtk2           R Documentation(utf8)

_A_t_k_S_t_a_t_e

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

     An AtkState describes a component's particular state.

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

     'atkStateTypeRegister(name)'
      'atkStateTypeGetName(type)'
      'atkStateTypeForName(name)'

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

     An AtkState describes a component's particular state. The actual
     state of an component is described by its AtkStateSet, which is a
     set of AtkStates.

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


     '_A_t_k_S_t_a_t_e_T_y_p_e' The possible types of states of an object  

          '_i_n_v_a_l_i_d' Indicates an invalid state - probably an error
               condition.

          '_a_c_t_i_v_e' Indicates a window is currently the active window,
               or is an active subelement within a container or table

          '_a_r_m_e_d' Indicates that the object is 'armed', i.e. will be
               activated by if a pointer button-release event occurs
               within its bounds.  Buttons often enter this state when
               a pointer click occurs within their bounds, as a
               precursor to activation.

          '_b_u_s_y' Indicates the current object is busy, i.e. onscreen
               representation is in the process of changing, or the
               object is temporarily unavailable for interaction due to
               activity already in progress.  This state may be used by
               implementors of Document to indicate that content
               loading is underway.  It also may indicate other
               'pending' conditions; clients may wish to interrogate
               this object when the ATK_STATE_BUSY flag is removed.

          '_c_h_e_c_k_e_d' Indicates this object is currently checked, for
               instance a checkbox is 'non-empty'.

          '_d_e_f_u_n_c_t' Indicates that this object no longer has a valid
               backing widget (for instance, if its peer object has
               been destroyed)

          '_e_d_i_t_a_b_l_e' Indicates the user can change the contents of this
               object

          '_e_n_a_b_l_e_d' Indicates that this object is enabled, i.e. that it
               currently reflects some application state. Objects that
               are "greyed out" may lack this state, and may lack the
               STATE_SENSITIVE if direct user interaction cannot cause
               them to acquire STATE_ENABLED. See also:
               ATK_STATE_SENSITIVE

          '_e_x_p_a_n_d_a_b_l_e' Indicates this object allows progressive
               disclosure of its children

          '_e_x_p_a_n_d_e_d' Indicates this object its expanded - see
               ATK_STATE_EXPANDABLE above

          '_f_o_c_u_s_a_b_l_e' Indicates this object can accept keyboard focus,
               which means all events resulting from typing on the
               keyboard will normally be passed to it when it has focus

          '_f_o_c_u_s_e_d' Indicates this object currently has the keyboard
               focus

          '_h_o_r_i_z_o_n_t_a_l' Indicates the orientation of this object is
               horizontal; used, for instance, by objects of
               ATK_ROLE_SCROLL_BAR.  For objects where
               vertical/horizontal orientation is especially
               meaningful.

          '_i_c_o_n_i_f_i_e_d' Indicates this object is minimized and is
               represented only by an icon

          '_m_o_d_a_l' Indicates something must be done with this object
               before the user can interact with an object in a
               different window

          '_m_u_l_t_i-_l_i_n_e' Indicates this (text) object can contain
               multiple lines of text

          '_m_u_l_t_i_s_e_l_e_c_t_a_b_l_e' Indicates this object allows more than one
               of its children to be selected at the same time, or in
               the case of text objects, that the object supports
               non-contiguous text selections.

          '_o_p_a_q_u_e' Indicates this object paints every pixel within its
               rectangular region.

          '_p_r_e_s_s_e_d' Indicates this object is currently pressed; c.f.
               ATK_STATE_ARMED

          '_r_e_s_i_z_a_b_l_e' Indicates the size of this object is not fixed

          '_s_e_l_e_c_t_a_b_l_e' Indicates this object is the child of an object
               that allows its children to be selected and that this
               child is one of those children that can be selected

          '_s_e_l_e_c_t_e_d' Indicates this object is the child of an object
               that allows its children to be selected and that this
               child is one of those children that has been selected

          '_s_e_n_s_i_t_i_v_e' Indicates this object is sensitive, e.g. to user
               interaction.  STATE_SENSITIVE usually accompanies
               STATE_ENABLED for user-actionable controls, but may be
               found in the absence of STATE_ENABLED if the current
               visible state of the  control is "disconnected" from the
               application state.  In such cases, direct user
               interaction can often result in the object gaining
               STATE_SENSITIVE, for instance if a user makes  an
               explicit selection using an object whose current state
               is ambiguous or undefined. 'see' STATE_ENABLED,
               STATE_INDETERMINATE.

          '_s_h_o_w_i_n_g' Indicates this object, the object's parent, the
               object's parent's parent, and so on,  are all 'shown' to
               the end-user, i.e. subject to "exposure" if blocking or
               obscuring objects do not interpose between this object
               and the top of the window stack.

          '_s_i_n_g_l_e-_l_i_n_e' Indicates this (text) object can contain only a
               single line of text

          '_s_t_a_l_e' Indicates that the information returned for this
               object may no longer be synchronized with the
               application state.  This is implied if the object has
               STATE_TRANSIENT, and can also occur towards the end of
               the object peer's lifecycle. It can also be used to
               indicate that  the index associated with this object has
               changed since the user accessed the object (in lieu of
               "index-in-parent-changed" events).

          '_t_r_a_n_s_i_e_n_t' Indicates this object is transient, i.e. a
               snapshot which may not emit events when its state
               changes.  Data from objects with ATK_STATE_TRANSIENT
               should not be cached, since there may be no notification
               given when the cached data becomes obsolete.

          '_v_e_r_t_i_c_a_l' Indicates the orientation of this object is
               vertical

          '_v_i_s_i_b_l_e' Indicates this object is visible, e.g. has been
               explicitly marked for exposure to the user.

          '_m_a_n_a_g_e_s-_d_e_s_c_e_n_d_a_n_t_s' Indicates that
               "active-descendant-changed" event is sent when children
               become 'active' (i.e. are selected or navigated to
               onscreen). Used to prevent need to enumerate all
               children in very large containers, like tables. The
               presence of STATE_MANAGES_DESCENDANTS is an indication
               to the client. that the children should not, and need
               not, be enumerated by the client. Objects implementing
               this state are expected to provide relevant state
               notifications to listening clients, for instance
               notifications of visibility changes and activation of
               their contained child objects, without the client 
               having previously requested references to those
               children.

          '_i_n_d_e_t_e_r_m_i_n_a_t_e' Indicates that a check box is in a state
               other than checked or not checked. This usually means
               that the boolean value reflected or  controlled by the
               object does not apply consistently to the entire current
               context. For example, a checkbox for the "Bold"
               attribute of text may have STATE_INDETERMINATE if the
               currently selected text contains a mixture of weight
               attributes.   In many cases interacting with a
               STATE_INDETERMINATE object will cause  the context's
               corresponding boolean attribute to be homogenized,
               whereupon the object will lose STATE_INDETERMINATE and a
               corresponding state-changed event will be fired.

          '_t_r_u_n_c_a_t_e_d' Indicates that an object is truncated, e.g. a
               text value in a speradsheet cell.

          '_r_e_q_u_i_r_e_d' Indicates that explicit user interaction with an
               object is required by the user interface, e.g. a
               required field in a "web-form" interface.

          '_a_n_i_m_a_t_e_d' Indicates that the object has encountered an error
               condition due to failure of input validation. For
               instance, a form control may acquire this state in
               response to invalid or malformed user input.

          '_v_i_s_i_t_e_d' Indicates that the object in question implements
               some form of ¨typeahead¨ or  pre-selection behavior
               whereby entering the first character of one or more
               sub-elements causes those elements to scroll into view
               or become selected.  Subsequent character input may
               narrow the selection further as long as one or more
               sub-elements match the string. This state is normally
               only useful and encountered on objects that implement
               Selection. In some cases the typeahead behavior may
               result in full or partial ¨completion¨ of  the data in
               the input field, in which case these input events may
               trigger text-changed events from the AtkText interface. 
               This state supplants 'ATK.ROLE.AUTOCOMPLETE'.

          '_d_e_f_a_u_l_t' Indicates that the object in question supports text
               selection. It should only be exposed on objects which
               implement the Text interface, in order to distinguish
               this state from 'ATK.STATE.SELECTABLE', which infers
               that the object in question is a selectable child of an
               object which implements Selection. While similar, text
               selection and subelement selection are distinct
               operations.

          '_l_a_s_t-_d_e_f_i_n_e_d' Indicates that the object is the "default"
               active component, i.e. the object which is activated by
               an end-user press of the "Enter" or "Return" key. 
               Typically a "close" or "submit" button.


_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/atk-AtkState.html>

