names.GtkObject             package:RGtk             R Documentation

_A_c_c_e_s_s _i_n_f_o_r_m_a_t_i_o_n _a_b_o_u_t _p_r_o_p_e_r_t_i_e_s _o_f _a _G_t_k_O_b_j_e_c_t

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

     These allow one to discover what ``properties'' or variables a Gtk
     object supports and the details of each property such as its type
     and whether it can be set or only read.

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

     names.GtkObject(x)
     gtkObjectGetArgInfo(obj, parents=TRUE, collapse=FALSE, strip=FALSE)

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

       x: the Gtk object the names of whose properties are to be
          queried

     obj: the Gtk object for which the property information is to be
          retrieved

 parents: a logical value indicating whether to get the properties of
          the parent classes as well as the specific class of the Gtk
          object 'obj'. If this is true, we iterate over the successive
          super-classes of 'obj'. 

collapse: a logical value indicating whether the information about
          parent classes should be collapsed into a single list
          ('TRUE') or maintained as separate elements in a top-level
          list that allows one to determine to which class each
          property originates. The names of a property contains the
          class for which it is defined. 

   strip: a logical value indicating whether to remove the class prefix
          in the name of the property ('TRUE') or leave it ('FALSE') so
          that one can identify for which class the property was
          defined and inherited.

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

     A regular user will probably want to look at 'names' and call
     'gtkObjectGetArgInfo' with 'parents = TRUE', 'collapse=TRUE' and
     'strip = TRUE' to find all the available properties in the most
     convenient format. Tool writers using the reflectance may want to
     get the associated classes and process the properties
     hierarchically.

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

     'names' returns a character vector giving the names of the
     available properties with the class prefix removed.

     'gtkObjectGetArgInfo' returns a list giving details of the
     properties. At the lowest level, each property is described by a
     list containing 

    type: an object of class 'GtkType' which identifies the type (!) of
          the value of the property.

    flag: an object of class 'GtkArgFlags' which specifies whether the
          property is read-only or read-write and when it can be
          specified, etc. This is a  logical OR of the relevant values.
          See '.GtkArgFlags'.

     Each property is indexed by its name in the list.

     The precise form of the returned value depends on the different
     arguments. If 'parents' is 'FALSE', then a simple list giving each
     property for the class of 'obj' is returned. If 'parents' is
     'TRUE' and 'collapse' is 'FALSE', then a list indexed by class is
     returned. Each element is a list containing the property
     information.

     If 'strip' is 'FALSE', the property names used to to index the
     list of properties does not contain the class identifier
     ('class:...'). Otherwise it does.

_N_o_t_e:

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

     Duncan Temple Lang <duncan@research.bell-labs.com>

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

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

     '$.GtkObject'

_E_x_a_m_p_l_e_s:

