rk.XML.cbox: Create XML node "checkbox" for RKWard plugins

View source: R/rk.XML.cbox.R

rk.XML.cboxR Documentation

Create XML node "checkbox" for RKWard plugins

Description

Create XML node "checkbox" for RKWard plugins

Usage

rk.XML.cbox(
  label,
  value = "true",
  un.value = NULL,
  chk = FALSE,
  id.name = "auto",
  help = NULL,
  component = rk.get.comp(),
  i18n = NULL
)

Arguments

label

Character string, a text label for this plugin element.

value

Character string, the value to submit if the element is checked.

un.value

Character string, an optional value for the unchecked option.

chk

Logical, whether this element should be checked by default.

id.name

Character string, a unique ID for this plugin element. If "auto", 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.

Note

There's also a simple wrapper function rk.XML.checkbox.

See Also

Introduction to Writing Plugins for RKWard

Examples

test.checkboxes <- rk.XML.row(rk.XML.col(
  list(
    rk.XML.cbox(label="foo", value="foo1", chk=TRUE),
    rk.XML.cbox(label="bar", value="bar2"))))
cat(pasteXML(test.checkboxes))

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