[rkward-cvs] SF.net SVN: rkward:[3830] trunk/rkward/rkward/rbackend/rpackages/rkwarddev

m-eik at users.sourceforge.net m-eik at users.sourceforge.net
Sun Sep 25 16:53:44 UTC 2011


Revision: 3830
          http://rkward.svn.sourceforge.net/rkward/?rev=3830&view=rev
Author:   m-eik
Date:     2011-09-25 16:53:44 +0000 (Sun, 25 Sep 2011)
Log Message:
-----------
rkwarddev: 0.01-5 release

Modified Paths:
--------------
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.connect.R
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.convert.R
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.external.R
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.logic.R
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.set.R
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.connect.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.convert.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.external.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.logic.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.set.Rd

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.connect.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.connect.R	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.connect.R	2011-09-25 16:53:44 UTC (rev 3830)
@@ -1,5 +1,8 @@
 #' Create XML node "connect" for RKWard plugins
 #'
+#' If you define a \code{XiMpLe.node} object as \code{governor} which is not a \code{<convert>} node,
+#' the function will automatically append ".state" to its \code{id}.
+#'
 #' @param governor Either a character string (the \code{id} of the property whose state should control
 #'		the \code{client}), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted
 #'		and used). Usually a \code{<convert>} node defined earlier (see
@@ -16,6 +19,11 @@
 #'		the \code{client} as well.
 #' @return A list of objects of class \code{XiMpLe.node}.
 #' @export
+#' @seealso
+#'		\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+#'		\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+#'		\code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+#'		\code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
 #' @examples
 #' test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
 #' cat(pasteXMLNode(test.connect, shine=1))

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.convert.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.convert.R	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.convert.R	2011-09-25 16:53:44 UTC (rev 3830)
@@ -19,12 +19,17 @@
 #'			\item{\code{min}}{True if \code{sources} is at least this value. They must be numeric.}
 #'			\item{\code{max}}{True if \code{sources} is below this value. They must be numeric.}
 #'		}
-#' @param required Logical, sets the state of the \code{required\_true} attribute. If \code{TRUE},
+#' @param required Logical, sets the state of the \code{required_true} attribute. If \code{TRUE},
 #'		the plugin submit button is only enabled if this property is true.
 #' @param id.name Character string, a unique ID for this plugin element.
 #'		If \code{"auto"}, an ID will be generated automatically from the sources and mode value.
 #' @return A list of objects of class \code{XiMpLe.node}.
 #' @export
+#' @seealso
+#'		\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+#'		\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+#'		\code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+#'		\code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
 #' @examples
 #' test.convert <- rk.XML.convert(c(string="foo"), mode=c(notequals="bar"))
 #' cat(pasteXMLNode(test.convert, shine=1))

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.external.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.external.R	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.external.R	2011-09-25 16:53:44 UTC (rev 3830)
@@ -4,6 +4,11 @@
 #' @param default Character string, initial value of the property if not connected.
 #' @return An object of class \code{XiMpLe.node}.
 #' @export
+#' @seealso
+#'		\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+#'		\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+#'		\code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+#'		\code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
 #' @examples
 #' test.external <- rk.XML.external(id="ext_property", default="none")
 #' cat(pasteXMLNode(test.external, shine=1))

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.logic.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.logic.R	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.logic.R	2011-09-25 16:53:44 UTC (rev 3830)
@@ -5,12 +5,26 @@
 #' @param nodes A list of objects of class \code{XiMpLe.node}. 
 #' @return A list of objects of class \code{XiMpLe.node}.
 #' @export
+#' @seealso
+#'		\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+#'		\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+#'		\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+#'		\code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
 #' @examples
-#' test.convert <- rk.XML.convert(c(string="foo"), mode=c(notequals="bar"), id.name="lgc_foobar")
-#' test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
-#' test.external <- rk.XML.external(id="ext_property", default="none")
-#' test.logic <- rk.XML.logic(nodes=list(test.convert, test.connect, test.external))
+#' # define an input field and two checkboxes
+#' test.input <- rk.XML.input("Type some text")
+#' test.cbox1 <- rk.XML.cbox(label="Want to type?", val="true")
+#' test.cbox2 <- rk.XML.cbox(label="Are you shure?", val="true")
+#' # now create some logic so that the input field is only enabled when both boxes are checked
+#' test.convert <- rk.XML.convert(c(state=test.cbox1,state=test.cbox2), mode=c(and=""))
+#' test.connect <- rk.XML.connect(governor=test.convert, client=test.input, set="enabled")
+#' test.logic <- rk.XML.logic(nodes=list(test.convert, test.connect))
 #' cat(pasteXMLNode(test.logic, shine=1))
+#' 
+#' # with only one checkbox, you can directly query if it's checked
+#' test.connect2 <- rk.XML.connect(governor=test.cbox1, client=test.input, set="enabled")
+#' test.logic2 <- rk.XML.logic(nodes=list(test.connect2))
+#' cat(pasteXMLNode(test.logic2, shine=1))
 
 rk.XML.logic <- function(nodes){
 	# check the node names and allow only valid ones

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.set.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.set.R	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rk.XML.set.R	2011-09-25 16:53:44 UTC (rev 3830)
@@ -11,6 +11,11 @@
 #' @param to Character string or logical, the value the property should be set to.
 #' @return A list of objects of class \code{XiMpLe.node}.
 #' @export
+#' @seealso
+#'		\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+#'		\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+#'		\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+#'		\code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
 #' @examples
 #' test.set <- rk.XML.set(id="input_foo", set="required", to=TRUE)
 #' cat(pasteXMLNode(test.set, shine=1))

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.connect.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.connect.Rd	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.connect.Rd	2011-09-25 16:53:44 UTC (rev 3830)
@@ -33,10 +33,19 @@
   A list of objects of class \code{XiMpLe.node}.
 }
 \description{
-  Create XML node "connect" for RKWard plugins
+  If you define a \code{XiMpLe.node} object as
+  \code{governor} which is not a \code{<convert>} node, the
+  function will automatically append ".state" to its
+  \code{id}.
 }
 \examples{
 test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
 cat(pasteXMLNode(test.connect, shine=1))
 }
+\seealso{
+  \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+  \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+  \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+  \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+}
 

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.convert.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.convert.Rd	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.convert.Rd	2011-09-25 16:53:44 UTC (rev 3830)
@@ -32,7 +32,7 @@
   below this value. They must be numeric.} }}
 
   \item{required}{Logical, sets the state of the
-  \code{required\_true} attribute. If \code{TRUE}, the
+  \code{required_true} attribute. If \code{TRUE}, the
   plugin submit button is only enabled if this property is
   true.}
 
@@ -50,4 +50,10 @@
 test.convert <- rk.XML.convert(c(string="foo"), mode=c(notequals="bar"))
 cat(pasteXMLNode(test.convert, shine=1))
 }
+\seealso{
+  \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+  \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+  \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+  \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+}
 

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.external.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.external.Rd	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.external.Rd	2011-09-25 16:53:44 UTC (rev 3830)
@@ -20,4 +20,10 @@
 test.external <- rk.XML.external(id="ext_property", default="none")
 cat(pasteXMLNode(test.external, shine=1))
 }
+\seealso{
+  \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+  \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+  \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+  \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+}
 

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.logic.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.logic.Rd	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.logic.Rd	2011-09-25 16:53:44 UTC (rev 3830)
@@ -16,10 +16,25 @@
   "connect" ,"external" and "set" nodes.
 }
 \examples{
-test.convert <- rk.XML.convert(c(string="foo"), mode=c(notequals="bar"), id.name="lgc_foobar")
-test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
-test.external <- rk.XML.external(id="ext_property", default="none")
-test.logic <- rk.XML.logic(nodes=list(test.convert, test.connect, test.external))
+# define an input field and two checkboxes
+test.input <- rk.XML.input("Type some text")
+test.cbox1 <- rk.XML.cbox(label="Want to type?", val="true")
+test.cbox2 <- rk.XML.cbox(label="Are you shure?", val="true")
+# now create some logic so that the input field is only enabled when both boxes are checked
+test.convert <- rk.XML.convert(c(state=test.cbox1,state=test.cbox2), mode=c(and=""))
+test.connect <- rk.XML.connect(governor=test.convert, client=test.input, set="enabled")
+test.logic <- rk.XML.logic(nodes=list(test.convert, test.connect))
 cat(pasteXMLNode(test.logic, shine=1))
+
+# with only one checkbox, you can directly query if it's checked
+test.connect2 <- rk.XML.connect(governor=test.cbox1, client=test.input, set="enabled")
+test.logic2 <- rk.XML.logic(nodes=list(test.connect2))
+cat(pasteXMLNode(test.logic2, shine=1))
 }
+\seealso{
+  \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+  \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+  \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+  \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+}
 

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.set.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.set.Rd	2011-09-25 15:20:46 UTC (rev 3829)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.set.Rd	2011-09-25 16:53:44 UTC (rev 3830)
@@ -29,4 +29,10 @@
 test.set <- rk.XML.set(id="input_foo", set="required", to=TRUE)
 cat(pasteXMLNode(test.set, shine=1))
 }
+\seealso{
+  \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
+  \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
+  \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
+  \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+}
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.





More information about the rkward-tracker mailing list