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

Separator bar. More...

Inheritance diagram for os::Separator:

List of all members.

Public Member Functions
	Separator (Rect cFrame, const String &cName, orientation eOrientation=VERTICAL, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND|WID_FULL_UPDATE_ON_RESIZE)
	Constructor.
	~Separator ()
void	Paint (const Rect &cUpdateRect)
	View callback, Renders the Separator.
Point	GetPreferredSize (bool bLargest) const
	Returns size for automatic layout.
void	SetOrientation (orientation eOrientation)
orientation	GetOrientation () const
Classes
class	Private

---

Detailed Description

Description:

The Separator shows a vertical or horizontal bar that is used to separate widgets from each other. It is commonly used in tool bars, to group similar commands.

Author:

Henrik Isaksson ([email protected])

---

Constructor & Destructor Documentation

Separator::Separator	(	Rect	cFrame,
		const String &	cName,
		orientation	eOrientation = VERTICAL,
		uint32	nResizeMask = CF_FOLLOW_LEFT|CF_FOLLOW_TOP,
		uint32	nFlags = WID_WILL_DRAW|WID_CLEAR_BACKGROUND|WID_FULL_UPDATE_ON_RESIZE
	)

Description:

Parameters:

	cFrame	The frame rectangle in the parents coordinate system.
	pzName	The logical name of the view. This parameter is newer rendered anywhere, but is passed to the Handler::Handler() constructor to identify the view.
	eOrientation	VERTICAL or HORIZONTAL.
	nResizeMask	Flags defining how the views frame rectangle is affected if the parent view is resized.
	nFlags	Various flags to control the views behaviour.

Author:

Henrik Isaksson ([email protected])

Separator::~Separator

(

)

---

Member Function Documentation

void Separator::Paint

(

const Rect &

cUpdateRect

)

[virtual]

Description:

This method is called by the OS when the Separator needs to redraw itself.

Parameters:

cUpdateRect

The part of the Separator that needs refreshing.

See also:

os::Image, os::View

Author:

Henrik Isaksson ([email protected])

Reimplemented from os::View.

Point Separator::GetPreferredSize

(

bool

bLargest

)

const [virtual]

Description:

This method is used by LayoutNode classes to calculate the size of the object.

Parameters:

bLargest

Tells whether the smallest (normal) size is requested, or the largest possible size.

Return values:

Returns

(3, 3) if bLargest is false, otherwise it returns Point( COORD_MAX, COORD_MAX ).

See also:

os::View, os::LayoutNode, os::LayoutView

Author:

Henrik Isaksson ([email protected])

Reimplemented from os::View.

void Separator::SetOrientation

(

orientation

eOrientation

)

orientation Separator::GetOrientation

(

)

const

---