#include "GUIslice.h"

Include dependency graph for XCheckbox.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	gslc_tsXCheckbox
	Extended data for Checkbox element. More...

Macros
#define	GSLC_TYPEX_CHECKBOX

#define	gslc_ElemXCheckboxCreate_P(pGui, nElemId, nPage, nX, nY, nW, nH, colFill, bFillEn, nGroup, bRadio_, nStyle_, colCheck_, bChecked_)
	Create a Checkbox or Radio button Element in Flash. More...

Typedefs
typedef bool(*	GSLC_CB_XCHECKBOX) (void pvGui, void pvElemRef, int16_t nSelId, bool bChecked)
	Callback function for checkbox/radio element state change. More...

Enumerations
enum	gslc_teXCheckboxStyle { GSLCX_CHECKBOX_STYLE_BOX, GSLCX_CHECKBOX_STYLE_X, GSLCX_CHECKBOX_STYLE_ROUND }
	Checkbox drawing style. More...

Functions
gslc_tsElemRef *	gslc_ElemXCheckboxCreate (gslc_tsGui pGui, int16_t nElemId, int16_t nPage, gslc_tsXCheckbox pXData, gslc_tsRect rElem, bool bRadio, gslc_teXCheckboxStyle nStyle, gslc_tsColor colCheck, bool bChecked)
	Create a Checkbox or Radio button Element. More...

bool	gslc_ElemXCheckboxGetState (gslc_tsGui pGui, gslc_tsElemRef pElemRef)
	Get a Checkbox element's current state. More...

void	gslc_ElemXCheckboxSetState (gslc_tsGui pGui, gslc_tsElemRef pElemRef, bool bChecked)
	Set a Checkbox element's current state. More...

gslc_tsElemRef *	gslc_ElemXCheckboxFindChecked (gslc_tsGui *pGui, int16_t nGroupId)
	Find the checkbox within a group that has been checked. More...

void	gslc_ElemXCheckboxToggleState (gslc_tsGui pGui, gslc_tsElemRef pElemRef)
	Toggle a Checkbox element's current state. More...

void	gslc_ElemXCheckboxSetStateFunc (gslc_tsGui pGui, gslc_tsElemRef pElemRef, GSLC_CB_XCHECKBOX pfuncCb)
	Assign the state callback function for a checkbox/radio button. More...

bool	gslc_ElemXCheckboxDraw (void pvGui, void pvElemRef, gslc_teRedrawType eRedraw)
	Draw a Checkbox element on the screen. More...

bool	gslc_ElemXCheckboxTouch (void pvGui, void pvElemRef, gslc_teTouch eTouch, int16_t nRelX, int16_t nRelY)
	Handle touch events to Checkbox element. More...

Macro Definition Documentation

#define gslc_ElemXCheckboxCreate_P	(	pGui,
		nElemId,
		nPage,
		nX,
		nY,
		nW,
		nH,
		colFill,
		bFillEn,
		nGroup,
		bRadio_,
		nStyle_,
		colCheck_,
		bChecked_
	)

Create a Checkbox or Radio button Element in Flash.

Parameters

[in]	pGui	Pointer to GUI
[in]	nElemId	Unique element ID to assign
[in]	nPage	Page ID to attach element to
[in]	nX	X coordinate of element
[in]	nY	Y coordinate of element
[in]	nW	Width of element
[in]	nH	Height of element
[in]	colFill	Color for the control background fill
[in]	bFillEn	True if background filled, false otherwise (recommend True)
[in]	nGroup	Group ID that radio buttons belong to (else GSLC_GROUP_NONE)
[in]	bRadio_	Radio-button functionality if true
[in]	nStyle_	Drawing style for checkbox / radio button
[in]	colCheck_	Color for inner fill when checked
[in]	bChecked_	Default state

Returns: none

#define GSLC_TYPEX_CHECKBOX

Typedef Documentation

typedef bool(* GSLC_CB_XCHECKBOX) (void *pvGui, void *pvElemRef, int16_t nSelId, bool bChecked)

Callback function for checkbox/radio element state change.

nSelId: Selected element's ID or GSLC_ID_NONE
bChecked: Element was selected if true, false otherwise

Enumeration Type Documentation

enum gslc_teXCheckboxStyle

Checkbox drawing style.

Enumerator
GSLCX_CHECKBOX_STYLE_BOX	Inner box.
GSLCX_CHECKBOX_STYLE_X	Crossed.
GSLCX_CHECKBOX_STYLE_ROUND	Circular.

Function Documentation

gslc_tsElemRef* gslc_ElemXCheckboxCreate	(	gslc_tsGui *	pGui,
		int16_t	nElemId,
		int16_t	nPage,
		gslc_tsXCheckbox *	pXData,
		gslc_tsRect	rElem,
		bool	bRadio,
		gslc_teXCheckboxStyle	nStyle,
		gslc_tsColor	colCheck,
		bool	bChecked
	)

Create a Checkbox or Radio button Element.

Parameters

[in]	pGui	Pointer to GUI
[in]	nElemId	Element ID to assign (0..16383 or GSLC_ID_AUTO to autogen)
[in]	nPage	Page ID to attach element to
[in]	pXData	Ptr to extended element data structure
[in]	rElem	Rectangle coordinates defining checkbox size
[in]	bRadio	Radio-button functionality if true
[in]	nStyle	Drawing style for checkbox / radio button
[in]	colCheck	Color for inner fill when checked
[in]	bChecked	Default state

Returns: Pointer to Element reference or NULL if failure

bool gslc_ElemXCheckboxDraw	(	void *	pvGui,
		void *	pvElemRef,
		gslc_teRedrawType	eRedraw
	)

Draw a Checkbox element on the screen.

Called from gslc_ElemDraw()

Parameters

[in]	pvGui	Void ptr to GUI (typecast to gslc_tsGui*)
[in]	pvElemRef	Void ptr to Element reference (typecast to gslc_tsElemRef*)
[in]	eRedraw	Redraw mode

Returns: true if success, false otherwise

gslc_tsElemRef* gslc_ElemXCheckboxFindChecked	(	gslc_tsGui *	pGui,
		int16_t	nGroupId
	)

Find the checkbox within a group that has been checked.

Parameters

[in]	pGui	Pointer to GUI
[in]	nGroupId	Group ID to search

Returns: Element Ptr or NULL if none checked

bool gslc_ElemXCheckboxGetState	(	gslc_tsGui *	pGui,
		gslc_tsElemRef *	pElemRef
	)

Get a Checkbox element's current state.

Parameters

[in]	pGui	Pointer to GUI
[in]	pElemRef	Pointer to Element reference

Returns: Current state

void gslc_ElemXCheckboxSetState	(	gslc_tsGui *	pGui,
		gslc_tsElemRef *	pElemRef,
		bool	bChecked
	)

Set a Checkbox element's current state.

Parameters

[in]	pGui	Pointer to GUI
[in]	pElemRef	Pointer to Element reference
[in]	bChecked	New state

Returns: none

void gslc_ElemXCheckboxSetStateFunc	(	gslc_tsGui *	pGui,
		gslc_tsElemRef *	pElemRef,
		GSLC_CB_XCHECKBOX	pfuncCb
	)

Assign the state callback function for a checkbox/radio button.

Parameters

[in]	pGui	Pointer to GUI
[in]	pElemRef	Pointer to Element reference
[in]	pfuncCb	Function pointer to callback routine (or NULL for none)

Returns: none

void gslc_ElemXCheckboxToggleState	(	gslc_tsGui *	pGui,
		gslc_tsElemRef *	pElemRef
	)

Toggle a Checkbox element's current state.

Parameters

[in]	pGui	Pointer to GUI
[in]	pElemRef	Pointer to Element reference

Returns: none

bool gslc_ElemXCheckboxTouch	(	void *	pvGui,
		void *	pvElemRef,
		gslc_teTouch	eTouch,
		int16_t	nRelX,
		int16_t	nRelY
	)

Handle touch events to Checkbox element.

Called from gslc_ElemSendEventTouch()

Parameters

[in]	pvGui	Void ptr to GUI (typecast to gslc_tsGui*)
[in]	pvElemRef	Void ptr to Element reference (typecast to gslc_tsElemRef*)
[in]	eTouch	Touch event type
[in]	nRelX	Touch X coord relative to element
[in]	nRelY	Touch Y coord relative to element

Returns: true if success, false otherwise

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation