SkyGI::StringView Class Reference

Inheritance diagram for SkyGI::StringView:[legend]Collaboration diagram for SkyGI::StringView:[legend]List of all members.

Public Member Functions
	StringView (Window *pParent, const Rect rFrame, const String &pLabel, unsigned int nWindowLayoutFlags, int iCommandID=-1)
	StringView (Window *pParent, const Point pPos, const String &pLabel, unsigned int nWindowLayoutFlags, int iCommandID=-1)
void	Paint (const Rect &rDirty)
String	GetString ()
void	SetString (const String &cString)
void	SetTextFlags (TextFlags nTextFlags)
TextFlags	GetTextFlags ()
Point	GetSizeHint (enumSizeHint nSizeHint)
void	ShowFrame (bool bShowFrame)
void	SetImage (Image *pImage)
void	SetImageSpacing (int iSpacing)
int	GetImageSpacing ()
void	SetTextColor (Color col)
Color	GetTextColor ()

---

Detailed Description

Examples:

clipboard.cpp, dnd.cpp, eventthread.cpp, listview.cpp, progressbar.cpp, textview.cpp, and thread.cpp.

---

Constructor & Destructor Documentation

StringView::StringView	(	Window *	pParent,
		const Rect	rFrame,
		const String &	pLabel,
		unsigned int	nWindowLayoutFlags,
		int	iCommandID = -1
	)

StringView::StringView	(	Window *	pParent,
		const Point	pPos,
		const String &	pLabel,
		unsigned int	nWindowLayoutFlags,
		int	iCommandID = -1
	)

---

Member Function Documentation

void StringView::Paint

(

const Rect &

rDirty

)

[virtual]

Paint window content

Description:

This function gets called whenever an area of the window has to be redrawn. Usually you should only draw from inside the Paint function. If you need to redraw a window (when lets say some content must be updated), simply call Invalidate() which will then (asynchronly) call this paint function.

Usually you should draw the background using Window::DrawBackground(rDirty) and the border with DrawBorder(rRect). This way the user has full control over the appearance of your window, meaning he can change the background and border style.
The window content area itself is defined by the border margin and the window margin. Every window may define a margin. If you draw content into this window always make sure to not draw into the margin area. Additionally, the border has a margin too. As the user has full control to select any border for your window make sure to user the current borders margin when drawing window content. the dra Window::Paint() just redraws the background using DrawBackground. Overload this member function to add custom dawing code

Overload this member function to add custom dawing code

Parameters:

rDirty

- Dirty rectangular region which has to be redrawn. Prior entering this function the painters clip region is automatically set to this dirty region.

See also:

DrawBorder, DrawBackground, Border, GetBorder, GetBorder::Margin, GetMargin

Reimplemented from SkyGI::Window.

String StringView::GetString

(

)

void StringView::SetString

(

const String &

cString

)

void StringView::SetTextFlags

(

TextFlags

nTextFlags

)

TextFlags StringView::GetTextFlags

(

)

Point StringView::GetSizeHint

(

enumSizeHint

nSizeHint

)

[virtual]

Get size hint

Description:

Overload this member function for derived classes to inform the GUI about size hints for your widget.

SIZE_HINT_PREFERRED

Return the preferred size of the widget (may depend on the actual content)

SIZE_HINT_MINIMUM

Return the minimum size the widget needs to display a proper content

Note:

If you want to get the minimum or preferred size of a window always use GetMinimumSize or GetPreferredSize. Don't call GetSizeHint directly

See also:

GetPreferredSize, GetMinimumSize, SetMinimumSize

Reimplemented from SkyGI::Window.

void StringView::ShowFrame

(

bool

bShowFrame

)

void StringView::SetImage

(

Image *

pImage

)

void StringView::SetImageSpacing

(

int

iSpacing

)

int StringView::GetImageSpacing

(

)

void StringView::SetTextColor

(

Color

col

)

Color StringView::GetTextColor

(

)

---