MMSCheckBoxWidget Class Reference

With this class you can display an on/off switch. More...

#include <mmscheckboxwidget.h>

Inheritance diagram for MMSCheckBoxWidget:


Public Member Functions
	MMSCheckBoxWidget (MMSWindow root, string className, MMSTheme theme=NULL)
	~MMSCheckBoxWidget ()
MMSWidget *	copyWidget ()
bool	getCheckedBgColor (MMSFBColor &checked_bgcolor)
bool	getCheckedSelBgColor (MMSFBColor &checked_selbgcolor)
bool	getCheckedBgColor_p (MMSFBColor &checked_bgcolor_p)
bool	getCheckedSelBgColor_p (MMSFBColor &checked_selbgcolor_p)
bool	getCheckedBgColor_i (MMSFBColor &checked_bgcolor_i)
bool	getCheckedSelBgColor_i (MMSFBColor &checked_selbgcolor_i)
bool	getCheckedBgImagePath (string &checked_bgimagepath)
bool	getCheckedBgImageName (string &checked_bgimagename)
bool	getCheckedSelBgImagePath (string &checked_selbgimagepath)
bool	getCheckedSelBgImageName (string &checked_selbgimagename)
bool	getCheckedBgImagePath_p (string &checked_bgimagepath_p)
bool	getCheckedBgImageName_p (string &checked_bgimagename_p)
bool	getCheckedSelBgImagePath_p (string &checked_selbgimagepath_p)
bool	getCheckedSelBgImageName_p (string &checked_selbgimagename_p)
bool	getCheckedBgImagePath_i (string &checked_bgimagepath_i)
bool	getCheckedBgImageName_i (string &checked_bgimagename_i)
bool	getCheckedSelBgImagePath_i (string &checked_selbgimagepath_i)
bool	getCheckedSelBgImageName_i (string &checked_selbgimagename_i)
bool	getChecked (bool &checked)
void	setCheckedBgColor (MMSFBColor checked_bgcolor, bool refresh=true)
void	setCheckedSelBgColor (MMSFBColor checked_selbgcolor, bool refresh=true)
void	setCheckedBgColor_p (MMSFBColor checked_bgcolor_p, bool refresh=true)
void	setCheckedSelBgColor_p (MMSFBColor checked_selbgcolor_p, bool refresh=true)
void	setCheckedBgColor_i (MMSFBColor checked_bgcolor_i, bool refresh=true)
void	setCheckedSelBgColor_i (MMSFBColor checked_selbgcolor_i, bool refresh=true)
void	setCheckedBgImagePath (string checked_bgimagepath, bool load=true, bool refresh=true)
void	setCheckedBgImageName (string checked_bgimagename, bool load=true, bool refresh=true)
void	setCheckedSelBgImagePath (string checked_selbgimagepath, bool load=true, bool refresh=true)
void	setCheckedSelBgImageName (string checked_selbgimagename, bool load=true, bool refresh=true)
void	setCheckedBgImagePath_p (string checked_bgimagepath_p, bool load=true, bool refresh=true)
void	setCheckedBgImageName_p (string checked_bgimagename_p, bool load=true, bool refresh=true)
void	setCheckedSelBgImagePath_p (string checked_selbgimagepath_p, bool load=true, bool refresh=true)
void	setCheckedSelBgImageName_p (string checked_selbgimagename_p, bool load=true, bool refresh=true)
void	setCheckedBgImagePath_i (string checked_bgimagepath_i, bool load=true, bool refresh=true)
void	setCheckedBgImageName_i (string checked_bgimagename_i, bool load=true, bool refresh=true)
void	setCheckedSelBgImagePath_i (string checked_selbgimagepath_i, bool load=true, bool refresh=true)
void	setCheckedSelBgImageName_i (string checked_selbgimagename_i, bool load=true, bool refresh=true)
void	setChecked (bool checked, bool refresh=true)
void	updateFromThemeClass (MMSCheckBoxWidgetClass *themeClass)
Private Member Functions
bool	create (MMSWindow root, string className, MMSTheme theme)
bool	init ()
bool	release ()
void	getCheckedBackground (MMSFBColor color, MMSFBSurface *image)
bool	enableRefresh (bool enable=true)
	Internal method: (re-)enable refresh status.
bool	checkRefreshStatus ()
	Internal method: check drawn background against new background and (re-)enable refresh status if needed.
bool	draw (bool *backgroundFilled=NULL)
void	handleInput (MMSInputEvent *inputevent)
Private Attributes
string	className
MMSCheckBoxWidgetClass *	checkBoxWidgetClass
MMSCheckBoxWidgetClass	myCheckBoxWidgetClass
MMSFBSurface *	checked_bgimage
MMSFBSurface *	checked_selbgimage
MMSFBSurface *	checked_bgimage_p
MMSFBSurface *	checked_selbgimage_p
MMSFBSurface *	checked_bgimage_i
MMSFBSurface *	checked_selbgimage_i
bool	current_checked_bgset
	current checked background values set?
MMSFBColor	current_checked_bgcolor
	current checked background color
MMSFBSurface *	current_checked_bgimage
	current checked background image

Detailed Description

With this class you can display an on/off switch.

The checkbox is focusable.

Author:: Jens Schneider

Definition at line 44 of file mmscheckboxwidget.h.

Constructor & Destructor Documentation

MMSCheckBoxWidget::MMSCheckBoxWidget	(	MMSWindow *	root,
		string	className,
		MMSTheme *	theme = `NULL`
	)

Definition at line 35 of file mmscheckboxwidget.cpp.

MMSCheckBoxWidget::~MMSCheckBoxWidget ( )

Definition at line 39 of file mmscheckboxwidget.cpp.

Member Function Documentation

bool MMSCheckBoxWidget::create	(	MMSWindow *	root,
		string	className,
		MMSTheme *	theme
	)			`[private]`

Definition at line 42 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::init ( ) [private, virtual]

Reimplemented from MMSWidget.

Definition at line 146 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::release ( ) [private, virtual]

Reimplemented from MMSWidget.

Definition at line 181 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::getCheckedBackground	(	MMSFBColor *	color,
		MMSFBSurface **	image
	)			`[private]`

Definition at line 203 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::enableRefresh ( bool enable = true ) [private, virtual]

Internal method: (re-)enable refresh status.

Reimplemented from MMSWidget.

Definition at line 244 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::checkRefreshStatus ( ) [private, virtual]

Internal method: check drawn background against new background and (re-)enable refresh status if needed.

Reimplemented from MMSWidget.

Definition at line 253 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::draw ( bool * backgroundFilled = NULL ) [private, virtual]

Reimplemented from MMSWidget.

Definition at line 286 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::handleInput ( MMSInputEvent * inputevent ) [private, virtual]

Reimplemented from MMSWidget.

Definition at line 66 of file mmscheckboxwidget.cpp.

MMSWidget * MMSCheckBoxWidget::copyWidget ( ) [virtual]

Implements MMSWidget.

Definition at line 92 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgColor ( MMSFBColor & checked_bgcolor )

Definition at line 500 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgColor ( MMSFBColor & checked_selbgcolor )

Definition at line 504 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgColor_p ( MMSFBColor & checked_bgcolor_p )

Definition at line 508 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgColor_p ( MMSFBColor & checked_selbgcolor_p )

Definition at line 512 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgColor_i ( MMSFBColor & checked_bgcolor_i )

Definition at line 516 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgColor_i ( MMSFBColor & checked_selbgcolor_i )

Definition at line 520 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgImagePath ( string & checked_bgimagepath )

Definition at line 524 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgImageName ( string & checked_bgimagename )

Definition at line 528 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgImagePath ( string & checked_selbgimagepath )

Definition at line 532 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgImageName ( string & checked_selbgimagename )

Definition at line 536 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgImagePath_p ( string & checked_bgimagepath_p )

Definition at line 540 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgImageName_p ( string & checked_bgimagename_p )

Definition at line 544 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgImagePath_p ( string & checked_selbgimagepath_p )

Definition at line 548 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgImageName_p ( string & checked_selbgimagename_p )

Definition at line 552 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgImagePath_i ( string & checked_bgimagepath_i )

Definition at line 556 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedBgImageName_i ( string & checked_bgimagename_i )

Definition at line 560 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgImagePath_i ( string & checked_selbgimagepath_i )

Definition at line 564 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getCheckedSelBgImageName_i ( string & checked_selbgimagename_i )

Definition at line 568 of file mmscheckboxwidget.cpp.

bool MMSCheckBoxWidget::getChecked ( bool & checked )

Definition at line 572 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgColor	(	MMSFBColor	checked_bgcolor,
		bool	refresh = `true`
	)

Definition at line 582 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgColor	(	MMSFBColor	checked_selbgcolor,
		bool	refresh = `true`
	)

Definition at line 591 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgColor_p	(	MMSFBColor	checked_bgcolor_p,
		bool	refresh = `true`
	)

Definition at line 600 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgColor_p	(	MMSFBColor	checked_selbgcolor_p,
		bool	refresh = `true`
	)

Definition at line 609 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgColor_i	(	MMSFBColor	checked_bgcolor_i,
		bool	refresh = `true`
	)

Definition at line 618 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgColor_i	(	MMSFBColor	checked_selbgcolor_i,
		bool	refresh = `true`
	)

Definition at line 627 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgImagePath	(	string	checked_bgimagepath,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 636 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgImageName	(	string	checked_bgimagename,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 653 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgImagePath	(	string	checked_selbgimagepath,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 670 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgImageName	(	string	checked_selbgimagename,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 687 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgImagePath_p	(	string	checked_bgimagepath_p,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 704 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgImageName_p	(	string	checked_bgimagename_p,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 721 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgImagePath_p	(	string	checked_selbgimagepath_p,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 738 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgImageName_p	(	string	checked_selbgimagename_p,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 755 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgImagePath_i	(	string	checked_bgimagepath_i,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 772 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedBgImageName_i	(	string	checked_bgimagename_i,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 789 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgImagePath_i	(	string	checked_selbgimagepath_i,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 806 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setCheckedSelBgImageName_i	(	string	checked_selbgimagename_i,
		bool	load = `true`,
		bool	refresh = `true`
	)

Definition at line 823 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::setChecked	(	bool	checked,
		bool	refresh = `true`
	)

Definition at line 840 of file mmscheckboxwidget.cpp.

void MMSCheckBoxWidget::updateFromThemeClass ( MMSCheckBoxWidgetClass * themeClass )

Definition at line 851 of file mmscheckboxwidget.cpp.

Member Data Documentation

string MMSCheckBoxWidget::className [private]

Definition at line 46 of file mmscheckboxwidget.h.

MMSCheckBoxWidgetClass* MMSCheckBoxWidget::checkBoxWidgetClass [private]

Definition at line 47 of file mmscheckboxwidget.h.

MMSCheckBoxWidgetClass MMSCheckBoxWidget::myCheckBoxWidgetClass [private]

Definition at line 48 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::checked_bgimage [private]

Definition at line 50 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::checked_selbgimage [private]

Definition at line 51 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::checked_bgimage_p [private]

Definition at line 52 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::checked_selbgimage_p [private]

Definition at line 53 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::checked_bgimage_i [private]

Definition at line 54 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::checked_selbgimage_i [private]

Definition at line 55 of file mmscheckboxwidget.h.

bool MMSCheckBoxWidget::current_checked_bgset [private]

current checked background values set?

Definition at line 58 of file mmscheckboxwidget.h.

MMSFBColor MMSCheckBoxWidget::current_checked_bgcolor [private]

current checked background color

Definition at line 61 of file mmscheckboxwidget.h.

MMSFBSurface* MMSCheckBoxWidget::current_checked_bgimage [private]

current checked background image

Definition at line 64 of file mmscheckboxwidget.h.

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

MMSCheckBoxWidget Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation