.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "HTMLDocument.addLabelledSelect" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
HTMLDocument::addLabelledSelect \- Adds a labelled selection box
.SH "SYNOPSIS"
.B ElementTree addLabelledSelect(
\fIElementTree block, String labeltext, String name, Int ssize, [Pair<String, [SelectOption]> ] optgroups, Bool lazy=false\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "parent"
The parent element
.PP
.B "labeltext"
The label for the selector
.PP
.B "name"
The name of the input. Remember that names starting with "kaya_" may be used by the Kaya standard library and should not be used directly by applications.
.PP
.B "ssize"
The size of the select element. If this is zero, the select element will only allow one option to be selected at any one time. If this is one or more, the select element will allow multiple options to be selected, and suggest to the browser that this many options be displayed simultaneously.
.PP
.B "optgroups"
The options to select from
.PP
.B "lazy"
This parameter is optional and defaults to
\fBfalse \fP
 If it is explicitly set to
\fBtrue \fP
then the selector will be generated lazily.
.SH "DESCRIPTION"
.PP
Adds a labelled selection box to a form. The selector itself is identical to that produced by
.B "HTMLDocument.addSelectElement"(3kaya)
or
.B "HTMLDocument.addLazySelect"(3kaya)
, depending on the value of the
\fBlazy \fP
parameter. Generally, it is more convenient to use this function to label selectors, than to create them individally.
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH LICENSE
The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.
.SH "RELATED"
.PD 0
.PP
.B "HTMLDocument.SelectOption"(3kaya)
.PP
.B "HTMLDocument.addLazySelect"(3kaya)
.PP
.B "HTMLDocument.addOptionList"(3kaya)
.PP
.B "HTMLDocument.addSelectElement"(3kaya)
.PD 0.4v