rk.XML.radio: Create XML node "radio" for RKWard plugins

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

Create XML node "radio" for RKWard plugins

Description

Create XML node "radio" for RKWard plugins

Usage

rk.XML.radio(
  label,
  options = list(label = c(val = NULL, chk = FALSE, i18n = NULL)),
  id.name = "auto",
  help = NULL,
  component = rk.get.comp(),
  i18n = NULL
)

Arguments

label	Character string, a text label for this plugin element.
options	A named list with options to choose from. The names of the list elements will become labels of the options, val defines the value to submit if the option is checked, and chk=TRUE should be set in the one option which is checked by default. You might also provide an i18n for this particular option (see i18n). Objects generated with rk.XML.option are accepted as well.
id.name	Character string, a unique ID for this plugin element. If "auto" and a label was provided, an ID will be generated automatically from the label.
help	Character string or list of character values and XiMpLe nodes, will be used as the text value for a setting node in the .rkh file. Also needs component to be set accordingly!
component	Character string, name of the component this node belongs to. Only needed if you want to use the scan features for automatic help file generation; needs help to be set accordingly, too!
i18n	Either a character string or a named list with the optional elements context or comment, to give some i18n_context information for this node. If set to FALSE, the attribute label will be renamed into noi18n_label.

Value

An object of class XiMpLe.node.

Note

It is also possible to address a particular option by giving it an ID, probably useful in logic sections. Have a look at rk.XML.option for details.

See Also

rk.XML.option, Introduction to Writing Plugins for RKWard

Examples

test.radio <- rk.XML.radio("Chose one",
  options=list("First Option"=c(val="val1"),
  "Second Option"=c(val="val2", chk=TRUE)))
cat(pasteXML(test.radio))

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.