Form::Control::checkboxes(3pm)
NAME
Embperl::Form::Control::checkboxes - A multiple checkbox control inside
an Embperl Form
SYNOPSIS
{
type => 'checkboxes',
text => 'blabla',
name => 'foo',
values => [1,2,3],
options => ['foo', 'bar', 'none'],
}
DESCRIPTION
- Used to create an checkboxes control inside an Embperl Form. See
Embperl::Form on how to specify parameters. - PARAMETER
- type
- Needs to be 'checkboxes'
- name
- Specifies the name of the checkboxes control
- text
- Will be used as label for the checkboxes control
- values
- Gives the values as an array ref of the checkboxes control.
- options
- Gives the options as an array ref that should be displayed to the user. If no options are given, the values from values are used.
- vert
- If specified arranges the checkboxes button vertically. The number
given specifies the number of <br>'s used the separate the checkboxes
buttons. - addtop
- Array ref which contains items that should be added at the left or top
of the checkboxes buttons. Each item consists of an array ref with two
entries, the first is the value and the second is the option that is
displayed on the page. If the second is missing the value (first
entry)is displayed. Example:
addtop => [ [1 => 'first item'], [2 => 'second item']] - addbottom
- Array ref which contains items that should be added at the right or
bottom of the checkboxes buttons. Each item consists of an array ref
with two entries, the first is the value and the second is the option
that is displayed on the page. If the second is missing the value
(first entry)is displayed. Example:
addbottom => [ [9999 => 'last item'], [9999 => 'very last item']] - filter
- If given, only items where the value matches the regex given in
"filter" are displayed.
Author
G. Richter (richter@dev.ecos.de)
See Also
- perl(1), Embperl, Embperl::Form