wGui::CGroupBox Class Reference

A GroupBox is really just a fancier label that includes a box. More...

#include <wg_groupbox.h>

Inheritance diagram for wGui::CGroupBox:

Public Member Functions

• CGroupBox (const CRect &WindowRect, CWindow *pParent, std::wstring sText=L"", CRGBColor &FontColor=DEFAULT_LINE_COLOR, CFontEngine *pFontEngine=0)
• virtual ~CGroupBox (void)

  Standard destructor.
  

• void SetFontColor (CRGBColor &FontColor)
• CRGBColor GetFontColor (void)
• virtual void Draw (void) const

  Renders the Window Text, and clips to the Window Rect.
  

• virtual void SetWindowText (const std::wstring &sWindowText)
• virtual void SetWindowRect (const CRect &WindowRect)

Protected Attributes

• CFontEngine * m_pFontEngine

  A pointer to the font engine to use to render the text.
  

• std::auto_ptr< CRenderedString > m_pRenderedString

  An autopointer to the rendered version of the string.
  

• CRGBColor m_FontColor

  The font color.
  

---

Detailed Description

A GroupBox is really just a fancier label that includes a box.

Definition at line 41 of file wg_groupbox.h.

---

Constructor & Destructor Documentation

wGui::CGroupBox::CGroupBox	(	const CRect &	WindowRect,
		CWindow *	pParent,
		std::wstring	sText = L"",
		CRGBColor &	FontColor = DEFAULT_LINE_COLOR,
		CFontEngine *	pFontEngine = 0
	)

Construct a new group box

Parameters:

	WindowRect	A CRect that defines the outer limits of the control
	pParent	A pointer to the parent window
	sText	The label text (defaults to an empty string)
	FontColor	The color of the label text
	pFontEngine	A pointer to the font engine to use when drawing the control If this is left out (or set to 0) it will use the default font engine specified by the CApplication (which must be set before instantiating this object)

Definition at line 33 of file wg_groupbox.cpp.

References Draw(), wGui::CApplication::GetDefaultBackgroundColor(), wGui::CApplication::GetDefaultFontEngine(), wGui::CRect::Grow(), wGui::CRenderedString::HALIGN_LEFT, wGui::CApplication::Instance(), wGui::CWindow::m_BackgroundColor, wGui::CWindow::m_ClientRect, m_pFontEngine, m_pRenderedString, wGui::CWindow::m_sWindowText, wGui::CRect::SetTop(), and wGui::CRenderedString::VALIGN_TOP.

---

Member Function Documentation

void wGui::CGroupBox::SetFontColor

(

CRGBColor &

FontColor

)

[inline]

Sets the color of the font used to render the label

Parameters:

FontColor

The color of the label text

Definition at line 59 of file wg_groupbox.h.

References m_FontColor.

CRGBColor wGui::CGroupBox::GetFontColor

(

void

)

[inline]

Gets the font color for the label od the group box

Returns:

The color of the text in the label

Definition at line 63 of file wg_groupbox.h.

References m_FontColor.

void wGui::CGroupBox::SetWindowText

(

const std::wstring &

sWindowText

)

[virtual]

Set the WindowText of the label

Parameters:

sWindowText

The text to assign to the window

Reimplemented from wGui::CWindow.

Definition at line 84 of file wg_groupbox.cpp.

References wGui::CRenderedString::HALIGN_LEFT, m_pFontEngine, m_pRenderedString, wGui::CWindow::SetWindowText(), and wGui::CRenderedString::VALIGN_TOP.

void wGui::CGroupBox::SetWindowRect

(

const CRect &

WindowRect

)

[virtual]

Giving a control a new WindowRect will move and resize the control

Parameters:

WindowRect

A CRect that defines the outer limits of the control

Reimplemented from wGui::CWindow.

Definition at line 93 of file wg_groupbox.cpp.

References wGui::CRect::Grow(), wGui::CWindow::m_ClientRect, wGui::CWindow::m_WindowRect, wGui::CRect::SetTop(), wGui::CWindow::SetWindowRect(), and wGui::CRect::SizeRect().

---

The documentation for this class was generated from the following files:

• wg_groupbox.h
• wg_groupbox.cpp

---