User Tools

Site Tools


DzDockWindow

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

More...

Inherited By : DzPaneGroup

Methods

Signals

voiddocked ()
voidlengthChanged ()
voidminimized ( DzDockWindow window )
voidoutlineDrawFinished ()
voidoutlineDrawStarting ()
voidrestored ( DzDockWindow window )
voidundocked ()

Detailed Description

TODO: Add detailed description.

Methods


void : dock()

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


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

Docks this window in the given area.


void : dock( DzDockArea area, Number columnNum )

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


DzDockArea : getArea()

Return Value:

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

Number : getColumnDimension()

Return Value:

  • The last width (or height) of the column (or row) that the window is docked in.

Number : getColumnNum()

Return Value:

  • The column of the dock area that this window was last docked in.

Size : getLastSize()

Return Value:

  • The last undocked size of this window (if any).

Number : getLength()

Return Value:

  • The actual length for this window while docked.

Number : getMinimumLength()

Return Value:

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

Number : getPreferredLength()

Return Value:

  • The preferred length for this window while docked.

Boolean : isDocked()

Return Value:

  • true if the this window is currently docked, otherwise false.

Boolean : isLengthFixed()

Return Value:

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

Boolean : isMinimized()

Return Value:

  • true if the this window is currently minimized, otherwise false.

void : minimize()

Sets this window to a minimized state.


void : restore()

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


void : setColumnDimension( Number dimension )

Store the width (or height) of the column (or row) that the window is docked in.

Parameter(s):

  • dimension - The width (or height) to set.

void : setColumnNum( Number columnNum )

Sets the column of the dock area that this window was last docked in.

Parameter(s):

  • columnNum - The column number to set.

void : setLength( Number length )

Sets the length for this window while docked.

Parameter(s):

  • length - The new length for the window.

void : setPreferredLength( Number length )

Sets the preferred length for this window while docked.

Parameter(s):

  • length - The new preferred length for the window.

void : setResizeHandlesVisible( Boolean yesNo )

Sets the visibility of the resizing handles.


void : setTitleBarVisible( Boolean yesNo )

Sets the visibility of the title bar.


void : toggleDock()

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


void : toggleMinimized()

Toggles this window between the minimized and restored state.


void : undock()

Undocks this window.

Signals


void : docked()

Signature:“docked()”

Emitted when this window is docked.


void : lengthChanged()

Signature:“lengthChanged()”

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


void : minimized( DzDockWindow window )

Signature:“minimized(DzDockWindow*)”

Emitted when this window becomes minimized.

Parameter(s):

  • window - This window.

void : outlineDrawFinished()

TODO: Add description.


void : outlineDrawStarting()

TODO: Add description.


void : restored( DzDockWindow window )

Signature:“restored(DzDockWindow*)”

Emitted when this window is restored.

Parameter(s):

  • window - This window.

void : undocked()

Signature:“undocked()”

Emitted when this window is undocked.