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

Description:

A view with a border surrounding it, and an optional title.

More...

Inheritance diagram for os::FrameView:

List of all members.

Public Member Functions
	FrameView (const Rect &cFrame, const String &cName, const String &cLabel, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND)
	FrameView constructor.
void	SetLabel (const String &cLabel)
View *	SetLabel (View *pcLabel, bool bResizeToPreferred=true)
String	GetLabelString () const
View *	GetLabelView () const
virtual void	AttachedToWindow ()
virtual void	FrameSized (const Point &cDelta)
	Virtual hook called by the system when the view is resized.
virtual void	FontChanged (Font *pcNewFont)
	Called to notify the view that the font has changed.
virtual void	Paint (const Rect &cUpdateRect)
	Called by the system update "damaged" areas of the view.
virtual Point	GetPreferredSize (bool bLargest) const

---

Detailed Description

Use this when grouping items that belong together.

See also:

Author:

Kurt Skauen ([email protected])

---

Constructor & Destructor Documentation

FrameView::FrameView	(	const Rect &	cFrame,
		const String &	cName,
		const String &	cLabel,
		uint32	nResizeMask = CF_FOLLOW_LEFT | CF_FOLLOW_TOP,
		uint32	nFlags = WID_WILL_DRAW | WID_CLEAR_BACKGROUND
	)

Description:

Note:

Warning:

Parameters:

\return

See also:

Author:

Kurt Skauen ([email protected])

---

Member Function Documentation

void FrameView::SetLabel

(

const String &

cLabel

)

View * FrameView::SetLabel	(	View *	pcLabel,
		bool	bResizeToPreferred = true
	)

String FrameView::GetLabelString

(

)

const

View * FrameView::GetLabelView

(

)

const

void FrameView::AttachedToWindow

(

)

[virtual]

Reimplemented from os::View.

void FrameView::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::LayoutView.

void FrameView::FontChanged

(

Font *

pcNewFont

)

[virtual]

Description:

FontChanged() is a virtual hook function that can be overloaded by inheriting classes to track changes to the view's font.

This hook function is called whenver the font is replaced through the View::SetFont() member or if the currently assigned font is modified in a way that whould alter the graphical appearance of the font.

Note:

View::SetFont() will call FontChanged() syncronously and will cause FontChanged() to be called even if the view is not yet added to a window. Changes done to the font-object cause a message to be sendt to the window thread and FontChanged() will then be called asyncronously from the window thread when the message arrive. For this reason it is only possible to track changes done to the font object itself when the view is added to a window.

Parameters:

pcNewFont

Pointer to the affected font (same as returned by GetFont()).

See also:

SetFont(), os::Font

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void FrameView::Paint

(

const Rect &

cUpdateRect

)

[virtual]

Description:

Note:

Warning:

Parameters:

cUpdateRect

A rectangle enclosing all damaged areas. This is just a rough "worst-case", further fine-grained clipping will be performed by the Application Server to avoid updating non-damaged pixels and make the update as fast and flicker-free as possible.

See also:

Invalidate(), Flush()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

Point FrameView::GetPreferredSize

(

bool

bLargest

)

const [virtual]

Reimplemented from os::LayoutView.

---