gWidgets2tcltk-undocumented: toolkit implementation for gmessage

.gmessage.guiWidgetsToolkittcltkR Documentation

toolkit implementation for gmessage

Description

toolkit implementation for gmessage

toolkit implementation for gconfirm

toolkit implmentation of ginput

toolkit implementation

toolkit implementation of galert

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit XXX constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit gedit constructor

toolkit constructor

Toolkit implementation

Toolkit constructor

Toolkit constructor

toolkit constructor for ggroup

gframe constructor

Toolkit constructor

Toolkit label constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit constructor

Toolkit XXX constructor

Toolkit constructor

Toolkit constructor

toolkit implementation of gtext

S3 method for gtimer

Toolkit constructor

Toolkit constructor

toolkit constructor for gwindow

add stock icons

Returns list of stock ids

return stock id

return stock id from object

Usage

## S3 method for class 'guiWidgetsToolkittcltk'
.gmessage(toolkit, msg,
  title = "message", icon = c("info", "warning", "error", "question"),
  parent = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gconfirm(toolkit, msg,
  title = "Confirm", icon = c("info", "warning", "error", "question"),
  parent = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.ginput(toolkit, msg, text = "",
  title = "Input", icon = c("info", "warning", "error", "question"),
  parent = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gbasicdialog(toolkit, title = "Dialog",
  parent = NULL, do.buttons = TRUE, handler = NULL, action = NULL,
  ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.galert(toolkit, msg, title = "message",
  delay = 3, parent = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gmenu(toolkit, menu.list = list(),
  popup = FALSE, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gaction(toolkit, label, tooltip = NULL,
  icon = NULL, key.accel = NULL, handler = NULL, action = NULL,
  parent = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gbutton(toolkit, text, handler, action,
  container, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gcalendar(toolkit, text = "",
  format = "%Y-%m-%d", handler = NULL, action = NULL,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gcheckbox(toolkit, text,
  checked = FALSE, use.togglebutton = FALSE, handler = NULL,
  action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gtable(toolkit, items,
  multiple = FALSE, chosen.col = 1, icon.col = NULL,
  tooltip.col = NULL, handler = NULL, action = NULL,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gcheckboxgroup(toolkit=NULL, items, checked = FALSE,horizontal = FALSE,
                use.table = FALSE, handler = NULL, action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gcombobox(toolkit, items, selected = 1,
  editable = FALSE, coerce.with = NULL, handler = NULL,
  action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gdf(toolkit, items = NULL,
  handler = NULL, action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gedit(toolkit, text = "", width = 25,
  coerce.with = NULL, initial.msg = initial.msg, handler = NULL,
  action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gexpandgroup(toolkit, text, markup,
  horizontal = TRUE, handler = NULL, action = NULL,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gfile(toolkit, text = "",
  type = c("open", "save", "selectdir"), initial.filename = NULL,
  initial.dir = getwd(), filter = list(), multi = FALSE, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gfilebrowse(toolkit, text = "",
  type = c("open", "save", "selectdir"), initial.filename = NULL,
  initial.dir = getwd(), filter = list(), quote = TRUE,
  handler = NULL, action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gformlayout(toolkit, align = "left",
  spacing = 5, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.ggroup(toolkit, horizontal = TRUE,
  spacing = 5, use.scrollwindow = FALSE, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gframe(toolkit, text, markup, pos,
  horizontal = TRUE, spacing = 5, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gimage(toolkit, filename = "",
  dirname = "", stock.id = NULL, size = "", handler = NULL,
  action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.glabel(toolkit, text = "",
  markup = FALSE, editable = FALSE, handler = NULL, action = NULL,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.glayout(toolkit, homogeneous = FALSE,
  spacing = 10, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gnotebook(toolkit, tab.pos = 3,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gpanedgroup(toolkit, horizontal = TRUE,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gprogressbar(toolkit, value, container,
  ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gradio(toolkit, items, selected = 1,
  horizontal = FALSE, handler = NULL, action = NULL,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gseparator(toolkit, horizontal = TRUE,
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gslider(toolkit, from = 0, to = 100,
  by = 1, value = from, horizontal = TRUE, handler = NULL,
  action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gspinbutton(toolkit, from = 0,
  to = 10, by = 1, value = from, digits = 0, handler = NULL,
  action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gstackwidget(toolkit, container = NULL,
  ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gstatusbar(toolkit, text = "",
  container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gtext(toolkit, text = NULL,
  width = NULL, height = 300, font.attr = NULL, wrap = TRUE,
  handler = NULL, action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gtimer(toolkit, ms, FUN, data = NULL,
  one.shot = FALSE, start = TRUE)

## S3 method for class 'guiWidgetsToolkittcltk'
.gtree(toolkit, offspring = NULL,
  offspring.data = NULL, chosen.col = 1, offspring.col = 2,
  icon.col = NULL, tooltip.col = NULL, multiple = FALSE,
  handler = NULL, action = NULL, container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gvarbrowser(toolkit, handler = NULL,
  action = "summary", container = NULL, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.gwindow(toolkit, title,
  visible = visible, name, width, height, parent, handler, action, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.addStockIcons(toolkit, iconNames,
  iconFiles, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.getStockIcons(toolkit, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.getStockIconByName(toolkit,name, ...)

## S3 method for class 'guiWidgetsToolkittcltk'
.stockIconFromObject(toolkit,obj, ...)

Arguments

toolkit

toolkit

msg

Character. message to display.

title

Character. Title

icon

What icon to show

parent

Hint as to where to display

...

ignored

text

Character. Initial text

do.buttons

FALSE to suppress buttons when no parent

handler

handler called when Ok button invoked

action

passed to handler for OK button

delay

delay

menu.list

A list defining the menu structure. Named sub lists determine the submenu titles and structure. The list may have components of class: GAction, mapped to a button; GSeparator, mapped to a horizontal separator; GRadio, mapped to linked buttons; or GCheckbox, mapped to a checkbox button.

popup

logical. If true, make a popup window to be added through a handler call

container

A parent container. When a widget is created it can be incorporated into the widget heirarchy by passing in a parent container at construction time. (For some toolkits this is not optional, e.g. gWidgets2tcltk or gWidgets2WWW2.)

label

label for action

tooltip

toolktip for actin

key.accel

keyboard accelerator. If given, parent must be specified.

format

Date format

checked

is button selected

use.togglebutton

Use a toggle button (shows depressed) not a check box

items

data.frame specifies items for selection. May be a vector, matrix or data frame

multiple

logical allow multiple selection

chosen.col

which value from the row is returned by selection

icon.col

NULL or integer. If latter, specifies column containing stock icon

tooltip.col

NULL or integer. If latter, specifies column containing tooltip

horizontal

logical. If true displayed horizontally, else vertically

use.table

logical. If supported, and TRUE then uses a table widget with scrollbars

selected

integer. Which item (by index) is selected. Use -1 for no selection

editable

logical. Is user allowed to edit value

coerce.with

A function of function name to be called before selected value is returned by svalue

width

width of widget

initial.msg

initial.msg

markup

does label use markup (toolkit specific)

type

type of browser: to open a file, to save a file or to select a directory

initial.filename

Suggested file name

initial.dir

initial directory. If a filename is given, and is not an absolute name, this will be prepended. If filename given initial directory will be taken from that.

filter

A filter specifiation. This can be a named character vector of file extensions or something toolkit specific. Here are some examples:

  • characterc("csv"="csv","txt"="txt")

  • RGtk2 Something like

    list("All files" = list(patterns = c("*")),
         "R files" = list(patterns = c("*.R", "*.Rdata")),
         "text files" = list(mime.types = c("text/plain"))
        )
      
  • tcltk

  • Qt

multi

Logical. Allow multiple files to be selected?

quote

quote output

align

alignment of label. Left justify or center balance. Leave as "default" for underlying toolkit default.

spacing

spacing between columns

use.scrollwindow

logical. Either TRUE, "TRUE", FALSE, "FALSE", "y", or "x". For all toolkits a non-FALSE value will place the child components into a scrollable container. For some toolkits this will only be in the direction of packing. If the toolkit allows it (RGtk2), then values of "x" or "y" can be used to override the default scrolling directions. A box container with scrollwindows should have it size set either directly or through packing with expand=TRUE as its size request will not reflect the size of its child components.

pos

position of label: 0=left, 1=right, some toolkit allow values in between

filename

basename of file

dirname

dirname of file

stock.id

stock id of icon (if non NULL)

size

size of icon when a stock id (toolkit dependent)

homogeneous

are cells all the same size

tab.pos

integer. Position of tabs, 1 on bottom, 2 left, 3 top, 4 right. (If supported)

value

a list or menu bar specifying the new men ubar

from

If a number of length one then a starting point, in which case to, by are passed to seq. Otherwise a sequence of values for which sort(unique(from)) will order

to

ending point when from is starting point

by

step size if not specified by from

digits

digits

height

height of widget (when width is specified)

font.attr

font attributes for text buffer. One can also specify font attributes for insertion. The font attributes are specified with a list with named components, with names and values coming from:

weight

in c("light", "normal", "bold", "heavy")

style

inc("normal", "oblique", "italic")

family

in c("sans", "helvetica", "times", "monospace")

size

in c("xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large")

foreground

a value in colors()

background

a value in colors()

wrap

logical do lines wrap

ms

interval in milliseconds

FUN

FUnction to call. Has one argument, data passed in

data

passed to function

one.shot

logical. If TRUE, called just once, else repeats

start

logical. If FALSE, started by start_timer OO method. (Call obj$start_time()).

offspring

function. A function passed values path and data, the latter from offspring.data. The path is the current position of the parent item using the named keys from the chosen column.

offspring.data

Passed to second argument of offspring function. Used to parameterize a function call.

offspring.col

integer or column name. Points to column containing logical values indicating if a row has offspring.

visible

logical. If codeTRUE window is drawn when constructed. Otherwise, window can be drawn later using visible<-. This value can default to FALSE by setting the option: options("gWidgets:gwindow-default-visible-is-false"=TRUE). There are advantages: windows can draw slowly when adding many items. With gWidgets2RGtk2, the ggraphics widget can like to be added to an undrawn widget as this avoids sizing issue.

name

name of icon

iconNames

names of icons

iconFiles

path of icons

obj

obj to get icon from

See Also

The documentation for this is found at gbutton.

The documentation for this is found at gprogressbar.


jverzani/gWidgets2tcltk documentation built on Feb. 4, 2024, 4:11 a.m.