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

NAME

IWL::Contentbox - a content box

INHERITANCE

IWL::Object -> IWL::Widget -> IWL::Container -> IWL::Contentbox

DESCRIPTION

The Contentbox is a box, which resembles a window, with a title, a header, a footer, and a central place for content.

CONSTRUCTOR

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

  autoWidth  - makes the content box as wide as the content, as long as
               an id is set. Turns off resizing
  shadows    - enable shadow classes
  modal      - make the window a modal window
  closeModalOnClick 
             - makes the window close when the user clicks outside of it

METHODS

appendTitle (WIDGET)

Sets the title of the content box.

Parameters: WIDGET - the widget of type IWL::Widget(3pm) with which to fill the title

appendTitleText (TEXT)

Sets the title of the content box.

Parameters: TEXT - the text to be append as the title

appendHeader (WIDGET)

Sets the header of the content box.

Parameters: WIDGET - the widget of type IWL::Widget(3pm) with which to fill the header

appendHeaderText (TEXT)

Sets the header of the content box.

Parameters: TEXT - the text to be append as the header

appendContent (WIDGET)

Sets the content of the content box.

Parameters: WIDGET - the widget of type IWL::Widget(3pm) with which to fill the content

appendContentText (TEXT)

Sets the content of the content box.

Parameters: TEXT - the text to be append as the content

appendFooter (WIDGET)

Sets the footer of the content box.

Parameters: WIDGET - the widget of type IWL::Widget(3pm) with which to fill the footer

appendFooterText (TEXT)

Sets the footer of the content box.

Parameters: TEXT - the text to be append as the footer

setType (TYPE)

Sets the type of the content box

Parameters: TYPE - the type of the content box : none - default, no type : drag - draggable : resize - resizable : dialog - draggable & resizable : window - dialog + close button : noresize - window without resizing

setHeaderColorType (INDEX)

Sets the color type of the header to a predefined value.

Parameters: INDEX - the index of the color type, which is defined in the stylesheets

setFooterColorType (INDEX)

Sets the color type of the footer to a predefined value.

Parameters: INDEX - the index of the color type, which is defined in the stylesheets

setShadows (BOOL)

Enables shadows under the contentbox. Effectively, only changes the class of the contentbox, so it is wise to not change the class if you are going to use this.

Parameters: BOOL - boolean value, true if the contentbox should have shadows

setAutoWidth (BOOL)

Sets whether the contentbox will try to fit itself to the size of it's content

Parameters: BOOL - true if the contentbox should try to set it's width according to it's content

setTitleImage (IMAGE)

Sets the image located in the title block of the contentbox

Parameters: IMAGE - an IWL::Image(3) image widget

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.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 495:

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