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

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

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

start_ex
int guiman::start_ex(const char *title,int x,int y,int xx,int yy,AbsThreadMan *tm,void(*_setup_function)(void))

cleanup
int guiman::cleanup()

run_demo
int guiman::run_demo(const char *title,void(*_setup_function)(void),void(*_cleanup_function)(void))

children_memcheck
void guiman::children_memcheck(void *elem)

appendChildToRootElement
void guiman::appendChildToRootElement(void *elem)

setRootElementLayout
void guiman::setRootElementLayout(void(*_layout_function)(Element *elem))

updateRootElement
void guiman::updateRootElement()

onExpose
void guiman::onExpose()

onExpose2
void guiman::onExpose2(CRegion *r)

updateUWIN
void guiman::updateUWIN()

updateUWIN2
void guiman::updateUWIN2(CRegion *r)

resizeUWIN
void guiman::resizeUWIN()

Motivation

Static Methods

main

This runs a demo.

Signature:

int guiman::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.

start_ex

Starts the gui system in a new thread.

Signature:

int guiman::start_ex(const char *title,int x,int y,int xx,int yy,AbsThreadMan *tm,void(*_setup_function)(void))

Parameters:

Type	Name	Direction	Description
const char *	title	[IN]	Title of the main window.
int	x		x-position of the main window.
int	y		y-position of the main window.
int	xx		Initial width of the main window.
int	yy		Initial height of the main window.
AbsThreadMan *	tm	[IN/OUT]	Pointer to a AbsThreadMan object.
void(_setup_function) ( void* )		[IN]	Function that runs the setup of the gui elements. This function has no parameters and no return value. Parameters

Return value:
The ID of the new thread of the gui system.

cleanup

Cleanup.

Signature:

int guiman::cleanup()

Return value:
Returns 0.

run_demo

Runs a demo of a gui element.

Signature:

int guiman::run_demo(const char *title,void(*_setup_function)(void),void(*_cleanup_function)(void))

Parameters:

Type	Name	Direction	Description
const char *	title		The title text of the window.
void(_setup_function) ( void* )		[IN]	Function that runs the setup of the gui elements. This function has no parameters and no return value. Parameters
void(_cleanup_function) ( void* )		[IN]	Function that frees all resources allocated by _setup_function(). This function has no parameters and no return value. Parameters

Return value:
Returns 0.

children_memcheck

Helper function. Checks available memory and reallocates a larger memory block if necessary.

Signature:

void guiman::children_memcheck(void *elem)

Parameters:

Type	Name	Direction	Description
void *	elem

appendChildToRootElement

Appends an element to the root-element.

Signature:

void guiman::appendChildToRootElement(void *elem)

Parameters:

Type	Name	Direction	Description
void *	elem

setRootElementLayout

Sets the layout of the root-element.

Signature:

void guiman::setRootElementLayout(void(*_layout_function)(Element *elem))

Parameters:

Type

Name

Direction

Description

void(*_layout_function)
(
Element *elem
)

with typedef

Type	Name
layoutfunc	_layout_function

[IN]

Layout function.

Parameters

elem: the gui element

updateRootElement

Updates the root-element.

Signature:

void guiman::updateRootElement()

onExpose

onExpose

Signature:

void guiman::onExpose()

onExpose2

onExpose

Signature:

void guiman::onExpose2(CRegion *r)

Parameters:

Type	Name	Direction	Description
CRegion *	r

updateUWIN

Updates the contents of the main window.

Signature:

void guiman::updateUWIN()

updateUWIN2

Updates the contents of the main window.

Signature:

void guiman::updateUWIN2(CRegion *r)

Parameters:

Type	Name	Direction	Description
CRegion *	r

resizeUWIN

Resizes the contents of the main window.

Signature:

void guiman::resizeUWIN()