os::LayoutView Class Reference
[The Syllable Graphical User Interface API]

Main class in the Syllable dynamic layout system. More...

Inheritance diagram for os::LayoutView:

List of all members.

Public Member Functions
	LayoutView (const Rect &cFrame, const String &cTitle, LayoutNode *pcRoot=NULL, uint32 nResizeMask=CF_FOLLOW_ALL, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND)
virtual	~LayoutView ()
LayoutNode *	GetRoot () const
	Get root layout.
void	SetRoot (LayoutNode *pcRoot)
	Set root layout.
LayoutNode *	FindNode (const String &cName, bool bRecursive=true)
	Find node by name.
void	InvalidateLayout ()
	Recalculate layout.
virtual Point	GetPreferredSize (bool bLargest) const
virtual void	AllAttached ()
virtual void	FrameSized (const Point &cDelta)
	Virtual hook called by the system when the view is resized.
Classes
class	Private

---

Detailed Description

Description:

This is the main layout class, to which a tree of LayoutNodes are added, using SetRoot(). The LayoutView itself is added to a Window, or another View, and will display its contents in that Window or View.

See also:

Author:

Kurt Skauen ([email protected])

---

Constructor & Destructor Documentation

LayoutView::LayoutView	(	const Rect &	cFrame,
		const String &	cTitle,
		LayoutNode *	pcRoot = NULL,
		uint32	nResizeMask = CF_FOLLOW_ALL,
		uint32	nFlags = WID_WILL_DRAW|WID_CLEAR_BACKGROUND
	)

LayoutView::~LayoutView

(

)

[virtual]

---

Member Function Documentation

LayoutNode * LayoutView::GetRoot

(

)

const

Description:

Get the root layout object.

See also:

SetRoot()

Author:

Kurt Skauen

void LayoutView::SetRoot

(

LayoutNode *

pcRoot

)

Description:

Set the root layout object.

Parameters:

pcRoot

Pointer to root layout node.

See also:

GetRoot()

Author:

Kurt Skauen

LayoutNode * LayoutView::FindNode	(	const String &	cName,
		bool	bRecursive = true
	)

Description:

Find a layout node (in the hierarchy specifided with SetRoot) by its name.

Parameters:

	cName	The name of the searched node.
	cRecursive	Set to true if you want to look at the root node's subnodes.

See also:

SetRoot()

Author:

Kurt Skauen

void LayoutView::InvalidateLayout

(

)

Description:

Causes the layout to be re-calculated.

Author:

Kurt Skauen

Point LayoutView::GetPreferredSize

(

bool

bLargest

)

const [virtual]

Reimplemented from os::View.

Reimplemented in os::FrameView.

void LayoutView::AllAttached

(

)

[virtual]

Reimplemented from os::View.

void LayoutView::FrameSized

(

const Point &

cDelta

)

[virtual]

Description:

Overload this member if you need to know when the view is resized.

Note:

This member is called after the view is resized. If you need the old size you can subtract the cDelta calue from the current size.

Parameters:

cDelta

The distance the bottom/right corner was moved relative to the upper/left corner.

See also:

FrameMoved(), SetFrame, ResizeBy(), ResizeTo()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

Reimplemented in os::FrameView.

---