NAME

Gtk2::Ex::FormFactory::CheckButtonGroup - A group of checkbuttons

SYNOPSIS

Gtk2::Ex::FormFactory::CheckButtonGroup->new (
  max_columns => Maximum number of columns,
  max_rows    => Maximum number of rows,
  ...
  Gtk2::Ex::FormFactory::Widget attributes
);

DESCRIPTION

This class implements a group of check buttons which allow a multiple selection out of a set from predefined values. It's arranged in a two dimensional table. You can specify either the maximum number of rows or columns, the actual dimensions are calculated automatically.

The value of a CheckBoxGroup is a hash. The value of each selected checkbox will result in a correspondent hash key with a true value assigned.

OBJECT HIERARCHY

Gtk2::Ex::FormFactory::Intro

Gtk2::Ex::FormFactory::Widget
+--- Gtk2::Ex::FormFactory::CheckButtonGroup

Gtk2::Ex::FormFactory::Layout
Gtk2::Ex::FormFactory::Rules
Gtk2::Ex::FormFactory::Context
Gtk2::Ex::FormFactory::Proxy

ATTRIBUTES

Attributes are handled through the common get_ATTR(), set_ATTR() style accessors, but they are mostly passed once to the object constructor and must not be altered after the associated FormFactory was built.

max_columns = SCALAR [optional]

Maximum number of columns the table should have. You must not set max_rows when you specify max_columns.

max_rows = SCALAR [optional]

Maximum number of rows the table should have. You must not set max_columns when you specify max_rows. If you omit both attributes max_rows defaults to 1, so all buttons will appear in one row.

REQUIREMENTS FOR ASSOCIATED APPLICATION OBJECTS

Application objects represented by a Gtk2::Ex::FormFactory::CheckButtonGroup must define additional methods. The naming of the methods listed beyond uses the standard get_ prefix for the attribute read accessor. ATTR needs to be replaced by the actual name of the attribute associated with the widget.

get_ATTR_list

This method must return a two dimensional array resp. a list of lists which represent the values the user can select from.

Example:

[
  [ 0, "Sun" ],
  [ 1, "Mon" ],
  [ 2, "Tue" ],
  ...
]

Each entry in the list consists of a list ref with two elements. The first is the value associated with the checkbox (which will become a hash key in the associated object attribute), the second the label of the checkbox on the GUI.

For more attributes refer to Gtk2::Ex::FormFactory::Widget.

AUTHORS

Jörn Reder <joern at zyn dot de>

COPYRIGHT AND LICENSE

Copyright 2004-2005 by Jörn Reder.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307 USA.