This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:

open all | close all

GUI Elements:

open all | close all

GUI Interactions:

open all | close all

GUI Layouts:

open all | close all

Games/Demos:

open all | close all

Third Party Libraries:

open all | close all

Information about this Website / Informationen zu dieser Webseite:

In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module text [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

main
int text::main(int argc,char **argv)

Constructors

create (version 1)
Element *text::create()

create (version 2)
Element *text::create(uint16_t width,uint16_t height,const char *font_filename,long int face_index)

Destructor

destroy
void text::destroy(Element *elem)

Drawing

draw
void text::draw(Element *elem)

Attributes

setText
void text::setText(Element *elem,const char *name)

Motivation

This module creates a text element.

Static Methods

main

Runs a test of the icon element.

Signature:

int text::main(int argc,char **argv)

Parameters:

Type	Name	Direction	Description
int	argc		The number of command-line parameters.
char **	argv	[IN]	The command-line parameters.

Return value:
Exit status.

create (version 1)

Creates an empty text element.

Signature:

Element *text::create()

Return value:
Pointer to an Element structure.

create (version 2)

Creates an empty text element.

Signature:

Element *text::create(uint16_t width,uint16_t height,const char *font_filename,long int face_index)

Parameters:

Type	Name	Direction	Description
uint16_t	width		The width of the text in pixels.
uint16_t	height		The height of the text in pixels.
const char *	font_filename
long int	face_index

Return value:
Pointer to an Element structure.

destroy

Destroys a text element.

This frees all resources associated with the Text.

Signature:

void text::destroy(Element *elem)

Parameters:

Type	Name	Direction	Description
Element *	elem	[IN/OUT]	Pointer to an Element structure.

draw

Draws a text element to be displayed later.

Signature:

void text::draw(Element *elem)

Parameters:

Type	Name	Direction	Description
Element *	elem	[IN/OUT]	Pointer to an Element structure.

setText

Sets the text to be displayed on the text.

Signature:

void text::setText(Element *elem,const char *name)

Parameters:

Type	Name	Direction	Description
Element *	elem	[IN/OUT]	Pointer to an Element structure.
const char *	name		The null-terminated string to be displayed on the Text.