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

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

Create XML node "preview" for RKWard plugins

Description

Create XML node "preview" for RKWard plugins

Usage

rk.XML.preview(
  label = "Preview",
  mode = "plot",
  placement = "default",
  active = FALSE,
  id.name = "auto",
  i18n = NULL
)

Arguments

label	A character string, text label for the preview checkbox.
mode	A character string, must be either "plot", "output", "data", or "custom".
placement	A character string, must be either "default", "attached", "detached", or "docked".
active	Logical, whether the preview should be enabled by default.
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 if present, otherwise from the objects in the frame. If NULL, no ID will be given.
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.preview <- rk.XML.preview("See a preview?")
cat(pasteXML(test.preview))

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