The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

IWL::Iconbox - an iconbox widget

INHERITANCE

IWL::Error -> IWL::Object -> IWL::Widget -> IWL::Container -> IWL::Iconbox

DESCRIPTION

The iconbox widget provides a container that holds icons.

CONSTRUCTOR

IWL::Iconbox->new ([%ARGS])

Where %ARGS is an optional hash parameter with with key-value options. These include:

width

Width of the iconbox without the borders

height

Height of the iconbox without the borders

multipleSelect

True if the iconbox should be able to select multiple icons

SIGNALS

select_all

Fires when all the icons have been selected

unselect_all

Fires when all the icons have been unselected

load

Fires when the iconbox and its icons have finished loading

EVENTS

IWL-Iconbox-refresh

Emitted when the iconbox has to be refreshed. This event is used by IWL::PageControl. The paramaters hashref contains:

type

The type of the request:

input

The given page comes from a user input. In this case, the value parameter is filled with the user requested page number.

first

The first page. Ideally, a first page should be generated and returned.

prev

The previous page. Ideally, the page, previous to the one given in the page parameter should be returned.

next

The next page. Ideally, the page, next to the one given in the page parameter should be returned.

last

The last page. Ideally, the last page should be generated and returned.

value

If the type parameter was input, this parameter holds the user requested page.

page

The current page of the widget.

pageSize

The number of entities per page.

pageCount

The total number of pages.

As a return first parameter, the perl callback has to return an arrayref of IWL::Iconbox::Icon objects. As a second return parameter, the perl callback can return any of above parameters in the hash reference. These parameters will change the state of the IWL::PageControl for this widget.

METHODS

appendIcon (ICON)

Appends an icon object to the iconbox.

Parameters: ICON - the IWL::Iconbox::Icon object to be appended

prependIcon (ICON)

Prepend an icon object to the iconbox.

Parameters: ICON - the IWL::Iconbox::Icon object to be prepended

LICENCE AND COPYRIGHT

Copyright (c) 2006-2008 Viktor Kojouharov. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perldoc perlartistic.

This program 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.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 290:

You forgot a '=back' before '=head1'