NAME

IWL::Contentbox - a content box

INHERITANCE

IWL::Error -> 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

If true, makes the content box as wide as the content. Defaults to false

positionAtCenter

If true, positions the contentbox at the center of the screen. Defaults to false

hasShadows

If true, enable shadow classes. Defaults to false

modal

If true, makes the window a modal window. Defaults to false

closeModalOnClick

If true, makes the window close when the user clicks outside of it. Defaults to false

SIGNALS

show

Fires when the contentbox has been shown

hide

Fires when the contentbox has been hidden

close

Fires when the contentbox has closed

METHODS

appendTitle (WIDGET)

Sets the title of the content box.

Parameters: WIDGET - the widget of type IWL::Widget 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 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 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 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, OPTIONS)

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

OPTIONS - a hash(ref) of options for use with the different types:

outline

If true, an outline of the contentbox will apear when it is dragged/resized.

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.