RGtkObject               package:RGtk2               R Documentation

_T_h_e _b_a_s_e _o_b_j_e_c_t _o_f _R_G_t_k_2

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

     'RGtkObject' identifies an external object as being owned by RGtk.
     Practically, it allows convenience operators to be specified for
     any external object.

_U_s_a_g_e:

     "[[.RGtkObject"(x, field)
     "$.RGtkObject"(x, member)
     "==.RGtkObject"(x, y)

_A_r_g_u_m_e_n_t_s:

       x: The 'RGtkObject' to which the method or field belongs or the
          left hand of a comparison

   field: The name of the field whose value will be retrieved

  member: The name of the member (eg method) that will be retrieved

       y: The right hand operand of a comparison

_D_e_t_a_i_l_s:

     The functions '[[.RGtkObject' and '$.RGtkObject' both expand to an
      RGtk function that accesses external objects. The '[[' operator
     looks for a field from an external C structure by expanding
     'objectOfClassName[[fieldName]]' to 'classNameGetFieldName()'.
     External "methods" are expanded by the '$' operator to form 
     'classNameMethodName(objectOfClassName, ...)' from the Java-like 
     'objectOfClassName$methodName(...)'. The long and short mechanisms
     give  the same result, but the shortcut is obviously more
     convenient. If the method does not exist, '$' will fall back to
     other types of members, like properties (for 'GObject's) and
     fields.

     The '==' operator compares two 'RGtkObject's on the basis of their
     internal pointer value. This should rarely be useful for users.

_V_a_l_u_e:

     A context-dependent value resulting from the specified API call.

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

     Michael Lawrence

