1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="vspx_radio_button">
<refmeta>
<refentrytitle>vspx_radio_button</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vspx_radio_button</refname>
<refpurpose>scriptable radio button</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="syn_vspx_radio_button">
<funcprototype id="proto_vspx_radio_button">
<funcdef>
<function>radio-button</function>
</funcdef>
<attributes>
<attribute>name (required) </attribute>
<attribute>annotation (optional) </attribute>
<attribute>initial-enable (optional) </attribute>
<attribute>group-name (required) </attribute>
<attribute>value (required) </attribute>
<attribute>initial-checked (optional) </attribute>
</attributes>
<childs>
<child>after-data-bind</child>
<child>after-data-bind-container</child>
<child>before-data-bind</child>
<child>before-data-bind-container</child>
<child>on-post</child>
<child>on-post-container</child>
<child>before-render</child>
<child>before-render-container</child>
</childs>
<class>
<screen><![CDATA[
create type vspx_radio_button under vspx_button
self as ref temporary
constructor method vspx_radio_button (name varchar, parent vspx_control),
overriding method vc_render () returns any
;
]]>
</screen>
</class>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vspx_radio_button">
<title>Description</title>
<para>
<function>vspx_radio_button</function>is a scriptable version of HTML radio button.</para>
</refsect1>
<refsect1 id="attrs_vspx_radio_button">
<title>Attributes</title>
<refsect2>
<title>name</title>
<para>A unique name identifying the control.</para>
</refsect2>
<refsect2>
<title>annotation</title>
<para>A human readable comment.</para>
</refsect2>
<refsect2>
<title>initial-enable</title>
<para>Designates is control visible or not initially. Could be data-bound to an SQL expression.</para>
</refsect2>
<refsect2>
<title>group-name</title>
<para>When more check boxes needs to be grouped, this is a name of group. When post such control name of group will be received on post rather than name of control.</para>
</refsect2>
<refsect2>
<title>value</title>
<para>Data bindable value of control, represents value of HTML control to be drawn. Can be accessed thru the ufl_value member of the control.</para>
</refsect2>
<refsect2>
<title>initial-checked</title>
<para>This flag designate is that particular item is checked initially or not.</para>
</refsect2>
</refsect1>
<refsect1 id="childs_vspx_radio_button">
<title>Children</title>
</refsect1>
<refsect1 id="examples_vspx_radio_button">
<title>Examples</title>
<example id="ex_vspx_radio_button">
<title>Simple example</title>
<para>This is to render a radio-button group
</para>
<screen><![CDATA[
<p><v:radio-button name="radio01" group-name="radio_gr" value="--'one'" initial-checked="1" /></p>
<p><v:radio-button name="radio02" group-name="radio_gr" value="--'two'" /></p>
]]>
</screen>
</example>
</refsect1>
</refentry>
|