uGFX/ugfx
2
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

gui doc

Browse Source
This commit is contained in:
Tectu 2012-06-26 13:57:00 +02:00
parent 3a63bff54d
commit 6743cde23d
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
gui.h
View File

@ -24,8 +24,37 @@ extern "C" {
enum {horizontal, vertical};
enum {inactive, active};
/*
* Description: creates the GUI thread
*
* param: - interval: thread sleep in milliseconds after each GUI element update
* - priority: priority of the thread
*
* return: pointer to created thread
*/
Thread *guiInit(uint16_t interval, tprio_t priority);
/*
* Description: prints all GUI elements structs (linked list)
*
* param: - chp: pointer to output stream
*
* return: none
*/
void guiPrintNode(BaseSequentialStream *chp);
/*
* Description: draws a button on the screen and keeps it's state up to date
*
* param: - x0, y0, x1, y1: start and end coordinates of the button's rectangle
* - str: string that gets drawn into the rectangle - button's lable
* - fontColor: color of the lable
* - buttonColor: color of the rectangle
* - active: pass pointer to variable which holds the state 'active' or 'inactive'
* - state: pass pointer to variable whcih will keep the state of the button (pressed / unpressed)'
*
* return: 1 if button successfully created
*/
uint8_t guiDrawButton(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, char *str, uint16_t fontColor, uint16_t buttonColor, uint8_t *active, uint8_t *state);
#ifdef __cplusplus