.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "HTML::FormFu::Element::ComboBox 3pm"
.TH HTML::FormFu::Element::ComboBox 3pm "2019-01-12" "perl v5.28.1" "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"
HTML::FormFu::Element::ComboBox \- Select / Text hybrid
.SH "VERSION"
.IX Header "VERSION"
version 2.07
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&    \-\-\-
\&    elements:
\&      \- type: ComboBox
\&        name: answer
\&        label: \*(AqSelect yes or no, or write an alternative:\*(Aq
\&        values:
\&          \- yes
\&          \- no
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Creates a multi element containing a Select
field and a Text field.
.PP
A ComboBox element named \f(CW\*(C`foo\*(C'\fR would result in a Select menu named
\&\f(CW\*(C`foo_select\*(C'\fR and a Text field named \f(CW\*(C`foo_text\*(C'\fR. The names can instead be
overridden by the \f(CW\*(C`name\*(C'\fR value in \*(L"select\*(R" and \*(L"text\*(R".
.PP
If a value is submitted for the Text field, this will be used in preference
to any submitted value for the Select menu.
.PP
You can access the submitted value by using the ComboBox's name:
.PP
.Vb 1
\&    my $value = $form\->param_value(\*(Aqfoo\*(Aq);
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "default"
.IX Subsection "default"
If the value matches one of the Select menu's options, that options will be
selected. Otherwise, the Text field will use the value as its default.
.SS "options"
.IX Subsection "options"
See \*(L"options\*(R" in HTML::FormFu::Role::Element::Group for details.
.SS "values"
.IX Subsection "values"
See \*(L"values\*(R" in HTML::FormFu::Role::Element::Group for details.
.SS "value_range"
.IX Subsection "value_range"
See \*(L"value_range\*(R" in HTML::FormFu::Role::Element::Group for details.
.SS "empty_first"
.IX Subsection "empty_first"
See \*(L"empty_first\*(R" in HTML::FormFu::Role::Element::Group for details.
.SS "empty_first_label"
.IX Subsection "empty_first_label"
See \*(L"empty_first_label\*(R" in HTML::FormFu::Role::Element::Group for details.
.SS "select"
.IX Subsection "select"
Arguments: \e%setting
.PP
Set values effecting the Select menu. Known keys are:
.PP
\fIname\fR
.IX Subsection "name"
.PP
Override the auto-generated name of the select menu.
.SS "text"
.IX Subsection "text"
Arguments: \e%setting
.PP
Set values effecting the Text field. Known keys are:
.PP
\fIname\fR
.IX Subsection "name"
.PP
Override the auto-generated name of the select menu.
.SH "CAVEATS"
.IX Header "CAVEATS"
Although this element inherits from HTML::FormFu::Element::Block, its
behaviour for the methods
filter/filters,
constraint/constraints,
inflator/inflators,
validator/validators and
transformer/transformers is more like that of
a field element, meaning all processors are
added directly to the date element, not to its child elements.
.PP
This element's get_elements and
get_all_elements are inherited from
HTML::FormFu::Element::Block, and so have the same behaviour. However, it
overrides the \f(CW\*(C`get_fields|HTML::FormFu/get_fields\*(C'\fR method, such that it
returns both itself and its child elements.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Is a sub-class of, and inherits methods from
HTML::FormFu::Element::Multi,
HTML::FormFu::Element::Block,
HTML::FormFu::Element
.PP
HTML::FormFu
.SH "AUTHOR"
.IX Header "AUTHOR"
Carl Franks, \f(CW\*(C`cfranks@cpan.org\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Carl Franks <cpan@fireartist.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Carl Franks.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.