NAME

IWL::Iconbox::Icon - an icon widget for the iconbox

INHERITANCE

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

DESCRIPTION

The Icon widget is a basic widget for the iconbox. It features an icon, and a title underneath it.

CONSTRUCTOR

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

Where %ARGS is an optional hash parameter with with key-value options. These include: direction: the direction in which the icon will float in the iconbox margin: the margin around the icon. Defaults to '5px'

SIGNALS

select

Fires when the icon is selected

unselect

Fires when the icon is unselected

remove

Fires when the icon is removed

activate

Fires when the icon is activated

METHODS

setImage (IMAGE, [ALT])

Sets the image of the icon to the one provided

Parameters: IMAGE - the url, or the stock id of the image, ALT - the alt text of the image

getImage

Returns the icon image

setText (TEXT)

Sets the text underneath the icon to the one provided

Parameters: TEXT - the text string

getText

Returns the text of the icon label

setSelected (BOOL)

Sets whether the icon should be selected.

Parameters: BOOL - true if the icon should be selected;

isSelected

Returns true if the icon is selected

setDimensions (WIDTH, [HEIGHT])

Sets the dimensions of the icon to the given ones.

Parameters: WIDTH - the width, HEIGHT - the height.

Note: the dimension units should be provided. Thus, the above parameters will be strings, with the dimension integer, and the given unit to it. E.g.: "64px". Omitting the units might not work on some user agents.

LICENCE AND COPYRIGHT

Copyright (c) 2006-2007 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.