os::LayoutNode Class Reference

Layout node. More...

Inheritance diagram for os::LayoutNode:

Classes
class	Private

Public Member Functions
	LayoutNode (const String &cName, float vWeight=1.0f, LayoutNode *pcParent=NULL, View *pcView=NULL)
virtual	~LayoutNode ()
virtual void	SetView (View *pcView)
View *	GetView () const
virtual void	Layout ()
virtual void	SetBorders (const Rect &cBorder)
virtual Rect	GetBorders () const
void	ExtendMinSize (const Point &cMinSize)
void	LimitMaxSize (const Point &cMaxSize)
void	ExtendMaxSize (const Point &cMaxSize)
float	GetWeight () const
void	SetWeight (float vWeight)
virtual void	SetFrame (const Rect &cFrame)
virtual Rect	GetFrame () const
virtual Rect	GetBounds () const
Rect	GetAbsFrame () const
void	SetHAlignment (alignment eAlignment)
void	SetVAlignment (alignment eAlignment)
alignment	GetHAlignment () const
alignment	GetVAlignment () const
void	AdjustPrefSize (Point *pcMinSize, Point *pcMaxSize)
virtual Point	GetPreferredSize (bool bLargest)
void	AddChild (LayoutNode *pcChild)
LayoutNode *	AddChild (View *pcChild, float vWeight=1.0f)
void	RemoveChild (LayoutNode *pcChild)
void	RemoveChild (View *pcChild)
String	GetName () const
const std::vector< LayoutNode * > &	GetChildList () const
LayoutNode *	GetParent () const
LayoutView *	GetLayoutView () const
LayoutNode *	FindNode (const String &cName, bool bRecursive=true, bool bIncludeSelf=false)
void	SameWidth (const char *pzName1,...)
void	SameHeight (const char *pzName1,...)
void	SetBorders (const Rect &cBorders, const char *pzFirstName,...)
void	SetWeights (float vWeight, const char *pzFirstName,...)
void	SetHAlignments (alignment eAlign, const char *pzFirstName,...)
void	SetVAlignments (alignment eAlign, const char *pzFirstName,...)
void	AddToWidthRing (LayoutNode *pcRing)
void	AddToHeightRing (LayoutNode *pcRing)

Protected Member Functions
virtual Point	CalculatePreferredSize (bool bLargest)

Friends
class	LayoutView

Detailed Description

Description:

This class is a base class for those classes that arrange GUI items by a specific algorithm, such as horizontal layout or vertical layout. Unless you intend to create such an algorithm yourself, you will not use this class directly, but instead one of its subclasses (HLayoutNode or VLayoutNode).

Example:

HLayoutNode* pcRoot = HLayoutNode( "pcRoot" );

pcRoot->AddChild( new Button( Rect(), "Button1", "One", new Message( ID_ONE ) ), 2.0 );
pcRoot->AddChild( new HLayoutSpacer( "Spacer" ) );
pcRoot->AddChild( new Button( Rect(), "Button2", "Two", new Message( ID_TWO ) ), 1.0 );

LayoutView* pcLayoutView = new LayoutView( pcMyWindow->GetBounds(), "pcLayoutView" );
pcLayoutView->SetRoot( pcRoot );
pcMyWindow->AddChild( pcLayoutView );

This example will result in a layout like this:
[One][Two]
If the window is made larger, the weights and the spacer will cause the layout to look like this:
[ One ] [Two]
That is, "One" has twice the weight of the two others, thus it will get twice the amount of excess screen space.

See Also

VLayoutNode, HLayoutNode, LayoutSpacer, SameWidth, SameHeight

Author

Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Constructor & Destructor Documentation

LayoutNode::LayoutNode	(	const String &	cName,
		float	vWeight = 1.0f,
		LayoutNode *	pcParent = NULL,
		View *	pcView = NULL
	)

References AddChild(), os::LayoutNode::Private::m_cBorders, os::LayoutNode::Private::m_cMaxSizeExtend, os::LayoutNode::Private::m_cMaxSizeLimit, os::LayoutNode::Private::m_cMinSize, os::LayoutNode::Private::m_cName, ShareNode::m_pcNext, ShareNode::m_pcPrev, os::LayoutNode::Private::m_pcView, os::LayoutNode::Private::m_sHeightRing, os::LayoutNode::Private::m_sWidthRing, os::LayoutNode::Private::m_vWeight, and MAX_SIZE.

Referenced by AddChild().

LayoutNode::~LayoutNode ( )

virtual

References os::LayoutNode::Private::m_cChildList, os::LayoutNode::Private::m_pcParent, and RemoveChild().

Member Function Documentation

void LayoutNode::AddChild

(

LayoutNode *

pcChild

)

References os::String::c_str(), GetName(), and os::LayoutNode::Private::m_cChildList.

Referenced by os::ToolBar::AddChild(), os::StatusBar::AddPanel(), os::FileRequester::FileRequester(), HandlerSelector::HandlerSelector(), InfoWin::InfoWin(), os::InputBox::Private::Layout(), LayoutNode(), os::DateView::MonthView::MonthView(), MountDialogWin::MountDialogWin(), NewDirWin::NewDirWin(), RenameFileWin::RenameFileWin(), os::ToolBar::ToolBar(), and os::DateView::YearView::YearView().

LayoutNode * LayoutNode::AddChild	(	View *	pcChild,
		float	vWeight = 1.0f
	)

References os::Handler::GetName(), and LayoutNode().

void LayoutNode::AddToHeightRing

(

LayoutNode *

pcRing

)

References ShareNode::m_pcNext, ShareNode::m_pcPrev, and os::LayoutNode::Private::m_sHeightRing.

Referenced by SameHeight().

void LayoutNode::AddToWidthRing

(

LayoutNode *

pcRing

)

References ShareNode::m_pcNext, ShareNode::m_pcPrev, and os::LayoutNode::Private::m_sWidthRing.

Referenced by SameWidth().

void LayoutNode::AdjustPrefSize	(	Point *	pcMinSize,
		Point *	pcMaxSize
	)

References os::LayoutNode::Private::m_cMaxSizeExtend, os::LayoutNode::Private::m_cMaxSizeLimit, os::LayoutNode::Private::m_cMinSize, os::Point::x, and os::Point::y.

Point LayoutNode::CalculatePreferredSize ( bool  bLargest )

protectedvirtual

Reimplemented in os::VLayoutNode, and os::HLayoutNode.

References os::Rect::bottom, os::View::GetPreferredSize(), os::Rect::left, os::LayoutNode::Private::m_cBorders, os::LayoutNode::Private::m_pcView, os::Rect::right, os::Rect::top, os::Point::x, and os::Point::y.

Referenced by GetPreferredSize().

void LayoutNode::ExtendMaxSize

(

const Point &

cMaxSize

)

References os::LayoutNode::Private::m_cMaxSizeExtend.

Referenced by os::DateView::MonthView::MonthView(), and os::DateView::YearView::YearView().

void LayoutNode::ExtendMinSize

(

const Point &

cMinSize

)

References os::LayoutNode::Private::m_cMinSize.

Referenced by os::ToolBar::AddChild(), os::DateView::MonthView::MonthView(), and os::DateView::YearView::YearView().

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

References os::LayoutNode::Private::m_cChildList, and os::LayoutNode::Private::m_cName.

Referenced by os::LayoutView::FindNode(), SameHeight(), and SameWidth().

Rect LayoutNode::GetAbsFrame

(

)

const

References GetAbsFrame(), os::Rect::LeftTop(), os::LayoutNode::Private::m_cFrame, and os::LayoutNode::Private::m_pcParent.

Referenced by GetAbsFrame(), SetFrame(), and SetView().

Rect LayoutNode::GetBorders ( ) const

virtual

References os::LayoutNode::Private::m_cBorders.

Referenced by os::HLayoutNode::CalculatePreferredSize(), os::VLayoutNode::CalculatePreferredSize(), os::HLayoutNode::Layout(), and os::VLayoutNode::Layout().

Rect LayoutNode::GetBounds ( void  ) const

virtual

References GetFrame().

Referenced by os::HLayoutNode::Layout(), and os::VLayoutNode::Layout().

const std::vector< LayoutNode * > & LayoutNode::GetChildList

(

)

const

References os::LayoutNode::Private::m_cChildList.

Referenced by os::ToolBar::AddChild(), os::HLayoutNode::CalculatePreferredSize(), os::VLayoutNode::CalculatePreferredSize(), os::HLayoutNode::Layout(), and os::VLayoutNode::Layout().

Rect LayoutNode::GetFrame ( ) const

virtual

References os::LayoutNode::Private::m_cFrame.

Referenced by GetBounds().

alignment LayoutNode::GetHAlignment

(

)

const

References os::LayoutNode::Private::m_eHAlign.

Referenced by os::VLayoutNode::Layout().

LayoutView * LayoutNode::GetLayoutView

(

)

const

References os::LayoutNode::Private::m_pcLayoutView.

String LayoutNode::GetName

(

)

const

References os::LayoutNode::Private::m_cName.

Referenced by AddChild(), and os::VLayoutNode::Layout().

LayoutNode * LayoutNode::GetParent

(

)

const

References os::LayoutNode::Private::m_pcParent.

Point LayoutNode::GetPreferredSize ( bool  bLargest )

virtual

References CalculatePreferredSize(), ShareNode::m_pcNext, os::LayoutNode::Private::m_sHeightRing, os::LayoutNode::Private::m_sWidthRing, os::Point::x, and os::Point::y.

Referenced by os::LayoutView::GetPreferredSize(), os::DateView::MonthView::MonthView(), and os::DateView::YearView::YearView().

alignment LayoutNode::GetVAlignment

(

)

const

References os::LayoutNode::Private::m_eVAlign.

View * LayoutNode::GetView

(

)

const

References os::LayoutNode::Private::m_pcView.

Referenced by os::ToolBar::AddChild().

float LayoutNode::GetWeight

(

)

const

References os::LayoutNode::Private::m_vWeight.

Referenced by os::ToolBar::AddChild().

void LayoutNode::Layout ( )

virtual

Reimplemented in os::VLayoutNode, and os::HLayoutNode.

References os::Rect::bottom, os::Rect::left, os::LayoutNode::Private::m_cBorders, os::LayoutNode::Private::m_cChildList, os::LayoutNode::Private::m_cFrame, os::Rect::Resize(), os::Rect::right, and os::Rect::top.

Referenced by os::LayoutView::InvalidateLayout(), SetBorders(), SetFrame(), SetHAlignment(), and SetVAlignment().

void LayoutNode::LimitMaxSize

(

const Point &

cMaxSize

)

References os::LayoutNode::Private::m_cMaxSizeLimit.

Referenced by os::ToolBar::AddChild(), os::DateView::MonthView::MonthView(), and os::DateView::YearView::YearView().

void LayoutNode::RemoveChild

(

LayoutNode *

pcChild

)

References os::LayoutNode::Private::m_cChildList.

Referenced by os::ToolBar::AddChild(), and ~LayoutNode().

void LayoutNode::RemoveChild

(

View *

pcChild

)

References os::LayoutNode::Private::m_cChildList, and SetView().

void LayoutNode::SameHeight	(	const char *	pzName1,
			...
	)

References AddToHeightRing(), FindNode(), ShareNode::m_pcNext, ShareNode::m_pcPrev, and os::LayoutNode::Private::m_sHeightRing.

Referenced by MountDialogWin::MountDialogWin().

void LayoutNode::SameWidth	(	const char *	pzName1,
			...
	)

References AddToWidthRing(), FindNode(), ShareNode::m_pcNext, ShareNode::m_pcPrev, and os::LayoutNode::Private::m_sWidthRing.

Referenced by InfoWin::InfoWin(), and os::InputBox::Private::Layout().

void LayoutNode::SetBorders ( const Rect &  cBorder )

virtual

References Layout(), and os::LayoutNode::Private::m_cBorders.

Referenced by os::ToolBar::AddChild(), os::StatusBar::AddPanel(), os::FileRequester::FileRequester(), HandlerSelector::HandlerSelector(), InfoWin::InfoWin(), MountDialogWin::MountDialogWin(), NewDirWin::NewDirWin(), RenameFileWin::RenameFileWin(), and SetBorders().

void LayoutNode::SetBorders	(	const Rect &	cBorders,
		const char *	pzFirstName,
			...
	)

References FOR_EACH_NAME, and SetBorders().

void LayoutNode::SetFrame ( const Rect &  cFrame )

virtual

References os::Rect::bottom, os::Rect::Floor(), GetAbsFrame(), Layout(), os::Rect::left, os::LayoutNode::Private::m_cBorders, os::LayoutNode::Private::m_cFrame, os::LayoutNode::Private::m_pcView, os::Rect::Resize(), os::Rect::right, os::View::SetFrame(), and os::Rect::top.

Referenced by os::FrameView::FrameSized(), and os::LayoutView::FrameSized().

void LayoutNode::SetHAlignment

(

alignment

eAlignment

)

References Layout(), and os::LayoutNode::Private::m_eHAlign.

Referenced by os::InputBox::Private::Layout(), and SetHAlignments().

void LayoutNode::SetHAlignments	(	alignment	eAlign,
		const char *	pzFirstName,
			...
	)

References FOR_EACH_NAME, and SetHAlignment().

void LayoutNode::SetVAlignment

(

alignment

eAlignment

)

References Layout(), and os::LayoutNode::Private::m_eVAlign.

Referenced by os::InputBox::Private::Layout(), and SetVAlignments().

void LayoutNode::SetVAlignments	(	alignment	eAlign,
		const char *	pzFirstName,
			...
	)

References FOR_EACH_NAME, and SetVAlignment().

void LayoutNode::SetView ( View *  pcView )

virtual

References os::View::AddChild(), GetAbsFrame(), os::LayoutNode::Private::m_pcLayoutView, os::LayoutNode::Private::m_pcView, os::View::RemoveChild(), and os::View::SetFrame().

Referenced by RemoveChild().

void LayoutNode::SetWeight

(

float

vWeight

)

References os::LayoutNode::Private::m_vWeight.

Referenced by SetWeights().

void LayoutNode::SetWeights	(	float	vWeight,
		const char *	pzFirstName,
			...
	)

References FOR_EACH_NAME, and SetWeight().

Friends And Related Function Documentation

friend class LayoutView

friend