D4D STRING API Macro's Specification

Collaboration diagram for D4D STRING API Macro's Specification:

Macros
#define	D4D_DECLARE_STRING_TABLE_BEGIN
	Macro that starts of default string table declaration. More...
#define	D4D_DECLARE_USR_STRING_TABLE_BEGIN(name)
	Macro that starts of user string table declaration. More...
#define	D4D_DECLARE_STRING(stringId, string_table)
	Macro that adds one language to strings table declaration. More...
#define	D4D_DECLARE_STRING_TABLE_END
	Macro that ends the strings table declaration. More...
#define	D4D_DECLARE_TAB_TABLE_BEGIN(name)
	Macro that starts of tabulator table declaration. More...
#define	D4D_DECLARE_TAB(tab)
	Macro that adds one tabulator to tabulator table declaration. More...
#define	D4D_DECLARE_TAB_TABLE_END
	Macro that close table declaration. More...
#define	D4D_DEFSTR(str)
	Macro that helps declare the strings in eGUI. More...
#define	D4D_IsDigit(x)
	Macro that returns if the input cahr is digit or not. Here is an example demonstrating how to used it. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define D4D_DECLARE_STRING	(		stringId,
			string_table
	)

Macro that adds one language to strings table declaration.

Parameters

stringId	- unique id of string(language) table
string_table	- pointer to string table

Note

None Here is an example demonstrating how to used it.

*       D4D_DECLARE_USR_STRING_TABLE_BEGIN(myUserStringTable)
*       D4D_DECLARE_STRING(1, myStrings1)
*       D4D_DECLARE_STRING(2, myStrings2)
*       D4D_DECLARE_STRING_TABLE_END
* 

Definition at line 170 of file d4d_string.h.

#define D4D_DECLARE_STRING_TABLE_BEGIN

Macro that starts of default string table declaration.

Note

This macro is used with D4D_DECLARE_STRING & D4D_DECLARE_STRING_TABLE_END to create the string (language) table in eGUI Here is an example demonstrating how to used it.

*       D4D_DECLARE_STRING_TABLE_BEGIN
*       D4D_DECLARE_STRING(1, myStrings1)
*       D4D_DECLARE_STRING(2, myStrings2)
*       D4D_DECLARE_STRING_TABLE_END
* 

Definition at line 141 of file d4d_string.h.

#define D4D_DECLARE_STRING_TABLE_END

Macro that ends the strings table declaration.

Note

None Here is an example demonstrating how to used it.

*       D4D_DECLARE_USR_STRING_TABLE_BEGIN(myUserStringTable)
*       D4D_DECLARE_STRING(1, myStrings1)
*       D4D_DECLARE_STRING(2, myStrings2)
*       D4D_DECLARE_STRING_TABLE_END
* 

Definition at line 184 of file d4d_string.h.

#define D4D_DECLARE_TAB

(

tab

)

Macro that adds one tabulator to tabulator table declaration.

Parameters

tab	- tabulator in pixels

Note

This macro is used with D4D_DECLARE_TAB_TABLE_BEGIN & D4D_DECLARE_TAB_TABLE_END to create the tabulator table in eGUI Here is an example demonstrating how to used it.

*       D4D_DECLARE_TAB_TABLE_BEGIN(myTabTable)
*       D4D_DECLARE_TAB(20)     // 20 Pixels
*       D4D_DECLARE_TAB(50)     // 50 Pixels
*       D4D_DECLARE_TAB_TABLE_END
* 

Definition at line 212 of file d4d_string.h.

#define D4D_DECLARE_TAB_TABLE_BEGIN

(

name

)

Macro that starts of tabulator table declaration.

Parameters

name	- Name of tabulator table

Note

This macro is used with D4D_DECLARE_TAB & D4D_DECLARE_TAB_TABLE_END to create the tabulator table in eGUI Here is an example demonstrating how to used it.

*       D4D_DECLARE_TAB_TABLE_BEGIN(myTabTable)
*       D4D_DECLARE_TAB(20)     // 20 Pixels
*       D4D_DECLARE_TAB(50)     // 50 Pixels
*       D4D_DECLARE_TAB_TABLE_END
* 

Definition at line 198 of file d4d_string.h.

#define D4D_DECLARE_TAB_TABLE_END

Macro that close table declaration.

Note

This macro is used with D4D_DECLARE_TAB_TABLE_BEGIN & D4D_DECLARE_TAB to create the tabulator table in eGUI Here is an example demonstrating how to used it.

*       D4D_DECLARE_TAB_TABLE_BEGIN(myTabTable)
*       D4D_DECLARE_TAB(20)     // 20 Pixels
*       D4D_DECLARE_TAB(50)     // 50 Pixels
*       D4D_DECLARE_TAB_TABLE_END
* 

Definition at line 225 of file d4d_string.h.

#define D4D_DECLARE_USR_STRING_TABLE_BEGIN

(

name

)

Macro that starts of user string table declaration.

Parameters

name	- Name of user string table

Note

This macro is used with D4D_DECLARE_STRING & D4D_DECLARE_STRING_TABLE_END to create the string (language) table in eGUI Here is an example demonstrating how to used it.

*       D4D_DECLARE_USR_STRING_TABLE_BEGIN(myUserStringTable)
*       D4D_DECLARE_STRING(1, myStrings1)
*       D4D_DECLARE_STRING(2, myStrings2)
*       D4D_DECLARE_STRING_TABLE_END
* 

Definition at line 155 of file d4d_string.h.

#define D4D_DEFSTR

(

str

)

Macro that helps declare the strings in eGUI.

Note

It handles UNICODE wide strings declaration if UNICODE is enabled. Here is an example demonstrating how to used it.

*       D4D_DEFSTR("My test string.")
* 

Definition at line 246 of file d4d_string.h.

#define D4D_IsDigit

(

x

)

Macro that returns if the input cahr is digit or not. Here is an example demonstrating how to used it.

*       D4D_CHAR my_char;
*       my_char = '6'; // Just for example fill up the variable
*       if(D4D_IsDigit(my_char))
*       {
*        // do code for digit char
*       }else
*       {
*        // do code for non digit char
*       {
* 

Definition at line 265 of file d4d_string.h.