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

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

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

Constructor

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

create (version 2)
Element *icon::create(const char *type)

Destructor

destroy
void icon::destroy(Element *elem)

Drawing

draw
void icon::draw(Element *elem)

Motivation

This module creates a icon element.

Icon Types:

left
right
up
down
fill
stop
null

Static Methods

main

Runs a test of the icon element.

Signature:

int icon::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 a new empty icon element.

Signature:

Element *icon::create()

Return value:
Pointer to an Element structure.

create (version 2)

Creates a new icon element.

Signature:

Element *icon::create(const char *type)

Parameters:

Type	Name	Direction	Description
const char *	type	[IN]	The type of the icon to create.

Return value:
Pointer to an Element structure.

destroy

Destroys an icon element.

This frees all resources associated with the Element.

Signature:

void icon::destroy(Element *elem)

Parameters:

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

draw

Draws an icon element to be displayed later.

Signature:

void icon::draw(Element *elem)

Parameters:

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