Global defines

Modules
	Global Component Functions
	Gloal InvisibleComponent Functions
	Global Object Functions
	Global Control function

Data Structures
struct	_NCS_RDR_ENTRY
typedef struct _NCS_RDR_ENTRY	NCS_RDR_ENTRY
MGNCS_EXPORT DWORD	ncsGetElementEx (mWidget *self, const char *rdrName, int id)
	Get the value of element id in specified window or renderer. More...
MGNCS_EXPORT DWORD	ncsSetElementEx (mWidget *self, const char *rdrName, int id, DWORD value)
	Set the value of element id in specified window or renderer. More...
MGNCS_EXPORT GHANDLE	ncsLoadRdrEtcFile (const char *etcfile, const char **rdrName, int count)
	Load renderer configure file from file system or incore mode. More...
MGNCS_EXPORT int	ncsUnloadRdrEtcFile (GHANDLE hEtcFile)
	Unload renderer configuration file. More...
MGNCS_EXPORT mWidgetRenderer *	ncsRetriveCtrlRDR (const char *rendererName, const char *className)
	get a renderer of special control More...
MGNCS_EXPORT BOOL	ncsRegisterCtrlRDR (const char *rendererName, const char *className, mWidgetRenderer *renderer)
	register one of implemention of a special control into system More...
MGNCS_EXPORT void	ncsUnregisterCtrlRDRs (const char *rdrName, const char *className)
	unregister a special rdr More...
MGNCS_EXPORT BOOL	ncsRegisterCtrlRDRs (const char *rendererName, NCS_RDR_ENTRY *entries, int count)
	register a group of renderers into system More...
MGNCS_EXPORT BOOL	ncsSetSystemRenderer (const char *name)
	Set the System renderer. If a system renderer would be used by all the controls who haven't been set the property "renderer", see mWidget and mWidgetRenderer. More...
MGNCS_EXPORT const char *	ncsGetSystemRenderer (void)
	get the system renderer name More...
#define	NCS_TYPE_MASK   WE_ATTR_TYPE_MASK
#define	ncsGetElement(self, id)   ncsGetElementEx((mWidget*)self, NULL, id)
	Get the value of element id in specified window. More...
#define	ncsSetElement(self, id, value)   ncsSetElementEx((mWidget*)self, NULL, id, value)
	Set the value of element id in specified window. More...

Detailed Description

Macro Definition Documentation

#define NCS_TYPE_MASK   WE_ATTR_TYPE_MASK

defgroup Renderer_functions Global Renderer function

Definition at line 59 of file mrdr.h.

#define ncsGetElement	(		self,
			id
	)		ncsGetElementEx((mWidget*)self, NULL, id)

Get the value of element id in specified window.

Definition at line 276 of file mrdr.h.

#define ncsSetElement	(		self,
			id,
			value
	)		ncsSetElementEx((mWidget*)self, NULL, id, value)

Set the value of element id in specified window.

Definition at line 283 of file mrdr.h.

Typedef Documentation

typedef struct _NCS_RDR_ENTRY NCS_RDR_ENTRY

A struct to include a Renderer register info

See also

ncsRegisterCtrlRDRs

Function Documentation

DWORD ncsGetElementEx	(	mWidget *	self,
		const char *	rdrName,
		int	id
	)

Get the value of element id in specified window or renderer.

When the window class is valid, it will return the element id value in current window. Otherwise return the value in specifed renderer.

Parameters

self	The instance.
rdrName	The renderer name.
id	The window element id number, can be one of the following value: NCS_FGC_3DBODY NCS_BGC_3DBODY NCS_FGC_WINDOW NCS_BGC_WINDOW NCS_FGC_SELECTED_ITEM NCS_BGC_SELECTED_ITEM NCS_FGC_HILIGHT_ITEM NCS_BGC_HILIGHT_ITEM NCS_FGC_DISABLED_ITEM NCS_BGC_DISABLED_ITEM NCS_BGC_SELITEM_NOFOCUS NCS_METRICS_3DBODY_ROUNDX NCS_METRICS_3DBODY_ROUNDY NCS_MODE_BGC NCS_MODE_FGC NCS_MODE_ITEM NCS_MODE_USEFLAT NCS_BGC_PRGBAR_CHUNK NCS_BGC_TRKBAR_SLIDER NCS_BGC_TRKBAR_THUMB NCS_IMAGE_ARROWS NCS_IMAGE_ARROWSHELL NCS_IMAGE_BUTTON NCS_IMAGE_CHKBTN NCS_IMAGE_RDOBTN NCS_IMAGE_LISTV_TREE NCS_IMAGE_LISTV_HDR NCS_IMAGE_PRPSHT_TAB NCS_IMAGE_PRGBAR_HCHUNK NCS_IMAGE_PRGBAR_VCHUNK NCS_IMAGE_PRGBAR_HSLIDER NCS_IMAGE_PRGBAR_VSLIDER NCS_IMAGE_TRKBAR_HTHUMB NCS_IMAGE_TRKBAR_VTHUMB NCS_IMAGE_TRKBAR_HSLIDER NCS_IMAGE_TRKBAR_VSLIDER

See also

ncsSetElementEx

const char * ncsGetSystemRenderer

(

void

)

get the system renderer name

Returns

return the current system renderer name or "\0";

GHANDLE ncsLoadRdrEtcFile	(	const char *	etcfile,
		const char **	rdrName,
		int	count
	)

Load renderer configure file from file system or incore mode.

Parameters

etcfile	The name of configuration file.
rdrName	The renderer name set.
count	The array size of rdrName.

BOOL ncsRegisterCtrlRDR	(	const char *	rendererName,
		const char *	className,
		mWidgetRenderer *	renderer
	)

register one of implemention of a special control into system

Parameters

rendererName	- the name of renderer, eg. skin, classic, fashion, flat, and so on
className	- the control's classname
renderer	- the renderer which would be rensigered

Note

if the system have not any renderer of special "rendererName", system will create a renderer table to recieve it

Returns

sucesses or not

See also

ncsRegisterCtrlRDRs, ncsRetriveCtrlRDR, ncsUnregisterCtrlRDRs

BOOL ncsRegisterCtrlRDRs	(	const char *	rendererName,
		NCS_RDR_ENTRY *	entries,
		int	count
	)

register a group of renderers into system

Parameters

rendererName	- the name of special renderer
entries	- the table of renderers,

See also

NCS_RDR_ENTRY

Parameters

count

- the table size of entries

Returns

sucess or not

See also

ncsRegisterCtrlRDR, NCS_RDR_ENTRY, ncsRetriveCtrlRDR

mWidgetRenderer * ncsRetriveCtrlRDR	(	const char *	rendererName,
		const char *	className
	)

get a renderer of special control

Parameters

rendererName	- the renderer name , eg. classic, skin, fashion, flat, and so
className	- the control's className

Returns

the implemention of renderer

See also

ncsRegisterCtrlRDR, ncsRegisterCtrlRDRs

DWORD ncsSetElementEx	(	mWidget *	self,
		const char *	rdrName,
		int	id,
		DWORD	value
	)

Set the value of element id in specified window or renderer.

When the window class is valid, it will set the element id value in current window. Otherwise set the value in specifed renderer.

Parameters

self	The instance.
rdrName	The renderer name.
id	The element id.
value	The new value.

Returns

The old value.

See also

ncsGetElementEx

BOOL ncsSetSystemRenderer

(

const char *

name

)

Set the System renderer. If a system renderer would be used by all the controls who haven't been set the property "renderer", see mWidget and mWidgetRenderer.

Parameters

name	- The name of system renderer.

Returns

TRUE - sucess, FALSE - failed

Note

same as basic renderer. If the renderer specialed by param name is not exist, it will be store the name, and wait user call ncsRegisterCtrlRDR or ncsRegisterCtrlRDRs; the new registered renderer would be set as new system renderer if the thir renderer name are same.

int ncsUnloadRdrEtcFile

(

GHANDLE

hEtcFile

)

Unload renderer configuration file.

Returns

0 on success, otherwise -1.

void ncsUnregisterCtrlRDRs	(	const char *	rdrName = NULL,
		const char *	className = NULL
	)

unregister a special rdr

Parameters

rdrName	the name of the unregistering renender
className	the special class of the render

See also

ncsRegisterCtrlRDRs