guiObjBrowse              package:svGUI              R Documentation

_F_u_n_c_t_i_o_n _t_o _i_m_p_l_e_m_e_n_t _a_n _o_b_j_e_c_t _b_r_o_w_s_e_r

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

     These functions provide features required to implement a complete
     object browser in the GUI client.

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

     guiObjBrowse(id = "default", env.name = NULL, pos = NULL, all.names = NULL,
         pattern = NULL, group = NULL, regenerate = FALSE)
     guiObjClear(id)
     guiObjDir()
     guiObjList(id = "default", env.name = NULL, pos = 1, all.names = FALSE,
         pattern = "", group = "", path = NULL, compare = TRUE)
     guiObjMenu(id = "default", selobject, objects, envir, path = NULL)
     guiObjSearch(path = NULL, compare = TRUE)

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

      id: The id of the object browser (you can run several ones
          concurrently) 

env.name: The name of the environment 

     pos: The position in the search path 

all.names: Do we display all names (including hidden variables starting
          with '.')? 

 pattern: A pattern to match for selecting variables 

   group: A group to filter 

regenerate: Do we force to regenerate the information? 

    path: The path where to write a temporary file with the requested
          information 

 compare: If 'compare == TRUE', result is compared with last cached
          value and the client is updated only if something changed 

selobject: The current selection in the object browser 

 objects: A list with selected items in the object browser 

   envir: The currently selected environment in the object browser 

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

     'guiObjBrowse' do the horsework. 'guiObjDir' gets the temporary
     directory where exchange files are stored. 'guiObjList' lists
     objects in a given workspace. 'guiObjSearch' lists the search
     path. 'guiObjClear' clears any reference to a given object
     browser. 'guiObjMenu' computes a context menu for a given object.

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

     Depending on the function, a list, a string, or a reference to an
     external, temporary file where data is written.

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

     Philippe Grosjean (phgrosjean@sciviews.org)

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

     'guiRemove', 'guiSave'

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

         #### TO DO...

