D4D BASIC DRAW API Macro's Specification

Collaboration diagram for D4D BASIC DRAW API Macro's Specification:

Macros
#define	D4D_DrawTextXY(x, y, buffText, colorText, colorBkgd)
	Function that draw text on the screen the coordination is sets directly XY. More...
#define	D4D_DrawText(ppt, buffText, colorText, colorBkgd)
	Function that draw simple text on the screen. More...
#define	D4D_DrawTextTab(ppt, buffText, pTab, colorText, colorBkgd)
	Function that draw text on the screen and respects Tabulator functionality. More...
#define	D4D_DrawTextRect(ppt, psz, buffText, colorText, colorBkgd)
	Function that draw text into defined rectangle on the screen. More...
#define	D4D_DrawTextRectTo(ppt, buffText, colorText, colorBkgd)
	Function that draw text into defined rectangle on the screen from previous draw point to to point specify by ppt structure. More...
#define	D4D_DrawTextRectXY(x1, y1, x2, y2, buffText, colorText, colorBkgd)
	Function that draw text into defined rectangle on the screen. More...
#define	D4D_DrawTextRectToXY(x, y, buffText, colorText, colorBkgd)
	Function that draw text into defined rectangle on the screen from previous draw point to to point specify by ppt structure. More...
#define	D4D_DrawTextRRect(ppt, psz, buffText, colorText, colorBkgd, radius)
	Function that draw text into defined rectangle on the screen with corner radius. More...
#define	D4D_DrawTextRRectTo(ppt, buffText, colorText, colorBkgd, radius)
	Function that draw text into defined rectangle with corner radius on the screen from previous draw point to to point specify by ppt structure. More...
#define	D4D_DrawTextRRectXY(x1, y1, x2, y2, buffText, colorText, colorBkgd, radius)
	Function that draw text into defined rectangle on the screen with corner radius. More...
#define	D4D_DrawTextRRectToXY(x, y, buffText, colorText, colorBkgd, radius)
	Function that draw text into defined rectangle with corner radius on the screen from previous draw point to to point specify by ppt structure. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define D4D_DrawText	(		ppt,
			buffText,
			colorText,
			colorBkgd
	)

Function that draw simple text on the screen.

Parameters

ppt	- pointer on point structure that defines top left corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the simple text on the screen

Definition at line 113 of file d4d_basic_draw.h.

#define D4D_DrawTextRect	(		ppt,
			psz,
			buffText,
			colorText,
			colorBkgd
	)

Function that draw text into defined rectangle on the screen.

Parameters

ppt	- pointer on point structure that defines top left corner of draw text
psz	- pointer on the size structure that defines size of the text rectangle
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 139 of file d4d_basic_draw.h.

#define D4D_DrawTextRectTo	(		ppt,
			buffText,
			colorText,
			colorBkgd
	)

Function that draw text into defined rectangle on the screen from previous draw point to to point specify by ppt structure.

Parameters

ppt	- pointer on point structure that specify the second point of rectangle. The first one is takes last drawing point.
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 154 of file d4d_basic_draw.h.

#define D4D_DrawTextRectToXY	(		x,
			y,
			buffText,
			colorText,
			colorBkgd
	)

Function that draw text into defined rectangle on the screen from previous draw point to to point specify by ppt structure.

Parameters

x	- coordination in axis X that defines right corner of draw text
y	- coordination in axis Y that defines bottom corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 185 of file d4d_basic_draw.h.

#define D4D_DrawTextRectXY	(		x1,
			y1,
			x2,
			y2,
			buffText,
			colorText,
			colorBkgd
	)

Function that draw text into defined rectangle on the screen.

Parameters

x1	- coordination in axis X that defines left corner of draw text
y1	- coordination in axis Y that defines top corner of draw text
x2	- coordination in axis X that defines right corner of draw text
y2	- coordination in axis Y that defines bottom corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 170 of file d4d_basic_draw.h.

#define D4D_DrawTextRRect	(		ppt,
			psz,
			buffText,
			colorText,
			colorBkgd,
			radius
	)

Function that draw text into defined rectangle on the screen with corner radius.

Parameters

ppt	- pointer on point structure that defines top left corner of draw text
psz	- pointer on the size structure that defines size of the text rectangle
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background
radius	- radius or text rectangle

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 200 of file d4d_basic_draw.h.

#define D4D_DrawTextRRectTo	(		ppt,
			buffText,
			colorText,
			colorBkgd,
			radius
	)

Function that draw text into defined rectangle with corner radius on the screen from previous draw point to to point specify by ppt structure.

Parameters

ppt	- pointer on point structure that specify the second point of rectangle. The first one is takes last drawing point.
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background
radius	- radius or text rectangle

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 216 of file d4d_basic_draw.h.

#define D4D_DrawTextRRectToXY	(		x,
			y,
			buffText,
			colorText,
			colorBkgd,
			radius
	)

Function that draw text into defined rectangle with corner radius on the screen from previous draw point to to point specify by ppt structure.

Parameters

x	- coordination in axis X that defines right corner of draw text
y	- coordination in axis Y that defines bottom corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background
radius	- radius or text rectangle

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 249 of file d4d_basic_draw.h.

#define D4D_DrawTextRRectXY	(		x1,
			y1,
			x2,
			y2,
			buffText,
			colorText,
			colorBkgd,
			radius
	)

Function that draw text into defined rectangle on the screen with corner radius.

Parameters

x1	- coordination in axis X that defines left corner of draw text
y1	- coordination in axis Y that defines top corner of draw text
x2	- coordination in axis X that defines right corner of draw text
y2	- coordination in axis Y that defines bottom corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background
radius	- radius or text rectangle

Returns

none

Note

Function that draw the text on the screeninto logic rectangle. In case of long texts it make text shorter and add three points "...". It also support text align and fill up complete rectangle in case that this is neccessary.

Definition at line 233 of file d4d_basic_draw.h.

#define D4D_DrawTextTab	(		ppt,
			buffText,
			pTab,
			colorText,
			colorBkgd
	)

Function that draw text on the screen and respects Tabulator functionality.

Parameters

ppt	- pointer on point structure that defines top left corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
pTab	- pointer on the tabulator description table
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the text on the screen with tabulator table

Definition at line 125 of file d4d_basic_draw.h.

#define D4D_DrawTextXY	(		x,
			y,
			buffText,
			colorText,
			colorBkgd
	)

Function that draw text on the screen the coordination is sets directly XY.

Parameters

x	- coordination in axis X that defines left corner of draw text
y	- coordination in axis Y that defines top corner of draw text
buffText	- pointer on the text buffer structure that contains text itself and its parameter
colorText	- color of text
colorBkgd	- color of text background

Returns

none

Note

Function that draw the simple text on the screen with defined XY coordination

Definition at line 102 of file d4d_basic_draw.h.