funArg-class {widgetInvoke}R Documentation

Class "funArg": A Class To Represent A Function Argument

Description

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.

Details

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.

Objects from the Class

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

Slots

argName:
Object of class "character": The name of the argument
argDefault:
Object of class "character": The default value of the argument.
argType:
Object of class "character": The type of the argument (e.g. numeric, character, logical)
argLocation:
Object of class "character": Which pane of the widget notebook to display this argument.
argWidgetType:
Object of class "character": What type of widget to use in displaying this argument.
argRequired:
Object of class "logical": Whether or not this argument is required to have a value for function evaluation.

Methods

argDefault
signature(object = "funArg"): Retrieves the argDefault slot.
argLocation
signature(object = "funArg"): Retrieves the argLocation slot.
argName
signature(object = "funArg"): Retrieves the argName slot.
argRequired
signature(object = "funArg"): Retrieves the argRequired slot.
argType
signature(object = "funArg"): Retrieves the argType slot.
argWidgetType
signature(object = "funArg"): Retrieves the argWidgetType slot

Author(s)

Jeff Gentry

See Also

createWF, widgetInvoke, wFun

Examples

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

[Package widgetInvoke version 0.0.9 Index]