gWidgets2tcltk

Description

The gWidgets2 package provides a programming interface for making graphical user interfaces within R. The package is a rewrite of the gWidgets package, introducing a few external changes but a significant number of internal ones. The package relies on one of several underlying toolkit packages providing access to the graphical libraries. This package provides the implementation to interface with the underlying tcltk package.

Drag and drop in tcltk is not supported by any underlying toolkit functionality. As such, in gWidgets2tcltk we roll our own. The result is a little limited: a) you can't drop values from other applications b) drop targets aren't allowed to be picky about what they receive (not by mime-type anyways).

GComponent is a parent class for both GContainer and GWidget and inherits its primary interface from gWidgets2::BasicToolkitInterface.

The GDf class provides a means to edit a data frame. We use the add on TK code provided by tablelist as the underlying widget

The main reference methods GTimer are start_timer and stop_timer

Arguments

Details

To implement drag and drop, we bind to the toplevel window the events: button1, motion and button1 release. The binding occurs not to to widget, but to the toplevel window containing the widget. This has some advantages, most imporantly it is unlikely the binding will be overwritten by usual gWidgets2tcltk programs. (Recall tkbind will only allow one binding per widget per signal).

The gWidgets2 way of doing drag and drop is implemented here. You add a drop source with a handler that returns the value of what you want to pass via the dnd process. Then you specify a widget as a drop target and give a handler. This handler receives the data through the dropdata component of the "h" argument. Here, the value is generated when the drop occurs, not when the drag initiates. Not sure this makes any difference, but it might.

Simply click on a row and the editor pops up as a modal dialog. The shortcut Shift+Enter will go onto the next case, saving changes provided the auto save featuer is employed.

There is no undo/redo support here. There is no support for editing rownames (just lazy at the moment, holler if you would like that). No support to change the dimensions of the data frame or edit factors, ...

Methods

is_watching()

Are we watching for a drag?

add_drag_motion(handler, action = NULL, ...)

Called when motion over widget occurs

add_to_parent(parent, child, expand = NULL, fill = NULL, anchor = NULL, ...)

Add a child to parent if it is ia container and non null. Dispatches to add_child method of parent

get_block()

Return surround block

get_enabled()

is widget sensistive to user input

get_index(drop = NULL, ...)

svalue; index=TRUE

get_tk_id()

Return tk ID

get_toplevel_tk_id()

return id of toplevel

get_value(drop = NULL, ...)

Get main value of widget. From 'svalue' when index = FALSE or NULL

get_widget()

Return widget (not block)

is_tkwidget()

Is widget older style widget

is_ttkwidget()

Is widget new style widget?. Override in subclass if not

set_enabled(value, ...)

specify with logical if widget is sensistive to user input

set_size(value, ...)

Set widget size (size request), value=c(width=-1, height=-1)

set_value(value, ..., drop = NULL)

for 'svalue<-' when index = FALSE or NULL

add(...)

add is just add_child

child_bookkeeping(child)

Update parent property of child and children property of parent container

get_widget()

Return widget (not block)

connect_to_toolkit_signal(signal, decorator, emitter = handler_widget(), ...)

Connect signal of toolkit to notify observer

remove_border()

Remove border by setting relief to none

get_length(...)

Get length of object. Needed for sapply.

save_data(nm, where)

Save data set

set_interval(ms)

Set the interval. Need to stop and start active timer to implement.

start_timer()

Start the timer

stop_timer()

stop the timer

Author(s)

John Verzani jverzani@gmail.com

Maintainer: John Verzani jverzani@gmail.com

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

See Also

The documentation for this is found at gbutton.

The documentation for this is found at gprogressbar.

GComponentObservable adds the observable interface

Description

GComponentObservable adds the observable interface

Usage

  GComponentObservable(...)

Arguments

show the word list

Description

show the word list

Arguments

Methods

add_bindings()

Add bindings to the entry box

clear_error()

Clear error message

clear_init_txt(...)

clear out init text, set back to black

find_match(x)

Find match in word list

make_styles(bg = "#ff6622")

Create tcl styles, cf http://paste.tclers.tk/506

set_error(msg)

Add error state and message to widget

set_init_txt(msg)

set initial text, gray out

set_invalid(value, msg)

Set widget as invalid or not

set_validator(FUN)

Set a function to do the validation

validate_input()

Return logical indicating if input is valid

Toplevel menu bar

Description

The GMenuBar class provides functionality for a top-level menubar. In tlctk the menubars can show either gaction items (proxied as buttons), gradio items or gcheckbox items. In the latter two cases, one uses the parent argument – not the container argument – to specify the parent container. Such items can also be shared with toolbars.

Usage

  GMenuBar(...)

Arguments

Examples

## Not run: 
w <- gwindow("having fun?")
sb <- gstatusbar("Your message here...", cont=w)
g <- ggroup(cont=w, horizontal=FALSE)
f <- function(h,...) message(h$obj$get_value())

l <- list(file=gaction("file", handler=function(h,...) print("file"),
               key.accel="<Control-x><Control-s>", parent=w),
          ok=gaction("ok", icon="ok", handler=function(h,...) print("ok")),
          radio=list(
            rb=gradio(state.name[1:3], parent=w, handler=function(h,...)
               print(h$obj$get_value()))
            )
          sep=gseparator(vertical=TRUE),
          ,cb=gcheckbox("really", parent=w, handler=function(h,...) print(h$obj$get_value()))
          )
mlist <- list(File=l)
mb <- gmenu(mlist, cont=w)

## End(Not run)

Spinbutton class

Description

Spinbutton class

Usage

  GSpinButton(...)

Arguments

GStatusBar is the base class for a status bar

Description

The GStatusBar class inherits for GBoxContainer meaning it can be used as a parent container. As such, one can add additional widgets beyond the plain label that is the main property of this widget.

Usage

  GStatusBar(...)

Arguments

GToolBar is the base class for toolbars

Description

The toolbar is a container, so can have other widgets added to it as though it were a box container. Buttons should be added as action items, so that they are rendered in the proper style. Check buttons should be given the argument use.togglebutton. Use addSpring to right align items.

Arguments

Methods

add_gaction_toolitem(obj)

Helper to add a gaction item

add_gseparator_toolitem()

Helper to add a separator

add_toolbar_items(items)

Map a toolbar list, a named list of gaction items or gsepartor items

clear_toolbar()

Clear toolbar items

get_widget()

What widget do we use for the parent of the children

set_value(value, ...)

We can't really adjust spacing between children after they have been positioned.

A list extension class.

Description

Like a list, but has some methods. Completely superflous, but makes copying some code algorithms easier. We implement methods such as append, push, pop and each for iteration. As well, there are some lookup methods.

Arguments

Methods

contains(name)

TRUE if name is key in array

core()

return list

each(FUN, ...)

Iterator for lists, like sapply, but FUN gets passed index, key, and value

flush(...)

Reset array, return contents as list

get_by_name(name)

get item under name

get_id()

Return an id, or name, for an object

get_item(index)

Get item by index

insert(x, name, index)

Insert item into List with 0 the head and index=len() the tail

len()

length

pluck(id, FUN, ...)

Like ext.pluck. Returns array with 'id' extracted from each item in the List

pop()

pop last element of list

push(x, name)

Append x with optional name. If name not specified new id created. Returns name

method for getWidget defined in gWidgets2

Description

method for getWidget defined in gWidgets2

Usage

## S3 method for class 'tkwin'
getWidget(obj)

Arguments

toolkit class for tlctk

Description

toolkit class for tlctk

align a column based on the class of the content

Description

Gives visual difference to data based on its class

Usage

gwidgets2_tcltk_column_alignment(x)

## Default S3 method:
gwidgets2_tcltk_column_alignment(x)

## S3 method for class 'numeric'
gwidgets2_tcltk_column_alignment(x)

## S3 method for class 'logical'
gwidgets2_tcltk_column_alignment(x)

Arguments

Value

anchor string

Format object to character class for inclusion in a table

Description

Gives chance to do more than as.character

Usage

gwidgets2_tcltk_format_to_char(x)

## Default S3 method:
gwidgets2_tcltk_format_to_char(x)

## S3 method for class 'factor'
gwidgets2_tcltk_format_to_char(x)

## S3 method for class 'integer'
gwidgets2_tcltk_format_to_char(x)

## S3 method for class 'numeric'
gwidgets2_tcltk_format_to_char(x)

## S3 method for class 'Date'
gwidgets2_tcltk_format_to_char(x)

## S3 method for class 'data.frame'
gwidgets2_tcltk_format_to_char(x)

Arguments

Value

object of character class with possible formatting.

make a calendar...

Description

make a calendar...

Usage

makeCalendar(date_var, widget, date, date_format = "%Y-%m-%d",
  set_value)

Arguments