diff options
Diffstat (limited to 'docs/src/windows.dox')
| -rw-r--r-- | docs/src/windows.dox | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/src/windows.dox b/docs/src/windows.dox new file mode 100644 index 00000000..699281a2 --- /dev/null +++ b/docs/src/windows.dox @@ -0,0 +1,31 @@ +/* + * This file is subject to the terms of the GFX License. If a copy of + * the license was not distributed with this file, you can obtain one at: + * + * http://ugfx.com/license.html + */ + +/** + * @file src/gwin/sys_defs.h + * + * @defgroup Windows Windows + * @ingroup GWIN + * + * @details The window is the most basic GWIN element. All the other windows, + * widgets and containers are based on this class. + * + * A window implements the following properties and attributes: + * <ul> + * <li>Position</li> + * <li>Size</li> + * <li>Foreground color</li> + * <li>Background color</li> + * </ul> + * + * Each Window can either be created statically or dynamically. + * Like any other good window system, uGFX provide some standard window + * types such as graphs, consoles, buttons, containers etc. This is done + * through "super-classing" basic windows to provide the extended capabilities. + * + * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h + */ |