.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Form::ControlMultValue 3pm"
.TH Form::ControlMultValue 3pm "2020-11-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Embperl::Form::ControlMultValue \- Base class for controls inside
an Embperl Form which have multiple values to select from, like
a select box or radio buttons.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Do not use directly, instead derive a class
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is not used directly, it is used as a base class for
all controls which have multiple values to select from inside
an Embperl Form. It provides a set of methods
that could be overwritten to customize the behaviour of your controls.
.SH "METHODS"
.IX Header "METHODS"
.SS "get_values"
.IX Subsection "get_values"
returns the values and options
.SS "get_datasource_controls"
.IX Subsection "get_datasource_controls"
returns additional controls provided by the
datasource object e.g. a browse button
.SS "get_active_id"
.IX Subsection "get_active_id"
get the id of the value which is currently active
.SH "PARAMETERS"
.IX Header "PARAMETERS"
\fIvalues\fR
.IX Subsection "values"
.PP
Arrayref with the values to select from. This is what gets
submited back to the server.
.PP
\fIoptions\fR
.IX Subsection "options"
.PP
Arrayref with the options to select from. This is what the user sees.
.PP
\fIdatasrc\fR
.IX Subsection "datasrc"
.PP
Name of an class which provides the values for the
values and options parameters. Either a full package name or
a name, in which case all packages which are returned
by Embperl::Form::get_datasrc_packages are searched.
Everything after '#' is ignored and can be used by the
DataSource module to do further selections.
.PP
\fIno_datasource_controls\fR
.IX Subsection "no_datasource_controls"
.PP
Disables the output of the additional controls
.SH "AUTHOR"
.IX Header "AUTHOR"
G. Richter (richter at embperl dot org)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), Embperl, Embperl::Form, Embperl::From::Control, Embperl::Form::DataSource