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

Prokee Modules:
  A
  B
  C
  D
  E
  F
  G
  I
  L
  M
  N
  O
  P
  R
  S
  T
  U
  W
     open all    |    close all

GUI Elements:
  B
  C
  I
  M
  P
  R
  S
  T
     open all    |    close all

GUI Interactions:
  B
  F
  H
  S
     open all    |    close all

GUI Layouts:
  L
     open all    |    close all

Games/Demos:
  M
     open all    |    close all

Third Party Libraries:
  P
  F
  Z
     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 panel [Version: v01]

This documentation describes the Prokee module interface.


Static Methods:
main
int panel::main(int argc,char **argv)
Constructors
create (version 1)
Element *panel::create()
create (version 2)
Element *panel::create(uint16_t width,uint16_t height)
createScrollPanel
Element *panel::createScrollPanel(uint16_t width,uint16_t height)
Destructor
destroy
void panel::destroy(Element *elem)
Drawing
draw
void panel::draw(Element *elem)

Motivation

This module creates a panel element.

Static Methods

   main


Runs panel as if it would be called from the command-line.

See Commandline-Interface.

Signature:
int panel::main(int argc,char **argv)

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

Return value:
Exit status.

   create (version 1)


Creates a empty panel element.

Signature:
Element *panel::create()

Return value:
Pointer to a Element structure.

   create (version 2)


Creates a empty panel element.

Signature:
Element *panel::create(uint16_t width,uint16_t height)

Parameters:
Type Name Direction Description
uint16_t widthThe width of the panel in pixels.
uint16_t heightThe height of the panel in pixels.

Return value:
Pointer to a Element structure.

   createScrollPanel


Creates a empty scroll-panel element.

Signature:
Element *panel::createScrollPanel(uint16_t width,uint16_t height)

Parameters:
Type Name Direction Description
uint16_t widthThe width of the panel in pixels.
uint16_t heightThe height of the panel in pixels.

Return value:
Pointer to a Element structure.

   destroy


Destroys a Text element.

This frees all resources associated with the Text.

Signature:
void panel::destroy(Element *elem)

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

   draw


Draws a Text element to be displayed later.

See explanations about the terms 'paint', 'draw' and 'stage'.

Signature:
void panel::draw(Element *elem)

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

Copyright © 2017 - 2019 by Andreas Pollhammer