[rkward-cvs] SF.net SVN: rkward:[2923] trunk/rkward/doc/rkward/ writing_plugins_introduction.docbook

[tfry at users.sourceforge.net]

Revision: 2923
          http://rkward.svn.sourceforge.net/rkward/?rev=2923&view=rev
Author:   tfry
Date:     2010-07-01 20:01:05 +0000 (Thu, 01 Jul 2010)

Log Message:
-----------
Document new features for varselector and saveobject

Modified Paths:
--------------
    trunk/rkward/doc/rkward/writing_plugins_introduction.docbook

Modified: trunk/rkward/doc/rkward/writing_plugins_introduction.docbook
===================================================================
--- trunk/rkward/doc/rkward/writing_plugins_introduction.docbook	2010-07-01 17:57:48 UTC (rev 2922)
+++ trunk/rkward/doc/rkward/writing_plugins_introduction.docbook	2010-07-01 20:01:05 UTC (rev 2923)
@@ -1768,6 +1768,14 @@
 	<term><required></term>
 	<listitem>Whether - for submitting the code - it is required that the field holds a permissible object name. See <link linkend="elementproperties">required-property</link> (optional, defaults to true)</listitem>
 	</varlistentry>
+	<varlistentry>
+	<term><checkable></term>
+	<listitem>In many use cases, saving to an R object is optional. In these cases, a checkbox can be integrated into the saveobject-element using this attribute. When set to true, the saveobject will be activated / deactivated by the checkbox. See the <link linkend="elementproperties">active-property</link> of saveobject (optional, defaults to false)</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term><checked></term>
+	<listitem>For checkable saveobject-elements, only: Whether the control is checked/enabled by default (optional, defaults to false)</listitem>
+	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
@@ -1983,6 +1991,10 @@
 	<term>selected</term>
 	<listitem>The objects currently selected. You probably do not want to use this. Used internally (RObject)</listitem>
 	</varlistentry>
+	<varlistentry>
+	<term>root</term>
+	<listitem>The root/parent object of the objects offered for selection (RObject)</listitem>
+	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>
@@ -2077,8 +2089,20 @@
 	<variablelist>
 	<varlistentry>
 	<term>selection</term>
-	<listitem>Current text (selected object name) (string)</listitem>
+	<listitem>Full name of the selected object (string; read-only - to set this programmatically, use "parent", and "objectname")</listitem>
 	</varlistentry>
+	<varlistentry>
+	<term>parent</term>
+	<listitem>The parent object of the selected object. This is always an existing R object of a type that can contain other objects (e.g. a list or data.frame). When set to an empty string or an invalid object, ".GlobalEnv" is assumed (RObject)</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term>objectname</term>
+	<listitem>The base-name of the selected object, i.e. the string entered by the user (changed to a valid R name, if necessary) (string)</listitem>
+	</varlistentry>
+	<varlistentry>
+	<term>active</term>
+	<listitem>For checkable saveobjects, only: Whether the control is checked/enabled. Always true for non-checkable saveobjects (bool)</listitem>
+	</varlistentry>
 	</variablelist></listitem>
 </varlistentry>
 <varlistentry>


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