.\" 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 "HTML::Widget::Constraint 3pm"
.TH HTML::Widget::Constraint 3pm "2023-08-10" "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"
HTML::Widget::Constraint \- Constraint Base Class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    my $c = $widget\->constraint( $type, @names );
\&    $c\->message(\*(AqValidation error.\*(Aq);
\&    $c\->names(@names);
\&    $c\->not(1);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Constraint Base Class.
.SH "METHODS"
.IX Header "METHODS"
.SS "default_message"
.IX Subsection "default_message"
Arguments: \f(CW$message\fR
.PP
Return Value: \f(CW$message\fR
.PP
Default error message for failing constraints.
.SS "init"
.IX Subsection "init"
Arguments: \f(CW$widget\fR
.PP
Called once when \fBprocess()\fR gets called for the first time.
.SS "javascript"
.IX Subsection "javascript"
Arguments: \f(CW$id\fR
.PP
Should return JavaScript for client side validation and the like.
.SS "msg"
.IX Subsection "msg"
.SS "message"
.IX Subsection "message"
Arguments: \f(CW$message\fR
.PP
Contains the validation error message.
.SS "mk_message"
.IX Subsection "mk_message"
Arguments: \f(CW$message\fR
.PP
Returns a validation error message.
.SS "names"
.IX Subsection "names"
Arguments: \f(CW@names\fR
.PP
Return Value: \f(CW@names\fR
.PP
Contains names of params to test.
.SS "not"
.IX Subsection "not"
Arguments: \f(CW$bool\fR
.PP
Return Value: \f(CW$bool\fR
.PP
Negate constraint.
.SS "prepare"
.IX Subsection "prepare"
Arguments: \f(CW$widget\fR
.PP
Called every time \fBprocess()\fR gets called.
.SS "process"
.IX Subsection "process"
Arguments: \f(CW$widget\fR, \f(CW$params\fR, \e@uploads
.PP
Return Value: \e@errors
.PP
Validates params and returns a arrayref containing HTML::Widget::Error
objects representing failed constraints.
.SS "process_js"
.IX Subsection "process_js"
Arguments: \f(CW$id\fR
.PP
Returns a hashref containing JavaScripts for client side validation and
the like.
.SS "render_errors"
.IX Subsection "render_errors"
Arguments: \f(CW@names\fR
.PP
A list of element names for which an error should be displayed.
.PP
If this is not set, the default behaviour is for the error to be displayed 
for all of the Constraint's named elements.
.SS "validate"
.IX Subsection "validate"
Arguments: \f(CW$value\fR
.PP
Return Value: \f(CW$bool\fR
.PP
Validates a value and returns 1 or 0.
.SH "AUTHOR"
.IX Header "AUTHOR"
Sebastian Riedel, \f(CW\*(C`sri@oook.de\*(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.