diff options
| author | inmarket <andrewh@inmarket.com.au> | 2014-02-19 08:00:52 +1000 | 
|---|---|---|
| committer | inmarket <andrewh@inmarket.com.au> | 2014-02-19 08:00:52 +1000 | 
| commit | b82448c3e23663a25a423402343fbca78253b80c (patch) | |
| tree | 57a03e35b88f6e434b6c4d084695fc5ce1061932 /src/gwin/sys_options.h | |
| parent | dcedf414136e55e6dacbe736babe748e1374e19e (diff) | |
| parent | 37966ff16d923bbca53c9464815cb49cbd7fc3be (diff) | |
| download | uGFX-b82448c3e23663a25a423402343fbca78253b80c.tar.gz uGFX-b82448c3e23663a25a423402343fbca78253b80c.tar.bz2 uGFX-b82448c3e23663a25a423402343fbca78253b80c.zip  | |
Merge branch 'master' into gwin
Diffstat (limited to 'src/gwin/sys_options.h')
| -rw-r--r-- | src/gwin/sys_options.h | 199 | 
1 files changed, 199 insertions, 0 deletions
diff --git a/src/gwin/sys_options.h b/src/gwin/sys_options.h new file mode 100644 index 00000000..07f63b99 --- /dev/null +++ b/src/gwin/sys_options.h @@ -0,0 +1,199 @@ +/* + * 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.org/license.html + */ + +/** + * @file    include/gwin/sys_options.h + * @brief   GWIN sub-system options header file. + * + * @addtogroup GWIN + * @brief	Module which provides a complete GUI toolkit based on widgets + *  + * @{ + */ + +#ifndef _GWIN_OPTIONS_H +#define _GWIN_OPTIONS_H + +/** + * @name    GWIN Functionality to be included + * @{ + */ +	/** +	 * @brief   Should window manager support be included +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_WINDOWMANAGER +		#define GWIN_NEED_WIDGET	FALSE +	#endif +	/** +	 * @brief	Should the widget hierarchy be included. This provides parent-child features. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_HIERARCHY +		#define GWIN_NEED_HIERARCHY	FALSE +	#endif +	/** +	 * @brief   Should widget functions be included. Needed for any widget (eg Buttons, Sliders etc) +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_WIDGET +		#define GWIN_NEED_WIDGET	FALSE +	#endif +	/** +	 * @brief	Should the frame widget be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_FRAME +		#define GWIN_NEED_FRAME		FALSE +	#endif +	/** +	 * @brief   Should console functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_CONSOLE +		#define GWIN_NEED_CONSOLE	FALSE +	#endif +	/** +	 * @brief   Should graph functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_GRAPH +		#define GWIN_NEED_GRAPH		FALSE +	#endif +	/** +	 * @brief   Should button functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_BUTTON +		#define GWIN_NEED_BUTTON	FALSE +	#endif +	/** +	 * @brief   Should slider functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_SLIDER +		#define GWIN_NEED_SLIDER	FALSE +	#endif +	/** +	 * @brief   Should checkbox functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_CHECKBOX +		#define GWIN_NEED_CHECKBOX	FALSE +	#endif +	/** +	 * @brief   Should image functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_IMAGE +		#define GWIN_NEED_IMAGE		FALSE +	#endif +	/** +	 * @brief   Should label functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_LABEL +		#define GWIN_NEED_LABEL		FALSE +	#endif +	/** +	 * @brief   Should radio button functions be included. +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_RADIO +		#define GWIN_NEED_RADIO		FALSE +	#endif +/** + * @} + * + * @name    GWIN Optional Parameters + * @{ + */ +	/** +	 * @brief   Buttons should not insist the mouse is over the button on mouse release +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_BUTTON_LAZY_RELEASE +		#define GWIN_BUTTON_LAZY_RELEASE		FALSE +	#endif +	/** +	 * @brief	Should the content of the console be saved for redrawing. +	 * @details	Defaults to FALSE +	 * @details	If this feature is enabled, the contents of the console will be saved +	 * 			as it is written. If a redraw is required it will be redrawn from the +	 * 			history. Scrolling will also use the history buffer if it is turned on. +	 * @note	Using this option allocates the amount of memory to store the +	 * 			history based on the minimum character width in the current font +	 * 			at the time the history is turned on. Using a fixed width font is a good +	 * 			idea to minimize memory usage. +	 * @note	If you change the size of the window or you change the font being displayed +	 * 			you should turn off the history and then turn it back on in order to get +	 * 			a new buffer of the correct size for the window/font combination. Strange +	 * 			redrawing and scrolling effects can occur if the buffer is too small to +	 * 			save a complete screen of data. Note the system tries to optimize storage +	 * 			so this may only be evident in very limited situations eg with a console +	 * 			with many characters in it. +	 * @note	@p gwinConsoleSetBuffer() can be used to turn the history buffer off and on. +	 */ +	#ifndef GWIN_CONSOLE_USE_HISTORY +		#define GWIN_CONSOLE_USE_HISTORY		FALSE +	#endif +	/** +	 * @brief	Use font width averaging for the history buffer allocation. +	 * @details	Defaults to FALSE +	 * @details	If this feature is enabled, the width one third of the way between +	 * 			the font's character width minimum and maximum will be used instead +	 * 			of the font's minimum width. +	 * @note	This option reduces the memory allocation for a variable width font's +	 * 			history buffer. Note that strange +	 * 			redrawing and scrolling effects can occur if the buffer is too small to +	 * 			save a complete screen of data. The system tries to optimize storage +	 * 			so this may only be evident in very limited situations eg with a console +	 * 			with many characters in it. +	 */ +	#ifndef GWIN_CONSOLE_HISTORY_AVERAGING +		#define GWIN_CONSOLE_HISTORY_AVERAGING	FALSE +	#endif +	/** +	 * @brief	Should the history be turned on for all console windows when they are first created. +	 * @details	Defaults to FALSE +	 * @note	@p gwinConsoleSetBuffer() can be used to turn the history buffer off and on at +	 * 			any time. +	 */ +	#ifndef GWIN_CONSOLE_HISTORY_ATCREATE +		#define GWIN_CONSOLE_HISTORY_ATCREATE	FALSE +	#endif +	/** +	 * @brief   Console Windows need floating point support in @p gwinPrintf +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_CONSOLE_USE_FLOAT +		#define GWIN_CONSOLE_USE_FLOAT			FALSE +	#endif +	/** +	 * @brief   Console Windows need BaseStreamSequential support (ChibiOS only) +	 * @details	Defaults to FALSE +	 * @note	To use the ChibiOS basestream functions such as chprintf() +	 * 			for printing in a console window you need to set this option to +	 * 			TRUE in your gfxconf.h and include in your application source file... +	 * 			\#include "chprintf.h" +	 * 			In your makefile, as part of your list of C source files, include +	 * 			${CHIBIOS}/os/various/chprintf.c +	 */ +	#ifndef GWIN_CONSOLE_USE_BASESTREAM +		#define GWIN_CONSOLE_USE_BASESTREAM		FALSE +	#endif +	/** +	 * @brief   Image windows can optionally support animated images +	 * @details	Defaults to FALSE +	 */ +	#ifndef GWIN_NEED_IMAGE_ANIMATION +		#define GWIN_NEED_IMAGE_ANIMATION		FALSE +	#endif +/** @} */ + +#endif /* _GWIN_OPTIONS_H */ +/** @} */  | 
