[rkward-cvs] SF.net SVN: rkward-code:[4890] trunk/rkward/doc/rkwardplugins/index.docbook

[tfry at users.sf.net]

Revision: 4890
          http://sourceforge.net/p/rkward/code/4890
Author:   tfry
Date:     2014-10-11 12:19:15 +0000 (Sat, 11 Oct 2014)
Log Message:
-----------
Apparently, enabling/disabling of individual radio-options was never documented, properly

Modified Paths:
--------------
    trunk/rkward/doc/rkwardplugins/index.docbook

Modified: trunk/rkward/doc/rkwardplugins/index.docbook
===================================================================
--- trunk/rkward/doc/rkwardplugins/index.docbook	2014-10-08 19:23:14 UTC (rev 4889)
+++ trunk/rkward/doc/rkwardplugins/index.docbook	2014-10-11 12:19:15 UTC (rev 4890)
@@ -2687,7 +2687,8 @@
 
 <varlistentry>
 <term><option></term>
-<listitem><para>Can only be used as a direct child of a <radio>, <dropdown>, <valueslot> or <select> element. Represents one selectable option in a radio control or dropdown list. Specifying the "id" parameter for the <option> elements is optional (and in fact it's recommended, not to set an "id", unless you plan to really use it to disable single options; <valueslot> and <select> options do not currently support ids). Only the parent element (<radio> or <dropdown> or <valueslot> or <select>) needs one. Attributes:
+<listitem><para>Can only be used as a direct child of a <radio>, <dropdown>, <valueslot> or <select> element. Represents one selectable option in a radio control or dropdown list. As <option> elements are always part of one of the selection elements, they do not normally
+have an "id" of their own, but see below. Attributes:
 	<variablelist>
 	<varlistentry>
 	<term><parameter>label</parameter></term>
@@ -2701,6 +2702,11 @@
 	<term><parameter>checked</parameter></term>
 	<listitem><para>Whether the option should be checked/selected by default "true" or "false". In a <radio> or <dropdown>, only one option may be set to <parameter>checked=</parameter><replaceable>"true"</replaceable>, and if no option is set to checked, the first option in the parent element will be checked/selected automatically. In a <select>, any number of options may be set to checked. (optional, default to "false")</para></listitem>
 	</varlistentry>
+	<varlistentry>
+	<term><parameter>id</parameter></term>
+	<listitem><para>Specifying the "id" parameter for the <option> elements is optional (and in fact it's recommended, not to set an "id", unless you really need one). However, specifying an "id" will allow you to enable/disable <option>s, dynamically, by connecting to the boolean property <replaceable>id_of_radio.id_of_optionX.enabled</replaceable>. Currently this works for options inside <radio> or <dropdown>
+	elements, only; <valueslot> and <select> options do not currently support ids.</para></listitem>
+	</varlistentry>
 	</variablelist></para></listitem>
 </varlistentry>