eGUI alias D4D  Release 3.0
Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
D4D STRING API Functions Specification
D4D STRING Handler
Collaboration diagram for D4D STRING API Functions Specification:

Functions

D4D_TCHAR * D4D_GetInternalStringPointer (const D4D_TCHAR *originTxt)
 The function gets the real internal pointer to string. More...
 
Byte D4D_SprintDecU32 (LWord val, D4D_TCHAR *pText, D4D_TCHAR fill)
 The function convert decimal unsigned 32 bit number to string. More...
 
Byte D4D_SprintDecS32 (sLWord val, D4D_TCHAR *pText, D4D_TCHAR fill)
 The function convert decimal signed 32 bit number to string. More...
 
Byte D4D_SprintDecU16 (Word val, D4D_TCHAR *pText, D4D_TCHAR fill)
 The function convert decimal unsigned 16 bit number to string. More...
 
Byte D4D_SprintDecS16 (sWord val, D4D_TCHAR *pText, D4D_TCHAR fill)
 The function convert decimal signed 16 bit number to string. More...
 
Byte D4D_SprintDecU8 (Byte val, D4D_TCHAR *pText, D4D_TCHAR fill)
 The function convert decimal unsigned 8 bit number to string. More...
 
Byte D4D_SprintDecS8 (sByte val, D4D_TCHAR *pText, D4D_TCHAR fill)
 The function convert decimal signed 8 bit number to string. More...
 
D4D_INDEX D4D_GetTextLength (D4D_TCHAR *pText)
 The function returns lenght of text. More...
 
D4D_COOR D4D_GetTextWidth (D4D_FONT ix, D4D_TCHAR *pText)
 The function returns width of text in pixels. More...
 
D4D_COOR D4D_GetTextBuffWidthTab (D4D_STRING *text_buffer, D4D_TAB *pTab)
 The function returns width of text in pixels, also with tab table. More...
 
D4D_INDEX D4D_GetTextMaxLength (D4D_STRING *pString, D4D_COOR maxWidth)
 The function find out the maximal text length that fits to maximal pixel width. More...
 
void D4D_SetText (D4D_OBJECT_PTR pObject, D4D_TCHAR *pText)
 The function change the text in main object text buffer. More...
 

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

D4D_TCHAR* D4D_GetInternalStringPointer ( const D4D_TCHAR *  originTxt)

The function gets the real internal pointer to string.

Parameters
originTxt- the defined string in application
Returns
pointer to real string - in case of string table pointer to right table to right place, in case of non string table texts it return s same as input one
Note
None.

Definition at line 108 of file d4d_string.c.

Here is the caller graph for this function:

D4D_COOR D4D_GetTextBuffWidthTab ( D4D_STRING *  text_buffer,
D4D_TAB *  pTab 
)

The function returns width of text in pixels, also with tab table.

Parameters
text_buffer- pointer to full string descriptor (MUST be full filled)
pTab- pointer to teb table
Returns
width of text in pixels
Note
The function find out the width of string printed with all specified properties in string descriptor.

Definition at line 403 of file d4d_string.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_INDEX D4D_GetTextLength ( D4D_TCHAR *  pText)

The function returns lenght of text.

Parameters
pText- pointer to text
Returns
count of characters in text
Note
None.

Definition at line 329 of file d4d_string.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_INDEX D4D_GetTextMaxLength ( D4D_STRING *  pString,
D4D_COOR  maxWidth 
)

The function find out the maximal text length that fits to maximal pixel width.

Parameters
pString- pointer to full string descriptor (MUST be full filled)
maxWidth- maximal width where the text should fits
Returns
length of text that's fits to given maximal width
Note
None.

Definition at line 492 of file d4d_string.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_COOR D4D_GetTextWidth ( D4D_FONT  ix,
D4D_TCHAR *  pText 
)

The function returns width of text in pixels.

Parameters
ix- font index
pText- pointer to text
Returns
width of text in pixels
Note
The function find out the width of string printed in given font.

Definition at line 357 of file d4d_string.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_SetText ( D4D_OBJECT_PTR  pObject,
D4D_TCHAR *  pText 
)

The function change the text in main object text buffer.

Parameters
pObject- pointer to object
pText- pointer to new string
Returns
None
Note
The function change the text in the object text buffer if the object has it.

Definition at line 573 of file d4d_string.c.

Here is the call graph for this function:

Byte D4D_SprintDecS16 ( sWord  val,
D4D_TCHAR *  pText,
D4D_TCHAR  fill 
)

The function convert decimal signed 16 bit number to string.

Parameters
val- the input numerical value
pText- pointer to output text buffer
fill- the fill character for non number characters (before number)
Returns
count of printed chars
Note
If fill parameter is 0 {'\0'}, only the numerical characters are printed.

Definition at line 242 of file d4d_string.c.

Here is the call graph for this function:

Byte D4D_SprintDecS32 ( sLWord  val,
D4D_TCHAR *  pText,
D4D_TCHAR  fill 
)

The function convert decimal signed 32 bit number to string.

Parameters
val- the input numerical value
pText- pointer to output text buffer
fill- the fill character for non number characters (before number)
Returns
count of printed chars
Note
If fill parameter is 0 {'\0'}, only the numerical characters are printed.

Definition at line 181 of file d4d_string.c.

Here is the call graph for this function:

Byte D4D_SprintDecS8 ( sByte  val,
D4D_TCHAR *  pText,
D4D_TCHAR  fill 
)

The function convert decimal signed 8 bit number to string.

Parameters
val- the input numerical value
pText- pointer to output text buffer
fill- the fill character for non number characters (before number)
Returns
count of printed chars
Note
If fill parameter is 0 {'\0'}, only the numerical characters are printed.

Definition at line 311 of file d4d_string.c.

Here is the call graph for this function:

Byte D4D_SprintDecU16 ( Word  val,
D4D_TCHAR *  pText,
D4D_TCHAR  fill 
)

The function convert decimal unsigned 16 bit number to string.

Parameters
val- the input numerical value
pText- pointer to output text buffer
fill- the fill character for non number characters (before number)
Returns
count of printed chars
Note
If fill parameter is 0 {'\0'}, only the numerical characters are printed.

Definition at line 201 of file d4d_string.c.

Here is the caller graph for this function:

Byte D4D_SprintDecU32 ( LWord  val,
D4D_TCHAR *  pText,
D4D_TCHAR  fill 
)

The function convert decimal unsigned 32 bit number to string.

Parameters
val- the input numerical value
pText- pointer to output text buffer
fill- the fill character for non number characters (before number)
Returns
count of printed chars
Note
If fill parameter is 0 {'\0'}, only the numerical characters are printed.

Definition at line 140 of file d4d_string.c.

Here is the caller graph for this function:

Byte D4D_SprintDecU8 ( Byte  val,
D4D_TCHAR *  pText,
D4D_TCHAR  fill 
)

The function convert decimal unsigned 8 bit number to string.

Parameters
val- the input numerical value
pText- pointer to output text buffer
fill- the fill character for non number characters (before number)
Returns
count of printed chars
Note
If fill parameter is 0 {'\0'}, only the numerical characters are printed.

Definition at line 262 of file d4d_string.c.

Here is the caller graph for this function: