DzDockAreaColumn Class Reference
[Interface Components]

Widget that makes up a column in a DzDockArea. More...

List of all members.

Methods
Number	depth ()
Number	getNumWindows ()
Number	getPreferredDepth ()
DzDockWindow	getWindow (Number which)
Boolean	isMinimized ()
void	minimize ()
Number	minimumDepth ()
void	restore ()
void	setPreferredDepth (Number depth)
void	toggleMinimized ()

---

Detailed Description

Widget that makes up a column in a DzDockArea.

---

Member Function Documentation

Number DzDockAreaColumn::depth

(

)

Returns:

The current depth of the column. This is the same as width() for Right and Left dock areas, or height() for Top and Bottom dock areas.

Number DzDockAreaColumn::getNumWindows

(

)

Returns:

The number of windows docked in this column

Number DzDockAreaColumn::getPreferredDepth

(

)

Returns:

The preferred depth of the column.

DzDockWindow DzDockAreaColumn::getWindow

(

Number

which

)

Parameters:

which

The index of the window to return.

Returns:

The docked window at the given index

Boolean DzDockAreaColumn::isMinimized

(

)

Returns:

true if this column is currently minimized

void DzDockAreaColumn::minimize

(

)

Minimizes the column, if it is not already. The column shrinks so that only its resizing handle is visible.

Number DzDockAreaColumn::minimumDepth

(

)

Returns:

The minimum depth of the column.

void DzDockAreaColumn::restore

(

)

Restores the column to its previous depth if the column is currently minimized.

void DzDockAreaColumn::setPreferredDepth

(

Number

depth

)

Set the depth of the column.

Parameters:

depth

The new depth for the column. If depth is less the minimum depth, the column becomes the minimum depth.

void DzDockAreaColumn::toggleMinimized

(

)

Toggles whether this column is minimized - if minimized, the column restores itself, if full size the column becomes minimized.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.