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

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

Create XML node "spinbox" for RKWard plugins

Description

Create XML node "spinbox" for RKWard plugins

Usage

rk.XML.spinbox(
  label,
  min = NULL,
  max = NULL,
  initial = 0,
  real = TRUE,
  precision = 2,
  max.precision = 8,
  id.name = "auto",
  help = NULL,
  component = rk.get.comp(),
  i18n = NULL
)

Arguments

label	Character string, a text label for this plugin element.
min	Numeric, the lowest value allowed. Defaults to the lowest value technically representable in the spinbox.
max	Numeric, the largest value allowed. Defaults to the highest value technically representable in the spinbox.
initial	Numeric, will be used as the initial value.
real	Logical, whether values should be real or integer numbers.
precision	Numeric, if real=TRUE defines the default number of decimal places shown in the spinbox.
max.precision	Numeric, maximum number of digits that can be meaningfully represented.
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.spinbox <- rk.XML.spinbox("Spin this:")
cat(pasteXML(test.spinbox))

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