funArg-class          package:widgetInvoke          R Documentation

_C_l_a_s_s "_f_u_n_A_r_g": _A _C_l_a_s_s _T_o _R_e_p_r_e_s_e_n_t _A _F_u_n_c_t_i_o_n _A_r_g_u_m_e_n_t

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

     This class is used by the 'widgetInvoke' to represent the
     necessary information for creation of widgets for a function
     argument.  Each argument for a function maps to an object of class
     'funArg', and stored as a list with the others in the 'funArgList'
     slot of the appropriate 'wFun' object.

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

     The 'argType' slot can specify a particular type, or use the
     string 'ANY' to allow this argument to be untyped.  When using the
     'fun2wFun' function, the default for a 'funArg' object is that if
     there is no 'argDefault' specified by the function, there will be
     no 'argType'.  Likewise, if there is an 'argDefault', the
     'argType' will be of the same type.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created by calls of the form 'new("funArg", ...)'.

_S_l_o_t_s:

     '_a_r_g_N_a_m_e': Object of class '"character"': The name of the argument

     '_a_r_g_D_e_f_a_u_l_t': Object of class '"character"': The default value of
          the argument.

     '_a_r_g_T_y_p_e': Object of class '"character"': The type of the argument
          (e.g. numeric, character, logical)

     '_a_r_g_L_o_c_a_t_i_o_n': Object of class '"character"': Which pane of the
          widget notebook to display this argument.

     '_a_r_g_W_i_d_g_e_t_T_y_p_e': Object of class '"character"': What type of
          widget to use in displaying this argument.

     '_a_r_g_R_e_q_u_i_r_e_d': Object of class '"logical"': Whether or not this
          argument is required to have a value for function evaluation.

_M_e_t_h_o_d_s:

     _a_r_g_D_e_f_a_u_l_t 'signature(object = "funArg")': Retrieves the
          argDefault slot.

     _a_r_g_L_o_c_a_t_i_o_n 'signature(object = "funArg")': Retrieves the
          argLocation slot.

     _a_r_g_N_a_m_e 'signature(object = "funArg")': Retrieves the argName
          slot.

     _a_r_g_R_e_q_u_i_r_e_d 'signature(object = "funArg")': Retrieves the
          argRequired slot.

     _a_r_g_T_y_p_e 'signature(object = "funArg")': Retrieves the argType
          slot.

     _a_r_g_W_i_d_g_e_t_T_y_p_e 'signature(object = "funArg")': Retrieves the
          argWidgetType slot

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

     Jeff Gentry

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

     'createWF', 'widgetInvoke', 'wFun'

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

             z <- readWIxml(system.file("wFun-example", "apropos.xml",
                       package="widgetInvoke"))
             a <- funArgList(z)[[1]]
             argRequired(a)
             argName(a)
             argType(a)

