Creates a void container for composing elements vertically. It is a box that arranges the elements it contains from top to bottom.

It does not have a native representation.


Ihandle* IupVbox(Ihandle *child, ...); [in C]
Ihandle* IupVboxV(Ihandle* child, va_list arglist); [in C]
Ihandle* IupVboxv(Ihandle **children); [in C]
iup.vbox{child, ...: ihandle} -> (ih: ihandle) [in Lua]
vbox(child, ...) [in LED]

child, ... : List of the identifiers that will be placed in the box. NULL must be used to define the end of the list in C. It can be empty, but in C must have at least the NULL terminator..

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


ALIGNMENT (non inheritable): Horizontally aligns the elements. Possible values: "ALEFT", "ACENTER", "ARIGHT". Default: "ALEFT".

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 horizontally and to fully occupy its space available inside the box. Default: "NO". This has the same effect as setting EXPAND=HORIZONTAL on each child. (since 3.0)

GAP, CGAP: Defines a vertical space in pixels between the children, CGAP is in the same units of the SIZE attribute for the height. Default: "0". (CGAP since 3.0)

NGAP, NCGAP (non inheritable): Same as GAP but are non inheritable. (since 3.0)

HOMOGENEOUS (non inheritable): forces all children to get equal vertical space. The space height will be  based on the highest 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 3.0)

NMARGIN, NCMARGIN (non inheritable): Same as MARGIN but are non inheritable. (since 3.0)

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". Same as using IupNormalizer. (since 3.0)

ORIENTATION (read-only) (non inheritable): Returns "VERTICAL". (since 3.28)

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

WID (read-only): returns -1 if mapped.


Attributes (at Children)

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 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". (since 3.0)


The box can be created with no elements and be dynamic filled using IupAppend or IupInsert.

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.

Also the vbox will not reduce its children beyond their vertical natural size even if SHRINK=Yes at the dialog.


Browse for Example Files


See Also

IupZbox, IupHbox