.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "CGI::Test::Form::Group 3pm"
.TH CGI::Test::Form::Group 3pm "2022-06-10" "perl v5.34.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"
CGI::Test::Form::Group \- Records groups of box\-type widgets
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& # $form is a CGI::Test::Form object
\&
\& use CGI::Test;
\&
\& my $rgroup = $form\->radio_groups;
\& ok 1, defined $rgroup;
\&
\& my @title = $rgroup\->widgets_in("title");
\& my ($mister) = grep { $_\->value eq "Mr" } @title;
\& ok 2, $mister\->is_checked;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is a container for box-type widgets, i.e. radio buttons and
checkboxes, which may be groupped by name.
.PP
It can be queried to easily retrieve widgets belonging to a group, or to
get all the group names.
.PP
It is also used internally by \f(CW\*(C`CGI::Test\*(C'\fR to keep track of associated
radio buttons, so that checking one automatically unchecks the others in the
same group.
.SH "INTERFACE"
.IX Header "INTERFACE"
The following features are available:
.ie n .IP """is_groupname"" \fIname\fR" 4
.el .IP "\f(CWis_groupname\fR \fIname\fR" 4
.IX Item "is_groupname name"
Checks whether \fIname\fR is the name of a group.
.ie n .IP """names""" 4
.el .IP "\f(CWnames\fR" 4
.IX Item "names"
Returns a list of group names, in random order.
.ie n .IP """widget_count"" \fIgroupname\fR" 4
.el .IP "\f(CWwidget_count\fR \fIgroupname\fR" 4
.IX Item "widget_count groupname"
Returns amount of widgets held in \fIgroupname\fR, 0 if none.
.ie n .IP """widgets_in"" \fIgroupname\fR" 4
.el .IP "\f(CWwidgets_in\fR \fIgroupname\fR" 4
.IX Item "widgets_in groupname"
Returns a list of all the widgets in the given \fIgroupname\fR.  If the
name is not a valid group name, the list will be empty.
.SH "AUTHORS"
.IX Header "AUTHORS"
The original author is Raphael Manfredi.
.PP
Steven Hilton was long time maintainer of this module.
.PP
Current maintainer is Alexander Tokarev \fI<tokarev@cpan.org>\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBCGI::Test::Form\fR\|(3), \fBCGI::Test::Form::Widget::Box\fR\|(3).