owl::TDockable Class Reference

TDockable is an abstract base class for fixed or floating docking windows that want to be dockable into docking slips. More...

#include <owl/docking.h>

Inheritance diagram for owl::TDockable:

Public Member Functions
virtual TSize	ComputeSize (TAbsLocation loc, TSize *dim)=0
	Returns the rectangle of the dockable window in the given location.
virtual void	GetRect (TRect &rect)=0
	Return the rectangle of the dockable window in the given location.
virtual void	Layout (TAbsLocation loc, TSize *dim=0)=0
	Changes the window to be equal to the size returned from ComputeNNNNN.
virtual bool	ShouldBeginDrag (TPoint &pt)=0
	This is overriden for any window that wants to be docked.
virtual TWindow *	GetWindow ()=0
	Gets dockable's window and hides it, in case we have to toss it around a bit.
virtual THarbor *	GetHarbor ()=0
	Returns the harbor containing the dockable object.

Detailed Description

TDockable is an abstract base class for fixed or floating docking windows that want to be dockable into docking slips.

Definition at line 57 of file docking.h.

Member Function Documentation

ComputeSize()

virtual TSize owl::TDockable::ComputeSize ( TAbsLocation loc, TSize * dim )

pure virtual

Returns the rectangle of the dockable window in the given location.

The dockable chooses its layout (horizontal, vertical or rectangle) in that position.

Implemented in owl::TDockableGadgetWindow, and owl::TFloatingSlip.

GetHarbor()

virtual THarbor * owl::TDockable::GetHarbor ( )

pure virtual

Returns the harbor containing the dockable object.

Implemented in owl::TDockableGadgetWindow, and owl::TFloatingSlip.

GetRect()

virtual void owl::TDockable::GetRect ( TRect & rect )

pure virtual

Return the rectangle of the dockable window in the given location.

The dockable chooses its layout (horizontal, vertical or rectangle) in that position.

Implemented in owl::TDockableGadgetWindow, and owl::TFloatingSlip.

GetWindow()

virtual TWindow * owl::TDockable::GetWindow ( )

pure virtual

Gets dockable's window and hides it, in case we have to toss it around a bit.

Implemented in owl::TDockableGadgetWindow, and owl::TFloatingSlip.

Layout()

virtual void owl::TDockable::Layout ( TAbsLocation loc, TSize * dim = 0 )

pure virtual

Changes the window to be equal to the size returned from ComputeNNNNN.

Implemented in owl::TDockableGadgetWindow, and owl::TFloatingSlip.

ShouldBeginDrag()

virtual bool owl::TDockable::ShouldBeginDrag ( TPoint & pt )

pure virtual

This is overriden for any window that wants to be docked.

This routine is called from an LButtonDown to determine if the mouse down should move the window or perform an action within the docked window. For example, if a gadget window is docked, this routine would decide if the mousedown is on an enabled gadget; if so, the control is not to be moved. Instead, the action of the gadget being depressed is performed. Otherwise, the gadget window is moved within the docking window.

Implemented in owl::TDockableGadgetWindow, and owl::TFloatingSlip.

---

The documentation for this class was generated from the following file:

• include/owl/docking.h