R: A flexible form dialog box

dlgForm {svDialogs} | R Documentation

## A flexible form dialog box

### Description

Fill a form in a dialog box.

### Usage

    dlgForm(form, title = "Fill the form", message = NULL, columns = 1,
        strip.type = TRUE, ..., gui = .GUI)

    ## These should not be called directly
    ## S3 method for class 'gui'
    dlgForm(form, title = "Fill the form", message = NULL, columns = 1,
        strip.type = TRUE, ..., gui = .GUI)
    ## S3 method for class 'textCLI'
    dlgForm(form, title = "Fill the form", message = NULL, columns = 1,
        strip.type = TRUE, ..., gui = .GUI)
    ## S3 method for class 'nativeGUI'
    dlgForm(form, title = "Fill the form", message = NULL, columns = 1,
        strip.type = TRUE, ..., gui = .GUI)

### Arguments

`form` | named list of default values, or list of possible items. Names are the labels of corresponding entries in the dialog box, followed by an indicator of the type of entry to place in the dialog box (see details).
`title` | the tile of the dialog box.
`message` | an optional message to display in the dialog box. Use `\n` for line break, or provide a vector of character strings, one for each line.
`columns` | arrange the entries on this number of columns (by row).
`strip.type` | do we strip the type from the names in results.
`...` | pass further arguments to methods.
`gui` | the 'gui' object concerned by this dialog box.

### Details

The form content is defined by a named list. Items are default values, or a list of possible items, e.g., for the combobox. Names are labels displayed in front of each field in the form. Follow them by a code that represents the type of entry you want to use:

`:TXT` for simple (default) textual box, `:H` for hidden text (password), `:RO` for read-only text, `:NUM` for null of positive integers with up/down arrows, `:CHK` for checkbox: `TRUE` or `FALSE`, `:CB` for read-only combobox, `:CBE` for editable combobox, `:FL` to select one existing file, `:MFL` to select multiple existing files, `:SFL` to select or create one file, `:DIR` to select a directory, `:CDIR` to select or create a directory, `:FN` to select font and font size, `:DT` to enter a date, `:CLR` to enter a RGB color, `:BTN` to create a button that execute some code, `:LBL` to add a label.

For the moment, the form dialog box is only supported on Linux. You have to install yad to get access to it. On Ubuntu, you do so by:

    sudo add-apt-repository ppa:webupd8team/y-ppa-manager
    sudo apt-get update
    sudo apt-get install yad

### Value

The modified 'gui' object is returned invisibly. The items entered by the user, or an empty list if the dialog box was cancelled can be obtained from `gui$res` (see example).

### Author(s)

Philippe Grosjean (phgrosjean@sciviews.org)

### See Also

`dlgInput`

### Examples

    ## Ask a series of items at once in a dialog box
    Form <- list(
        "Name:TXT" = "John Smith",
        "Age:NUM" = 25,
        "Sex:CB" = c("male", "female"),
        "Married:CHK"=FALSE
    )
    dlgForm(Form, "My form")$res

[Package svDialogs version 0.9-57 Index]