DzDockWindow Class Reference
[Interface Components]

Base class of windows that can be docked in a DzDockArea. More...

Inheritance diagram for DzDockWindow:

List of all members.

Methods
void	dock (DzDockArea area, Integer columnNum)
void	dock (DzDockArea area, Boolean newColumn=false)
void	dock ()
DzDockArea	getArea ()
Number	getLength ()
Number	getMinimumLength ()
Boolean	isDocked ()
Boolean	isLengthFixed ()
Boolean	isMinimized ()
void	minimize ()
void	restore ()
void	setLength (Number length)
void	toggleDock ()
void	toggleMinimized ()
void	undock ()
Signals
void	docked ()
	Signature: "docked()"
void	lengthChanged ()
	Signature: "lengthChanged()"
void	minimized (DzDockWindow window)
	Signature: "minimized(DzDockWindow*)"
void	restored (DzDockWindow window)
	Signature: "restored(DzDockWindow*)"
void	undocked ()
	Signature: "undocked()"

---

Detailed Description

Base class of windows that can be docked in a DzDockArea.

---

Member Function Documentation

void DzDockWindow::dock	(	DzDockArea	area,
		Integer	columnNum
	)

Docks this window in the given area in the given column number.

void DzDockWindow::dock	(	DzDockArea	area,
		Boolean	newColumn = false
	)

Docks this window in the given area.

void DzDockWindow::dock

(

)

Re-Docks this window in the last area it was docked in.

void DzDockWindow::docked

(

)

[signal]

Signature: "docked()"

Emitted when this window is docked.

DzDockArea DzDockWindow::getArea

(

)

Returns:

The area that the window is currently docked in, or the last area it was docked in if it is undocked.

Number DzDockWindow::getLength

(

)

Returns:

The actual length for this window while docked.

Number DzDockWindow::getMinimumLength

(

)

Returns:

The minimum length for this window (if it is not minimized) while docked.

Boolean DzDockWindow::isDocked

(

)

Returns:

true if the this window is currently docked.

Boolean DzDockWindow::isLengthFixed

(

)

Returns:

true if the value returned by length() is the only valid length for this window currently.

Boolean DzDockWindow::isMinimized

(

)

Returns:

true if the this window is currently minimized.

void DzDockWindow::lengthChanged

(

)

[signal]

Signature: "lengthChanged()"

Emitted when the value returned by length() has changed.

void DzDockWindow::minimize

(

)

Sets this window to a minimized state.

DzDockWindow::minimized

(

DzDockWindow

window

)

[signal]

Signature: "minimized(DzDockWindow*)"

Emitted when this window becomes minimized.

Parameters:

window

A pointer to this window.

void DzDockWindow::restore

(

)

Returns this window to its former length if it is minimized.

DzDockWindow::restored

(

DzDockWindow

window

)

[signal]

Signature: "restored(DzDockWindow*)"

Emitted when this window is restored.

Parameters:

window

A pointer to this window

void DzDockWindow::setLength

(

Number

length

)

Sets the preferred length for this window while docked.

Parameters:

The

new preferred length for the window.

void DzDockWindow::toggleDock

(

)

Toggles this window between its docked and undocked state. Calls dock() if this window is undocked, or undock() if it is docked.

void DzDockWindow::toggleMinimized

(

)

Toggles this window between the minimized and restored state.

void DzDockWindow::undock

(

)

Undocks this window.

void DzDockWindow::undocked

(

)

[signal]

Signature: "undocked()"

Emitted when this window is undocked.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.