R/ghtml.R

In jverzani/gWidgets2: Rewrite of gWidgets API for Simplified GUI Construction

##' @include methods.R
NULL

##' Widget for HTML display
##'
##' This widget, when supported by the toolkit (not
##' \pkg{gWidgets2RGtk2} and \pkg{gWidgets2tcltk}) provides a simple
##' means to display HTML formatted text.
##' @param x url or character vector of HTML formatted text. URLs marked by "http://" prefix
##' @inheritParams gwidget
##' @return a \code{GHtml} instance.
##' @export
ghtml <- function(x, 
                  container=NULL,
                  ...,
                  toolkit=guiToolkit()) {
  
  x <- paste(x, collapse="\n")

  if(is.character(toolkit))
    toolkit <- guiToolkit(toolkit)
  
  obj <- .ghtml(toolkit, x, container, ...)

  check_return_class(obj, "GHtml")
  obj   
  
}

##' S3 generic whose methods are implemented in the toolkit packages
##'
##' @rdname ghtml
##' @export
##' @author john verzani
.ghtml <- function(toolkit, x, container=NULL, ...) UseMethod(".ghtml")


##' \code{svalue<-} method for a ghtml
##'
##' Use to update displayed content. Value is HTML fragment or url
##' @inheritParams svalue
##' @export
##' @usage \method{svalue}{GHtml} (obj, index=TRUE, ...) <- value
##' @rdname ghtml
##' @method svalue<- GHtml
"svalue<-.GHtml" <- function(obj, index=TRUE,  ..., value) {
  value <- paste(value, collapse="\n")
  NextMethod()
}