Add to git.
[monolith.git] / doc / ml_form_radio_get_checked.3.html
1 <html>
2 <head>
3 <meta name="generator" content="groff -Thtml, see www.gnu.org">
4 <meta name="Content-Style" content="text/css">
5 <title>new_ml_form_radio</title>
6 </head>
7 <body>
8
9 <h1 align=center>new_ml_form_radio</h1>
10 <a href="#NAME">NAME</a><br>
11 <a href="#SYNOPSIS">SYNOPSIS</a><br>
12 <a href="#DESCRIPTION">DESCRIPTION</a><br>
13 <a href="#AUTHOR">AUTHOR</a><br>
14 <a href="#LICENSE">LICENSE</a><br>
15 <a href="#VERSION">VERSION</a><br>
16 <a href="#SEE ALSO">SEE ALSO</a><br>
17
18 <hr>
19 <!-- Creator     : groff version 1.17.2 -->
20 <!-- CreationDate: Sat Aug 31 18:05:57 2002 -->
21 <a name="NAME"></a>
22 <h2>NAME</h2>
23 <table width="100%" border=0 rules="none" frame="void"
24        cols="2" cellspacing="0" cellpadding="0">
25 <tr valign="top" align="left">
26 <td width="10%"></td><td width="90%">
27 new_ml_form_radio, ml_form_radio_set_checked, ml_form_radio_get_checked - monolith radio button widget</td></table>
28 <a name="SYNOPSIS"></a>
29 <h2>SYNOPSIS</h2>
30
31 <table width="100%" border=0 rules="none" frame="void"
32        cols="2" cellspacing="0" cellpadding="0">
33 <tr valign="top" align="left">
34 <td width="10%"></td><td width="90%">
35 <pre><b>#include &lt;ml_form_radio.h&gt;
36
37 ml_form_radio new_ml_form_radio (pool pool, ml_form_radio_group group, const char *value);
38 void ml_form_radio_set_checked (ml_form_radio w, int checked);
39 int ml_form_radio_get_checked (ml_form_radio w);
40 </b></pre></td></table>
41 <a name="DESCRIPTION"></a>
42 <h2>DESCRIPTION</h2>
43
44 <table width="100%" border=0 rules="none" frame="void"
45        cols="2" cellspacing="0" cellpadding="0">
46 <tr valign="top" align="left">
47 <td width="10%"></td><td width="90%">
48 This is a radio button input, for use in forms. Radio
49 buttons represent choices, and thus are grouped together.
50 For this reason, you must place all related radio buttons
51 inside a <b>ml_form_radio_group</b> widget, which itself
52 goes inside the form.</td></table>
53
54 <table width="100%" border=0 rules="none" frame="void"
55        cols="2" cellspacing="0" cellpadding="0">
56 <tr valign="top" align="left">
57 <td width="10%"></td><td width="90%">
58 <b>new_ml_form_radio</b> creates a new radio button widget.
59 The radio button group into which this widget is being
60 embedded is passed as the <b>group</b>
61 parameter.</td></table>
62
63 <table width="100%" border=0 rules="none" frame="void"
64        cols="2" cellspacing="0" cellpadding="0">
65 <tr valign="top" align="left">
66 <td width="10%"></td><td width="90%">
67 After the form has been submitted, you can see which button
68 was pressed by checking the value of the
69 <b>ml_form_radio_group</b> widget, or by looking at the
70 checked status of each individual radio button using
71 <b>ml_form_radio_(set|get)_checked</b>.</td></table>
72 <a name="AUTHOR"></a>
73 <h2>AUTHOR</h2>
74
75 <table width="100%" border=0 rules="none" frame="void"
76        cols="2" cellspacing="0" cellpadding="0">
77 <tr valign="top" align="left">
78 <td width="10%"></td><td width="90%">
79 Richard Jones &lt;rich@annexia.org&gt;</td></table>
80 <a name="LICENSE"></a>
81 <h2>LICENSE</h2>
82
83 <table width="100%" border=0 rules="none" frame="void"
84        cols="2" cellspacing="0" cellpadding="0">
85 <tr valign="top" align="left">
86 <td width="10%"></td><td width="90%">
87 GNU LGPL (see http://www.gnu.org/)</td></table>
88 <a name="VERSION"></a>
89 <h2>VERSION</h2>
90
91 <table width="100%" border=0 rules="none" frame="void"
92        cols="2" cellspacing="0" cellpadding="0">
93 <tr valign="top" align="left">
94 <td width="10%"></td><td width="90%">
95 monolith-1.0.0</td></table>
96 <a name="SEE ALSO"></a>
97 <h2>SEE ALSO</h2>
98
99 <table width="100%" border=0 rules="none" frame="void"
100        cols="2" cellspacing="0" cellpadding="0">
101 <tr valign="top" align="left">
102 <td width="10%"></td><td width="90%">
103 <b>new_ml_form(3)</b>,
104 <b>new_ml_form_radio_group(3)</b>.</td></table>
105 <hr>
106 </body>
107 </html>