AtkDocument              package:RGtk2              R Documentation

_A_t_k_D_o_c_u_m_e_n_t

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

     The ATK interface which represents the toplevel container for
     document content.

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

     'atkDocumentGetDocumentType(object)'
      'atkDocumentGetDocument(object)'
      'atkDocumentGetAttributeValue(object, attribute.name)'
      'atkDocumentSetAttributeValue(object, attribute.name,
     attribute.value)'
      'atkDocumentGetAttributes(object)'
      'atkDocumentGetLocale(object)'

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

     GInterface
        +----AtkDocument 

_I_m_p_l_e_m_e_n_t_a_t_i_o_n_s:

     AtkDocument is implemented by 'AtkNoOpObject'.

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

     The AtkDocument interface should be supported by any object whose
     content is a  representation or view of a document.  The
     AtkDocument interface should appear on the toplevel container for
     the document content; however AtkDocument  instances may be nested
     (i.e. an AtkDocument may be a descendant of another AtkDocument)
     in those cases where one document contains "embedded content" 
     which can reasonably be considered a document in its own right.

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


     '_A_t_k_D_o_c_u_m_e_n_t' The AtkDocument structure does not contain any
          fields.


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


     '_l_o_a_d-_c_o_m_p_l_e_t_e(_a_t_k_d_o_c_u_m_e_n_t, _u_s_e_r._d_a_t_a)' The 'load-complete' signal
          is emitted when a pending load of a static document has
          completed.  This signal is to be expected by ATK clients  if
          and when AtkDocument implementors expose ATK_STATE_BUSY.  If
          the state of an AtkObject which implements AtkDocument does
          not include ATK_STATE_BUSY, it should be safe for clients to
          assume that the AtkDocument's static contents are fully
          loaded into the container.  (Dynamic document contents should
          be exposed via other signals.)

          '_a_t_k_d_o_c_u_m_e_n_t' ['AtkDocument'] 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.


     '_l_o_a_d-_s_t_o_p_p_e_d(_a_t_k_d_o_c_u_m_e_n_t, _u_s_e_r._d_a_t_a)' The 'load-stopped' signal
          is emitted when a pending load of document contents is
          cancelled, paused, or otherwise interrupted by the user or
          application  logic.  It should not however be emitted while
          waiting for a resource (for instance while blocking on a file
          or  network read) unless a user-significant timeout has
          occurred.

          '_a_t_k_d_o_c_u_m_e_n_t' ['AtkDocument'] 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.


     '_r_e_l_o_a_d(_a_t_k_d_o_c_u_m_e_n_t, _u_s_e_r._d_a_t_a)' The 'reload' signal is emitted
          when the contents of a document is refreshed from its source.
           Once 'reload' has been emitted, a matching 'load-complete' 
          or 'load-stopped' signal should follow, which clients may
          await before  interrogating ATK for the latest document
          content.

          '_a_t_k_d_o_c_u_m_e_n_t' ['AtkDocument'] 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.


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

