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 character [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

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

Constructor

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

create (version 2)
Element *character::create(const char *ch)

Destructor

destroy
void character::destroy(Element *elem)

Drawing

draw
void character::draw(Element *elem)

Motivation

This module handles a single character.

A block of text may be assambled by a series of single characters. This can be useful, if characters have to be placed or moved individually. Alternativelly, module 'text' provides functionality to draw a string (constisting of more than one character).

Static Methods

main

Runs a test of the character element.

Signature:

int character::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 character element.

Signature:

Element *character::create()

Return value:
Pointer to an Element structure.

create (version 2)

Creates an empty character element.

Signature:

Element *character::create(const char *ch)

Parameters:

Type	Name	Direction	Description
const char *	ch	[IN]	The character to be displayed, a utf-8 encoded character provided as null-terminated string.

Return value:
Pointer to an Element structure.

destroy

Destroys a character element.

This frees all resources associated with the Element.

Signature:

void character::destroy(Element *elem)

Parameters:

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

draw

Draws a character element to be displayed later.

Signature:

void character::draw(Element *elem)

Parameters:

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