.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 3pm"
.TH Form 3pm "2023-01-22" "perl v5.36.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 \- Embperl Form class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new ($controls, $options)"
.el .SS "new ($controls, \f(CW$options\fP)"
.IX Subsection "new ($controls, $options)"
.IP "\(bu" 4
\&\f(CW$controls\fR
.Sp
Array ref with controls which should be displayed
inside the form. Each control needs either to be a
hashref with all parameters for the control or
a control object.
.Sp
If hash refs are given it's necessary to specify
the \f(CW\*(C`type\*(C'\fR parameter, to let Embperl::Form
know which control to create.
.Sp
See Embperl::Form::Control and Embperl::Form::Control::*
for a list of available parameters.
.IP "\(bu" 4
\&\f(CW$options\fR
.Sp
Hash ref which can take the following parameters:
.RS 4
.IP "\(bu" 4
formname
.Sp
Will be used as name and id attribute of the form. If you have more
then one form on a page it's necessary to have different form names
to make form validation work correctly.
.IP "\(bu" 4
masks
.Sp
Contains a hash ref which can specify a set of masks
for the controls. A mask is a set of parameter which
overwrite the setting of a control. You can specify
a mask for a control name (key is name), for a control
type (key is *type) or for all controls (key is *).
.Sp
Example:
.Sp
.Vb 5
\&    {
\&    \*(Aqinfo\*(Aq      => { readonly => 1},
\&    \*(Aq*textarea\*(Aq => { cols => 80 },
\&    \*(Aq*\*(Aq         => { labelclass => \*(Aqmyclass\*(Aq, labelnowrap => 1}
\&    }
.Ve
.Sp
This will force the control with the name \f(CW\*(C`info\*(C'\fR to be readonly, it
will force all \f(CW\*(C`textarea\*(C'\fR controls to have 80 columns and
it will force the label of all controls to have a class of myclass
and not to wrap the text.
.IP "\(bu" 4
defaults
.Sp
Contains a hash ref which can specify a set of defaults
for the controls. You can specify
a default for a control name (key is name), for a control
type (key is *type) or for all controls (key is *).
.Sp
Example:
.Sp
.Vb 5
\&    {
\&    \*(Aqinfo\*(Aq      => { readonly => 1},
\&    \*(Aq*textarea\*(Aq => { cols => 80 },
\&    \*(Aq*\*(Aq         => { labelclass => \*(Aqmyclass\*(Aq, labelnowrap => 1}
\&    }
.Ve
.Sp
This will make the control with the name \f(CW\*(C`info\*(C'\fR to default to be readonly, it
will default all \f(CW\*(C`textarea\*(C'\fR controls to have 80 columns and
it will set the default class for the labels of all controls to
myclass and not to wrap the text.
.IP "\(bu" 4
language
.Sp
Language setting is used for Embperl::Form::Validate, e.g. 'en' or 'de'
.IP "\(bu" 4
charset
.Sp
Charset setting is used for Embperl::Form::Validate, e.g. 'utf\-8'
.IP "\(bu" 4
valign
.Sp
valign for control cells. Defaults to 'top' .
.IP "\(bu" 4
jsnamespace
.Sp
Give the JavaScript Namespace. This allows one to load js files in
a top frame or different frame, which will speed up page loading,
because the browser does not need to reload the js code on every load.
.Sp
Example:
.Sp
.Vb 1
\&    jsnamespace => \*(Aqtop\*(Aq
.Ve
.IP "\(bu" 4
classdiv
.Sp
Gives the \s-1CSS\s0 class of the \s-1DIV\s0 around the form. Default cTableDiv.
.IP "\(bu" 4
checkitems
.Sp
If set to true, allows one to call the function diff_checkitems after the data is
posted and see which form fields are changed.
.IP "\(bu" 4
control_packages
.Sp
Arrayref with package names to search for form controls. Alternatively you can
overwrite the method get_control_packages.
.IP "\(bu" 4
datasrc_packages
.Sp
Arrayref with package names to search for form data source modules. Alternatively you can
overwrite the method get_datasrc_packages.
.RE
.RS 4
.RE
.SS "layout"
.IX Subsection "layout"
.SS "validate"
.IX Subsection "validate"
.SS "show"
.IX Subsection "show"
.SS "convert_label"
.IX Subsection "convert_label"
Converts the label of a control to the text that should be outputed.
By default does return the text or name parameter of the control.
Can be overwritten to allow for example internationalization.
.ie n .IP "$ctrl" 4
.el .IP "\f(CW$ctrl\fR" 4
.IX Item "$ctrl"
Embperl::Form::Control object
.ie n .IP "$name" 4
.el .IP "\f(CW$name\fR" 4
.IX Item "$name"
optional: name to translate, if not given take \f(CW$ctrl\fR \-> {name}
.SS "convert_text"
.IX Subsection "convert_text"
Converts the text of a control to the text that should be outputed.
By default does return the text or name parameter of the control.
Can be overwritten to allow for example internationalization.
.ie n .IP "$ctrl" 4
.el .IP "\f(CW$ctrl\fR" 4
.IX Item "$ctrl"
Embperl::Form::Control object
.SS "convert_options"
.IX Subsection "convert_options"
Converts the values of a control to the text that should be outputed.
By default does nothing.
Can be overwritten to allow for example internationalization.
.ie n .IP "$ctrl" 4
.el .IP "\f(CW$ctrl\fR" 4
.IX Item "$ctrl"
Embperl::Form::Control object
.ie n .IP "$values" 4
.el .IP "\f(CW$values\fR" 4
.IX Item "$values"
values of the control i.e. values that are submitted
.ie n .IP "$options" 4
.el .IP "\f(CW$options\fR" 4
.IX Item "$options"
options of the control i.e. text that should be displayed
.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::Control