getSlotHTMLTable         package:RGtkViewers         R Documentation

_G_e_n_e_r_a_t_e _H_T_M_L _d_i_s_p_l_a_y_i_n_g _G_t_k _c_l_a_s_s _i_n_f_o_r_m_a_t_i_o_n

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

     Compute the HTML text for displaying the slot information for  the
     specified class. The complete and combined arguments control if
     and how we group information about inherited slots. If combined is
     FALSE, then we get separate tables for each of the ancestor/base
     classes in the inheritance hierarchy

     Alternatively, if combined is TRUE, then if complete is TRUE, we
     put all the slots - inherited and defined locally with the class -
     together into a single table, but color code each slot by the
     class in which it was defined. See 'formatClassSlots'.

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

     getSlotHTMLTable(className, complete = TRUE, combined = FALSE)

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

className: the name of the class whose slots are to be found and
          described.

complete: a logical value indicating whether to get the slots that are
          inherited from base/ancestor classes ('TRUE') or just work
          with the slots defined explicitly by this class ('FALSE'). If
          this is 'FALSE', 'combined' is not relevant.

combined: a logical value indicating how to present the inherited slots
          relative to the directly defined slots. If this is 'TRUE',
          all slots are displayed in a single HTML table and the slots
          are color coded to match the class name (shown in a simple
          hierarchy made up of links). If this is 'FALSE', then there
          is a separate table for each of the   ancestor classes. 

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

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

     A HTML string.

_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:

     <URL: http://www.omegahat.org/RGtk>, <URL:
     http://www.omegahat.org/RSMethods/index.html>   <URL:
     http://www.gtk.org>

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

     'formatClassSlots'

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

