add_actions: Add GUI elements like actions (menu items), icons, or methods...

View source: R/add_actions.R

add_actionsR Documentation

Add GUI elements like actions (menu items), icons, or methods in a predefined list

Description

Manage lists of GUI actions, icons and methods.

Usage

add_actions(
  obj = get_actions(),
  text = NULL,
  code = NULL,
  state = NULL,
  options = NULL,
  replace = TRUE
)

get_actions()

add_icons(obj = ".svIcons", icons, replace = TRUE)

add_methods(methods)

addActions(
  obj = get_actions(),
  text = NULL,
  code = NULL,
  state = NULL,
  options = NULL,
  replace = TRUE
)

addIcons(obj = ".svIcons", icons, replace = TRUE)

addMethods(methods)

Arguments

obj

The name of the object in SciViews:TempEnv to manipulate.

text

The text of actions to add (label on first line, tip on other lines).

code

The R code of actions to add.

state

The default (initial) state of an action, as a succession of letters: c = checked, u = unchecked (default); d = disabled, e = enabled (default); h = hidden, v = visible (default). Default values are optional. Ex: udv means: unchecked - disabled - visible and it equals to simply d, given the defaults for the other properties.

options

A character vector with other options to pass to the graphical toolkit for this action.

replace

Do we replace existing items in 'x'?

icons

The description of the icons to add.

methods

The list of methods to add (character string).

Value

The modified object is returned invisibly.

See Also

add_items(), obj_menu(), temp_env()

Examples

# This is useful to add actions, icons, descriptions, shortcuts or methods
# TODO: examples and use for functions add_actions(), add_icons() and
# add_methods()

SciViews/svMisc documentation built on May 3, 2024, 6:36 a.m.