415 lines
13 KiB
C
415 lines
13 KiB
C
/*
|
|
* 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.io/license.html
|
|
*/
|
|
|
|
/**
|
|
* @file src/gwin/gwin_options.h
|
|
* @brief GWIN sub-system options header file.
|
|
*
|
|
* @addtogroup GWIN
|
|
* @brief The GWIN module uses all the other modules (GDISP, GINPUT, GTIMER...) to
|
|
* form a complete GUI toolkit.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _GWIN_OPTIONS_H
|
|
#define _GWIN_OPTIONS_H
|
|
|
|
/**
|
|
* @name GWIN Functionality to be included
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Should window manager support be included
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_WINDOWMANAGER
|
|
#define GWIN_NEED_WINDOWMANAGER GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the widget hierarchy be included. This provides parent-child features.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_CONTAINERS
|
|
#define GWIN_NEED_CONTAINERS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should widget functions be included. Needed for any widget (eg Buttons, Sliders etc)
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_WIDGET
|
|
#define GWIN_NEED_WIDGET GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief The width of the rectangle that highlights a widget that is focused
|
|
* @details Defaults to 1
|
|
*/
|
|
#ifndef GWIN_FOCUS_HIGHLIGHT_WIDTH
|
|
#define GWIN_FOCUS_HIGHLIGHT_WIDTH 1
|
|
#endif
|
|
/**
|
|
* @brief Should the simple container be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_CONTAINER
|
|
#define GWIN_NEED_CONTAINER GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the frame widget be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_FRAME
|
|
#define GWIN_NEED_FRAME GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should console functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_CONSOLE
|
|
#define GWIN_NEED_CONSOLE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should graph functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_GRAPH
|
|
#define GWIN_NEED_GRAPH GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should gl3d functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_GL3D
|
|
#define GWIN_NEED_GL3D GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should button functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_BUTTON
|
|
#define GWIN_NEED_BUTTON GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should progressbar functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_PROGRESSBAR
|
|
#define GWIN_NEED_PROGRESSBAR GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should slider functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_SLIDER
|
|
#define GWIN_NEED_SLIDER GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should checkbox functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_CHECKBOX
|
|
#define GWIN_NEED_CHECKBOX GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should image functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_IMAGE
|
|
#define GWIN_NEED_IMAGE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should label functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_LABEL
|
|
#define GWIN_NEED_LABEL GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should radio button functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_RADIO
|
|
#define GWIN_NEED_RADIO GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should list widget functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_LIST
|
|
#define GWIN_NEED_LIST GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should tabset functions be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_TABSET
|
|
#define GWIN_NEED_TABSET GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the virtual keyboard be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_KEYBOARD
|
|
#define GWIN_NEED_KEYBOARD GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the textedit widget be included.
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_TEXTEDIT
|
|
#define GWIN_NEED_TEXTEDIT GFXOFF
|
|
#endif
|
|
/**
|
|
* @}
|
|
*
|
|
* @name GWIN Optional Parameters
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Add a tag to each widget
|
|
* @details Defaults to GFXOFF
|
|
* @note Adds a tag member to each widget. Any events created include this tag.
|
|
* The enables switch based application logic to detect the event source.
|
|
*/
|
|
#ifndef GWIN_WIDGET_TAGS
|
|
#define GWIN_WIDGET_TAGS GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use flat styling for controls rather than a 3D look
|
|
* @details Defaults to GFXOFF
|
|
* @note This may appear better on color-restricted displays
|
|
* @note Flat styling is less graphics and cpu intensive (marginally) than the default 3D look.
|
|
*/
|
|
#ifndef GWIN_FLAT_STYLING
|
|
#define GWIN_FLAT_STYLING GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Don't use a timer for redrawing windows
|
|
* @details Defaults to GFXOFF
|
|
* @note Normally windows and widgets are redrawn on a timer. Setting this
|
|
* option causes them to be redrawn immediately. Note that this can
|
|
* cause extended blocking times on events and saves little code.
|
|
* @note If GWIN_NEED_WINDOWMANAGER is GFXOFF then this setting is ignored
|
|
* as redrawing always occurs immediately.
|
|
*/
|
|
#ifndef GWIN_REDRAW_IMMEDIATE
|
|
#define GWIN_REDRAW_IMMEDIATE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Redraw all windows in a single operation
|
|
* @details Defaults to GFXOFF
|
|
* @note Windows are normally redraw one per gtimer cycle.
|
|
* Setting this option causes all windows to be redrawn in
|
|
* a single gtimer cycle. Note that this can
|
|
* cause extended blocking times on the timer thread but may
|
|
* speed up redraw slightly.
|
|
* @note This is only relevant if GWIN_REDRAW_IMMEDIATE is GFXOFF.
|
|
* Everything always gets redrawn in a single operation if
|
|
* GWIN_REDRAW_IMMEDIATE is GFXON.
|
|
*/
|
|
#ifndef GWIN_REDRAW_SINGLEOP
|
|
#define GWIN_REDRAW_SINGLEOP GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Buttons should not insist the mouse is over the button on mouse release
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_BUTTON_LAZY_RELEASE
|
|
#define GWIN_BUTTON_LAZY_RELEASE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the content of the console be saved for redrawing.
|
|
* @details Defaults to GFXOFF
|
|
* @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 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Use font width averaging for the history buffer allocation.
|
|
* @details Defaults to GFXOFF
|
|
* @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 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the history be turned on for all console windows when they are first created.
|
|
* @details Defaults to GFXOFF
|
|
* @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 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Console Windows need floating point support in @p gwinPrintf
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_CONSOLE_USE_FLOAT
|
|
#define GWIN_CONSOLE_USE_FLOAT GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Console windows support escape sequences to control display
|
|
* @details Defaults to GFXOFF
|
|
*
|
|
* @note
|
|
* Currently supported:
|
|
* ESC color Change subsequent text color
|
|
* color: "0" = black, "1" = red, "2" = green, "3" = yellow, "4" = blue,
|
|
* "5" = magenta, "6" = cyan, "7" = white
|
|
* ESC C Revert subsequent text color to the window default
|
|
* ESC u Turn on underline
|
|
* ESC U Turn off underline
|
|
* ESC b Turn on bold
|
|
* ESC B Turn off bold
|
|
* ESC J Clear the window
|
|
*/
|
|
#ifndef GWIN_CONSOLE_ESCSEQ
|
|
#define GWIN_CONSOLE_ESCSEQ GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Console Windows need BaseStreamSequential support (ChibiOS only)
|
|
* @details Defaults to GFXOFF
|
|
* @note To use the ChibiOS basestream functions such as chprintf()
|
|
* for printing in a console window you need to set this option to
|
|
* GFXON 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 GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Image windows can optionally support animated images
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_IMAGE_ANIMATION
|
|
#define GWIN_NEED_IMAGE_ANIMATION GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Enable the API to use attributes in the label widget
|
|
* @details Defaults to GFXOFF
|
|
* @note Using this feature is discouraged. The proper (and faster as well
|
|
* as more efficient) way is to use two separate labels.
|
|
*/
|
|
#ifndef GWIN_LABEL_ATTRIBUTE
|
|
#define GWIN_LABEL_ATTRIBUTE GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Enable the API to use images in items in the list widget
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_NEED_LIST_IMAGES
|
|
#define GWIN_NEED_LIST_IMAGES GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Enable the API to automatically increment the progressbar over time
|
|
* @details Defaults to GFXOFF
|
|
*/
|
|
#ifndef GWIN_PROGRESSBAR_AUTO
|
|
#define GWIN_PROGRESSBAR_AUTO GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief Should the slider avoid snapping to a fixed position when the mouse is released
|
|
* @details Defaults to GFXOFF
|
|
* @note If GFXOFF the slider will snap to the closest set-able position when the
|
|
* mouse is released. If GFXON it will maintain the position the
|
|
* mouse was released at, except when at the minimum and maximum slider values.
|
|
*/
|
|
#ifndef GWIN_SLIDER_NOSNAP
|
|
#define GWIN_SLIDER_NOSNAP GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief The number of pixels of dead-band at each end of the slider
|
|
* @details Defaults to 5
|
|
* @note A dead-band is required because fingers can often cannot
|
|
* accurately control the slider peg at the edges of the slider
|
|
*/
|
|
#ifndef GWIN_SLIDER_DEAD_BAND
|
|
#define GWIN_SLIDER_DEAD_BAND 5
|
|
#endif
|
|
/**
|
|
* @brief How many toggles it takes to go from minimum to maximum value on a slider
|
|
* @details Defaults to 20
|
|
* @note When the slider is being operated by a toggle device this setting describes
|
|
* how many toggles are required to go from end to end.
|
|
*/
|
|
#ifndef GWIN_SLIDER_TOGGLE_INC
|
|
#define GWIN_SLIDER_TOGGLE_INC 20
|
|
#endif
|
|
/**
|
|
* @brief The height in pixels of a row of tabs in a tabset
|
|
* @details Defaults to 18
|
|
*/
|
|
#ifndef GWIN_TABSET_TABHEIGHT
|
|
#define GWIN_TABSET_TABHEIGHT 18
|
|
#endif
|
|
/**
|
|
* @brief Should flashing of widgets be supported
|
|
* @details Defaults to GFXOFF
|
|
* @pre Requires GWIN_NEED_WINDOWMANAGER to be GFXON
|
|
*/
|
|
#ifndef GWIN_NEED_FLASHING
|
|
#define GWIN_NEED_FLASHING GFXOFF
|
|
#endif
|
|
/**
|
|
* @brief What is the period for the flashing timer
|
|
* @details Defaults to 250 milliseconds
|
|
*/
|
|
#ifndef GWIN_FLASHING_PERIOD
|
|
#define GWIN_FLASHING_PERIOD 250
|
|
#endif
|
|
/**
|
|
* @brief The default keyboard layout for the virtual gwin keyboard
|
|
* @details Defaults to VirtualKeyboardLayout_English1
|
|
*/
|
|
#ifndef GWIN_KEYBOARD_DEFAULT_LAYOUT
|
|
#define GWIN_KEYBOARD_DEFAULT_LAYOUT VirtualKeyboard_English1
|
|
#endif
|
|
/**
|
|
* @}
|
|
*
|
|
* @name GWIN Virtual Keyboard Layouts
|
|
* @brief One or more of these may be defined. They will only be created if GWIN_NEED_KEYBOARD is GFXON.
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief The default keyboard layout for the virtual gwin keyboard
|
|
* @details Defaults to VirtualKeyboardLayout_English1
|
|
*/
|
|
#ifndef GWIN_NEED_KEYBOARD_ENGLISH1
|
|
#define GWIN_NEED_KEYBOARD_ENGLISH1 GFXON
|
|
#endif
|
|
/** @} */
|
|
|
|
#endif /* _GWIN_OPTIONS_H */
|
|
/** @} */
|