AtkUtil                package:RGtk2                R Documentation

_A_t_k_U_t_i_l

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

     A set of ATK utility functions for event and toolkit support.

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

     'atkAddFocusTracker(focus.tracker)'
      'atkRemoveFocusTracker(tracker.id)'
      'atkFocusTrackerInit(add.function)'
      'atkFocusTrackerNotify(object)'
      'atkAddGlobalEventListener(listener, event.type)'
      'atkRemoveGlobalEventListener(listener.id)'
      'atkAddKeyEventListener(listener, data)'
      'atkRemoveKeyEventListener(listener.id)'
      'atkGetRoot()'
      'atkGetFocusObject()'
      'atkGetToolkitName()'
      'atkGetToolkitVersion()'

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

     GObject
        +----AtkUtil 

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

     A set of ATK utility functions which are used to support event
     registration of various types, and obtaining the 'root' accessible
     of a process and information about the current ATK implementation
     and toolkit version.

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


     '_A_t_k_U_t_i_l' The AtkUtil struct does not contain any fields.


     '_A_t_k_K_e_y_E_v_e_n_t_S_t_r_u_c_t' Encapsulates information about a key event.  
          *'AtkKeyEventStruct' is a transparent-type.*

          '_t_y_p_e' [integer]  An AtkKeyEventType, generally one of
               ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE

          '_s_t_a_t_e' [numeric]  A bitmask representing the state of the
               modifier keys immediately after the event takes place.  
                The meaning of the bits is currently defined to match
               the bitmask used by GDK in GdkEventType.state, see 
               http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html'GdkEventKey'

          '_k_e_y_v_a_l' [numeric]  A guint representing a keysym value
               corresponding to those used by GDK and X11: see
               /usr/X11/include/keysymdef.h.

          '_l_e_n_g_t_h' [integer]  The length of member 'string'.

          '_s_t_r_i_n_g' [character]  A string containing one of the
               following: either a string approximating the text that
               would  result from this keypress, if the key is a
               control or graphic character, or a symbolic name for
               this keypress. Alphanumeric and printable keys will have
               the symbolic key name in this string member, for
               instance "A". "0",  "semicolon", "aacute".  Keypad keys
               have the prefix "KP".

          '_k_e_y_c_o_d_e' [integer]  The raw hardware code that generated the
               key event.  This field is raraly useful.

          '_t_i_m_e_s_t_a_m_p' [numeric]  A timestamp in milliseconds indicating
               when the event occurred.   These timestamps are relative
               to a starting point which should be considered
               arbitrary,  and only used to compare the dispatch times
               of events to one another.


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


     '_A_t_k_C_o_o_r_d_T_y_p_e' Specifies how xy coordinates are to be interpreted.
          Used by functions such as 'atkComponentGetPosition' and
          'atkTextGetCharacterExtents'  

          '_s_c_r_e_e_n' specifies xy coordinates relative to the screen

          '_w_i_n_d_o_w' specifies xy coordinates relative to the widget's 
               top-level window


     '_A_t_k_K_e_y_E_v_e_n_t_T_y_p_e' Specifies the type of a keyboard evemt.  

          '_p_r_e_s_s' specifies a key press event

          '_r_e_l_e_a_s_e' specifies a key release event

          '_l_a_s_t-_d_e_f_i_n_e_d' Not a valid value; specifies end of
               enumeration


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


     '_A_t_k_E_v_e_n_t_L_i_s_t_e_n_e_r(_o_b_j)' A function which is called when an object
          emits a matching event, as used in 'atkAddFocusTracker'.
          Currently the only events for which object-specific handlers
          are supported are events of type "focus:".  Most clients of
          ATK will prefer to  attach signal handlers for the various
          ATK signals instead. 'see': atk_add_focus_tracker.  

          '_o_b_j' ['AtkObject']  An 'AtkObject' instance for whom the
               callback will be called when the specified event (e.g.
               'focus:') takes place.


     '_A_t_k_E_v_e_n_t_L_i_s_t_e_n_e_r_I_n_i_t()' An 'AtkEventListenerInit' function is a
          special function that is called in order to initialize the
          per-object event registration system used by
          'AtkEventListener', if any preparation is required.   'see':
          atk_focus_tracker_init.  


     '_A_t_k_K_e_y_S_n_o_o_p_F_u_n_c(_e_v_e_n_t, _f_u_n_c._d_a_t_a)' An 'AtkKeySnoopFunc' is a type
          of callback which is called whenever a key event occurs,  if
          registered via atk_add_key_event_listener.  It allows for
          pre-emptive  interception of key events via the return code
          as described below.  

          '_e_v_e_n_t' ['AtkKeyEventStruct']  an AtkKeyEventStruct
               containing information about the key event for which
               notification is being given.

          '_f_u_n_c._d_a_t_a' [R object]  a block of data which will be passed
               to the event listener, on notification.

          _Returns:_ [integer]  TRUE (nonzero) if the event emission
          should be stopped and the event  discarded without being
          passed to the normal GUI recipient; FALSE (zero) if the 
          event dispatch to the client application should proceed as
          normal.

          'see': atk_add_key_event_listener.


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

