kmx > IUP-0.202 > IUP::Hbox

Download:
IUP-0.202.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

IUP::Hbox - [GUI element] container for composing elements horizontally

DESCRIPTION ^

Creates a void container for composing elements horizontally. It is a box that arranges the elements it contains from left to right.

It does not have a native representation.

default layout HOMOGENEOUS=YES EXPANDCHILDREN=YES

USAGE ^

CREATION - new() method

 #standard way
 my $hbox = IUP::Hbox->new( child=>[$elem1, $elem2], ANYATTRIBUTE=>'any value' );
 
 #or with just a single child
 my $hbox = IUP::Hbox->new( child=>$elem, ANYATTRIBUTE=>'any value' );
 
 #or with just 1 parameter (arrayref)
 my $hbox = IUP::Hbox->new( [$elem1, $elem2] );
 
 #or with just 1 parameter (reference to child elements)
 my $hbox = IUP::Hbox->new( $elem );

child: (named parameter) List of the references to elements (or just a single element) that will be placed in the box.

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:

ALIGNMENT

(non inheritable)

Aligns the elements vertically. Possible values: "ATOP", "ACENTER", "ABOTTOM". Default: "ATOP".

EXPAND

(non inheritable*)

The default value is "YES". See the documentation of the attribute for EXPAND inheritance.

EXPANDCHILDREN

(non inheritable)

Forces all children to expand vertically. Default: "NO". This has the same effect as setting EXPAND=VERTICAL on each child, but their horizontal expansion will be preserved.

EXPANDWEIGHT

(non inheritable, at children only)

If a child defines the expand weight, then it is used to multiply the free space used for expansion. (since iup-3.1)

FLOATING

(non inheritable, at children only)

If a child has FLOATING=YES then its size and position will be ignored by the layout processing. Default: "NO".

GAP, CGAP

Defines an horizontal space in pixels between the children, CGAP is in the same units of the SIZE attribute for the width. Default: "0". (CGAP since iup-3.0)

NGAP, NCGAP

(non inheritable)

Same as GAP but are non inheritable.

HOMOGENEOUS

(non inheritable)

Forces all children to get equal horizontal space. The natural size width will be based on the largest child. Default: "NO". Notice that this does not changes the children size, only the available space for each one of them to expand. (since 3.0)

MARGIN, CMARGIN

Defines a margin in pixels, CMARGIN is in the same units of the SIZE attribute. Its value has the format "widthxheight", where width and height are integer values corresponding to the horizontal and vertical margins, respectively. Default: "0x0" (no margin). (CMARGIN since iup-3.0)

NMARGIN, NCMARGIN

(non inheritable)

Same as MARGIN but are non inheritable.

NORMALIZESIZE

(non inheritable)

Normalizes all children natural size to be the biggest natural size among them. All natural width will be set to the biggest width, and all natural height will be set to the biggest height according to is value. Can be NO, HORIZONTAL, VERTICAL or BOTH. Default: "NO".

SIZE / RASTERSIZE (non inheritable)

Defines the width of the box. When consulted behaves as the standard SIZE/RASTERSIZE attributes. The standard format "wxh" can also be used, but height will be ignored (since iup-3.3).

WID

(read-only)

Returns -1 if mapped.

The following common attributes are also accepted:

NOTES ^

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

The box will NOT expand its children, it will allow its children to expand according to the space left in the box parent. So for the expansion to occur, the children must be expandable with EXPAND!=NO, and there must be room in the box parent.

EXAMPLES ^

The element IUP::Hbox is used in the following sample scripts:

SEE ALSO ^

IUP::Zbox, IUP::Vbox

The original doc: iuphbox.html

syntax highlighting: