GRadioButton Class Reference

#include <GRadioGroup.h>

Inheritance diagram for GRadioButton:

List of all members.

Public Member Functions
char *	GetClass ()
char *	Name ()
	Returns the utf-8 text associated with this view.
char16 *	NameW ()
	Returns the wide char text associated with this view.
bool	Name (char *n)
	Sets the utf-8 text associated with this view.
bool	NameW (char16 *n)
	Sets the wide char text associated with this view.
int64	Value ()
	Gets the integer representation of the view's contents.
void	Value (int64 i)
	Sets the integer representation of the view's contents.
void	SetFont (GFont *Fnt, bool OwnIt=false)
	Sets the font for this control.
void	OnMouseClick (GMouse &m)
	The mouse was clicked over this view.
void	OnMouseEnter (GMouse &m)
	Mouse moves into the area over the control.
void	OnMouseExit (GMouse &m)
	Mouse leaves the area over the control.
bool	OnKey (GKey &k)
	A key was pressed while this view has focus.
void	OnFocus (bool f)
	The view gains or loses the keyboard focus.
void	OnPaint (GSurface *pDC)
	Called to paint the onscreen representation of the view.
void	OnAttach ()
	Called after the view is attached to a new parent.
int	OnEvent (GMessage *m)
	Called to process every message received by this window.
Friends
class	GRadioGroup

---

Detailed Description

A radio button control. A radio button is used to select between mutually exclusive options. i.e. only one can be valid at any given time. For non-mutually exclusive options see the GCheckBox control.

---

Member Function Documentation

char* GRadioButton::GetClass

(

)

[inline]

The class' name. Should be overriden in child classes to return the right class name. Mostly used for debugging, but in the win32 port it is also the default WIN32 class name passed to RegisterClass() in GView::CreateClass().

Returns:

the Class' name for debugging

Reimplemented from GView.

bool GRadioButton::Name

(

char *

n

)

Sets the utf-8 text associated with this view.

Name and NameW are interchangable. Using them in any order will convert the text between utf-8 and wide to satify any requirement. Generally once the opposing version of the string is required both the utf-8 and wide copies of the string remain cached in RAM until the Name is changed.

Reimplemented from GView.

References GView::GetFont(), and Name().

char16* GRadioButton::NameW

(

)

[inline, virtual]

Returns the wide char text associated with this view.

On Win32 the wide characters are 16 bits, on unix systems they are 32-bit characters.

Reimplemented from GView.

References GView::NameW().

Referenced by NameW().

void GRadioButton::SetFont	(	GFont *	Fnt,
		bool	OwnIt = false
	)			[virtual]

Sets the font for this control.

The lifetime of the font passed in is the responsibility of the caller. The GView object assumes the pointer will be valid at all times.

Reimplemented from GView.

References GView::GetFont(), and GView::Invalidate().

---

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

• GRadioGroup.h
• common/Widgets/GRadioGroup.cpp
• win32/Widgets/GRadioGroup.cpp