rk.XML.saveobj: Create XML node "saveobject" for RKWard plugins

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

Create XML node "saveobject" for RKWard plugins

Description

Create XML node "saveobject" for RKWard plugins

Usage

rk.XML.saveobj(
  label,
  chk = FALSE,
  checkable = TRUE,
  initial = "auto",
  required = FALSE,
  id.name = "auto",
  help = NULL,
  component = rk.get.comp(),
  i18n = NULL
)

Arguments

label	Character string, a text label for this plugin element.
chk	Logical, if TRUE and checkable=TRUE the option is checkable and active by default.
checkable	Logical, if TRUE the option can be switched on and off.
initial	Character string, the default name for the object should be saved to. If "auto" and a label was provided, an name will be generated automatically from the label.
required	Logical, whether an entry is mandatory or not.
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. If set to FALSE, rk.rkh.scan will ignore this node. 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.

See Also

Introduction to Writing Plugins for RKWard

Examples

test.saveobj <- rk.XML.saveobj("Save the results")
cat(pasteXML(test.saveobj))

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