Added a couple of doxygen comments to gui.h
This commit is contained in:
parent
96557465c2
commit
1cf551d149
@ -14,13 +14,19 @@ class IWidget;
|
|||||||
#include "canvas.hpp"
|
#include "canvas.hpp"
|
||||||
#include "input.hpp"
|
#include "input.hpp"
|
||||||
|
|
||||||
|
/// Main root object of libpdraw
|
||||||
|
/**
|
||||||
|
* The main required global of the library.
|
||||||
|
* You MUST set g_pGUI to a valid pointer and run Setup() afterwards for anything to function.
|
||||||
|
*/
|
||||||
class CatGUI {
|
class CatGUI {
|
||||||
public:
|
public:
|
||||||
CatGUI();
|
CatGUI();
|
||||||
~CatGUI();
|
~CatGUI();
|
||||||
|
|
||||||
void Setup();
|
void Setup();
|
||||||
Canvas* GetRootWindow();
|
Canvas* GetRootWindow(); /**< Use to get a container you can add widgets to. */
|
||||||
Canvas* m_pRootWindow;
|
Canvas* m_pRootWindow;
|
||||||
};
|
};
|
||||||
|
/** Must be a valid pointer for library to function. */
|
||||||
extern CatGUI* g_pGUI;
|
extern CatGUI* g_pGUI;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user