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

Description:

Display a non-editable text string (text label)-

More...

Inheritance diagram for os::StringView:

List of all members.

Public Member Functions
	StringView (Rect cFrame, const String &cName, const String &cString, uint32 nAlign=DTF_DEFAULT, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_FULL_UPDATE_ON_RESIZE)
	Create a new StringView.
	StringView (Rect cFrame, const String &cName, const String &cString, alignment eAlign, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_FULL_UPDATE_ON_RESIZE)
	Create a new StringView (deprecated).
	~StringView ()
void	SetMinPreferredSize (int nWidthChars, int nHeightChars=1)
void	SetMaxPreferredSize (int nWidthChars, int nHeightChars=1)
virtual Point	GetPreferredSize (bool bLargest) const
virtual void	Paint (const Rect &cUpdateRect)
	Called by the system update "damaged" areas of the view.
void	SetString (const String &cString)
const String &	GetString (void) const
void	SetAlignment (uint32 nAlign)
uint32	GetAlignment (void) const
bool	HasBorder () const
void	SetRenderBorder (bool bRender)
virtual void	AttachedToWindow ()
Classes
class	Private

---

Detailed Description

See also:

TextView

Author:

Kurt Skauen ([email protected])

---

Constructor & Destructor Documentation

StringView::StringView	(	Rect	cFrame,
		const String &	cName,
		const String &	cString,
		uint32	nAlign = DTF_DEFAULT,
		uint32	nResizeMask = CF_FOLLOW_LEFT | CF_FOLLOW_TOP,
		uint32	nFlags = WID_WILL_DRAW | WID_FULL_UPDATE_ON_RESIZE
	)

Description:

Parameters:

	cFrame,cName,nResizeMask,nFlags	See os::View::View( const Rect &cFrame, const String &cTitle, uint32 nResizeMask, uint32 nFlags )
	cString	The text to be displayed in the StringView.
	nAlign	A bitmask of os::drawtext_flags specifying the alignment of the text within the view.

See also:

os::View::View( const Rect &cFrame, const String &cTitle, uint32 nResizeMask, uint32 nFlags ), os::drawtext_flags

StringView::StringView	(	Rect	cFrame,
		const String &	cName,
		const String &	cString,
		alignment	eAlign,
		uint32	nResizeMask = CF_FOLLOW_LEFT | CF_FOLLOW_TOP,
		uint32	nFlags = WID_WILL_DRAW | WID_FULL_UPDATE_ON_RESIZE
	)

Description:

See StringView( Rect cFrame, const String& cName, const String& cString, uint32 nAlign, uint32 nResizeMask, uint32 nFlags ). This constructor accepts a single alignment value from os::alignment, rather than a bitmask from os::drawtext_flags. Thus it does not provide as flexible alignment as the previous constructor; for instance, it is impossible to specify both horizontal and vertical alignment with this constructor. It is deprecated and provided only for compatibility

Parameters:

eAlign

A value from os::alignment specifying the alignment.

Note:

This constructor is deprecated and may be removed in future Syllable releases. The previous constructor should be used instead.

See also:

os::StringView::StringView( const Rect &cFrame, const String &cTitle, const String& cString, uint32 nAlign, uint32 nResizeMask, uint32 nFlags ), os::alignment, os::drawtext_flags

StringView::~StringView

(

)

---

Member Function Documentation

void StringView::SetMinPreferredSize	(	int	nWidthChars,
		int	nHeightChars = 1
	)

void StringView::SetMaxPreferredSize	(	int	nWidthChars,
		int	nHeightChars = 1
	)

Point StringView::GetPreferredSize

(

bool

bLargest

)

const [virtual]

Reimplemented from os::View.

void StringView::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.

void StringView::SetString

(

const String &

cString

)

const String & StringView::GetString

(

void

)

const

void StringView::SetAlignment

(

uint32

nAlign

)

uint32 StringView::GetAlignment

(

void

)

const

bool StringView::HasBorder

(

)

const

void StringView::SetRenderBorder

(

bool

bRender

)

void StringView::AttachedToWindow

(

)

[virtual]

Reimplemented from os::View.

---