kmx > IUP > IUP::ScrollBox

Download:
IUP-0.202.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source   Latest Release: IUP-0.202_1

NAME ^

IUP::ScrollBox - [GUI element] container that allows its child to be scrolled

DESCRIPTION ^

Creates a native container that allows its child to be scrolled. It inherits from IUP::Canvas.

USAGE ^

CREATION - new() method

 #standard way
 $mlist = IUP::ScrollBox->new( child=>$child, ANYATTRIBUTE=>'any value' );
 #or with just 1 parameter
 $mlist = IUP::ScrollBox->new($child);

child: (named parameter) reference to an interface element.

Returns: the identifier of the created element, or undef if an error occurs.

NOTE: You can pass to new() other ATTRIBUTE=>'value' or CALLBACKNAME=>\&func pairs relevant to this element - see IUP::Manual::02_Elements.

ATTRIBUTES

For more info about concept of attributes (setting/getting values etc.) see IUP::Manual::03_Attributes. Attributes specific to this element:

Inherits all attributes and callbacks of the IUP::Canvas, but redefines a few attributes.

BGCOLOR

will use the background color of the native parent by default.

BORDER

(creation only) the default value is "NO".

EXPAND

(non inheritable) the default value is "YES".

SCROLLBAR

(creation only) the default value is "YES".

CLIENTSIZE, CLIENTOFFSET also accepted.

NOTES ^

The box allows the application to create a virtual space for the dialog that is actually larger than the visible area. The current size of the box defines the visible area. The natural size of the child (and its children) defines the virtual space size. So the IUP::ScrollBox does not depend on its child size or expansion, and its natural size is always "0x0".

The user can move the box contents by dragging the background. Also the mouse wheel scrolls the contents vertically.

The box can be created with no elements and be dynamic filled using Append or Insert.

EXAMPLES ^

Unfortunately there are no sample scripts using this element.

SEE ALSO ^

The original doc: iupscrollbox.html

syntax highlighting: