UM03001 emWin5.book
SEGGER Microcontroller GmbH & Co. KG
UM03001 emWin5 4 emWin
Graphic Library with Graphical User Interface User & Reference Guide
Document: UM03001 Software version: V5.20
Document revision: 2
Date: March 8, 2013
A product of SEGGER Microcontroller GmbH & Co. KG
www.segger.com
2
CHAPTER
Disclaimer
Specifications written in this document are believed to be accurate, but are not guaranteed to be entirely free of error. The information in this manual is subject to change for functional or performance improvements without notice. Please make sure your manual is the latest edition. While the information herein is assumed to be accurate, SEGGER Microcontroller GmbH & Co. KG (SEGGER) assumes no responsibility for any errors or omissions. SEGGER makes and you receive no warranties or conditions, express, implied, statutory or in any communication with you. SEGGER specifically disclaims any implied warranty of merchantability or fitness for a particular purpose.
Copyright notice
You may not extract portions of this manual or modify the PDF file in any way without the prior written permission of SEGGER. The software described in this document is furnished under a license and may only be used or copied in accordance with the terms of such a license. © 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG, Hilden / Germany
Trademarks
Names mentioned in this manual may be trademarks of their respective companies. Brand and product names are trademarks or registered trademarks of their respective holders.
Contact address
SEGGER Microcontroller GmbH & Co. KG In den Weiden 11 D-40721 Hilden Germany Tel.+49 2103-2878-0 Fax.+49 2103-2878-28 E-mail: support@segger.com Internet: http://www.segger.com
Manual versions
This manual describes the current software version. If any error occurs, inform us and we will try to assist you as soon as possible. Contact us for further information on topics or routines not yet specified. Print date: March 8, 2013
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
3
Software Rev. Date
5.20
2
130308
5.20
1
130305
5.20
0
130218
By
Description
Chapter 28 'Language Support' AS - New function GUI_LANG_GetTextBuffered() added.
- New function GUI_LANG_GetTextBufferedEx() added.
Chapter 19 'Skinning' AS - New function CHECKBOX_GetSkinFlexButtonSize() added.
- New function CHECKBOX_SetSkinFlexButtonSize() added.
Chapter 25 'Sprites'
- New function GUI_SPRITE_CreateHidden() added.
- New function GUI_SPRITE_CreateHiddenEx() added.
Chapter 29 'Display Drivers'
GUIDRV_FlexColor:
- Support for Himax HX8340 added to 66712.
- New module 66772 added wit support for:
Hitachi HD66772, Samsung S6D0117, Sitronix ST7712,
Himax HX8301, Ilitek ILI9220 and ILI9221
GUIDRV_SLin:
- Support for Epson S1D13305 added.
Chapter 30 'VNC-Server'
- New function GUI_VNC_SetLockFrame() added.
Chapter 32 'Timing and execution'
- New function GUI_Error() added.
Chapter 34 'Configuration'
JE
- New function GUI_SetOnErrorFunc() added. Chapter 25 'Sprites'
- New function GUI_SPRITE_CreateHidden() added.
- New function GUI_SPRITE_CreateHiddenEx() added.
Chapter 29 'Display Drivers'
GUIDRV_FlexColor:
- Support for Himax HX8340 added to 66712.
- New module 66772 added wit support for:
Hitachi HD66772, Samsung S6D0117, Sitronix ST7712,
Himax HX8301, Ilitek ILI9220 and ILI9221
GUIDRV_SLin:
- Support for Epson S1D13305 added.
Chapter 30 'VNC-Server'
- New function GUI_VNC_SetLockFrame() added.
Chapter 32 'Timing and execution'
- New function GUI_Error() added.
Chapter 34 'Configuration'
- New function GUI_SetOnErrorFunc() added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
4
CHAPTER
Software Rev. Date
5.18
0
120917
5.16
2
120809
5.16
1
120628
5.16
0
120605
By
Description
Chapter 8 'Displaying bitmap files'
- New function GUI_BMP_SerializeExBpp() added.
Chapter 9 'Bitmap Converter'
- New functions added to create animated sprites and cursors out
of animated GIF files.
Chapter 13 'Memory Devices'
- New function GUI_MEMDEV_SerializeBMP() added.
Chapter 15 'The Window Manager (WM)'
New function WM_SetCaptureMove() added.
New function WM_Screen2hWin() added.
New function WM_Screen2hWinEx() added.
Chapter 16 'Window Objects (Widgets)'
- New functions added:
TEXT_GetText()
LISTVIEW_SetWrapMode()
JE AS
Chapter 27 'Antialiasing' - New function GUI_AA_SetDrawMode() added. Chapter 28 'Foreign Language Support'
- New feature "Text- and language resource files" added.
Chapter 29 'Display drivers'
GUIDRV_FlexColor:
- Function GUIDRV_FlexColor_SetInterface66709_B16() replaced
by the function GUIDRV_FlexColor_SetReadFunc66709_B16().
- Function GUIDRV_FlexColor_SetInterface66720_B16() replaced
by the function GUIDRV_FlexColor_SetReadFunc66720_B16().
- New module 66702 added:
Solomon SSD1284, SSD1289, SSD1298
- New module 66715 added:
Himax HX8352B
- Recommended calling sequence for configuration functions
added.
GUIDRV_S1D13781:
- Additional information about initialized registers added.
Chapter 16 'Window Objects (Widgets)' AS - New function SPINBOX_SetRange() added.
Various corrections.
Chapter 15 'The Window Manager (WM)' Descriptions of the following functions reworked: - WM_GetScrollPosH() AS - WM_GetScrollPosV() - WM_SetScrollPosH() - WM_SetScrollPosV() Preface, About and Chapter 1 'Intro' reworked.
Chapter 12 'Colors'
JE AS
- New color conversion routine added to support 1bpp at different color depths.
Chapter 13 'Memory Devices'
- New function GUI_MEMDEV_RotateHQT() added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
5
Software Rev. Date
5.16
0
120605
By
Description
Chapter 15 'The Window Manager (WM)'
- Support for ToolTips added.
- New functions added:
WM_TOOLTIP_AddTool()
WM_TOOLTIP_Create()
WM_TOOLTIP_Delete()
WM_TOOLTIP_SetDefaultFont()
WM_TOOLTIP_SetDefaultColor()
WM_TOOLTIP_SetDefaultPeriod()
Chapter 16 'Window Objects (Widgets)'
- New functions added:
BUTTON_SetReactOnTouch()
DROPDOWN_SetUpMode()
ICONVIEW_EnableStreamAuto()
- Changed function SPINBOX_SetButtonSize():
New option SPINBOX_EDGE_CENTER.
Chapter 17 'Dialogs'
- CHOOSECOLOR dialog and functions added:
CHOOSECOLOR_Create()
CHOOSECOLOR_GetSel()
CHOOSECOLOR_SetSel()
CHOOSECOLOR_SetDefaultColor()
CHOOSECOLOR_SetDefaultSpace()
CHOOSECOLOR_SetDefaultBorder()
CHOOSECOLOR_SetDefaultButtonSize()
- CHOOSEFILE dialog and functions added:
CHOOSEFILE_Create()
CHOOSEFILE_EnableToolTips()
CHOOSEFILE_SetButtonText()
CHOOSEFILE_SetDefaultButtonText()
CHOOSEFILE_SetToolTips()
JE AS
CHOOSEFILE_SetTopMode() Chapter 23 'Pointer Input Devices' - New function GUI_PID_IsPressed() added.
Chapter 24 'Keyboard Input'
- New function GUI_GetKeyState() added.
Chapter 28 'Foreign Language Support'
- New function GUI_LANG_GetNumItems() added.
- New function GUI_LANG_GetText() added.
- New function GUI_LANG_GetTextEx() added.
- New function GUI_LANG_LoadCSV() added.
- New function GUI_LANG_LoadCSVEx() added.
- New function GUI_LANG_LoadText() added.
- New function GUI_LANG_LoadTextEx() added.
- New function GUI_LANG_SetLang() added.
- New function GUI_LANG_SetMaxNumLang() added.
- New function GUI_LANG_SetSep() added.
Chapter 29 'Display drivers'
- New display controller supported by
GUIDRV_SPage:
GUIDRV_SPage_Set1510:
Epson S1D15605, S1D15606, S1D15607,
S1D15608, S1D15705, S1D15710, S1D15714
Integrated Solutions Technology IST3020
New Japan Radio Company NJU6676
Novatek NT7502, NT7534, NT7538, NT75451
Samsung S6B0719, S6B0713, S6B0724, S6B1713
Sino Wealth SH1101A
Sitronix ST7522, ST7565, ST7567
Solomon SSD1303, SSD1805, SSD1815, SSD1821
Sunplus SPLC501C
UltraChip UC1608, UC1701, UC1601, UC1606
GUIDRV_SPage_Set1512:
Epson S1D15E05, S1D15E06, S1D15719, S1D15721
GUIDRV_SPage_SetST7591: Sitronix ST7591
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
6
CHAPTER
Software Rev. Date
5.16
0
120605
5.14
3
120202
5.14
2
120201
5.14
1
120124
5.14
0
120111
By
Description
Chapter 29 'Display drivers'
- New display controllers supported by GUIDRV_FlexColor:
66708: Ilitek ILI9335
66709: Ilitek ILI9338, ILI9340, ILI9341, ILI9342
66719: Samsung S6E63D6
- New function LCD_SetMaxNumColors() added.
JE AS
- Support for 1bpp added to GUIDRV_SPage. - Function GUIDRV_SPage_SetS1D15() obsolete
Replaced by GUIDRV_SPage_Set1512
- New variants GUIDRV_Lin added:
GUIDRV_LIN_OX_8
GUIDRV_LIN_OXY_8
- New driver GUIDRV_S1D13781 added.
New chapter 'Touch drivers' (30) added.
- New driver GUITDRV_ADS7846 added.
Chapter 29 'Display drivers'
- New display controller supported by
GUIDRV_FlexColor:
66709: Ilitek ILI9340
- New display controllers supported by
GUIDRV_SPage:
Epson S1D15605, S1D15606, S1D15607,
S1D15608, S1D15705, S1D15710, S1D15714
Integrated Solutions Technology IST3020
AS
New Japan Radio Company NJU6676
Novatek NT7502, NT7534, NT7538, NT75451
Samsung S6B0719, S6B0713, S6B0724, S6B1713
Sino Wealth SH1101A
Sitronix ST7522, ST7565, ST7567
Solomon SSD1805, SSD1303, SSD1815
UltraChip UC1608, UC1701, UC1601, UC1606
Sunplus SPLC501C
- New function GUIDRV_SPage_Set1510 added.
- New function GUIDRV_SPage_Set1512 added.
Chapter 8 'Displaying bitmaps files' - Improved description of how the 'GetData'-function
is used by emWin. Chapter 29 'Display drivers' - GUIDRV_SPage now supports 1bpp. AS - New display controllers supported by
GUIDRV_SPage: Epson S1D15E05, S1D15E06, S1D15719, S1D15721 Sitronix ST7591
- New function GUIDRV_SPage_SetST7591 added.
Chapter 16 'Window Objects (Widgets)' AS - New function EDIT_GetTextColor().
- New function SPINBOX_GetEditHandle().
Chapter 3 'Simulation'
- New function SIM_GUI_Enable() added.
Chapter 7 '2D Graphic Library'
- New functions added:
GUI_DrawStreamedBitmapAuto()
GUI_DrawStreamedBitmapExAuto()
JE AS
GUI_DrawStreamedBitmap24Ex() GUI_DrawStreamedBitmap555Ex() GUI_DrawStreamedBitmap565Ex()
GUI_DrawStreamedBitmapM555Ex()
GUI_DrawStreamedBitmapM565Ex()
Chapter 11 'Font Converter'
- Functions to size, shift and move characters added.
Chapter 12 'Colors'
- Sub chapter 'Gamma correction' added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
7
Software Rev. Date
5.14
0
120111
5.12
1
111021
5.12
0
110621
By
Description
Chapter 15 'The Window Manager (WM)'
- Change of the WM_MOVE message to transmit
position changes.
- New functions added:
WM_MOTION_Enable()
WM_MOTION_SetMovement()
WM_MOTION_SetDeceleration()
WM_MOTION_SetDefaultPeriod()
WM_MOTION_SetMotion()
WM_MOTION_SetMoveable()
WM_MOTION_SetSpeed()
Chapter 16 'Window Objects (Widgets)'
- New widget "SPINBOX" added.
- New widget "IMAGE" added.
- Return values added to the following functions:
BUTTON_SetText()
TEXT_SetText()
- New function DROPDOWN_GetItemText() added.
- New function EDIT_GetBkColor() added.
JE AS
- New function EDIT_SetBkColor() added. - New function EDIT_SetFocussable() added. - New function EDIT_GetFont() added.
- New function GUI_EditFloat() added.
- Listing of widget IDs added.
Chapter 25 'Sprites'
- New function GUI_SPRITE_CreateAnim() added.
- New function GUI_SPRITE_CreateExAnim() added.
Chapter 26 'Cursors'
- New function GUI_CURSOR_SelectAnim() added.
Chapter 29 'Display drivers'
- New display controllers supported by GUIDRV_FlexColor:
66708: FocalTech FT1509
66709: Renesas R61526
66709: Ilitek ILI9342
66712: Himax HX8347
66712: Himax HX8352
- New display controllers supported by
GUIDRV_CompactColor_16:
66708: FocalTech FT1509
66709: Renesas R61526
66709: Ilitek ILI9342
Font Converter documentation added as chapter 11.
- New function GUIDRV_FlexColor_SetFunc66712() added.
- New function GUIDRV_FlexColor_SetInterface66712B16()
added.
AS
- New display controller supported by GUIDRV_07X1: 741: Novatek NT7508
- New display controller supported by GUIDRV_Page1bpp:
1510: Solomon SSD1821
- GUIDRV_Lin 'Using the Lin driver in systems with cache memory'
changed.
Chapter 16 'Window Objects (Widgets)' - New function LISTVIEW_SetHeaderHeight() added. - New function ICONVIEW_AddStreamedBitmapItem() added. - New function ICONVIEW_GetItemText() added. - New function ICONVIEW_GetItemUserData() added. - New function ICONVIEW_GetNumItems() added. - New function ICONVIEW_InsertBitmapItem() added. AS - New function ICONVIEW_InsertStreamedBitmapItem() added. JE - New function ICONVIEW_SetBitmapItem() added. - New function ICONVIEW_SetFrame() added. - New function ICONVIEW_SetItemText() added. - New function ICONVIEW_SetItemUserData() added. - New function ICONVIEW_SetSpace() added. - New function ICONVIEW_SetStreamedBitmapItem() added. - New function ICONVIEW_SetTextAlign() added. - New function TEXT_GetNumLines() added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
8
CHAPTER
Software Rev. Date
5.12
0
110621
5.10
1
110531
5.10
0
110329
5.08
0
110112
By
Description
Chapter 29 'Display Drivers' - New display drivers added:
GUIDRV_Dist GUIDRV_SPage AS - New display controller supported by JE GUIDRV_CompactColor_16: 66709: Solomon SSD1961 - LCD_SetDevFunc(): LCD_DEVFUNC_COPYRECT added. - GUIDRV_Lin: Support for LCD_DEVFUNC_COPYRECT added.
AS Chapter 29 'Display Drivers JE - New display driver: GUIDRV_FlexColor
Chapter 13 'Memory Devices'
- Default for GUI_USE_MEMDEV_1BPP_FOR_SCREEN set to 1.
- New function GUI_MEMDEV_MarkDirty() added.
New Chapter 18 'GUIBuilder' added.
AS JE
Chapter 29 'Display Drivers' - New display controllers supported by
GUIDRV_CompactColor_16:
66708: Ilitek ILI9328
66709: Sitronix ST7715
66772: Ilitek ILI9221
- New function GUIDRV_BitPlains_Config() added.
Chapter 9 '2D Graphic Library'
- New function GUI_CreateBitmapFromStreamRLEAlpha() added.
- New function GUI_CreateBitmapFromStreamRLE32() added.
- Function GUI_CreateBitmapFromStream() supports additional
formats.
Chapter 12 'Bitmap Converter'
- New format 'Alpha channel, compressed' added.
- New format 'True color with alpha channel, compressed' added.
- New function 'Image/Convert Into/Best Palette + transparency'
added.
Chapter 14 'Memory Devices'
- New functions GUI_MEMDEV_SetAnimationCallback() added.
- New functions GUI_MEMDEV_ShiftInWindow() added.
- New functions GUI_MEMDEV_ShiftOutWindow() added.
Chapter 15 'Execution Model'
- New function GUI_SetSignalEventFunc() added.
- New function GUI_SetWaitEventFunc() added.
- New function GUI_SetWaitEventTimedFunc() added.
AS JE
- Definitions of configuration macros changed. Chapter 16 'Window Manager' - New function WM_MULTIBUF_Enable() added.
- New messages WM_PRE_PAINT and WM_POST_PAINT added.
Chapter 17 'Widgets'
- LISTVIEW_SetUserData() renamed in
LISTVIEW_SetUserDataRow().
- LISTVIEW_GetUserData() renamed in
LISTVIEW_GetUserDataRow().
- New function <WIDGET>_SetUserData() added for all widgets.
- New function <WIDGET>_GetUserData() added for all widgets.
- New function <WIDGET>_CreateUser() added for all widgets.
- New function BUTTON_GetTextAlign() added.
- New function BUTTON_SetReactOnLevel() added.
- New function ICONVIEW_CreateIndirect() added.
- New function ICONVIEW_DeleteItem() added.
- New function LISTWHEEL_CreateIndirect() added.
- New function SCROLLBAR_SetThumbSizeMin() added.
- New function SCROLLBAR_GetThumbSizeMin() added.
- New function TREEVIEW_ITEM_CollapseAll() added.
- New function TREEVIEW_ITEM_ExpandAll() added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
9
Software Rev. Date
5.08
0
110112
5.06
0
100907
5.04
2
100526
5.04
1
100505
5.04
0
100104
By
Description
Chapter 19 'Skinning' - New configuration macro WIDGET_USE_FLEX_SKIN added. - New message WIDGET_ITEM_GET_RADIUS added to
frame window skin. AS Chapter 20 'Multiple buffering'. JE - New function GUI_MULTIBUF_Begin() added.
- New function GUI_MULTIBUF_End() added. - New function GUI_MULTIBUF_Config() added. Chapter 28 'Foreign Language Support' - New function GUI_UC_EnableBIDI() added.
Chapter 9 'Fonts':
- New function GUI_SetDefaultFont() added.
Chapter 12 'Memory Devices':
- New function GUI_MEMDEV_FadeDevices() added.
Chapter 15 'Widgets':
- New functions added:
BUTTON_SetReactOnLevel()
GRAPH_DATA_XY_SetOwnerDraw()
JE
LISTVIEW_SetItemBitmap() LISTWHEEL_SetPos()
SCROLLBAR_GetNumItems()
SCROLLBAR_GetPageSize()
New chapter 17 'Skinning':
- Skinning for the most common widgets added.
Chapter 26 'Display Driver':
- New function GUI_SetOrientation() added.
- New OXY-orientations for 16, 24 and 32 bpp added to
GUIDRV_Lin.
Chapter 'Widgets':
- New function GRAPH_DATA_XY_SetOwnerDraw() added.
- New function LISTVIEW_SetItemBitmap() added.
Chapter 'Fonts':
- New function GUI_SetDefaultFont() added.
Chapter '2-D Graphic Library':
- New function GUI_GetPixelIndex() added.
Chapter 'Execution Model':
AS
GUITASK_SetMaxTask() - GUIDRV_CompactColor_16:
Support for the following display controllers added:
Himax HX8353
LGDP4551
Orisetech SPFD54124C
Renesas R61505
Sitronix ST7735, ST7787
Solomon SSD1284, SSD2119
- Added driver macros to each driver which uses them.
New Drivers 'GUIDRV_S1D15G00' and 'GUIDRV_SLin' added.
Various corrections
Chapter '2-D Graphic Library':
- New function GUI_DrawGradientRoundedV()
- New function GUI_DrawGradientRoundedH()
- New function GUI_DrawRoundedFrame()
AS
Chapter 'Memory Devices': - New function GUI_MEMDEV_MoveInWindow()
- New function GUI_MEMDEV_MoveOutWindow()
- New function GUI_MEMDEV_FadeInWindow()
- New function GUI_MEMDEV_FadeOutWindow()
Chapter 'Simulation'
- New function SIM_GUI_SetCallback()
- New function SIM_GUI_ShowDevice()
Chapter 5 'Displaying Text': JE - New function GUI_DispStringInRectWrap() added.
- New function GUI_WrapGetNumLines() added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
10
CHAPTER
Software Rev. Date
5.04
0
100104
5.00
1
090409
5.00
0
090326
By
Description
Chapter 7 '2-D Graphic Library':
- New function GUI_EnableAlpha() added.
- New function GUI_RestoreUserAlpha() added.
- New function GUI_SetUserAlpha() added.
- New function GUI_CreateBitmapFromStream() added.
- New function GUI_DrawStreamedBitmapEx() added.
- New function GUI_GetStreamedBitmapInfo() added.
- New function GUI_GetStreamedBitmapInfoEx() added.
- New function GUI_SetStreamedBitmapHook() added.
- New function GUI_CreateBitmapFromStreamIDX() added.
- New function GUI_CreateBitmapFromStreamRLE4() added.
- New function GUI_CreateBitmapFromStreamRLE8() added.
- New function GUI_CreateBitmapFromStream565() added.
- New function GUI_CreateBitmapFromStreamM565() added.
- New function GUI_CreateBitmapFromStream555() added.
- New function GUI_CreateBitmapFromStreamM555() added.
- New function GUI_CreateBitmapFromStreamRLE16() added.
- New function GUI_CreateBitmapFromStreamRLEM16() added.
- New function GUI_CreateBitmapFromStream24() added.
- New function GUI_CreateBitmapFromStreamAlpha() added.
Chapter 9 'Fonts':
- New font F20F_ASCII (framed) added.
- New fonts F6x8_ASCII and F6x8_1 added.
- New fonts F8x8_ASCII and F8x8_1 added.
- New fonts F8x16_ASCII and F8x16_1 added.
- Support for new font formats extended AA2 and extended AA4
added.
Chapter 12 'Memory Devices':
- Considerations for multiple layers/displays added.
JE
Chapter 14 'Window Manager': - WM_DeleteWindow() now also deletes any associated timer.
Chapter 15 'Widgets':
- New function WINDOW_SetBkColor() added.
Chapter 19 'Pointer Input Devices':
- PID buffer added.
- Explanation of touch calibration revised.
Chapter 20 'Keyboard':
- Keyboard buffer added.
Chapter 25 'Display Driver':
- New driver GUIDRV_BitPlains added.
- New driver GUIDRV_SLin added.
- New driver GUIDRV_SSD1926 added.
- Driver GUIDRV_1611 added.
- Driver GUIDRV_6331 added.
- Driver GUIDRV_7529 added.
- Driver GUIDRV_Page1bpp added.
- GUIDRV_CompactColor_16:
Support for the following display controllers added:
Himax HX8340, HX8352
Solomon SSD1298, SSD1355, SSD1963
Epson S1D19122
Orisetech SPFD5414D
Ilitek ILI9320, ILI9326
Chapter 26 'VNC Server':
- New function GUI_VNC_EnableKeyboardInput()
- New function GUI_VNC_GetNumConnections()
- New function GUI_VNC_SetPassword()
- New function GUI_VNC_SetProgName()
- New function GUI_VNC_SetSize()
- New function GUI_VNC_RingBell()
Chapter 3 'Simulator':
JE
- Completely revised. Chapter 8 'Displaying bitmap files'
- PNG support added.
Software has been completely revised. JE For the version history of earlier versions, refer to older docu-
ments.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
11
About this document
Assumptions
This document assumes that you already have a solid knowledge of the following:
· The software tools used for building your application (assembler, linker, C compiler)
· The C programming language · The target processor · DOS command line
If you feel that your knowledge of C is not sufficient, we recommend The C Programming Language by Kernighan and Richie (ISBN 0-13-1103628), which describes the standard in C-programming and, in newer editions, also covers the ANSI C standard.
How to use this manual
This manual explains all the functions and macros that the product offers. It assumes you have a working knowledge of the C language. Knowledge of assembly programming is not required.
Typographic conventions for syntax
This manual uses the following typographic conventions:
Style
Used for
Body
Keyword
Body text.
Text that you enter at the command-prompt or that appears on the display (that is system functions, file- or pathnames).
Parameter
Parameters in API functions.
Sample Sample comment
Example code in program examples. Comments in program examples.
New Example Reference
Example code that has been added to an existing program example. Reference to chapters, sections, tables and figures or other documents.
GUIElement
Warning
Buttons, dialog boxes, menu names, menu commands. Important cautions or reminders.
Emphasis
Very important sections.
Table 0.1: Typographic conventions
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
12
SEGGER Microcontroller GmbH & Co. KG develops and distributes software development tools and ANSI C software components (middleware) for embedded systems in several industries such as telecom, medical technology, consumer electronics, automotive industry and industrial automation.
SEGGER's intention is to cut software development time for embedded applications by offering compact flexible and easy to use middleware, allowing developers to concentrate on their application.
Our most popular products are emWin, a universal graphic software package for embedded applications, and embOS, a small yet efficient real-time kernel. emWin, written entirely in ANSI C, can easily be used on any CPU and most any display. It is complemented by the available PC tools: Bitmap Converter, Font Converter, Simulator and Viewer. embOS supports most 8/16/32-bit CPUs. Its small memory footprint makes it suitable for single-chip applications.
Apart from its main focus on software tools, SEGGER develops and produces programming tools for flash micro controllers, as well as J-Link, a JTAG emulator to assist in development, debugging and production, which has rapidly become the industry standard for debug access to ARM cores.
Corporate Office: http://www.segger.com
United States Office: http://www.segger-us.com
EMBEDDED SOFTWARE (Middleware)
emWin
Graphics software and GUI emWin is designed to provide an efficient, processor- and display controller-independent graphical user interface (GUI) for any application that operates with a graphical display.
embOS
Real Time Operating System embOS is an RTOS designed to offer the benefits of a complete multitasking system for hard real time applications with minimal resources.
embOS/IP
TCP/IP stack embOS/IP a high-performance TCP/IP stack that has been optimized for speed, versatility and a small memory footprint.
emFile
File system emFile is an embedded file system with FAT12, FAT16 and FAT32 support. Various Device drivers, e.g. for NAND and NOR flashes, SD/MMC and CompactFlash cards, are available.
USB-Stack
USB device/host stack A USB stack designed to work on any embedded system with a USB controller. Bulk communication and most standard device classes are supported.
SEGGER TOOLS
Flasher
Flash programmer Flash Programming tool primarily for micro controllers.
J-Link
JTAG emulator for ARM cores USB driven JTAG interface for ARM cores.
J-Trace
JTAG emulator with trace USB driven JTAG interface for ARM cores with Trace memory. supporting the ARM ETM (Embedded Trace Macrocell).
J-Link / J-Trace Related Software
Add-on software to be used with SEGGER's industry standard JTAG emulator, this includes flash programming software and flash breakpoints.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
13
Table of Contents
1 Introduction to emWin ....................................................................................................29
1.1 1.2 1.2.1 1.2.2 1.3 1.4 1.5 1.6 1.7 1.8
Purpose of this document ......................................................................... 29 Requirements.......................................................................................... 29 Target system (hardware) ........................................................................ 29 Development environment (compiler)......................................................... 30 Features................................................................................................. 30 Examples and demos ............................................................................... 31 Starter kits ............................................................................................. 31 Screen and coordinates ............................................................................ 32 How to connect the display to the micro controller ....................................... 32 Data types.............................................................................................. 33
2 Getting Started...............................................................................................................35
2.1 2.1.1 2.1.2 2.2 2.3 2.3.1 2.4 2.5 2.6 2.7 2.8
Recommended project structure ................................................................ 36 Subdirectories ......................................................................................... 36 Include directories ................................................................................... 36 Adding emWin to the target program ......................................................... 37 Creating a library..................................................................................... 37 Adapting the library batch files to a different system .................................... 38 C files to include in the project .................................................................. 39 Configuring emWin .................................................................................. 40 Initializing emWin .................................................................................... 40 Using emWin with target hardware ............................................................ 41 The "Hello world" example program ........................................................... 42
3 Simulation ......................................................................................................................43
3.1 3.1.1 3.1.1.1 3.1.1.2 3.1.1.3 3.1.1.4 3.1.2 3.1.2.1 3.1.2.2 3.1.2.3 3.1.3 3.1.3.1 3.1.3.2 3.1.3.3 3.2 3.2.1 3.2.2 3.2.3 3.3 3.4 3.4.1 3.5 3.5.1 3.5.2
Using the simulation ................................................................................ 44 Using the simulation with the trial version of emWin..................................... 44 Directory structure................................................................................... 44 Visual C++ workspace.............................................................................. 44 Compiling the demo program .................................................................... 45 Compiling the examples ........................................................................... 45 Using the simulation with the emWin source................................................ 46 Directory structure................................................................................... 46 Visual C++ workspace.............................................................................. 46 Compiling the application.......................................................................... 47 Advanced features of the simulation........................................................... 47 Pause and Resume .................................................................................. 47 View system info ..................................................................................... 47 Copy to clipboard .................................................................................... 47 Device simulation .................................................................................... 48 Generated frame view .............................................................................. 49 Custom bitmap view ................................................................................ 49 Window view........................................................................................... 50 Device simulation API............................................................................... 51 Hardkey simulation .................................................................................. 56 Hardkey simulation API ............................................................................ 57 Integrating the emWin simulation into an existing simulation......................... 60 Directory structure................................................................................... 60 Using the simulation library....................................................................... 60
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
14
3.5.2.1 3.5.2.2 3.5.3 3.5.3.1 3.5.3.2 3.5.4
Modifying WinMain .................................................................................. 60 Example application................................................................................. 61 Integration into the embOS Simulation....................................................... 62 WinMain................................................................................................. 62 Target program (main) ............................................................................ 64 GUI simulation API .................................................................................. 65
4 Viewer ............................................................................................................................69
4.1 4.1.1 4.1.2 4.1.3 4.1.4 4.1.5 4.1.6 4.1.7 4.1.8
Using the viewer ..................................................................................... 70 Using the simulation and the viewer .......................................................... 70 Using the viewer with virtual pages ........................................................... 71 Always on top ......................................................................................... 71 Open further windows of the display output ................................................ 71 Zooming ................................................................................................ 71 Copy the output to the clipboard ............................................................... 72 Using the viewer with multiple displays ...................................................... 73 Using the viewer with multiple layers ......................................................... 73
5 Displaying Text ..............................................................................................................75
5.1
Basic routines ......................................................................................... 76
5.2
Text API................................................................................................. 77
5.3
Routines to display text............................................................................ 78
5.4
Selecting text drawing modes ................................................................... 85
5.5
Selecting text alignment........................................................................... 87
5.6
Setting the current text position ................................................................ 89
5.7
Retrieving the current text position............................................................ 90
5.8
Routines to clear a window or parts of it..................................................... 90
6 Displaying Values ..........................................................................................................91
6.1
Value API ............................................................................................... 92
6.2
Displaying decimal values......................................................................... 93
6.3
Displaying floating point values ................................................................. 97
6.4
Displaying binary values..........................................................................100
6.5
Displaying hexadecimal values .................................................................101
6.6
Version of emWin ...................................................................................102
7 2-D Graphic Library......................................................................................................103
7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 7.9 7.10 7.11 7.12 7.13 7.14 7.15 7.16 7.17
Graphic API ...........................................................................................104 Drawing modes......................................................................................107 Query current client rectangle ..................................................................108 Pen size ................................................................................................109 Basic drawing routines ............................................................................110 Alpha blending.......................................................................................116 Drawing bitmaps ....................................................................................119 Drawing streamed bitmaps ......................................................................122 Drawing lines.........................................................................................129 Drawing polygons...................................................................................133 Drawing circles ......................................................................................138 Drawing ellipses.....................................................................................139 Drawing arcs .........................................................................................140 Drawing graphs .....................................................................................142 Drawing pie charts .................................................................................143 Saving and restoring the GUI-context .......................................................144 Clipping ................................................................................................145
8 Displaying bitmap files .................................................................................................147
8.1 8.1.1 8.1.2
BMP file support .....................................................................................148 Supported formats .................................................................................148 BMP file API...........................................................................................148
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
15
8.2 8.2.1 8.2.2 8.2.3 8.2.4 8.2.5 8.2.6 8.3 8.3.1 8.3.2 8.3.3 8.3.4 8.4 8.4.1 8.4.2 8.4.3 8.4.4 8.5
JPEG file support ................................................................................... 155 Supported JPEG compression methods ..................................................... 155 Converting a JPEG file to C source............................................................ 155 Displaying JPEG files .............................................................................. 155 Memory usage ...................................................................................... 156 Progressive JPEG files ............................................................................ 156 JPEG file API ......................................................................................... 156 GIF file support ..................................................................................... 161 Converting a GIF file to C source ............................................................. 161 Displaying GIF files ................................................................................ 161 Memory usage ...................................................................................... 161 GIF file API ........................................................................................... 162 PNG file support .................................................................................... 170 Converting a PNG file to C source ............................................................ 170 Displaying PNG files ............................................................................... 170 Memory usage ...................................................................................... 170 PNG file API .......................................................................................... 170 Getting data with the ...Ex() functions ...................................................... 174
9 Bitmap Converter .........................................................................................................177
9.1 9.2 9.2.1 9.2.2 9.2.3 9.3 9.4 9.4.1 9.4.2 9.4.3 9.4.4 9.5 9.5.1 9.5.2 9.5.3 9.5.4 9.5.5 9.5.6 9.6 9.7 9.8 9.9 9.9.1 9.9.2 9.10
What it does ......................................................................................... 178 Loading a bitmap................................................................................... 179 Supported input file formats.................................................................... 179 Loading from a file................................................................................. 179 Using the clipboard ................................................................................ 179 Color conversion.................................................................................... 180 Using a custom palette ........................................................................... 181 Saving a palette file ............................................................................... 181 Palette file format .................................................................................. 181 Palette files for fixed palette modes.......................................................... 181 Converting a bitmap .............................................................................. 182 Generating C files from bitmaps............................................................... 182 Supported bitmap formats ...................................................................... 182 Palette information ................................................................................ 182 Transparency ........................................................................................ 183 Alpha blending ...................................................................................... 183 Selecting the best format........................................................................ 184 Saving the file ....................................................................................... 185 Generating C stream files ....................................................................... 186 Compressed bitmaps.............................................................................. 187 Creating animated sprites / cursors.......................................................... 187 Command line usage.............................................................................. 190 Format for commands ............................................................................ 190 Valid command line options..................................................................... 190 Example of a converted bitmap ............................................................... 192
10 Fonts ..........................................................................................................................195
10.1 10.2 10.3 10.3.1 10.3.2 10.3.3 10.3.4 10.3.5 10.4 10.5 10.6 10.7 10.8
Introduction.......................................................................................... 196 Font types ............................................................................................ 196 Font formats ......................................................................................... 198 C file format ......................................................................................... 198 System Independent Font (SIF) format..................................................... 198 External Bitmap Font (XBF) format .......................................................... 199 iType font engine support ....................................................................... 200 TrueType Font (TTF) format .................................................................... 201 Converting a TTF file to C source ............................................................. 202 Declaring custom fonts ........................................................................... 202 Selecting a font ..................................................................................... 202 Font API ............................................................................................... 203 C file related font functions ..................................................................... 204
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
16
10.9
'SIF' file related font functions..................................................................205
10.10
'TTF' file related font functions .................................................................207
10.11
'XBF' file related font functions.................................................................210
10.12
Common font-related functions ................................................................212
10.13
Character sets .......................................................................................216
10.13.1 ASCII ...................................................................................................216
10.13.2 ISO 8859-1 Western Latin character set ....................................................216
10.13.3 Unicode ................................................................................................218
10.14
Font Converter.......................................................................................219
10.14.1 Adding fonts ..........................................................................................219
10.15
Standard fonts.......................................................................................220
10.15.1 Font identifier naming convention.............................................................220
10.15.2 Font file naming convention .....................................................................221
10.15.3 Measurement, ROM-size and character set of fonts .....................................221
10.15.4 Proportional fonts...................................................................................222
10.15.4.1 Overview ..............................................................................................222
10.15.4.2 Measurement, ROM size and used files ......................................................222
10.15.4.3 Characters ............................................................................................224
10.15.5 Proportional fonts, framed .......................................................................230
10.15.5.1 Overview ..............................................................................................230
10.15.5.2 Measurement, ROM size and used files ......................................................230
10.15.5.3 Characters ............................................................................................230
10.15.6 Monospaced fonts ..................................................................................231
10.15.6.1 Overview ..............................................................................................231
10.15.6.2 Measurement, ROM size and used files ......................................................232
10.15.6.3 Characters ............................................................................................233
10.15.7 Digit fonts (proportional).........................................................................238
10.15.7.1 Overview ..............................................................................................238
10.15.7.2 Measurement, ROM size and used files ......................................................238
10.15.7.3 Characters ............................................................................................238
10.15.8 Digit fonts (monospaced) ........................................................................240
10.15.8.1 Overview ..............................................................................................240
10.15.8.2 Measurement, ROM size and used files ......................................................240
10.15.8.3 Characters ............................................................................................240
11 Font Converter ...........................................................................................................243
11.1 11.2 11.2.1 11.2.2 11.2.2.1 11.2.2.2 11.2.2.3 11.2.3 11.2.3.1 11.2.3.2 11.2.3.3 11.2.4 11.2.4.1 11.2.4.2 11.2.4.3 11.2.4.4 11.2.4.5 11.2.4.6 11.3 11.3.1 11.3.1.1 11.3.1.2 11.3.1.3 11.3.2 11.3.3
Requirements ........................................................................................244 Using the Font Converter.........................................................................245 Creating an emWin font file from a Windows font .......................................245 Font generation options dialog .................................................................247 Type of font to generate..........................................................................247 Encoding ...............................................................................................248 Antialiasing ...........................................................................................248 Font Dialog............................................................................................248 Font, Font Style, and Size .......................................................................249 Script ...................................................................................................249 Unit of Size ...........................................................................................249 User Interface........................................................................................249 Selecting the current character ................................................................249 Toggling character status ........................................................................249 Selecting pixels......................................................................................250 Modifying character bits ..........................................................................250 Operations ............................................................................................250 Modifying the viewing mode ....................................................................251 Options.................................................................................................251 Saving the font ......................................................................................252 Creating a C file .....................................................................................252 Creating a System Independent Font (SIF) ................................................253 Creating an External Binary Font (XBF) .....................................................253 Modifying an existing C font file................................................................254 Merging fonts with existing C font files ......................................................255
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
17
11.4 11.4.1 11.4.2 11.4.3 11.5 11.5.1 11.5.2 11.6 11.6.1 11.6.2 11.7 11.7.1 11.8 11.9 11.10
Pattern files .......................................................................................... 256 Creating pattern files using Notepad......................................................... 256 Creating pattern files using the Font Converter .......................................... 256 Enabling characters using a pattern file .................................................... 256 Supported output modes ........................................................................ 256 Standard mode ..................................................................................... 257 Antialiased modes.................................................................................. 257 Command line options............................................................................ 258 Table of commands................................................................................ 258 Execution examples ............................................................................... 259 Font Examples ...................................................................................... 260 Resulting C code, standard mode ............................................................. 260 Resulting C code, 2 bpp antialiased mode ................................................. 261 Resulting C code, 4 bpp antialiased mode ................................................. 262 Resulting C code, extended mode ............................................................ 263
12 Colors.........................................................................................................................265
12.1 12.2 12.3 12.4 12.5 12.6 12.7 12.8 12.8.1 12.8.2
Predefined colors ................................................................................... 266 The color bar test routine ....................................................................... 266 Fixed palette modes............................................................................... 267 Detailed fixed palette mode description .................................................... 268 Application defined color conversion ......................................................... 279 Custom palette mode ............................................................................. 280 Gamma correction ................................................................................. 280 Color API .............................................................................................. 281 Basic color functions .............................................................................. 282 Index & color conversion ........................................................................ 284
13 Memory Devices ........................................................................................................287
13.1 13.2 13.3 13.4 13.5 13.6 13.7 13.8 13.9 13.10 13.10.1 13.11 13.12 13.13 13.14 13.15 13.16 13.17
Using Memory Devices: an illustration ...................................................... 288 Supported color depth (bpp) ................................................................... 288 Memory Devices and the Window Manager ................................................ 289 Memory Devices and multiple layers......................................................... 289 Memory requirements ............................................................................ 289 Performance ......................................................................................... 290 Basic functions ...................................................................................... 291 In order to be able to use Memory Devices................................................ 291 Multi layer / multi display configurations ................................................... 291 Configuration options ............................................................................. 291 GUI_USE_MEMDEV_1BPP_FOR_SCREEN ................................................... 291 Memory device API ................................................................................ 292 Basic functions ...................................................................................... 293 Banding Memory Device ......................................................................... 307 Auto device object ................................................................................. 308 Measurement device object..................................................................... 311 Animation functions ............................................................................... 313 Animation functions (Window Manager required)........................................ 314
14 Execution Model: Single Task / Multitask ..................................................................319
14.1 14.2 14.2.1 14.2.2 14.2.3 14.2.4 14.2.5 14.2.6 14.3 14.3.1 14.3.2
Supported execution models ................................................................... 320 Single task system (superloop)................................................................ 320 Description ........................................................................................... 320 Superloop example (without emWin) ........................................................ 320 Advantages........................................................................................... 320 Disadvantages ...................................................................................... 320 Using emWin......................................................................................... 320 Superloop example (with emWin) ............................................................ 321 Multitask system: one task calling emWin ................................................. 321 Description ........................................................................................... 321 Advantages........................................................................................... 321
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
18
14.3.3 14.3.4 14.4 14.4.1 14.4.2 14.4.3 14.4.4 14.4.5 14.4.6 14.5 14.6 14.7 14.7.1
Disadvantages .......................................................................................321 Using emWin .........................................................................................321 Multitask system: multiple tasks calling emWin ..........................................322 Description ............................................................................................322 Advantages ...........................................................................................322 Disadvantages .......................................................................................322 Using emWin .........................................................................................322 Recommendations ..................................................................................322 Example ...............................................................................................322 Configuration functions for multitasking support .........................................323 Configuration macros for multitasking support ...........................................325 Kernel interface API................................................................................326 Examples ..............................................................................................329
15 The Window Manager (WM) ......................................................................................331
15.1 15.2 15.2.1 15.2.2 15.2.3 15.2.4 15.2.5 15.2.6 15.2.7 15.2.8 15.2.9 15.2.10 15.3 15.3.1 15.3.2 15.3.2.1 15.3.2.2 15.3.3 15.3.3.1 15.4 15.4.1 15.4.2 15.4.2.1 15.4.2.2 15.5 15.5.1 15.5.2 15.5.3 15.5.4 15.5.5 15.5.6 15.6 15.7 15.7.1 15.8 15.9 15.10 15.11 15.12 15.13 15.14
Description of terms ...............................................................................332 Callback mechanism, invalidation, rendering and keyboard input ..................333 Rendering without callbacks.....................................................................333 Rendering using callbacks .......................................................................334 Overwriting callback functions..................................................................334 Background window redrawing and callback...............................................335 Invalidation ...........................................................................................336 Rendering of transparent windows ............................................................336 Automatic use of memory devices ............................................................336 Automatic use of multiple frame buffers ....................................................336 Automatic use of display driver cache .......................................................337 Keyboard input ......................................................................................337 Motion support.......................................................................................337 Enabling motion support of the WM ..........................................................337 Basic motion support for a window ...........................................................337 Using creation flags ................................................................................337 Using API function ..................................................................................337 Advanced motion support ........................................................................338 WM_MOTION message and WM_MOTION_INFO..........................................338 ToolTips ................................................................................................339 How they work.......................................................................................339 Creating ToolTips ...................................................................................339 Creating ToolTips for dialog items.............................................................339 Creating ToolTips for simple windows........................................................340 Messages ..............................................................................................340 Message structure ..................................................................................340 List of messages ....................................................................................341 System-defined messages .......................................................................342 Pointer input device (PID) messages .........................................................346 System-defined notification codes ............................................................350 Application-defined messages ..................................................................350 Configuration options..............................................................................351 WM API.................................................................................................352 Using the WM API functions .....................................................................354 WM API: Basic functions..........................................................................355 WM API: Motion support..........................................................................385 WM API: ToolTip related functions ............................................................389 WM API: Memory device support (optional) ...............................................392 WM API: Timer related functions ..............................................................393 WM API: Widget related functions.............................................................395 Example ...............................................................................................399
16 Window Objects (Widgets).........................................................................................401
16.1 16.1.1
Some basics ..........................................................................................402 Available widgets ...................................................................................402
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
19
16.1.2 Understanding the redrawing mechanism.................................................. 403
16.1.3 How to use widgets................................................................................ 403
16.2
Configuration options ............................................................................. 405
16.3
Widget IDs ........................................................................................... 406
16.4
General widget API ................................................................................ 406
16.4.1 WM routines used for widgets.................................................................. 406
16.4.2 Common routines .................................................................................. 406
16.4.3 User drawn widgets ............................................................................... 410
16.5
BUTTON: Button widget.......................................................................... 412
16.5.1 Configuration options ............................................................................. 412
16.5.2 Predefined IDs ...................................................................................... 413
16.5.3 Notification codes .................................................................................. 413
16.5.4 Keyboard reaction ................................................................................. 413
16.5.5 BUTTON API ......................................................................................... 413
16.5.6 Examples ............................................................................................. 426
16.6
CHECKBOX: Checkbox widget ................................................................. 428
16.6.1 Configuration options ............................................................................. 428
16.6.2 Predefined IDs ...................................................................................... 429
16.6.3 Notification codes .................................................................................. 429
16.6.4 Keyboard reaction ................................................................................. 429
16.6.5 CHECKBOX API...................................................................................... 429
16.6.6 Example ............................................................................................... 443
16.7
DROPDOWN: Dropdown widget ............................................................... 444
16.7.1 Configuration options ............................................................................. 444
16.7.2 Predefined IDs ...................................................................................... 445
16.7.3 Notification codes .................................................................................. 445
16.7.4 Keyboard reaction ................................................................................. 445
16.7.5 DROPDOWN API .................................................................................... 445
16.7.6 Example ............................................................................................... 458
16.8
EDIT: Edit widget .................................................................................. 459
16.8.1 Configuration options ............................................................................. 459
16.8.2 Predefined IDs ...................................................................................... 459
16.8.3 Notification codes .................................................................................. 459
16.8.4 Keyboard reaction ................................................................................. 460
16.8.5 EDIT API .............................................................................................. 460
16.8.6 Examples ............................................................................................. 477
16.9
FRAMEWIN: Frame window widget ........................................................... 478
16.9.1 Structure of the frame window ................................................................ 479
16.9.2 Configuration options ............................................................................. 480
16.9.3 Keyboard reaction ................................................................................. 480
16.9.4 FRAMEWIN API...................................................................................... 480
16.9.5 Example ............................................................................................... 501
16.10
GRAPH: Graph widget ............................................................................ 502
16.10.1 Structure of the graph widget.................................................................. 502
16.10.2 Creating and deleting a graph widget ....................................................... 503
16.10.3 Drawing process .................................................................................... 503
16.10.4 Supported types of curves ...................................................................... 503
16.10.4.1 GRAPH_DATA_XY .................................................................................. 504
16.10.4.2 GRAPH_DATA_YT................................................................................... 504
16.10.5 Configuration options ............................................................................. 504
16.10.5.1 Graph widget ........................................................................................ 504
16.10.5.2 Scale object .......................................................................................... 504
16.10.6 Predefined IDs ...................................................................................... 504
16.10.7 Keyboard reaction ................................................................................. 504
16.10.8 GRAPH API ........................................................................................... 504
16.10.8.1 Common routines .................................................................................. 506
16.10.8.2 GRAPH_DATA_YT related routines............................................................ 514
16.10.8.3 GRAPH_DATA_XY related routines............................................................ 518
16.10.8.4 Scale related routines ............................................................................ 522
16.10.9 Examples ............................................................................................. 527
16.11
HEADER: Header widget ......................................................................... 528
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
20
16.11.1 16.11.2 16.11.3 16.11.4 16.11.5 16.12 16.12.1 16.12.2 16.12.3 16.12.4 16.12.5 16.12.6 16.13 16.13.1 16.13.2 16.13.3 16.14 16.14.1 16.14.2 16.14.3 16.14.4 16.14.5 16.14.6 16.15 16.15.1 16.15.2 16.15.3 16.15.4 16.15.5 16.15.6 16.16 16.16.1 16.16.2 16.16.3 16.16.4 16.16.5 16.17 16.17.1 16.17.2 16.17.3 16.17.4 16.17.5 16.17.6 16.18 16.18.1 16.18.2 16.18.3 16.18.4 16.18.5 16.18.6 16.19 16.19.1 16.19.2 16.19.3 16.19.4 16.19.5 16.19.6 16.20 16.20.1 16.20.2 16.20.3
Configuration options..............................................................................529 Notification codes...................................................................................529 Keyboard reaction ..................................................................................529 HEADER API ..........................................................................................529 Example ...............................................................................................541 ICONVIEW: Icon view widget ...................................................................542 Configuration options..............................................................................542 Predefined IDs .......................................................................................543 Notification codes...................................................................................543 Keyboard reaction ..................................................................................543 ICONVIEW API .......................................................................................543 Example ...............................................................................................555 IMAGE: Image widget .............................................................................556 Configuration options..............................................................................556 Predefined IDs .......................................................................................556 IMAGE API ............................................................................................556 LISTBOX: List box widget ........................................................................559 Configuration options..............................................................................559 Predefined IDs .......................................................................................559 Notification codes...................................................................................559 Keyboard reaction ..................................................................................560 LISTBOX API .........................................................................................560 Examples ..............................................................................................576 LISTVIEW: Listview widget ......................................................................577 Configuration options..............................................................................578 Predefined IDs .......................................................................................578 Notification codes...................................................................................578 Keyboard reaction ..................................................................................579 LISTVIEW API ........................................................................................579 Example ...............................................................................................601 LISTWHEEL: Listwheel widget ..................................................................602 Configuration options..............................................................................602 Predefined IDs .......................................................................................602 Notification codes...................................................................................602 Keyboard reaction ..................................................................................603 LISTWHEEL API......................................................................................603 MENU: Menu widget ...............................................................................616 Menu messages .....................................................................................617 Data structures ......................................................................................618 Configuration options..............................................................................618 Keyboard reaction ..................................................................................619 MENU API .............................................................................................619 Example ...............................................................................................633 MULTIEDIT: Multi line text widget.............................................................634 Configuration options..............................................................................634 Predefined IDs .......................................................................................635 Notification codes...................................................................................635 Keyboard reaction ..................................................................................635 MULTIEDIT API ......................................................................................635 Example ...............................................................................................645 MULTIPAGE: Multiple page widget ............................................................646 Configuration options..............................................................................647 Predefined IDs .......................................................................................647 Notification codes...................................................................................647 Keyboard reaction ..................................................................................647 MULTIPAGE API .....................................................................................647 Example ...............................................................................................659 PROGBAR: Progress bar widget ................................................................660 Configuration options..............................................................................660 Predefined IDs .......................................................................................660 Keyboard reaction ..................................................................................660
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
21
16.20.4 PROGBAR API ....................................................................................... 660
16.20.5 Examples ............................................................................................. 665
16.21
RADIO: Radio button widget ................................................................... 666
16.21.1 Configuration options ............................................................................. 666
16.21.2 Predefined IDs ...................................................................................... 667
16.21.3 Notification codes .................................................................................. 667
16.21.4 Keyboard reaction ................................................................................. 667
16.21.5 RADIO API............................................................................................ 667
16.21.6 Examples ............................................................................................. 677
16.22
SCROLLBAR: Scroll bar widget................................................................. 678
16.22.1 Configuration options ............................................................................. 678
16.22.2 Predefined IDs ...................................................................................... 678
16.22.3 Notification codes .................................................................................. 678
16.22.4 Keyboard reaction ................................................................................. 678
16.22.5 SCROLLBAR API .................................................................................... 679
16.22.6 Example ............................................................................................... 686
16.23
SLIDER: Slider widget ............................................................................ 688
16.23.1 Configuration options ............................................................................. 688
16.23.2 Predefined IDs ...................................................................................... 688
16.23.3 Notification codes .................................................................................. 688
16.23.4 Keyboard reaction ................................................................................. 688
16.23.5 SLIDER API........................................................................................... 689
16.23.6 Example ............................................................................................... 694
16.24
SPINBOX: Spinning box widget................................................................ 695
16.24.1 Configuration options ............................................................................. 696
16.24.2 Predefined IDs ...................................................................................... 697
16.24.3 Notification codes .................................................................................. 697
16.24.4 Keyboard reaction ................................................................................. 697
16.24.5 SPINBOX API ........................................................................................ 697
16.24.6 Example ............................................................................................... 704
16.25
TEXT: Text widget ................................................................................. 705
16.25.1 Configuration options ............................................................................. 705
16.25.2 Predefined IDs ...................................................................................... 705
16.25.3 Keyboard reaction ................................................................................. 705
16.25.4 TEXT API .............................................................................................. 705
16.25.5 Examples ............................................................................................. 711
16.26
TREEVIEW: Treeview widget ................................................................... 712
16.26.1 Description of terms............................................................................... 713
16.26.2 Configuration options ............................................................................. 714
16.26.3 Predefined IDs ...................................................................................... 714
16.26.4 Notification codes .................................................................................. 714
16.26.5 Keyboard reaction ................................................................................. 715
16.26.6 TREEVIEW API ...................................................................................... 715
16.26.6.1 Common routines .................................................................................. 716
16.26.6.2 Item related routines ............................................................................. 728
16.26.7 Example ............................................................................................... 733
16.27
WINDOW: Window widget....................................................................... 735
16.27.1 Configuration options ............................................................................. 735
16.27.2 Keyboard reaction ................................................................................. 735
16.27.3 WINDOW API ........................................................................................ 735
17 Dialogs .......................................................................................................................737
17.1 17.2 17.2.1 17.2.2 17.2.2.1 17.2.2.2 17.3 17.4 17.4.1
Dialog basics......................................................................................... 738 Creating a dialog ................................................................................... 739 Resource table ...................................................................................... 739 Dialog procedure ................................................................................... 739 Initializing the dialog.............................................................................. 740 Defining dialog behavior ......................................................................... 741 Dialog API ............................................................................................ 743 Common dialogs.................................................................................... 745 CALENDAR............................................................................................ 745
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
22
17.4.1.1 17.4.1.2 17.4.1.3 17.4.2 17.4.2.1 17.4.2.2 17.4.2.3 17.4.3 17.4.3.1 17.4.3.2 17.4.3.3 17.4.3.4 17.4.4 17.4.4.1 17.4.4.2 17.4.4.3
Notification codes...................................................................................745 Keyboard reaction ..................................................................................745 CALENDAR API.......................................................................................746 CHOOSECOLOR......................................................................................751 Notification codes...................................................................................751 Keyboard reaction ..................................................................................751 CHOOSECOLOR API ................................................................................751 CHOOSEFILE .........................................................................................756 Configuration options..............................................................................756 Keyboard reaction ..................................................................................756 File- and path names ..............................................................................756 CHOOSEFILE API....................................................................................756 MESSAGEBOX ........................................................................................763 Configuration options..............................................................................763 Keyboard reaction ..................................................................................763 MESSAGEBOX API ..................................................................................763
18 GUIBuilder .................................................................................................................765
18.1 18.2 18.3 18.3.1 18.3.2 18.3.3 18.3.4 18.3.5 18.3.6 18.4 18.5 18.6 18.7
Introduction ..........................................................................................766 Getting started ......................................................................................767 Creating a dialog....................................................................................768 Selecting a parent widget ........................................................................768 Resizing and positioning in the editor ........................................................768 Modifying the widget properties................................................................768 Adding additional functions to a widget .....................................................768 Deleting a widget property ......................................................................769 Deleting a widget ...................................................................................769 Saving the current dialog(s) ....................................................................770 Output of the GUIBuilder.........................................................................771 Modifying the C files ...............................................................................773 How to use the C files .............................................................................773
19 Skinning .....................................................................................................................775
19.1 19.2 19.3 19.4 19.4.1 19.4.2 19.5 19.6 19.6.1 19.6.2 19.6.3 19.7 19.8 19.8.1 19.8.2 19.8.3 19.8.4 19.9 19.9.1 19.9.2 19.9.3 19.9.4 19.10 19.10.1 19.10.2 19.10.3 19.10.4
What is a 'skin'?.....................................................................................776 From using API functions to skinning ........................................................776 Skinnable widgets ..................................................................................777 Using a skin ..........................................................................................777 Runtime configuration.............................................................................778 Compile time configuration ......................................................................778 Simple changes to the look of the 'Flex' skin ..............................................778 Major changes to the look of the 'Flex' skin................................................779 The skinning callback mechanism .............................................................779 Changing the look of the default skin ........................................................779 List of commands ...................................................................................780 General skinning API ..............................................................................782 BUTTON_SKIN_FLEX...............................................................................785 Configuration structure ...........................................................................785 Configuration options..............................................................................785 Skinning API..........................................................................................786 List of commands ...................................................................................787 CHECKBOX_SKIN_FLEX...........................................................................788 Configuration structure ...........................................................................788 Configuration options..............................................................................788 Skinning API..........................................................................................789 List of commands ...................................................................................791 DROPDOWN_SKIN_FLEX .........................................................................793 Configuration structure ...........................................................................793 Configuration options..............................................................................794 Skinning API..........................................................................................794 List of commands ...................................................................................795
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
23
19.11 19.11.1 19.11.2 19.11.3 19.11.4 19.12 19.12.1 19.12.2 19.12.3 19.12.4 19.13 19.13.1 19.13.2 19.13.3 19.13.4 19.14 19.14.1 19.14.2 19.14.3 19.14.4 19.15 19.15.1 19.15.2 19.15.3 19.15.4 19.16 19.16.1 19.16.2 19.16.3 19.16.4 19.17 19.17.1 19.17.2 19.17.3 19.17.4
FRAMEWIN_SKIN_FLEX .......................................................................... 796 Configuration structure........................................................................... 796 Configuration options ............................................................................. 797 Skinning API ......................................................................................... 797 List of commands .................................................................................. 798 HEADER_SKIN_FLEX .............................................................................. 801 Configuration structure........................................................................... 801 Configuration options ............................................................................. 801 Skinning API ......................................................................................... 802 List of commands .................................................................................. 802 PROGBAR_SKIN_FLEX ............................................................................ 804 Configuration structure........................................................................... 804 Configuration options ............................................................................. 804 Skinning API ......................................................................................... 805 List of commands .................................................................................. 805 RADIO_SKIN_FLEX ................................................................................ 808 Configuration structure........................................................................... 808 Configuration options ............................................................................. 809 Skinning API ......................................................................................... 809 List of commands .................................................................................. 810 SCROLLBAR_SKIN_FLEX ......................................................................... 812 Configuration structure........................................................................... 812 Configuration options ............................................................................. 813 Skinning API ......................................................................................... 813 List of commands .................................................................................. 814 SLIDER_SKIN_FLEX ............................................................................... 817 Configuration structure........................................................................... 817 Configuration options ............................................................................. 818 Skinning API ......................................................................................... 818 List of commands .................................................................................. 819 SPINBOX_SKIN_FLEX............................................................................. 821 Configuration structure........................................................................... 821 Configuration options ............................................................................. 822 Skinning API ......................................................................................... 822 List of commands .................................................................................. 823
20 Multiple buffering........................................................................................................825
20.1 20.1.1 20.1.2 20.2 20.3 20.4 20.4.1 20.4.2 20.5 20.6
How it works......................................................................................... 826 Double buffering.................................................................................... 826 Triple buffering...................................................................................... 826 Requirements........................................................................................ 827 Limitations............................................................................................ 827 Configuration ........................................................................................ 827 LCD_X_Config() .................................................................................... 827 LCD_X_DisplayDriver()........................................................................... 828 Automatic use of multiple buffers with the WM .......................................... 829 Multiple buffer API ................................................................................. 830
21 Virtual screens / Virtual pages ...................................................................................835
21.1 21.2 21.3 21.4 21.4.1 21.4.2 21.4.3 21.5
Introduction.......................................................................................... 836 Requirements........................................................................................ 836 Configuration ........................................................................................ 837 Examples ............................................................................................ 837 Basic example ....................................................................................... 837 Real time example using the Window Manager........................................... 839 Dialog example using the Window Manager ............................................... 840 Virtual screen API .................................................................................. 842
22 Multi layer / multi display support...............................................................................843
22.1
Introduction.......................................................................................... 844
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
24
22.1.1 22.1.2 22.1.2.1 22.2 22.2.1 22.2.2 22.2.3 22.2.4 22.3 22.3.1 22.3.2 22.3.3 22.4 22.5 22.6
Selecting a layer for drawing operations ....................................................844 Selecting a layer for a window .................................................................844 Moving a window from one layer to an other ..............................................845 Using multi layer support ........................................................................847 Transparency.........................................................................................847 Alpha blending.......................................................................................848 Hardware cursors ...................................................................................849 Multi layer example ................................................................................849 Using multi display support......................................................................849 Enabling multi display support .................................................................849 Run-time screen rotation.........................................................................850 Multi display example .............................................................................850 Configuring multi layer support ................................................................850 Configuring multi display support .............................................................851 Multi layer API .......................................................................................851
23 Pointer Input Devices.................................................................................................855
23.1 23.2 23.3 23.3.1 23.3.2 23.3.2.1 23.3.2.2 23.4 23.4.1 23.4.2 23.4.2.1 23.4.2.2 23.4.2.3 23.4.2.4 23.4.2.5 23.5
Description ............................................................................................856 Pointer input device API ..........................................................................856 Mouse driver .........................................................................................858 Generic mouse API .................................................................................858 PS2 mouse driver ...................................................................................859 Using the PS2 mouse driver.....................................................................859 PS2 mouse driver API .............................................................................859 Touch screen driver ................................................................................860 Generic touch screen API ........................................................................860 The analog touch screen driver ................................................................861 Setting up the analog touch screen...........................................................862 Runtime calibration ................................................................................864 Hardware routines..................................................................................864 Driver API for analog touch screens ..........................................................866 Configuring the analog touch-screen driver ................................................867 Joystick input example............................................................................868
24 Keyboard Input...........................................................................................................869
24.1 24.1.1 24.1.2
Description ............................................................................................870 Driver layer API .....................................................................................871 Application layer API...............................................................................872
25 Sprites........................................................................................................................875
25.1 25.2
Introduction ..........................................................................................876 Sprite API .............................................................................................876
26 Cursors ......................................................................................................................883
26.1 26.2
Available cursors ....................................................................................884 Cursor API ............................................................................................885
27 Antialiasing.................................................................................................................889
27.1 27.1.1 27.1.2 27.1.3 27.2 27.3 27.4 27.5
Introduction ..........................................................................................890 Quality of antialiasing .............................................................................890 Antialiased Fonts....................................................................................890 High-resolution coordinates .....................................................................891 Antialiasing API......................................................................................892 Control functions....................................................................................892 Drawing functions ..................................................................................893 Examples ..............................................................................................897
28 Language Support .....................................................................................................903
28.1
Unicode ................................................................................................904
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
25
28.1.1 28.1.2 28.1.3 28.1.3.1 28.1.4 28.1.4.1 28.1.4.2 28.2 28.2.1 28.2.2 28.2.3 28.2.4 28.2.5 28.2.6 28.3 28.3.1 28.3.2 28.3.3 28.3.4 28.3.5 28.3.6 28.3.7 28.4 28.4.1 28.4.2 28.4.3 28.4.4 28.5 28.5.1
UTF-8 encoding ..................................................................................... 904 Unicode characters ................................................................................ 905 UTF-8 strings ........................................................................................ 905 Using U2C.exe to convert UTF-8 text into C code ....................................... 905 Unicode API .......................................................................................... 906 UTF-8 functions ..................................................................................... 906 Double byte functions ............................................................................ 909 Text- and language resource files ............................................................ 910 Unicode support .................................................................................... 910 Loading files from RAM ........................................................................... 910 Loading files from non addressable areas .................................................. 910 Rules for CSV files ................................................................................. 910 Rules for text files ................................................................................. 910 Text- and language resource file API ........................................................ 911 Arabic support....................................................................................... 916 Notation forms ...................................................................................... 916 Ligatures .............................................................................................. 917 Bidirectional text alignment..................................................................... 917 Requirements........................................................................................ 918 How to enable Arabic support .................................................................. 918 Example ............................................................................................... 918 Font files used with Arabic text ................................................................ 918 Thai language support............................................................................ 919 Requirements........................................................................................ 919 How to enable Thai support..................................................................... 919 Example ............................................................................................... 919 Font files used with Thai text................................................................... 919 Shift JIS support ................................................................................... 920 Creating Shift JIS fonts .......................................................................... 920
29 Display drivers ...........................................................................................................921
29.1 29.1.1 29.1.2 29.1.3 29.1.4 29.1.5 29.2 29.2.1 29.2.2 29.2.2.1 29.2.3 29.2.3.1 29.2.4 29.2.4.1 29.2.5 29.2.5.1 29.3 29.3.1 29.3.2 29.3.2.1 29.3.2.2 29.4 29.5 29.5.1 29.5.1.1 29.5.1.2 29.5.2 29.6 29.6.1 29.7
Available display drivers ......................................................................... 922 Driver file naming convention .................................................................. 922 Run-time configurable drivers ................................................................. 923 Compile-time configurable drivers............................................................ 924 Available, but not yet migrated drivers ..................................................... 925 Special purpose drivers .......................................................................... 925 CPU / Display controller interface............................................................. 926 Direct interface ..................................................................................... 926 Indirect interface - Parallel bus ................................................................ 926 Example routines for connection to I/O pins .............................................. 927 Indirect interface - 4 pin SPI ................................................................... 927 Example routines for connection to I/O pins .............................................. 927 Indirect interface - 3 pin SPI ................................................................... 927 Example routines for connection to I/O pins .............................................. 928 Indirect interface - I2C bus ..................................................................... 928 Example routines for connection to I/O pins .............................................. 928 Hardware interface configuration ............................................................. 929 Direct interface ..................................................................................... 929 Indirect interface ................................................................................... 929 Run-time configuration ........................................................................... 929 Compile-time configuration ..................................................................... 931 Non readable displays ............................................................................ 934 Display orientation................................................................................. 934 Driver based configuration of display orientation ........................................ 934 Run-time configuration ........................................................................... 934 Compile-time configuration ..................................................................... 934 Function based configuration of display orientation..................................... 935 Display driver callback function ............................................................... 937 Commands passed to the callback function ............................................... 937 Detailed display driver descriptions .......................................................... 939
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
26
29.7.1 29.7.2 29.7.3 29.7.4 29.7.5 29.7.6 29.7.7 29.7.8 29.7.9 29.7.10 29.7.11 29.7.12 29.7.13 29.7.14 29.7.15 29.7.16 29.7.17 29.7.18 29.7.19 29.7.20 29.8 29.8.1 29.8.2 29.8.2.1 29.8.2.2 29.8.2.3
GUIDRV_BitPlains...................................................................................939 GUIDRV_DCache ....................................................................................942 GUIDRV_Dist .........................................................................................944 GUIDRV_FlexColor..................................................................................946 GUIDRV_IST3088...................................................................................958 GUIDRV_Lin ..........................................................................................960 GUIDRV_S1D13748 ................................................................................964 GUIDRV_S1D13781 ................................................................................967 GUIDRV_S1D15G00 ...............................................................................970 GUIDRV_SLin ........................................................................................973 GUIDRV_SPage ......................................................................................977 GUIDRV_SSD1926 .................................................................................983 GUIDRV_CompactColor_16 ......................................................................986 GUIDRV_Fujitsu_16 ................................................................................991 GUIDRV_Page1bpp .................................................................................993 GUIDRV_07X1 .......................................................................................996 GUIDRV_1611 .......................................................................................999 GUIDRV_6331 .....................................................................................1002 GUIDRV_7529 .....................................................................................1004 GUIDRV_Template - Template for a new driver ........................................ 1007 LCD layer and display driver API ............................................................1008 Display driver API ................................................................................1008 LCD layer routines................................................................................1009 "Get" group ......................................................................................... 1009 Configuration group.............................................................................. 1012 Cache group ........................................................................................1016
30 VNC Server..............................................................................................................1017
30.1 30.1.1 30.1.2 30.2 30.2.1 30.3 30.3.1 30.3.2 30.3.3 30.4 30.5 30.6
Introduction ........................................................................................1018 Requirements ...................................................................................... 1018 Notes on this implementation ................................................................ 1018 The VNC viewer ................................................................................... 1019 How to use the VNC viewer ................................................................... 1019 emWin VNC server ...............................................................................1020 Starting the emWin VNC server.............................................................. 1020 How the server starts... ........................................................................ 1020 Integration of the VNC server on the target ............................................. 1020 Requirements ...................................................................................... 1020 Configuration options............................................................................ 1021 VNC Server API.................................................................................... 1021
31 Touch drivers ...........................................................................................................1025
31.1
GUITDRV_ADS7846.............................................................................. 1026
32 Timing- and execution-related functions ..................................................................1029
32.1
Timing and execution API ...................................................................... 1030
33 Performance and Resource Usage..........................................................................1033
33.1 33.1.1 33.1.2 33.2 33.2.1 33.2.2 33.3
Performance ........................................................................................1034 Driver benchmark ................................................................................1034 Image drawing performance ..................................................................1035 Memory requirements........................................................................... 1036 Memory requirements of the GUI components.......................................... 1036 Stack requirements .............................................................................. 1037 Memory requirements of example applications .........................................1037
34 Configuration............................................................................................................1039
34.1 34.2
What needs to be configured? ................................................................ 1040 Run-time- and compile-time configuration ...............................................1040
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
27
34.3 34.4 34.4.1 34.4.1.1 34.4.2 34.4.2.1 34.4.3 34.4.3.1 34.4.3.2 34.4.3.3 34.5 34.5.1 34.5.1.1 34.5.1.2 34.5.1.3 34.5.2 34.6
Initialization process of emWin .............................................................. 1040 Run-time configuration ......................................................................... 1041 Customizing GUIConf.c......................................................................... 1041 API functions to be used in GUI_X_Config()............................................. 1041 Customizing LCDConf.c ........................................................................ 1043 API functions to be used in LCD_X_Config() ............................................ 1045 Customizing GUI_X.c ........................................................................... 1045 Timing routines ................................................................................... 1046 Debug routines.................................................................................... 1046 Kernel interface routines....................................................................... 1047 Compile time configuration ................................................................... 1048 Customizing GUIConf.h ........................................................................ 1048 Configuring the available features of emWin ............................................ 1048 Default font and default color configuration ............................................. 1048 Advanced GUI configuration options ....................................................... 1049 Customizing LCDConf.h ........................................................................ 1050 Request available memory .................................................................... 1050
35 Support ....................................................................................................................1051
35.1 35.1.1 35.1.2 35.1.3 35.1.4 35.2 35.3 35.4 35.5 35.6
Problems with tool chain (compiler, linker) .............................................. 1052 Compiler crash .................................................................................... 1052 Compiler warnings ............................................................................... 1052 Compiler errors ................................................................................... 1052 Linker problems .................................................................................. 1053 Problems with hardware/driver .............................................................. 1053 Problems with API functions .................................................................. 1054 Problems with the performance ............................................................. 1054 Contacting support .............................................................................. 1055 FAQ's ................................................................................................. 1056
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
28
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
29
Chapter 1 Introduction to emWin
This introduction gives some information about this document. It also gives an overview of what features emWin consists of and what it requires.
1.1 Purpose of this document
This guide describes how to install, configure and use the emWin graphical user interface for embedded applications. It also explains the internal structure of the software and all the functions which are offered by emWin and intended for direct use (API, Application Programming Interface). Before actually using emWin, you should read or at least glance through this manual in order to become familiar with the software. The following steps are recommended:
· Copy the emWin files to your computer. · Go through the chapter "Getting Started" on page 35. · Use the simulator in order to become more familiar with what the software can
do (refer to the chapter "Simulation" on page 43). · Expand your program using the rest of the manual for reference.
1.2 Requirements
A target system is not required in order to develop software with emWin; most of the software can be developed using the simulator. However, the final purpose is usually to be able to run the software on a target system.
1.2.1 Target system (hardware)
Your target system must:
· Have a CPU (8/16/32/64 bits) · Have a minimum of RAM and ROM · Have a full graphic display (any type and any resolution)
The RAM needs to be 8-, 16- and 32-bit accessible. Memory requirements vary depending on which parts of the software are used and how efficient your target compiler is. It is therefore not possible to specify precise values, but the following applies to typical systems.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
30
CHAPTER
Introduction to emWin
Small systems (no Window Manager)
· RAM: 100 Bytes · Stack: 600 Bytes · ROM: 10-25 KBytes (depending on the functionality used)
Big systems (including Window Manager and widgets)
· RAM: 2-6 kb (depending on number of windows required) · Stack: 1200-1800 bytes (depending on the functionality used) · ROM: 30-60 kb (depending on the functionality used)
ROM requirements increase according to the number of fonts used in the application. All values are rough estimates and cannot be guaranteed. Detailed information can be found in the chapter "Performance and Resource Usage" on page 1033.
1.2.2 Development environment (compiler)
The CPU used is of no importance; only an ANSI-compliant C compiler complying with at least one of the following international standard is required:
· ISO/IEC/ANSI 9899:1990 (C90) with support for C++ style comments (//) · ISO/IEC 9899:1999 (C99) · ISO/IEC 14882:1998 (C++)
If your compiler has some limitations, let us know and we will inform you if these will be a problem when compiling the software. Any compiler for 16/32/64-bit CPUs or DSPs that we know of can be used; most 8-bit compilers can be used as well. A C++ compiler is not required, but can be used. The application program can therefore also be programmed in C++ if desired.
1.3 Features
emWin is designed to provide an efficient, processor- and display controller-independent graphical user interface for any application that operates with a graphical display. It is compatible with single-task and multitask environments, with a proprietary operating system or with any commercial RTOS. emWin is shipped as C source code. It may be adapted to any size physical and virtual display with any display controller and CPU. Its features include the following:
General
· Any (monochrome, grayscale or color) display with any controller supported (if the right driver is available).
· May work without display controller on smaller displays. · Any interface supported using configuration macros. · Display-size configurable. · Characters and bitmaps may be written at any point on the display, not just on
even-numbered byte addresses. · Routines are optimized for both size and speed. · Compile time switches allow for different optimizations. · For slower display controllers, display can be cached in memory, reducing access
to a minimum and resulting in very high speed. · Clear structure. · Virtual display support; the virtual display can be larger than the actual display.
Graphic library
· Bitmaps of different color depths supported. · Bitmap Converter available. · Absolutely no floating-point usage. · Fast line/point drawing (without floating-point usage). · Very fast drawing of circles/polygons. · Different drawing modes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
31
Fonts
· A variety of different fonts are shipped with the basic software: 4*6, 6*8, 6*9, 8*8, 8*9, 8*16, 8*17, 8*18, 24*32, and proportional fonts with pixel-heights of 8, 10, 13, 16. For more information, see chapter 'Fonts'.
· New fonts can be defined and simply linked in. · Only the fonts used by the application are actually linked to the resulting execut-
able, resulting in minimum ROM usage. · Fonts are fully scalable, separately in X and Y. · Font Converter available; any font available on your host system (that is,
Microsoft Windows) can be converted.
String/value output routines
· Routines to show values in decimal, binary, hexadecimal, any font. · Routines to edit values in decimal, binary, hexadecimal, any font.
Window Manager (WM)
· Complete window management including clipping. Overwriting of areas outside a window's client area is impossible.
· Windows can be moved and resized. · Callback routines supported (usage optional). · WM uses minimum RAM (app. 50 bytes per window).
Optional widgets for PC look and feel
· Widgets (window objects, also known as controls) are available. They generally operate automatically and are simple to use.
Touch-screen & mouse support
· For window objects such as the button widget, emWin offers touch-screen and mouse support.
PC tools
· Simulation library for WIN32-Environments. The source code may be purchased additionally.
· emWinView. · Bitmap Converter. · Font Converter. · GUIBuilder.
1.4 Examples and demos
To give you a better idea of what emWin can do, we have different demos available as "ready-to-use" simulation executables under Sample\EXE. The source of the sample applications is located in the folder Sample. The folder Sample\GUIDemo contains an application program showing many features of emWin. All examples are also available at www.segger.com.
1.5 Starter kits
Complete starter kits including a demo board with a display, a C compiler and an example project are available. For more details, take a look at our website at www.segger.com.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
32
CHAPTER
Introduction to emWin
1.6 Screen and coordinates
The screen consists of many dots that can be controlled individually. These dots are called pixels. Most of the text and drawing functions that emWin offers in its API to the user program can write or draw on any specified pixel. The horizontal scale is called the X-axis, whereas the vertical scale is called the Yaxis. Coordinates are denoted as a pair consisting of an X- and a Y-value (X, Y). The X-coordinate is always first in routines that require X and Y coordinates. The upper left corner of the display (or a window) has per default the coordinates (0,0). Positive X-values are always to the right; positive Y-values are always down. The above graph illustrates the coordinate system and directions of the X- and Y- axes. All coordinates passed to an API function are always specified in pixels.
1.7 How to connect the display to the micro controller
emWin handles all access to the display. Virtually any display controller can be supported, independently of how it is accessed. For details, refer to the chapter "Configuration" on page 1039. Also, get in contact with us if your display controller is not supported. We are currently writing drivers for all display controllers available on the market and may already have a proven driver for the display controller that you intend to use. It is usually very simple to write the routines (or macros) used to access the display in your application SEGGER Microcontroller GmbH & Co. KG offers the service of making these customizations for you, if necessary with your target hardware. It does not really matter how the display is connected to the system as long as it is somehow accessible by software, which may be accomplished in a variety of ways. Most of these interfaces are supported by a driver which is supplied in source code form. This driver does not normally require modifications, but is configured for your hardware by making changes in the file LCDConf.h. Details about how to customize a driver to your hardware as necessary are provided in the chapter "Display drivers" on page 921. The most common ways to access the display are described as follows. If you simply want to understand how to use emWin, you may skip this section.
Display with memory-mapped display controller:
The display controller is connected directly to the data bus of the system, which means the controller can be accessed just like a RAM. This is a very efficient way of accessing the display controller and is most recommended. The display addresses are defined to the segment LCDSEG, and in order to be able to access the display the linker/locator simply needs to be told where to locate this segment. The location must be identical to the access address in physical address space. Drivers are available for this type of interface and for different display controllers.
Display with display controller connected to port / buffer
For slower display controllers used on fast processors, the use of port-lines may be the only solution. This method of accessing the display has the disadvantage of being somewhat slower than direct bus-interface but, particularly with a cache that minimizes the accesses to the display, the display update is not slowed down significantly. All that needs to be done is to define routines or macros which set or read the hardware ports/buffers that the display is connected to. This type of interface is also supported by different drivers for the different display controllers.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
33
Proprietary solutions: display without display controller
The display can also be connected without an display controller. In this case, the display data is usually supplied directly by the controller via a 4- or 8-bit shift register. These proprietary hardware solutions have the advantage of being inexpensive, but the disadvantage of using up much of the available computation time. Depending on the CPU, this can be anything between 20 and almost 100 percent; with slower CPUs, it is really not possible at all. This type of interface does not require a specific display driver because emWin simply places all the display data into the display cache. You yourself must write the hardware-dependent portion that periodically transfers the data in the cache memory to your display. Example code for transferring the video image into the display is available in both C and optimized assembler for M16C and M16C/80.
1.8 Data types
Since C does not provide data types of fixed lengths which are identical on all platforms, emWin uses, in most cases, its own data types as shown in the table below:
Data type
I8 U8 I16 U16 I32 U32 I16P U16P
Definition
Explanation
signed char
8-bit signed value
unsigned char 8-bit unsigned value
signed short
16-bit signed value
unsigned short 16-bit unsigned value
signed long
32-bit signed value
unsigned long 32-bit unsigned value
signed short
16-bit (or more) signed value
unsigned short 16-bit (or more) unsigned value
For most 16/32-bit controllers, the settings will work fine. However, if you have similar defines in other sections of your program, you might want to change or relocate them. A recommended place is in the file Global.h.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
34
CHAPTER
Introduction to emWin
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
35
Chapter 2 Getting Started
The following chapter provides an overview of the basic procedures for setting up and configuring emWin on your target system. It also includes a simple program example. If you find yourself unsure about certain areas, keep in mind that most topics are treated in greater detail in later chapters. You will most likely need to refer to other parts of the manual before you begin more complicated programming.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
36
CHAPTER
Getting Started
2.1 Recommended project structure
We recommend keeping emWin separate from your application files. It is good practice to keep all the program files (including the header files) together in the GUI subdirectories of your project's root directory. The directory structure should be similar to the one pictured on the right. This practice has the advantage of being very easy to update to newer versions of emWin by simply replacing the GUI\ directories. Your application files can be stored anywhere.
Warning: When updating to a newer emWin version: Since files may have been added, moved or deleted, the project directories may need to be updated accordingly.
2.1.1 Subdirectories
The following table shows the contents of all GUI subdirectories:
Directory
Config GUI\AntiAlias GUI\ConvertMono GUI\ConvertColor GUI\Core GUI\Font GUI\DisplayDriver GUI\MemDev GUI\VNC GUI\Widget GUI\WM
Contents
Configuration files Antialiasing support * Color conversion routines used for grayscale displays * Color conversion routines used for color displays * emWin core files Font files Display driver Memory device support * VNC support * Widget library * Window Manager *
(* = optional)
2.1.2 Include directories
You should make sure that the include path contains the following directories (the order of inclusion is of no importance):
· Config · GUI\Core · GUI\DisplayDriver · GUI\Widget (if using the widget library) · GUI\WM (if using Window Manager)
Warning: Always make sure that you have only one version of each file!
It is frequently a major problem when updating to a new version of emWin if you have old files included and therefore mix different versions. If you keep emWin in the directories as suggested (and only in these), this type of problem cannot occur. When updating to a newer version, you should be able to keep your configuration files and leave them unchanged. For safety reasons, we recommend backing up (or at least renaming) the GUI\ directories prior to updating.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
37
2.2 Adding emWin to the target program
You basically have a choice between including only the source files that you are actually going to use in your project, which will then be compiled and linked, or creating a library and linking the library file. If your tool chain supports "smart" linking (linking in only the modules that are referenced and not those that are not referenced), there is no real need to create a library at all, since only the functions and data structures which are required will be linked. If your tool chain does not support "smart" linking, a library makes sense, because otherwise everything will be linked in and the program size will be excessively large. For some CPUs, we have example projects available to help you get started.
2.3 Creating a library
Building a library from the sources is a simple procedure. The
first step is to copy the batch files (located under Sam- Makelib.bat
ple\Makelib) into your project's root directory. That means the
parent directory containing the 'Config' and the 'GUI' folder
explained in chapter 2.1. Then, make any necessary changes.
Prep.bat
There are a total of four batch files which need to be copied,
described in the table below. The main file, Makelib.bat, will
be the same for all systems and requires no changes. To build a library for your target system, you will normally need to make
CC.bat
slight modifications to the other three smaller files. Finally,
start the file Makelib.bat to create the library. The batch files
No
assume that your GUI and Config subdirectories are set up as recommended. The procedure for creating a library is illustrated in the flow
All files in library?
chart to the right. The Makelib.bat file first calls Prep.bat to
prepare the environment for the tool chain. Then it calls CC.bat
Yes
for every file to be included in the library. It does this as many
times as necessary. CC.bat adds each object file to a list that
lib.bat
will be used by lib.bat. When all files to be added to the
library have been listed, Makelib.bat then calls lib.bat,
which uses a librarian to put the listed object files into the actual library. Of course
you are free to create libraries in another way.
It is not recommended to create an emWin library including a compile-time config-
urable display driver. For further information about the configurability of display driv-
ers, please refer to "Available display drivers" on page 922.
File
Makelib.bat Prep.bat
CC.bat
lib.bat
Explanation
Main batch file. No modification required.
Called by Makelib.bat to prepare environment for the tool chain to be used,
Called by Makelib.bat for every file to be added to the library; creates a list of these object files which will then be used in the next step by the librarian in the lib.bat file.
Called by Makelib.bat to put the object files listed by CC.bat into a library.
The files as shipped assume that a Microsoft compiler is installed in its default location. If all batch files are copied to the root directory (directly above GUI) and no changes are made at all, a simulation library will be generated for the emWin simulation. In order to create a target library, however, it will be necessary to modify Prep.bat, CC.bat, and lib.bat.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
38
CHAPTER
Getting Started
2.3.1 Adapting the library batch files to a different system
The following will show how to adapt the files by an example adaptation for a Mitsubishi M32C CPU.
Adapting Prep.bat
Prep.bat is called at the beginning of Makelib.bat. As described above its job is to set the environment variables for the used tools and the environment variable PATH, so that the batch files can call the tools without specifying an absolute path. Assuming the compiler is installed in the folder C:\MTOOL the file Prep.bat could look as follows:
@ECHO OFF SET TOOLPATH=C:\MTOOL REM ****************************************************************** REM Set the variable PATH to be able to call the tools SET PATH=%TOOLPATH%\BIN;%TOOLPATH%\LIB308;%PATH% REM ****************************************************************** REM Set the tool internal used variables SET BIN308=%TOOLPATH%\BIN SET INC308=%TOOLPATH%\INC308 SET LIB308=%TOOLPATH%\LIB308 SET TMP308=%TOOLPATH%\TMP
Adapting CC.bat
The job of CC.bat is to compile the passed source file and adding the file name of the object file to a link list. When starting MakeLib.bat it creates the following subdirectories relative to its position:
Directory Lib Temp\Output Temp\Source
Contents
This folder should contain the library file after the build process.
Should contain all the compiler output and the link list file. Will be deleted after the build process.
MakeLib.bat uses this folder to copy all source and header files used for the
build process. Will be deleted after the build process.
The object file should be created (or moved) to Temp\Output. This makes sure all the output will be deleted after the build process. Also the link list should be located in the output folder. The following shows an example for the Mitsubishi compiler:
@ECHO OFF
GOTO START
REM ******************************************************************
REM Explanation of the used compiler options:
-silent : Suppresses the copyright message display at startup
-M82 : Generates object code for M32C/80 Series (Remove this switch
for M16C80 targets)
-c
: Creates a relocatable file (extension .r30) and ends processing
-I
: Specifies the directory containing the file(s) specified in #include
-dir : Specifies the destination directory
-OS
: Maximum optimization of speed followed by ROM size
-fFRAM : Changes the default attribute of RAM data to far
-fETI : Performs operation after extending char-type data to the int type
(Extended according to ANSI standards)
:START
REM ******************************************************************
REM Compile the passed source file with the Mitsubishi NC308 compiler
NC308 -silent -M82 -c -IInc -dir Temp\Output -OS -fFRAM -fETI Temp\Source\%1.c
REM ******************************************************************
REM Pause if any problem occurs
IF ERRORLEVEL 1 PAUSE
REM ******************************************************************
REM Add the file name of the object file to the link list
ECHO Temp\Output\%1.R30>>Temp\Output\Lib.dat
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
39
Adapting Lib.bat
After all source files have been compiled Lib.bat will be called from MakeLib.bat. The job is to create a library file using the link list created by CC.bat. The destination folder of the library file should be the Lib folder created by MakeLib.bat. The following shows an example for the Mitsubishi librarian:
@ECHO OFF GOTO START REM ****************************************************************** REM Explanation of the used options: -C : Creates new library file @ : Specifies command file :START REM ****************************************************************** REM Create the first part of the linker command file ECHO -C Lib\GUI>Temp\Output\PARA.DAT REM ****************************************************************** REM Merge the first part with the link list to the linker command file COPY Temp\Output\PARA.DAT+Temp\Output\Lib.dat Temp\Output\LINK.DAT REM ****************************************************************** REM Call the Mitsubishi librarian LB308 @Temp\Output\LINK.DAT REM ****************************************************************** REM Pause if any problem occurs IF ERRORLEVEL 1 PAUSE
2.4 C files to include in the project
Generally speaking, you need to include the core C files of emWin, the display driver, all font files you plan to use and any optional modules you have ordered with emWin:
· All C files of the folder Config · All C files of the folder GUI\Core · The fonts you plan to use (located in GUI\Font) · Display driver: All C files of the folder GUI\DisplayDriver.
Additional software packages
If you plan to use additional, optional modules you must also include their C files:
· Gray scale converting functions: all C files located in GUI\ConvertMono · Color conversion functions: all C files located in GUI\ConvertColor · Antialiasing: all C files located in GUI\AntiAlias · Memory Devices: all C files located in GUI\MemDev · VNC support: all C files located in GUI\VNC · Widget library: all C files located in GUI\Widget · Window Manager: all C files located in GUI\WM
Target specifics
For displays with indirect interface hardware routines must be included. Examples for several kinds of indirect interface routines are available under Samples\LCD_X.
RTOS specifics
· If emWin is intended to be used with an RTOS, some RTOS dependent functions need to be implemented. emWin comes with several sample files including implementations for common RTOS packages (called GUI_X_<RTOS>.c), as well as the file GUI_X_Ex.c which just contains place holders of the required functions and might be used to make emWin work with any RTOS.
· If multitasking is not required (access of the display by one task only) the file GUI_X.c may be used as a starting point for a custom implementation.
The sample files can be found in the folder Sample\GUI_X which is contained in the emWin package.
Additional information
Be sure to include GUI.h in all emWin accessing source files.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
40
CHAPTER
Getting Started
2.5 Configuring emWin
The Config folder should contain all configuration files. The chapter 'Configuration' explains in detail how emWin should be configured. The following types of configuration macros are available:
Binary switches "B"
Switches can have a value of either 0 or 1, where 0 means deactivated and 1 means activated (actually anything other than 0 would work, but using 1 makes it easier to read a config file). These switches can enable or disable a certain functionality or behavior. Switches are the simplest form of configuration macro.
Numerical values "N"
Numerical values are used somewhere in the code in place of a numerical constant. Typical examples are in the configuration of the resolution of a display.
Selection switches "S"
Selection switches are used to select one out of multiple options where only one of those options can be selected. A typical example might be the selection of the type of display controller used, where the number selected denotes which source code (in which display driver) is used to generate object code.
Alias "A"
A macro which operates like a simple text substitute. An example would be the define U8, in which the preprocessor would replace with unsigned char.
Function replacements "F"
Macros can basically be treated like regular functions although certain limitations apply, as a macro is still put into the code as simple text replacement. Function replacements are mainly used to add specific functionality to a module (such as the access to a display) which is highly hardware-dependent. This type of macro is always declared using brackets (and optional parameters).
2.6 Initializing emWin
The following functions should be used to initialize and 'deinitialize' emWin in order to start the configuration process (see chapter "Configuration" on page 1039) or clear internal data from memory again.
Routine GUI_Init() GUI_Exit()
Explanation
Initializes emWin internal data structures and variables. Clears emWin internal data from memory.
GUI_Init()
Description
Initializes emWin internal data structures and variables.
Prototype
int GUI_Init(void);
Return value
0, if successful; another value if the initialization of the display driver fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
41
Additional information
Executing this function is mandatory before using any emWin functions. The only exception is setting create flags for windows (see "WM_SetCreateFlags()" on page 378). If the Window Manager is used, the background window is created from within GUI_Init(). So if create flags are set up before GUI_Init() is called, the background window is created according to them.
GUI_Exit()
Description
Clears emWin internal data from memory to make further calls of GUI_Init() possible.
Prototype
void GUI_Exit(void);
Additional information
This function should be used if emWin represents a part of the application which is not used continuously and therefore has to be able to be turned on and off again. Please note that after GUI_Exit was called emWin will not work properly until GUI_Init() is called again.
2.7 Using emWin with target hardware
The following is just a basic outline of the general steps that should be taken when starting to program with emWin. All steps are explained further in subsequent chapters.
Step 1: Configuring emWin
The first step is usually to customize emWin. For details about the configuration, refer to the chapter "Configuration" on page 1039".
Step 2: Defining access addresses or access routines
For memory-mapped display controllers, the access addresses of the display simply need to be defined in the configuration file of the display controller. For port/bufferaccessed display controllers, interface routines must be defined. Examples of the required routines are available under Samples\LCD_X.
Step 3: Compiling, linking and testing the example code
emWin comes with example code for both single- and multitask environments. Compile, link and test these little example programs until you feel comfortable doing so.
Step 4: Modifying the example program
Make simple modifications to the example programs. Add additional commands such as displaying text in different sizes on the display, showing lines and so on.
Step 5: In multitask applications: adapt to your OS (if necessary)
If multiple tasks should be able to access the display simultaneously, the macros GUI_MAXTASK and GUI_OS come into play, as well as the file GUITask.c. For details and example adaptations, refer to the chapter "Configuration" on page 1039".
Step 6: Write your own application using emWin
By now you should have a clearer understanding of how to use emWin. Think about how to structure the program your application requires and use emWin by calling the appropriate routines. Consult the reference chapters later in this manual, as they discuss the specific emWin functions and configuration macros that are available.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
42
CHAPTER
Getting Started
2.8 The "Hello world" example program
In the following we will show the "Hello world" example program. If you like to see a wide range of emWin based sample applications as well as further simple tutorial applications, please have a look in the Sample folder of your emWin shipment or visit the "emWin Samples" section on www.segger.com.
A "Hello world" program has been used as a starting point for C programming since the early days, because it is essentially the smallest program that can be written. An emWin "Hello world" program is shown below and is available as BASIC_HelloWorld.c in the Sample\Tutorial folder shipped with emWin. The whole purpose of the program is to write "Hello world" in the upper left corner of the display. In order to be able to do this, the hardware of the application, the display controller and the GUI must be initialized first. emWin is initialized by a simple call of GUI_Init() in the beginning of the program. In this example, we assume that the hardware of your application is already initialized. The "Hello world" program looks as follows:
#include "GUI.h"
void MainTask(void) { GUI_Init(); GUI_DispString("Hello world!"); while(1);
}
Adding functionality to the "Hello world" program
Our little program has not been doing too much so far. We can now extend the functionality a bit: after displaying "Hello world", we would like the program to start counting on the display in order to be able to estimate how fast outputs to the display can be made. We can simply add a bit of code to the loop at the end of the main program, which is essentially a call to the function that displays a value in decimal form. The example is available as BASIC_Hello1.c in the Sample folder.
#include "GUI.h"
void MainTask(void) { int i=0; GUI_Init(); GUI_DispString("Hello world!"); while(1) { GUI_DispDecAt( i++, 20,20,4); if (i > 9999) { i = 0; } }
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
43
Chapter 3 Simulation
The PC simulation of emWin allows you to compile the same C source on your Windows PC using a native (typically Microsoft) compiler and create an executable for your own application. Doing so allows the following: · Design of the user interface on your PC (no hardware required!). · Debugging of the user interface program. · Creation of demos of your application, which can be used to discuss the user
interface. The resulting executable can be sent easily via e-mail.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
44
CHAPTER
Simulation
3.1 Using the simulation
The emWin simulation requires Microsoft Visual C++ (version 6.00 or higher) and the integrated development environment (IDE) which comes with it. You will see a simulation of your LCD on your PC screen, which has the same resolution in X and Y and can display the exact same colors as your LCD once it has been properly configured. The entire graphic library API and Window Manager API of the simulation are identical to those on your target system; all functions will behave in the very same way as on the target hardware since the simulation uses the same C source code as the target system. The difference lies only in the lower level of the software: the display driver. Instead of using the actual display driver, the PC simulation uses a simulation driver which writes into a bitmap. The bitmap is then displayed on your screen using a second thread of the simulation. This second thread is invisible to the application; it behaves just as if the LCD routines were writing directly to the display.
3.1.1 Using the simulation with the trial version of emWin
The trial version of emWin contains a full library which allows you to evaluate all available features of emWin. It also includes the emWin viewer (used for debugging applications), as well as demo versions of the Font Converter and the Bitmap Converter. Keep in mind that, being a trial version, you will not be able to view the source code of emWin or the simulation, but you will still be able to become familiar with what emWin can do.
3.1.1.1 Directory structure
The directory structure of the simulation in the trial version is shown at the right side. The table below explains the contents of the folders:
Directory
Application
Config
Exe GUI Sample Simulation Tool
Content
Source of the demo program.
Configuration files used to build the library. Note that changes at the header files do not have any effect on the precompiled library!
Ready-to-use demo program.
Library files and include files needed to use the library.
Simulation examples.
Files needed for the simulation.
The emWin viewer, a demo version of the Bitmap Converter and a demo version of the Font Converter.
3.1.1.2 Visual C++ workspace
The root directory shown above includes the Microsoft Visual C++ workspace (SimulationTrial.dsw) and project file (SimulationTrial.dsp). The workspace allows you to modify an application program and debug it before compiling it on your target system. Double-click the workspace file to open the Microsoft IDE. The directory structure of the Visual C++ workspace will look like the one shown to the right.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
45
3.1.1.3 Compiling the demo program
The source files for the demo program are located in the Application directory as a ready-to-go simulation, meaning that you only need to rebuild and start it. Note that to rebuild the executable, you will need to have Microsoft Visual C++ (version 6.00 or later) installed.
· Step 1: Open the Visual C++ workspace by double-clicking on SimulationTrial.dsw.
· Step 2: Rebuild the project by choosing Build/Rebuild All from the menu (or by pressing F7).
· Step 3: Start the simulation by choosing Build/Start Debug/Go from the menu (or by pressing F5).
The demo project will begin to run and may be closed at any time by right-clicking on it and selecting Exit.
3.1.1.4 Compiling the examples
The Sample directory contains ready-to-go examples that demonstrate different features of emWin and provide examples of some of their typical uses. In order to build any of these executables, their C source must be 'activated' in the project. This is easily done with the following procedure:
· Step 1: Exclude the Application folder from the build process by right-clicking the Application folder of the workspace and selecting 'Settings\General\Exclude from build'.
· Step 2: Open the Sample folder of the workspace by double-clicking on it. Include the example which should be used by right-clicking on it and deselecting 'Settings\General\Exclude' from build.
· Step 3: If the example contains its own configuration files (LCDConf.c and/or SIMConf.c) the default configuration files located in the config folder need to be excluded from the build process.
· Step 4: Rebuild the example by choosing Build/Rebuild All from the menu (or by pressing F7).
· Step 5: Start the simulation by choosing Build/Start Debug/Go from the menu (or by pressing F5). The result of the example selected above is pictured below:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
46
CHAPTER
3.1.2 Using the simulation with the emWin source
3.1.2.1 Directory structure
The root directory of the simulation can be anywhere on your PC, for example C:\Work\emWinSim. The directory structure will appear as shown to the right. This structure is very similar to that which we recommend for your target application (see Chapter 3: "Getting Started" for more information). The following table shows the contents of the folders:
Directory
Doc Sample Start Tool
Content
Contains the emWin documentation. Code examples, described later in this documentation. All you need to create a new project with emWin. Tools shipped with emWin.
A new project can be started by making a copy of the Startfolder. It contains all required files for a new project. Subdirectories containing the emWin sources are in the Start\GUI folder and should contain the exact same files as the directories of the same names which are used for your target (cross) compiler. The files of the GUI subdirectories should not be changed, as this would make updating to a newer version of emWin more difficult. The Start\Config directory contains configuration files which need to be modified in order to reflect your target hardware settings (mainly LCD-size and colors which can be displayed).
3.1.2.2 Visual C++ workspace
The root directory shown above includes the Microsoft Visual C++ workspace (Simulation.dsw) and project files (Simulation.dsp). The workspace allows you to modify an application program and debug it before compiling it on your target system. The directory structure of the Visual C++ workspace will appear similar to that shown to the right. Here, the GUI folder is open to display the emWin subdirectories. Note that your GUI directory may not look exactly like the one pictured, depending on which additional features of emWin you have. The folders Core, Font and DisplayDriver are part of the basic emWin package and will always appear in the workspace directory.
Simulation
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
47
3.1.2.3 Compiling the application
The simulation contains one or more application C files (located in the Application directory), which can be modified or removed and additional files can be added to the project. You should then rebuild the program within the Visual C++ workspace in order to test/debug it. Once you have reached a point where you are satisfied with the result and want to use the program in your application, you should be able to compile these same files on your target system and get the same result on the target display. The general procedure for using the simulation would be as follows:
· Step 1: Open the Visual C++ workspace by double-clicking on Simulation.dsw. · Step 2: Compile the project by choosing Build/Rebuild All from the menu (or
by pressing F7). · Step 3: Run the simulation by choosing Build/Start Debug/Go from the menu
(or by pressing F5). · Step 4: Replace the bitmap with your own logo or image. · Step 5: Make further modifications to the application program as you wish, by
editing the source code or adding/deleting files. · Step 6: Compile and run the application program within Visual C++ to test the
results. Continue to modify and debug as needed. · Step 7: Compile and run the application program on your target system.
3.1.3 Advanced features of the simulation
Clicking the right mouse button shows a context menu with several advanced functions:
3.1.3.1 Pause and Resume
These menu items allows to pause and to resume the application currently running in the simulation. The same can be done by pressing <F4> or <F5>. Trying to pause an already paused application or trying to resume an already running application causes an error message.
3.1.3.2 View system info
This menu item opens a further window with information of the memory currently used by the application. The window continuously shows the current status of memory consumption by showing the free and used bytes and the free and used number of memory blocks.
3.1.3.3 Copy to clipboard
This menu item copies the current contents of the display into the clipboard. This makes it easy to use it for documentation purpose with other applications.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
48
CHAPTER
3.2 Device simulation
The device simulation supports 3 views:
· Generated frame view · Custom bitmap view · Window view
The table below shows the different views:
Generated frame view
Simulation Custom bitmap view
Window view
The following will explain in detail how each option can be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
49
3.2.1 Generated frame view
The simulation shows the display inside an automatically generated frame surrounding the display. The frame contains a small button which per default closes the application. This is the default behavior of the simulation for single layer systems. 'Single layer system' means that only the first layer is initialized.
3.2.2 Custom bitmap view
The simulation can show the simulated display in a bitmap of your choice, typically your target device. The bitmap can be used to simulate the behavior of the entire target device. In order to simulate the appearance of the device, bitmaps are required.
Device bitmap
The first bitmap is usually a photo (top view) of the device, and needs to be named Device.bmp. It may be a separate file (in the same directory as the executable), or it may be included as a resource in the application. How to do this is explained later in this chapter. The file should provide an area for the simulated display of the same size in pixels as the physical display resolution. If there are any hardkeys to be simulated the bitmap should also show all of them in unpressed state. Transparent areas need to be colored with exact the same color as defined with the function SIM_GUI_SetTransColor(), typically bright red (0xFF0000). These areas do not have to be rectangular; they can have an arbitrary shape (up to a certain complexity which is limited by your operating system, but is normally sufficient). Bright red is the default color for transparent areas, mainly because it is not usually contained in most bitmaps. To use a bitmap with bright red, the default transparency color may be changed with the function SIM_GUI_SetTransColor().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
50
CHAPTER
Simulation
Hardkey bitmap
The second bitmap file is required for defining the hardkeys and must be named Device1.bmp. It contains the buttons in pressed state. The non hardkey area has to be filled with the transparent color. This is only a short description. For more details about how to simulate hardkeys, see "Hardkey simulation" on page 56.
Using separate files
When starting the simulation, it checks if the directory of the executable contains the bitmap files Device.bmp and Device1.bmp. If these files are available, they are used automatically and the resource bitmaps are ignored. Note that this is only valid with single layer systems.
Adding the bitmap to the application resources
The resource file of the simulation can be found under System\Simulation\Res\Sim-
ulation.rc. It contains the following section:
/////////////////////////////////////////////////////////////////////////////
//
// Customizable bitmaps
//
IDB_DEVICE
BITMAP DISCARDABLE
"Device.bmp"
IDB_DEVICE1
BITMAP DISCARDABLE
"Device1.bmp"
This section can be used to set custom device files. More information can be found in the Win32 documentation.
3.2.3 Window view
Default for simulating a multiple layer system is showing each layer in a separate window without using bitmaps or a generated frames.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
51
3.3 Device simulation API
All of the device simulation API functions should be called in the setup phase. The calls should be done from within the routine SIM_X_Config(), which is located in the file SIMConf.c in the configuration folder. The example below calls SIM_SetLCDPos() in the setup:
#include "LCD_SIM.h"
void SIM_X_Config() { SIM_GUI_SetLCDPos(50, 20); // Define the position of the LCD in the bitmap}
}
The table below lists the available device-simulation-related routines in alphabetical order. Detailed descriptions of the routines follow:
Routine SIM_GUI_ShowDevice() SIM_GUI_SetCallback() SIM_GUI_SetCompositeColor() SIM_GUI_SetCompositeSize() SIM_GUI_SetLCDColorBlack() SIM_GUI_SetLCDColorWhite() SIM_GUI_SetLCDPos() SIM_GUI_SetMag() SIM_GUI_SetTransColor() SIM_GUI_UseCustomBitmaps()
Explanation
Manages the visibility of the device bitmap.
Sets a callback function for receiving the handles of the simulation windows. Sets the background color of the composite window. (Only used with multi layer systems) Sets the size of the composite window. (Only used with multi layer systems) Set the color to be used as black (color monochrome displays). Set the color to be used as white (color monochrome displays). Set the position for the simulated LCD within the target device bitmap.
Set magnification factors for X and/or Y axis.
Set the color to be used for transparent areas (default: 0xFF0000). Tells the simulation to use the custom bitmaps from the application resource file.
SIM_GUI_ShowDevice()
Description
This function can be used to manage the visibility of the surrounding device bitmap of the simulation.
Prototype
void SIM_GUI_ShowDevice(int OnOff);
Parameter OnOff
Description
1 for showing the bitmap, 0 for hiding it.
Additional information
On systems with multiple layers the device bitmap is not shown per default and on single layer systems the bitmap is visible. If a different behavior is required this function can be used to set up the visibility of the device bitmap.
SIM_GUI_SetCallback()
Description
If it is required to simulate more than the display window or hardkeys, you can set a callback function to receive the window handles of the simulation. This opens up the possibility e.g. to add additional controls outside of the display window like leds or sliders. Please note that the emWin functions can not be used there.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
52
CHAPTER
Simulation
Prototype
void SIM_GUI_SetCallback(int (* _pfInfoCallback)(SIM_GUI_INFO * pInfo));
Parameter _pfInfoCallback
Description
Pointer to the callback function. The function has to expect a pointer to a SIM_GUI_INFO structure as a parameter
Type
HWND HWND HWND
Content of the SIM_GUI_INFO structure
Name
hWndMain ahWndLCD[16] ahWndColor[16]
Description
Handle to the main window Array of handles to the display layers Array of handles to the palette layers
SIM_GUI_SetCompositeColor()
Description
When simulating a multiple layer system each layer can be shown in its own window. However, the physical display has only one area. It shows the result of the blended layers. The simulation shows the result in the composite window which can have its own size independent of the layers. Each layer can have its own position and its own size within the composite window. This means that not necessarily the complete area is covered by the layers. For this case (and also for transparency effects) this function sets the default background color of the composite window.
Prototype
void SIM_GUI_SetCompositeColor(U32 Color);
Parameter Color
Background color to be used.
Description
SIM_GUI_SetCompositeSize()
Description
As described above under SIM_GUI_SetCompositeColor() the size of the composite window is independent of the size of the layers. This function is used to set the size of the composite window.
Prototype
void SIM_GUI_SetCompositeSize(int xSize, int ySize);
Parameter xSize ySize
Horizontal size in pixels. Vertical size in pixels.
Description
Example
The following shows a typical use (with a multi layer system):
void SIM_X_Config() { SIM_GUI_SetCompositeSize(240, 320); // Set size of composite window SIM_GUI_SetCompositeColor(0x800000); // Define background color of composite window
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
53
SIM_GUI_SetLCDColorBlack(), SIM_GUI_SetLCDColorWhite()
Description
Set the colors to be used as black or white, respectively, on color monochrome displays.
Prototypes
int SIM_GUI_SetLCDColorBlack(int DisplayIndex, int Color); int SIM_GUI_SetLCDColorWhite(int DisplayIndex, int Color);
Parameter DisplayIndex Color
Description
Reserved for future use; must be 0. RGB value of the color.
Additional information
These functions can be used to simulate the true background color of your display. The default color values are black and white, or 0x000000 and 0xFFFFFF.
Example using default settings
void SIM_X_Config() { SIM_GUI_SetLCDPos(14,84);
SIM_GUI_SetLCDColorBlack (0, 0x000000); SIM_GUI_SetLCDColorWhite (0, 0xFFFFFF); (used for colored monochrome displays) }
// Define the position of the LCD // in the bitmap // Define the color used as black // Define the color used as white
Example using yellow instead of white
void SIM_X_Config() { SIM_GUI_SetLCDPos(14,84);
SIM_GUI_SetLCDColorBlack (0, 0x000000); SIM_GUI_SetLCDColorWhite (0, 0x00FFFF); (used for colored monochrome displays) }
// Define the position of the LCD // in the bitmap // Define the color used as black // Define the color used as white
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
54
CHAPTER
Simulation
SIM_GUI_SetLCDPos()
Description
Sets the position for the simulated LCD within the target device bitmap.
Prototype
void SIM_GUI_SetLCDPos(int x, int y);
Parameter x y
Description
X-position of the upper left corner for the simulated LCD (in pixels). Y-position of the upper left corner for the simulated LCD (in pixels).
Additional information
The X- and Y-positions are relative to the target device bitmap, therefore position (0,0) refers to the upper left corner (origin) of the bitmap and not your actual LCD. Only the origin of the simulated screen needs to be specified; the resolution of your display should already be reflected in the configuration files in the Config directory. The use of this function enables the use of the bitmaps Device.bmp and Device1.bmp. Note that the values need to be >= 0 for enabling the use of the bitmaps. If the use of the device bitmaps should be disabled, omit the call of this function in SIM_X_Init().
SIM_GUI_SetMag()
Description
Sets magnification factors for X and/or Y axis.
Prototype
void SIM_GUI_SetMag(int MagX, int MagY);
Parameter MagX MagY
Magnification factor for X axis. Magnification factor for Y axis.
Description
Additional information
Per default the simulation uses one pixel on the PC for each pixel of the simulated display. The use of this function makes sense for small displays. If using a device bitmap together with a magnification > 1 the device bitmap needs to be adapted to the magnification. The device bitmap is not magnified automatically.
SIM_GUI_SetTransColor()
Description
Sets the color to be used for transparent areas of device or hardkey bitmaps.
Prototype
I32 SIM_GUI_SetTransColor(I32 Color);
Parameter Color
Description
RGB value of the color in the format 00000000RRRRRRRRGGGGGGGGBBBBBBBB.
Additional information
The default setting for transparency is bright red (0xFF0000). You would typically only need to change this setting if your bitmap contains the same shade of red.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
55
SIM_GUI_UseCustomBitmaps()
Description
As described earlier in this chapter it is possible to use device bitmaps from the application resources. This function tells the simulation to use the device- and hardkey bitmaps from the application resources and not to generate the default frame bitmap.
Prototype
void SIM_GUI_UseCustomBitmaps(void);
Additional information
The emWin shipment contains per default 2 bitmaps, Device.bmp and Device1.bmp, located in Start\System\Simulation\Res which can be used as a starting point for your own bitmaps.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
56
CHAPTER
Simulation
3.4 Hardkey simulation
The hardkey simulation can only be used in the custom bitmap view. Hardkeys may also be simulated as part of the device, and may be selected with the mouse pointer. The idea is to be able to distinguish whether a key or button on the simulated device is pressed or unpressed. A hardkey is considered "pressed" as long as the mouse button is held down; releasing the mouse button or moving the pointer off of the hardkey "unpresses" the key. A toggle behavior between pressed and unpressed may also be specified with the routine SIM_HARDKEY_SetMode(). In order to simulate hardkeys, you need a second bitmap of the device which is transparent except for the keys themselves (in their pressed state). As described earlier in this chapter, this bitmap can be in a separate file in the directory, or included as a resource in the executable. Hardkeys may be any shape, as long as they are exactly the same size in pixels in both Device.bmp and Device1.bmp. The following example illustrates this:
Device bitmap: unpressed hardkey state (Device.bmp)
Device hardkey bitmap: pressed hardkey state (Device1.bmp)
When a key is "pressed" with the mouse, the corresponding section of the hardkey bitmap (Device1.bmp) will overlay the device bitmap in order to display the key in its pressed state. The keys may be polled periodically to determine if their states (pressed/unpressed) have changed and whether they need to be updated. Alternatively, a callback routine may be set to trigger a particular action to be carried out when the state of a hardkey changes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
57
3.4.1 Hardkey simulation API
The hardkey simulation functions are part of the standard simulation program shipped with emWin. If using a user defined emWin simulation these functions may not be available. The table below lists the available hardkey-simulation-related routines in alphabetical order within their respective categories. Detailed descriptions of the routines follow:
Routine SIM_HARDKEY_GetNum() SIM_HARDKEY_GetState() SIM_HARDKEY_SetCallback() SIM_HARDKEY_SetMode() SIM_HARDKEY_SetState()
Explanation
Return the number of available hardkeys.
Return the state of a specified hardkey (0: unpressed, 1: pressed). Set a callback routine to be executed when the state of a specified hardkey changes. Set the behavior for a specified hardkey (default = 0: no toggle). Set the state for a specified hardkey (0: unpressed, 1: pressed).
SIM_HARDKEY_GetNum()
Description
Returns the number of available hardkeys.
Prototype
int SIM_HARDKEY_GetNum(void);
Return value
The number of available hardkeys found in the bitmap.
Additional information
The numbering order for hardkeys is standard reading order (left to right, then top to bottom). The topmost pixel of a hardkey is therefore found first, regardless of its horizontal position. In the bitmap below, for example, the hardkeys are labeled as they would be referenced by the KeyIndex parameter in other functions:
It is recommended to call this function in order to verify that a bitmap is properly loaded.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
58
CHAPTER
Simulation
SIM_HARDKEY_GetState()
Description
Returns the state of a specified hardkey.
Prototype
int SIM_HARDKEY_GetState(unsigned int KeyIndex);
Parameter KeyIndex
Description
Index of hardkey (0 = index of first key).
Return value
State of the specified hardkey: 0: unpressed 1: pressed
SIM_HARDKEY_SetCallback()
Description
Sets a callback routine to be executed when the state of a specified hardkey changes.
Prototype
SIM_HARDKEY_CB * SIM_HARDKEY_SetCallback(unsigned int KeyIndex, SIM_HARDKEY_CB * pfCallback);
Parameter KeyIndex pfCallback
Description
Index of hardkey (0 = index of first key). Pointer to callback routine.
Return value
Pointer to the previous callback routine.
Additional information
Note that multi tasking support has to be enabled if GUI functions need to be called within the callback functions. Without multi tasking support only the GUI functions which are allowed to be called within an interrupt routine should be used. The callback routine must have the following prototype:
Prototype
typedef void SIM_HARDKEY_CB(int KeyIndex, int State);
Parameter KeyIndex State
Description
Index of hardkey (0 = index of first key). State of the specified hardkey. See table below.
Permitted values for parameter State
0
Unpressed.
1
Pressed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
59
SIM_HARDKEY_SetMode()
Description
Sets the behavior for a specified hardkey.
Prototype
int SIM_HARDKEY_SetMode(unsigned int KeyIndex, int Mode);
Parameter KeyIndex Mode
Description
Index of hardkey (0 = index of first key). Behavior mode. See table below.
Permitted values for parameter Mode
0
Normal behavior (default).
1
Toggle behavior.
Additional information
Normal (default) hardkey behavior means that a key is considered pressed only as long as the mouse button is held down on it. When the mouse is released or moved off of the hardkey, the key is considered unpressed. With toggle behavior, each click of the mouse toggles the state of a hardkey to pressed or unpressed. That means if you click the mouse on a hardkey and it becomes pressed, it will remain pressed until you click the mouse on it again.
SIM_HARDKEY_SetState()
Description
Sets the state for a specified hardkey.
Prototype
int SIM_HARDKEY_SetState(unsigned int KeyIndex, int State);
Parameter KeyIndex State
Description
Index of hardkey (0 = index of first key). State of the specified hardkey. See table below.
Permitted values for parameter State
0
Unpressed.
1
Pressed.
Additional information
This function is only usable when SIM_HARDKEY_SetMode() is set to 1 (toggle mode).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
60
CHAPTER
Simulation
3.5 Integrating the emWin simulation into an existing simulation
In order to integrate the emWin simulation into an existing simulation, the source code of the simulation is not required. The source code of the simulation is not normally shipped with emWin. It is a separate (optional) software item and is not included in the emWin basic package. Normally the source code of the emWin simulation is not needed but available as an optional software item. As described earlier in this chapter the basic package and the trial version contains a simulation library. The API functions of this library can be used if for example the emWin simulation should be added to an existing hardware or real time kernel (RTOS) simulation. To add the emWin simulation to an existing simulation (written in C or C++, using the Win32 API), only a few lines of code need to be added.
3.5.1 Directory structure
The subfolder Simulation of the System folder contains the emWin simulation. The directory structure is shown on the right. The table below explains the contents of the subfolders:
Directory Simulation Res SIM_GUI WinMain
Content
Simulation source and header files to be used with and without the simulation source code. The folder also contains a ready to use simulation library. Resource files. GUI simulation source code (optional). Contains the WinMain routine.
3.5.2 Using the simulation library
The following steps will show how to use the simulation library to integrate the emWin simulation into an existing simulation:
· Step 1: Add the simulation library GUISim.lib to the project. · Step 2: Add all GUI files to the project as described in the chapter 2.1.1, "Subdi-
rectories". · Step 3: Add the include directories to the project as described in the chapter
2.1.2, "Include Directories". · Step 4: Modify WinMain.
3.5.2.1 Modifying WinMain
Every windows Win32 program starts with WinMain() (contrary to a normal C program from the command line, which starts with main(). All that needs to be done is to add a few lines of code to this routine. The following function calls need to be added (normally in the order as it's shown in the following application code example):
· SIM_GUI_Enable · SIM_GUI_Init · SIM_GUI_CreateLCDWindow · CreateThread · SIM_GUI_Exit
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
61
3.5.2.2 Example application
The following application is available under Sample\WinMain\SampleApp.c and shows how to integrate the emWin simulation into an existing application: #include <windows.h> #include "GUI_SIM_Win32.h"
void MainTask(void);
/*********************************************************************
*
*
_Thread
*/
static DWORD __stdcall _Thread(void * Parameter) {
MainTask();
return 0;
}
/*********************************************************************
*
*
_WndProcMain
*/
static LRESULT CALLBACK _WndProcMain(HWND hWnd, UINT message,
WPARAM wParam, LPARAM lParam) {
SIM_GUI_HandleKeyEvents(message, wParam);
switch (message) {
case WM_DESTROY:
PostQuitMessage(0);
break;
}
return DefWindowProc(hWnd, message, wParam, lParam);
}
/*********************************************************************
*
*
_RegisterClass
*/
static void _RegisterClass(HINSTANCE hInstance) {
WNDCLASSEX wcex;
memset(&wcex, 0, sizeof(wcex));
wcex.cbSize
= sizeof(WNDCLASSEX);
wcex.hInstance
= hInstance;
wcex.style
= CS_HREDRAW | CS_VREDRAW;
wcex.lpfnWndProc = (WNDPROC)_WndProcMain;
wcex.hIcon
= 0;
wcex.hCursor
= LoadCursor(NULL, IDC_ARROW);
wcex.hbrBackground = (HBRUSH)(COLOR_APPWORKSPACE + 1);
wcex.lpszMenuName = 0;
wcex.lpszClassName = "GUIApplication";
RegisterClassEx(&wcex);
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
62
CHAPTER
Simulation
/*********************************************************************
*
*
WinMain
*/
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
LPSTR
lpCmdLine, int
nCmdShow) {
DWORD ThreadID;
MSG Msg;
HWND hWndMain;
//
// Register window class
//
_RegisterClass(hInstance);
//
// Make sure the driver configuration is done
//
SIM_GUI_Enable();
//
// Create main window
//
hWndMain = CreateWindow("GUIApplication", "Application window",
WS_OVERLAPPEDWINDOW | WS_CLIPCHILDREN | WS_VISIBLE,
0, 0, 328, 267, NULL, NULL, hInstance, NULL);
//
// Initialize the emWin simulation and create an LCD window
//
SIM_GUI_Init(hInstance, hWndMain, lpCmdLine, "embOS - emWin Simulation");
SIM_GUI_CreateLCDWindow(hWndMain, 0, 0, 320, 240, 0);
//
// Create a thread which executes the code to be simulated
//
CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)_Thread, NULL, 0, &ThreadID);
//
// Main message loop
//
while (GetMessage(&Msg, NULL, 0, 0)) {
TranslateMessage(&Msg);
DispatchMessage(&Msg);
}
SIM_GUI_Exit();
}
3.5.3 Integration into the embOS Simulation
3.5.3.1 WinMain
The following code example shows how to modify the existing WinMain of the embOS simulation in order to integrate the emWin simulation. The red colored lines should be added to WinMain to initialize the emWin simulation, to create a simulation window and to exit the emWin simulation:
...
#include "GUI_SIM_Win32.h"
...
int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
LPSTR
lpCmdLine, int
nCmdShow) {
MSG Msg;
HACCEL hAccelTable;
HWND hWndMain;
BITMAP BmpDevice;
DWORD ThreadID;
//
// Init global data
//
_StopHyperThreading();
_hInst = hInstance;
//
// Register main window class
//
_RegisterClass();
//
// Load bitmap
//
_hBmpDevice = (HBITMAP)LoadImage(_hInst,
(LPCTSTR) IDB_DEVICE,
IMAGE_BITMAP, 0, 0, 0);
_hMenuPopup = LoadMenu(_hInst, (LPCSTR)IDC_CONTEXTMENU);
_hMenuPopup = GetSubMenu(_hMenuPopup, 0);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
63
// // Make sure the driver configuration is done // SIM_GUI_Enable(); // // Create main window // GetObject(_hBmpDevice, sizeof(BmpDevice), &BmpDevice); hWndMain = CreateWindowEx(WS_EX_TOPMOST, _sWindowClass, "embOS Simulation",
WS_SYSMENU | WS_CLIPCHILDREN | WS_POPUP | WS_VISIBLE, 10, 20, BmpDevice.bmWidth, BmpDevice.bmHeight, NULL, NULL, _hInst, NULL); if (!hWndMain) { return 1; // Error } // // Init emWin simulation and create window // SIM_GUI_Init(hInstance, hWndMain, lpCmdLine, "embOS - emWin Simulation"); SIM_GUI_CreateLCDWindow(hWndMain, 80, 50, 128, 64, 0); // // Show main window // ShowWindow(hWndMain, nCmdShow); // // Load accelerator table // hAccelTable = LoadAccelerators(_hInst, (LPCTSTR)IDC_WINMAIN); // // Application initialization // CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)Thread, NULL, 0, &ThreadID); // // Main message loop // if (SIM_Init(hWndMain) == 0) { while (GetMessage(&Msg, NULL, 0, 0)) { if (!TranslateAccelerator(Msg.hwnd, hAccelTable, &Msg)) { TranslateMessage(&Msg); DispatchMessage(&Msg); } } } // // Exit emWin simulation // SIM_GUI_Exit(); return 0; }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
64
CHAPTER
Simulation
3.5.3.2 Target program (main)
The emWin API can be called from one or more target threads. Without RTOS, the WIN32 API function CreateThread is normally used to create a target thread which calls the emWin API; within an RTOS simulation, a target task/thread (Created by the simulated RTOS) is used to call the emWin API. In other words: Use OS_CreateTask to create a task for the user interface. Below a modified embOS start application:
#include <windows.h> #include "RTOS.H" #include "HW_LED.h" #include "GUI.h"
OS_STACKPTR int Stack0[128], Stack1[128], Stack2[2000]; // Task stacks
OS_TASK
TCB0,
TCB1,
TCB2;
// Task-control-blocks
void Task0(void) { while (1) { HW_LED_Toggle0(); OS_Delay(100); }
}
void Task1(void) { while (1) { HW_LED_Toggle1(); OS_Delay(500); }
}
void MainTask(void) { int i;
GUI_COLOR aColor[] = {GUI_RED, GUI_YELLOW}; GUI_Init(); while (1) {
for (i = 0; i < 2; i++) { GUI_Clear(); GUI_SetColor(aColor[i]); GUI_SetFont(&GUI_FontComic24B_ASCII); GUI_DispStringAt("Hello world!", 1, 1); OS_Delay(200);
} } }
/**********************************************************
*
*
main
*/
void main(void) {
OS_IncDI();
// Initially disable interrupts
OS_InitKern();
// Initialize OS
OS_InitHW();
// Initialize Hardware for OS
//
// You need to create at least one task here!
//
OS_CREATETASK(&TCB0, "HP Task", Task0, 100, Stack0);
OS_CREATETASK(&TCB1, "LP Task", Task1,
50, Stack1);
OS_CREATETASK(&TCB2, "GUI Task", MainTask, 80, Stack2);
OS_Start();
// Start multitasking
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
65
The following table shows the simulation before and after integrating the emWin simulation:
Before
After
3.5.4 GUI simulation API
The table below lists the available routines for user defined simulation programs in alphabetical order within their respective categories. The functions are only available with the source code of the emWin simulation. Detailed descriptions of the routines follow:
Routine
SIM_GUI_CreateLCDInfoWindow() SIM_GUI_CreateLCDWindow() SIM_GUI_Enable() SIM_GUI_Exit() SIM_GUI_Init() SIM_GUI_SetLCDWindowHook()
Explanation
Creates a window which shows the available colors of the given layer with the given size and position. Creates a LCD window with the given size and position. Executes memory and driver configuration.
Stops the GUI simulation. Initializes the GUI simulation. Sets a hook function to be called if the LCD window receives a message.
SIM_GUI_CreateLCDInfoWindow()
Description
Creates a window which shows the available colors for the given layer.
Prototype
HWND SIM_GUI_CreateLCDInfoWindow(HWND hParent, int x, int y, int xSize, int ySize int LayerIndex);
Parameter hParent x y xSize
ySize LayerIndex
Description
Handle of the parent window.
X position in parent coordinates.
Y position in parent coordinates. X size in pixel of the new window. Should be 160 if using a color depth between 1 and 8 or 128 if working in high color mode. Y size in pixel of the new window. Should be 160 if using a color depth between 1 and 8 or 128 if working in high color mode. Index of layer to be shown.
Additional information
The created color window has no frame, no title bar and no buttons.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
66
CHAPTER
Example
SIM_GUI_CreateLCDInfoWindow(hWnd, 0, 0, 160, 160, 0);
Screenshot
Simulation
SIM_GUI_CreateLCDWindow()
Description
Creates a window which simulates a LCD display with the given size at the given position.
Prototype
HWND SIM_GUI_CreateLCDWindow(HWND hParent, int x, int y, int xSize, int ySize int LayerIndex);
Parameter hParent x y xSize ySize LayerIndex
Description
Handle of the parent window. X position in parent coordinates. Y position in parent coordinates. X size in pixel of the new window. Y size in pixel of the new window. Index of layer to be shown.
Additional information
All display output to the given layer will be shown in this window. The size of the window should be the same as configured in LCDConf.c. The created simulation window has no frame, no title bar and no buttons.
SIM_GUI_Enable()
Description
The function needs to be called at the beginning of the application to make sure that memory and driver will be configured at first.
Prototype
void SIM_GUI_Enable(void);
SIM_GUI_Exit()
Description
The function should be called before the simulation returns to the calling process.
Prototype
void SIM_GUI_Exit(void);
SIM_GUI_Init()
Description
This function initializes the emWin simulation and should be called before any other SIM_GUI... function call.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
67
Prototype
int SIM_GUI_Init(HINSTANCE hInst, HWND hWndMain, char * pCmdLine, const char * sAppName);
Parameter hInst hWndMain pCmdLine sAppName
Description Handle to current instance passed to WinMain.
Handle of the simulations main window.
Pointer to command line passed to WinMain
Pointer to a string that contains the application name.
Additional information
The parameters hWndMain and sAppName are used if a message box should be displayed.
SIM_GUI_SetLCDWindowHook()
Description
Sets a hook function to be called from the simulation if the LCD window receives a message.
Prototype
void SIM_GUI_SetLCDWindowHook(SIM_GUI_tfHook * pfHook);
Parameter pfHook
Pointer to hook function.
Description
Prototype of hook function
int Hook(HWND hWnd,
UINT Message, WPARAM wParam, LPARAM lParam,
int * pResult);
Parameter hWnd Message wParam lParam
pResult
Description
Handle of LCD window. Message received from the operating system. wParam message parameter passed by the system. lParam message parameter passed by the system. Pointer to an integer which should be used as return code if the message has been processed by the hook function.
Return value
The hook function should return 0 if the message has been processed. In this case the GUI simulation ignores the message.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
68
CHAPTER
Simulation
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
69
Chapter 4
Viewer
If you use the simulation when debugging your application, you cannot see the display output when stepping through the source code. The primary purpose of the viewer is to solve this problem. It shows the contents of the simulated display(s) while debugging in the simulation. The viewer gives you the following additional capabilities: · Multiple windows for each layer · Watching the whole virtual layer in one window · Magnification of each layer window · Composite view if using multiple layers
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
70
CHAPTER
Viewer
4.1 Using the viewer
The viewer allows you to: · Open multiple windows for any
layer/display · Zoom in on any area of a layer/
display · See the contents of the individ-
ual layers/displays as well as the composite view in multilayer configurations · See the contents of the virtual screen and the visible display when using the virtual screen support. The screenshot shows the viewer displaying the output of a single layer configuration. The upper left corner shows the simulated display. In the upper right corner is a window, which shows the available colors of the display configuration. At the bottom of the viewer a second display window shows a magnified area of the simulated display. If you start to debug your application, the viewer shows one display window per layer and one color window per layer. In a multi layer configuration, a composite view window will also be visible.
4.1.1 Using the simulation and the viewer
If you use the simulation when debugging your application, you cannot see the display output when stepping through the source code. This is due to a limitation of Win32: If one thread (the one being debugged) is halted, all other threads of the process are also halted. This includes the thread which outputs the simulated display on the screen. The emWin viewer solves this problem by showing the display window and the color window of your simulation in a separate process. It is your choice if you want to start the viewer before debugging your application or while you are debugging. Our suggestion:
· Step 1: Start the viewer. No display- or color window is shown until the simulation has been started.
· Step 2: Open the Visual C++ workspace. · Step 3: Compile and run the application program. · Step 4: Debug the application as described previously.
The advantage is that you can now follow all drawing operations step by step in the LCD window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
71
4.1.2 Using the viewer with virtual pages
By default the viewer opens one window per layer which shows the visible part of the video RAM, normally the display. If the configured virtual video RAM is larger than the display, the command View/Virtual Layer/Layer (0...4) can be used to show the whole video RAM in one window. When using the function GUI_SetOrg(), the contents of the visible screen will change, but the virtual layer window remains unchanged:
For more information about virtual screens, refer to chapter "Virtual screens / Virtual pages" on page 835.
4.1.3 Always on top
Per default the viewer window is always on top. You can change this behavior by selecting Options\Always on top from the menu.
4.1.4 Open further windows of the display output
If you want to show a magnified area of the LCD output or the composite view of a multi layer configuration it could be useful to open more than one output window. You can do this by View/Visible Layer/Layer (1...4), View/Virtual Layer/ Layer (1...4) or View/Composite.
4.1.5 Zooming
Zooming in or out is easy: Right-click on a layer or composite window opens the Zoom popup menu.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
72
CHAPTER
Choose one of the zoom options:
Using the grid
Viewer
If you magnify the LCD output >= 300%, you have the choice between showing the output with or without a grid. It is possible to change the color of the grid. This can be done choosing the Menu point Options/Grid color.
Adapting the size of the window
If you want to adapt the size of the window to the magnification choose Fit window to size from the first popup menu.
4.1.6 Copy the output to the clipboard
Click onto a LCD window or a composite view with the right mouse key and choose Copy to clipboard. Now you can paste the contents of the clipboard for example into the MS Paint application.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
73
4.1.7 Using the viewer with multiple displays
If you are working with multiple displays you should set the viewer into 'Multi display mode' by using the command Options/Multi layer/display.
When starting the debugger the viewer will open one display window and one color window for each display:
4.1.8 Using the viewer with multiple layers
If you are working with multiple layers you should set the viewer into 'Multi layer mode' by using the command Options/Multi layer/display.
When starting the debugger the viewer will open one LCD window and one color window for each layer and one composite window for the result.
Example
The example below shows a screenshot of the viewer with 2 layers. Layer 0 shows color bars with a high color configuration. Layer 1 shows a transparent circle on a white background with colored rectangles. The composite window shows the result which is actually visible on the display
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
74
CHAPTER
Viewer
Transparency
The composite window of the viewer shows all layers; layers with higher index are on top of layers with lower index and can have transparent pixels:
No transparency Pixels can be transparent
Layer 0 Layer 1 . . . Layer n
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
75
Chapter 5 Displaying Text
It is very easy to display text with emWin. Knowledge of only a few routines already allows you to write any text, in any available font, at any point on the display. We first provide a short introduction to displaying text, followed by more detailed explanations of the individual routines that are available.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
76
CHAPTER
Displaying Text
5.1 Basic routines
In order to display text on the LCD, simply call the routine GUI_DispString() with the text you want to display as parameters. For example:
GUI_DispString("Hello world!");
The above code will display the text "Hello world" at the current text position. However, as you will see, there are routines to display text in a different font or in a certain position. In addition, it is possible to write not only strings but also decimal, hexadecimal and binary values to the display. Even though the graphic displays are usually byte-oriented, the text can be positioned at any pixel of the display, not only at byte positions.
Control characters
Control characters are characters with a character code of less than 32. The control characters are defined as part of ASCII. emWin ignores all control characters except for the following:
Char. ASCII Code code
C
Description
10
LF
13
CR
Line feed.
The current text position is changed to the beginning of the next line. Per
\n
default, this is: X = 0.
Y + =font-distance in pixels (as delivered by GUI_GetFontDistY()).
Carriage return.
\r
The current text position is changed to the beginning of the current line. Per
default, this is: X = 0.
Usage of the control character LF can be very convenient in strings. A line feed can be made part of a string so that a string spanning multiple lines can be displayed with a single routine call.
Positioning text at a selected position
This may be done by using the routine GUI_GotoXY() as shown in the following example:
GUI_GotoXY(10,10);// Set text position (in pixels) GUI_DispString("Hello world!");// Show text
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
77
5.2 Text API
The table below lists the available text-related routines in alphabetical order within their respective categories. Detailed descriptions of the routines can be found in the sections that follow.
Routine
Explanation
Routines to display text
GUI_DispChar()
Displays single character at current position.
GUI_DispCharAt()
Displays single character at specified position.
GUI_DispChars()
Displays character a specified number of times.
GUI_DispNextLine()
Moves the cursor to the beginning of the next line.
GUI_DispString()
Displays string at current position.
GUI_DispStringAt()
Displays string at specified position.
GUI_DispStringAtCEOL()
Displays string at specified position, then clear to end of line.
GUI_DispStringHCenterAt() Displays string centered horizontally at the given position.
GUI_DispStringInRect()
Displays string in specified rectangle.
GUI_DispStringInRectEx() Displays string in specified rectangle and optionally rotates it.
GUI_DispStringInRectWrap() Displays string in specified rectangle with optional wrapping.
GUI_DispStringLen()
Display string at current position with specified number of characters.
GUI_WrapGetNumLines()
Get the number of text lines for the given wrap mode.
Selecting text drawing modes
GUI_GetTextMode()
Returns the current text mode
GUI_SetTextMode()
Sets text drawing mode.
GUI_SetTextStyle()
Sets the text style to be used.
Selecting text alignment
GUI_GetTextAlign()
Return current text alignment mode.
GUI_SetLBorder()
Set left border after line feed.
GUI_SetTextAlign()
Set text alignment mode.
Setting the current text position
GUI_GotoX()
Set current X-position.
GUI_GotoXY()
Set current (X,Y) position.
GUI_GotoY()
Set current Y-position.
Retrieving the current text position
GUI_GetDispPosX()
Return current X-position.
GUI_GetDispPosY()
GUI_Clear() GUI_DispCEOL()
Return current Y-position.
Routines to clear a window or parts of it
Clear active window (or entire display if background is the active window). Clear display from current text position to end of line.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
78
CHAPTER
Displaying Text
5.3 Routines to display text
GUI_DispChar()
Description
Displays a single character at the current text position in the current window using the current font.
Prototype
void GUI_DispChar(U16 c);
Parameter c
Character to display.
Description
Additional information
This is the basic routine for displaying a single character. All other display routines (GUI_DispCharAt(), GUI_DispString(), etc.) call this routine to output the individual characters. Which characters are available depends on the selected font. If the character is not available in the current font, nothing is displayed.
Example
Shows a capital A on the display: GUI_DispChar('A');
Related topics
GUI_DispChars(), GUI_DispCharAt()
GUI_DispCharAt()
Description
Displays a single character at a specified position in the current window using the current font.
Prototype
void GUI_DispCharAt(U16 c, I16P x, I16P y);
Parameter c x y
Description
Character to display. X-position to write to in pixels of the client window. Y-position to write to in pixels of the client window.
Add information
Displays the character with its upper left corner at the specified (X,Y) position. Writes the character using the routine GUI_DispChar(). If the character is not available in the current font, nothing is displayed.
Example
Shows a capital A on the display in the upper left corner: GUI_DispCharAt('A',0,0);
Related topics
GUI_DispChar(), GUI_DispChars()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
79
GUI_DispChars()
Description
Displays a character a specified number of times at the current text position in the current window using the current font.
Prototype
void GUI_DispChars(U16 c, int Cnt);
Parameter c Cnt
Description
Character to display. Number of repetitions (0 <= Cnt <= 32767).
Additional information
Writes the character using the routine GUI_DispChar(). If the character is not available in the current font, nothing is displayed.
Example
Shows the line "******************************" on the display: GUI_DispChars('*', 30);
Related topics
GUI_DispChar(), GUI_DispCharAt()
GUI_DispNextLine()
Description
Moves the cursor to the beginning of the next line.
Prototype
void GUI_DispNextLine(void);
Related topics
GUI_SetLBorder()
GUI_DispString()
Description
Displays the string passed as parameter at the current text position in the current window using the current font.
Prototype
void GUI_DispString(const char GUI_FAR * s);
Parameter
s
String to display.
Description
Additional information
The string can contain the control character \n. This control character moves the current text position to the beginning of the next line.
Example
Shows "Hello world" on the display and "Next line" on the next line: GUI_DispString("Hello world"); //Disp text GUI_DispString("\nNext line"); //Disp text
Related topics
GUI_DispStringAt(), GUI_DispStringAtCEOL(), GUI_DispStringLen()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
80
CHAPTER
Displaying Text
GUI_DispStringAt()
Description
Displays the string passed as parameter at a specified position in the current window using the current font.
Prototype
void GUI_DispStringAt(const char GUI_FAR * s, int x, int y);
Parameter s x y
Description
String to display. X-position to write to in pixels of the client window. Y-position to write to in pixels of the client window.
Example
Shows "Position 50,20" at position 50,20 on the display: GUI_DispStringAt("Position 50,20", 50, 20); // Disp text
Related topics
GUI_DispString(), GUI_DispStringAtCEOL(), GUI_DispStringLen(),
GUI_DispStringAtCEOL()
Description
This routine uses the exact same parameters as GUI_DispStringAt(). It does the same thing: displays a given string at a specified position. However, after doing so, it clears the remaining part of the line to the end by calling the routine GUI_DispCEOL(). This routine can be handy if one string is to overwrite another, and the overwriting string is or may be shorter than the previous one.
GUI_DispStringHCenterAt()
Description
Displays the string passed as parameter horizontally centered at a specified position in the current window using the current font.
Prototype
void GUI_DispStringHCenterAt(const char GUI_FAR * s, int x, int y);
Parameter s x y
Description
String to display. X-position to write to in pixels of the client window. Y-position to write to in pixels of the client window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
81
GUI_DispStringInRect()
Description
Displays the string passed as parameter at a specified position within a specified rectangle, in the current window using the current font.
Prototype
void GUI_DispStringInRect(const char GUI_UNI_PTR * s,
GUI_RECT
* pRect,
int
TextAlign);
Parameter s pRect
TextAlign
Description
String to display.
Rectangle to write to in pixels of the client window.
Alignment flags; "OR" combinable. A flag for horizontal and a flag for vertical alignment
should be combined. Available flags are: GUI_TA_TOP, GUI_TA_BOTTOM, GUI_TA_VCENTER for vertical alignment. GUI_TA_LEFT, GUI_TA_RIGHT, GUI_TA_HCENTER for horizontal alignment.
Example
Shows the word "Text" centered horizontally and vertically in the current window: GUI_RECT rClient; GUI_GetClientRect(&rClient); GUI_DispStringInRect("Text", &rClient, GUI_TA_HCENTER | GUI_TA_VCENTER);
Additional information
If the specified rectangle is too small, the text will be clipped.
Related topics
GUI_DispString(), GUI_DispStringAtCEOL(), GUI_DispStringLen(),
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
82
CHAPTER
Displaying Text
GUI_DispStringInRectEx()
Description
Displays the string passed as parameter at a specified position within a specified rectangle, in the current window using the current font and (optionally) rotates it.
Prototype
void GUI_DispStringInRectEx(const char *
s,
GUI_RECT *
pRect,
int
TextAlign,
int
MaxLen,
const GUI_ROTATION * pLCD_Api);
Parameter s pRect
TextAlign
MaxLen pLCD_Api
Description
String to display.
Rectangle to write to in pixels of the client window.
Alignment flags; "OR" combinable. A flag for horizontal and a flag for vertical align-
ment should be combined. Available flags are: GUI_TA_TOP, GUI_TA_BOTTOM, GUI_TA_VCENTER for vertical alignment. GUI_TA_LEFT, GUI_TA_RIGHT, GUI_TA_HCENTER for horizontal alignment. Maximum number of characters to be shown.
See table below.
Permitted values for parameter pLCD_Api
GUI_ROTATE_0
Does not rotate the text. Shows it from left to right.
GUI_ROTATE_180 GUI_ROTATE_CCW
Rotates the text by 180 degrees. Rotates the text counter clockwise.
GUI_ROTATE_CW
Rotates the text clockwise.
Example
Shows the word "Text" centered horizontally and vertically in the given rectangle:
GUI_RECT Rect = {10, 10, 40, 80}; char acText[] = "Rotated\ntext"; GUI_SetTextMode(GUI_TM_XOR); GUI_FillRectEx(&Rect); GUI_DispStringInRectEx(acText,
&Rect, GUI_TA_HCENTER | GUI_TA_VCENTER, strlen(acText), GUI_ROTATE_CCW);
Screenshot of above example
Additional information
If the specified rectangle is too small, the text will be clipped. To make the function available the configuration switch GUI_SUPPORT_ROTATION must be activated (default).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
83
GUI_DispStringInRectWrap()
Description
Displays a string at a specified position within a specified rectangle, in the current window using the current font and (optionally) wraps the text.
Prototype
void GUI_DispStringInRectWrap(const char GUI_UNI_PTR * s,
GUI_RECT *
pRect,
int
TextAlign,
GUI_WRAPMODE
WrapMode);
Parameter s pRect
TextAlign
WrapMode
Description
String to display.
Rectangle to write to in pixels of the client window.
Alignment flags; "OR" combinable. A flag for horizontal and a flag for vertical align-
ment should be combined. Available flags are: GUI_TA_TOP, GUI_TA_BOTTOM, GUI_TA_VCENTER for vertical alignment. GUI_TA_LEFT, GUI_TA_RIGHT, GUI_TA_HCENTER for horizontal alignment. See table below.
Permitted values for parameter WrapMode GUI_WRAPMODE_NONE No wrapping will be performed. GUI_WRAPMODE_WORD Text is wrapped word wise. GUI_WRAPMODE_CHAR Text is wrapped char wise.
Additional information
If word wrapping should be performed and the given rectangle is too small for a word char wrapping is executed at this word.
Example
Shows a text centered horizontally and vertically in the given rectangle with word
wrapping:
int i;
char acText[]
= "This example demonstrates text wrapping";
GUI_RECT Rect
= {10, 10, 59, 59};
GUI_WRAPMODE aWm[] = {GUI_WRAPMODE_NONE,
GUI_WRAPMODE_CHAR,
GUI_WRAPMODE_WORD};
GUI_SetTextMode(GUI_TM_TRANS);
for (i = 0; i < 3; i++) {
GUI_SetColor(GUI_BLUE);
GUI_FillRectEx(&Rect);
GUI_SetColor(GUI_WHITE);
GUI_DispStringInRectWrap(acText, &Rect, GUI_TA_LEFT, aWm[i]);
Rect.x0 += 60;
Rect.x1 += 60;
}
Screenshot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
84
CHAPTER
Displaying Text
GUI_DispStringLen()
Description
Displays the string passed as parameter with a specified number of characters at the current text position, in the current window using the current font.
Prototype
void GUI_DispStringLen(const char GUI_FAR * s, int Len);
Parameter s Len
Description
String to display. Should be a \0 terminated array of 8-bit character. Passing NULL as parameter is permitted. Number of characters to display.
Additional information
If the string has less characters than specified (is shorter), it is padded with spaces. If the string has more characters than specified (is longer), then only the given number of characters is actually displayed. This function is especially useful if text messages can be displayed in different languages (and will naturally differ in length), but only a certain number of characters can be displayed.
Related topics
GUI_DispString(), GUI_DispStringAt(), GUI_DispStringAtCEOL(),
GUI_WrapGetNumLines()
Description
Returns the number of lines used to show the given text with the given wrap mode.
Prototype
int GUI_WrapGetNumLines(const char GUI_UNI_PTR * pText,
int
xSize,
GUI_WRAPMODE
WrapMode);
Parameter pText xSize WrapMode
Description
String to display. Should be a \0 terminated array of 8-bit character. Passing NULL as parameter is permitted. X-size to be used to draw the text. See table below.
Permitted values for parameter WrapMode GUI_WRAPMODE_NONE No wrapping will be performed. GUI_WRAPMODE_WORD Text is wrapped word wise. GUI_WRAPMODE_CHAR Text is wrapped char wise.
Additional information
Please remember that the number of lines required to draw text depends on the currently selected font.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
85
5.4 Selecting text drawing modes
Normally, text is written into the selected window at the current text position using the selected font in normal text. Normal text means that the text overwrites whatever is already displayed where the bits set in the character mask are set on the display. In this mode, active bits are written using the foreground color, while inactive bits are written with the background color. However, in some situations it may be desirable to change this default behavior. emWin offers four flags for this purpose (one default plus three modifiers), which may be combined:
Normal text
Text can be displayed normally by specifying GUI_TEXTMODE_NORMAL or 0.
Reverse text
Text can be displayed reverse by specifying GUI_TEXTMODE_REV. What is usually displayed as white on black will be displayed as black on white.
Transparent text
Text can be displayed transparently by specifying GUI_TEXTMODE_TRANS. Transparent text means that the text is written on top of whatever is already visible on the display. The difference is that whatever was previously on the screen can still be seen, whereas with normal text the background is replaced with the currently selected background color.
XOR text
Text can be displayed using the XOR mode by specifying GUI_TEXTMODE_XOR. What usually is drawn white (the actual character) is inverted. The effect is identical to that of the default mode (normal text) if the background is black. If the background is white, the output is identical to reverse text. If you use colors, an inverted pixel is calculated as follows: New pixel color = number of colors - actual pixel color - 1.
Transparent reversed text
Text can be displayed in reverse transparently by specifying GUI_TEXTMODE_TRANS | GUI_TEXTMODE_REV. As with transparent text, it does not overwrite the background, and as with reverse text, the text is displayed in reverse.
Additional information
Please note that you can also use the abbreviated form: e.g. GUI_TM_NORMAL
Example
Displays normal, reverse, transparent, XOR, and transparent reversed text:
GUI_SetFont(&GUI_Font8x16);
GUI_SetBkColor(GUI_BLUE);
GUI_Clear();
GUI_SetPenSize(10);
GUI_SetColor(GUI_RED);
GUI_DrawLine(80, 10, 240, 90);
GUI_DrawLine(80, 90, 240, 10);
GUI_SetBkColor(GUI_BLACK);
GUI_SetColor(GUI_WHITE);
GUI_SetTextMode(GUI_TM_NORMAL);
GUI_DispStringHCenterAt("GUI_TM_NORMAL"
, 160, 10);
GUI_SetTextMode(GUI_TM_REV);
GUI_DispStringHCenterAt("GUI_TM_REV"
, 160, 26);
GUI_SetTextMode(GUI_TM_TRANS);
GUI_DispStringHCenterAt("GUI_TM_TRANS"
, 160, 42);
GUI_SetTextMode(GUI_TM_XOR);
GUI_DispStringHCenterAt("GUI_TM_XOR"
, 160, 58);
GUI_SetTextMode(GUI_TM_TRANS | GUI_TM_REV);
GUI_DispStringHCenterAt("GUI_TM_TRANS | GUI_TM_REV", 160, 74);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
86
CHAPTER
Screen shot of above example
Displaying Text
GUI_GetTextMode()
Description
Returns the currently selected text mode.
Prototype
int GUI_GetTextMode(void);
Return value
The currently selected text mode.
GUI_SetTextMode()
Description
Sets the text mode to the parameter specified.
Prototype
int GUI_SetTextMode(int TextMode);
Parameter TextMode
Description
Text mode to set. May be any combination of the TEXTMODE flags.
Permitted values for parameter TextMode (OR-combinable)
GUI_TEXTMODE_NORMAL
GUI_TEXTMODE_REV GUI_TEXTMODE_TRANS GUI_TEXTMODE_XOR
Causes text to be displayed normally. This is the default setting; the value is identical to 0. Causes text to be displayed reverse. Causes text to be displayed transparent. Causes text to invert the background.
Return value
The previous selected text mode.
Example
Shows "The value is" at position 0,0 on the display, shows a value in reverse text, then sets the text mode back to normal: int i = 20; GUI_DispStringAt("The value is", 0, 0); GUI_SetTextMode(GUI_TEXTMODE_REV); GUI_DispDec(20, 3); GUI_SetTextMode(GUI_TEXTMODE_NORMAL);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
87
GUI_SetTextStyle()
Description
Sets the text style to the parameter specified.
Prototype
char GUI_SetTextStyle(char Style);
Parameter Style
Description
Text style to set. See table below.
Permitted values for parameter Style
GUI_TS_NORMAL GUI_TS_UNDERLINE GUI_TS_STRIKETHRU GUI_TS_OVERLINE
Renders text normal (default). Renders text underlined. Renders text in strike through type. Renders text in overline type.
Return value
The previous selected text style.
5.5 Selecting text alignment
GUI_GetTextAlign()
Description
Returns the current text alignment mode.
Prototype
int GUI_GetTextAlign(void);
GUI_SetLBorder()
Description
Sets the left border for line feeds in the current window.
Prototype
void GUI_SetLBorder(int x)
Parameter
Description
x
New left border (in pixels, 0 is left border).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
88
CHAPTER
Displaying Text
GUI_SetTextAlign()
Description
Sets the text alignment mode for the next string output operation in the current window.
Prototype
int GUI_SetTextAlign(int TextAlign);
Parameter TextAlign
Description
Text alignment mode to set. May be a combination of a horizontal and a vertical alignment flag.
Permitted values for parameter TextAlign (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT GUI_TA_HCENTER GUI_TA_RIGHT
Align X-position left (default). Center X-position. Align X-position right.
Vertical alignment
GUI_TA_TOP
Align Y-position with top of characters (default).
GUI_TA_VCENTER Center Y-position.
GUI_TA_BOTTOM Align Y-position with bottom pixel line of font.
Return value
The selected text alignment mode.
Additional information
Setting the text alignment does not affect GUI_DispChar...()-functions. Text alignment is valid only for the current window.
Example
Displays the value 1234 with the center of the text at x=100, y=100: GUI_SetTextAlign(GUI_TA_HCENTER | GUI_TA_VCENTER); GUI_DispDecAt(1234,100,100,4);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
89
5.6 Setting the current text position
Every task has a current text position. This is the position relative to the origin of the window (usually (0,0)) where the next character will be written if a text output routine is called. Initially, this position is (0,0), which is the upper left corner of the current window. There are 3 functions which can be used to set the current text position.
GUI_GotoXY(), GUI_GotoX(), GUI_GotoY()
Description
Set the current text write position.
Prototypes
char GUI_GotoXY(int x, int y); char GUI_GotoX(int x); char GUI_GotoY(int y);
Parameter x y
Description
New X-position (in pixels, 0 is left border). New Y-position (in pixels, 0 is top border).
Return value
Usually 0. If a value != 0 is returned, then the current text position is outside of the window (to the right or below), so a following write operation can be omitted.
Additional information
GUI_GotoXY() sets both the X- and Y-components of the current text position. GUI_GotoX() sets the X-component of the current text position; the Y-component remains unchanged. GUI_GotoY() sets the Y-component of the current text position; the X-component remains unchanged.
Example
Shows "(20,20)" at position 20,20 on the display: GUI_GotoXY(20,20) GUI_DispString("The value is");
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
90
CHAPTER
5.7 Retrieving the current text position
GUI_GetDispPosX()
Description
Returns the current X-position.
Prototype
int GUI_GetDispPosX(void);
GUI_GetDispPosY()
Description
Returns the current Y-position.
Prototype
int GUI_GetDispPosY(void);
Displaying Text
5.8 Routines to clear a window or parts of it
GUI_Clear()
Description
Clears the current window.
Prototype
void GUI_Clear(void);
Additional information
If no window has been defined, the current window is the entire display. In this case, the entire display is cleared.
Example
Shows "Hello world" on the display, waits 1 second and then clears the display:
GUI_DispStringAt("Hello world", 0, 0); // Disp text
GUI_Delay(1000);
// Wait 1 second (not part of emWin)
GUI_Clear();
// Clear screen
GUI_DispCEOL()
Description
Clears the current window (or the display) from the current text position to the end of the line using the height of the current font.
Prototype
void GUI_DispCEOL(void);
Example
Shows "Hello world" on the display, waits 1 second and then displays "Hi" in the same place, replacing the old string:
GUI_DispStringAt("Hello world", 0, 0);// Disp text Delay (1000); GUI_DispStringAt("Hi", 0, 0); GUI_DispCEOL();
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
91
Chapter 6
Displaying Values
The preceding chapter explained how to show strings on the display. Of course you may use strings and the functions of the standard C library to display values. However, this can sometimes be a difficult task. It is usually much easier (and much more efficient) to call a routine that displays the value in the form that you want. emWin supports different decimal, hexadecimal and binary outputs. The individual routines are explained in this chapter. All functions work without the usage of a floating-point library and are optimized for both speed and size. Of course sprintf may also be used on any system. Using the routines in this chapter can sometimes simplify things and save both ROM space and execution time.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
92
CHAPTER
Displaying Values
6.1 Value API
The table below lists the available value-related routines in alphabetical order within their respective categories. Detailed descriptions of the routines can be found in the sections that follow.
Routine
Explanation
GUI_DispDec() GUI_DispDecAt() GUI_DispDecMin() GUI_DispDecShift() GUI_DispDecSpace() GUI_DispSDec() GUI_DispSDecShift()
Displaying decimal values
Display value in decimal form at current position with specified number of characters.
Display value in decimal form at specified position with specified number of characters.
Display value in decimal form at current position with minimum number of characters.
Display long value in decimal form with decimal point at current position with specified number of characters.
Display value in decimal form at current position with specified number of characters, replace leading zeros with spaces.
Display value in decimal form at current position with specified number of characters and sign.
Display long value in decimal form with decimal point at current position with specified number of characters and sign.
Displaying floating-point values
GUI_DispFloat() GUI_DispFloatFix() GUI_DispFloatMin() GUI_DispSFloatFix()
GUI_DispSFloatMin()
Display floating-point value with specified number of characters.
Display floating-point value with fixed no. of digits to the right of decimal point.
Display floating-point value with minimum number of characters.
Display floating-point value with fixed no. of digits to the right of decimal point and sign. Display floating-point value with minimum number of characters and sign.
Displaying binary values
GUI_DispBin()
Display value in binary form at current position.
GUI_DispBinAt()
Display value in binary form at specified position.
Displaying hexadecimal values
GUI_DispHex()
Display value in hexadecimal form at current position.
GUI_DispHexAt()
Display value in hexadecimal form at specified position.
Version of emWin
GUI_GetVersionString() Return the current version of emWin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
93
6.2 Displaying decimal values
GUI_DispDec()
Description
Displays a value in decimal form with a specified number of characters at the current text position, in the current window using the current font.
Prototype
void GUI_DispDec(I32 v, U8 Len);
Parameter v Len
Description
Value to display. Minimum -2147483648 (= -2^31). Maximum 2147483647 (= 2^31 -1).
No. of digits to display (max. 10).
Additional information
Leading zeros are not suppressed (are shown as 0). If the value is negative, a minus sign is shown.
Example
// Display time as minutes and seconds GUI_DispString("Min:"); GUI_DispDec(Min,2); GUI_DispString(" Sec:"); GUI_DispDec(Sec,2);
Related topics
GUI_DispSDec(), GUI_DispDecAt(), GUI_DispDecMin(), GUI_DispDecSpace()
GUI_DispDecAt()
Description
Displays a value in decimal form with a specified number of characters at a specified position, in the current window using the current font.
Prototype
void GUI_DispDecAt(I32 v, I16P x, I16P y, U8 Len);
Parameter
v
x y Len
Description
Value to display. Minimum -2147483648 (= -2^31). Maximum 2147483647 (= 2^31 -1). X-position to write to in pixels of the client window.
Y-position to write to in pixels of the client window.
No. of digits to display (max. 10).
Additional information
Leading zeros are not suppressed. If the value is negative, a minus sign is shown.
Example
// Update seconds in upper right corner GUI_DispDecAT(Sec, 200, 0, 2);
Related topics
GUI_DispDec(), GUI_DispSDec(), GUI_DispDecMin(), GUI_DispDecSpace()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
94
CHAPTER
Displaying Values
GUI_DispDecMin()
Description
Displays a value in decimal form at the current text position in the current window using the current font. The length of the value does not require to be specified. The minimum length will automatically be used.
Prototype
void GUI_DispDecMin(I32 v);
Parameter v
Description
Value to display. Minimum: -2147483648 (= -2^31); maximum 2147483647 (= 2^31 -1).
Additional information
The maximum number of displayed digits is 10. This function should not be used if values have to be aligned but differ in the number of digits. Try one of the functions which require specification of the number of digits to use in this case.
Example
// Show result GUI_DispString("The result is :"); GUI_DispDecMin(Result);
Related topics
GUI_DispDec(), GUI_DispDecAt(), GUI_DispSDec(), GUI_DispDecSpace()
GUI_DispDecShift()
Description
Displays a long value in decimal form with a specified number of characters and with decimal point at the current text position, in the current window using the current font.
Prototype
void GUI_DispDecShift(I32 v, U8 Len, U8 Shift);
Parameter v Len Shift
Description
Value to display. Minimum: -2147483648 (= -2^31); maximum: 2147483647 (= 2^31 -1). No. of digits to display (max. 10). No. of digits to show to right of decimal point.
Additional information
Watch the maximum number of 9 characters (including sign and decimal point).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
95
GUI_DispDecSpace()
Description
Displays a value in decimal form at the current text position in the current window using the current font. Leading zeros are suppressed (replaced by spaces).
Prototype
void DispDecSpace(I32 v, U8 MaxDigits);
Parameter v MaxDigits
Description
Value to display. Minimum: -2147483648 (= -2^31); maximum: 2147483647 (= 2^31 -1). No. of digits to display, including leading spaces. Maximum no. of digits displayed is 10 (excluding leading spaces).
Additional information
If values have to be aligned but differ in the number of digits, this function is a good choice.
Example
// Show result GUI_DispString("The result is :"); GUI_DispDecSpace(Result, 200);
Related topics
GUI_DispDec(), GUI_DispDecAt(), GUI_DispSDec(), GUI_DispDecMin()
GUI_DispSDec()
Description
Displays a value in decimal form (with sign) with a specified number of characters at the current text position, in the current window using the current font.
Prototype
void GUI_DispSDec(I32 v, U8 Len);
Parameter v Len
Description
Value to display. Minimum: -2147483648 (= -2^31); maximum: 2147483647 (= 2^31 -1). No. of digits to display (max. 10).
Additional information
Leading zeros are not suppressed. This function is similar to GUI_DispDec, but a sign is always shown in front of the value, even if the value is positive.
Related topics
GUI_DispDec(), GUI_DispDecAt(), GUI_DispDecMin(), GUI_DispDecSpace()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
96
CHAPTER
Displaying Values
GUI_DispSDecShift()
Description
Displays a long value in decimal form (with sign) with a specified number of characters and with decimal point at the current text position, in the current window using the current font.
Prototype
void GUI_DispSDecShift(I32 v, U8 Len, U8 Shift);
Parameter v Len Shift
Description
Value to display. Minimum: -2147483648 (= -2^31); maximum: 2147483647 (= 2^31 -1). No. of digits to display (max. 10).
No. of digits to show to right of decimal point.
Additional information
A sign is always shown in front of the value. Watch the maximum number of 9 characters (including sign and decimal point).
Example
void DemoDec(void) { long l = 12345; GUI_Clear(); GUI_SetFont(&GUI_Font8x8); GUI_DispStringAt("GUI_DispDecShift:\n",0,0); GUI_DispSDecShift(l, 7, 3); GUI_SetFont(&GUI_Font6x8); GUI_DispStringAt("Press any key",0,GUI_VYSIZE-8); WaitKey();
}
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
97
6.3 Displaying floating point values
GUI_DispFloat()
Description
Displays a floating point value with a specified number of characters at the current text position in the current window using the current font.
Prototype
void GUI_DispFloat(float v, char Len);
Parameter v Len
Description
Value to display. Minimum 1.2 E-38; maximum 3.4 E38. Number of digits to display (max. 10).
Additional information
Leading zeros are suppressed. The decimal point counts as one character. If the value is negative, a minus sign is shown.
Example
/* Shows all features for displaying floating point values */ void DemoFloat(void) {
float f = 123.45678; GUI_Clear(); GUI_SetFont(&GUI_Font8x8); GUI_DispStringAt("GUI_DispFloat:\n",0,0); GUI_DispFloat (f,9); GUI_GotoX(100); GUI_DispFloat (-f,9); GUI_DispStringAt("GUI_DispFloatFix:\n",0,20); GUI_DispFloatFix (f,9,2); GUI_GotoX(100); GUI_DispFloatFix (-f,9,2); GUI_DispStringAt("GUI_DispSFloatFix:\n",0,40); GUI_DispSFloatFix (f,9,2); GUI_GotoX(100); GUI_DispSFloatFix (-f,9,2); GUI_DispStringAt("GUI_DispFloatMin:\n",0,60); GUI_DispFloatMin (f,3); GUI_GotoX(100); GUI_DispFloatMin (-f,3); GUI_DispStringAt("GUI_DispSFloatMin:\n",0,80); GUI_DispSFloatMin (f,3); GUI_GotoX(100); GUI_DispSFloatMin (-f,3); GUI_SetFont(&GUI_Font6x8); GUI_DispStringAt("Press any key",0,GUI_VYSIZE-8); WaitKey(); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
98
CHAPTER
Screen shot of above example
Displaying Values
GUI_DispFloatFix()
Description
Displays a floating-point value with specified number of total characters and a specified number of characters to the right of the decimal point, at the current text position in the current window using the current font.
Prototype
void GUI_DispFloatFix(float v, char Len, char Decs);
Parameter v Len Decs
Description
Value to display. Minimum 1.2 E-38; maximum 3.4 E38. Number of digits to display (max. 10). Number of digits to show to the right of the decimal point.
Additional information
Leading zeros are not suppressed. If the value is negative, a minus sign is shown.
GUI_DispFloatMin()
Description
Displays a floating-point value with a minimum number of decimals to the right of the decimal point, at the current text position in the current window using the current font.
Prototype
void GUI_DispFloatMin(float f, char Fract);
Parameter v Fract
Description
Value to display. Minimum 1.2 E-38; maximum 3.4 E38. Minimum number of characters to display.
Additional information
Leading zeros are suppressed. If the value is negative, a minus sign is shown. The length does not need to be specified. The minimum length will automatically be used. If values have to be aligned but differ in the number of digits, one of the "...Fix()"functions should be used instead.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
99
GUI_DispSFloatFix()
Description
Displays a floating-point value (with sign) with a specified number of total characters and a specified number of characters to the right of the decimal point, in the current window using the current font.
Prototype
void GUI_DispSFloatFix(float v, char Len, char Decs);
Parameter v Len Decs
Description
Value to display. Minimum 1.2 E-38; maximum 3.4 E38. Number of digits to display (max. 10).
Number of digits to show to the right of the decimal point.
Additional information
Leading zeros are not suppressed. A sign is always shown in front of the value.
GUI_DispSFloatMin()
Description
Displays a floating-point value (with sign) with a minimum number of decimals to the right of the decimal point, at the current text position in the current window using the current font.
Prototype
void GUI_DispSFloatMin(float f, char Fract);
Parameter v Fract
Description
Value to display. Minimum 1.2 E-38; maximum 3.4 E38. Minimum number of digits to display.
Additional information
Leading zeros are suppressed. A sign is always shown in front of the value. The length does not need to be specified. The minimum length will automatically be used. If values have to be aligned but differ in the number of digits, one of the "...Fix()"functions should be used instead.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
100
CHAPTER
Displaying Values
6.4 Displaying binary values
GUI_DispBin()
Description
Displays a value in binary form at the current text position in the current window using the current font.
Prototype
void GUI_DispBin(U32 v, U8 Len);
Parameter v Len
Description
Value to display, 32-bit. No. of digits to display (including leading zeros).
Additional information
As with decimal and hexadecimal values, the least significant bit is rightmost.
Example
// // Show binary value 7, result: 000111 //
U32 Input = 0x7; GUI_DispBin(Input, 6);
Related topics
GUI_DispBinAt()
GUI_DispBinAt()
Description
Displays a value in binary form at a specified position in the current window using the current font.
Prototype
void GUI_DispBinAt(U32 v, I16P x, I16P y, U8 Len);
Parameter v x y Len
Description
Value to display, 16-bit. X-position to write to in pixels of the client window. Y-position to write to in pixels of the client window. No. of digits to display (including leading zeroes).
Additional information
As with decimal and hexadecimal values, the least significant bit is rightmost.
Example
// // Show binary input status //
GUI_DispBinAt(Input, 0,0, 8);
Related topics
GUI_DispBin(), GUI_DispHex()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
101
6.5 Displaying hexadecimal values
GUI_DispHex()
Description
Displays a value in hexadecimal form at the current text position in the current window using the current font.
Prototype
void GUI_DispHex(U32 v, U8 Len);
Parameter v Len
Value to display, 16-bit. No. of digits to display.
Description
Additional information
As with decimal and binary values, the least significant bit is rightmost.
Example
/* Show value of AD-converter */
GUI_DispHex(Input, 4);
Related topics
GUI_DispDec(), GUI_DispBin(), GUI_DispHexAt()
GUI_DispHexAt()
Description
Displays a value in hexadecimal form at a specified position in the current window using the current font.
Prototype
void GUI_DispHexAt(U32 v, I16P x, I16P y, U8 Len);
Parameter v x y Len
Description
Value to display, 16-bit. X-position to write to in pixels of the client window. Y-position to write to in pixels of the client window. No. of digits to display.
Additional information
As with decimal and binary values, the least significant bit is rightmost.
Example
// // Show value of AD-converter at specified position // GUI_DispHexAt(Input, 0, 0, 4);
Related topics
GUI_DispDec(), GUI_DispBin(), GUI_DispHex()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
102
CHAPTER
6.6 Version of emWin
GUI_GetVersionString()
Description
Returns a string containing the current version of emWin.
Prototype
const char * GUI_GetVersionString(void);
Example
// // Displays the current version at the current cursor position // GUI_DispString(GUI_GetVersionString());
Displaying Values
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
103
Chapter 7 2-D Graphic Library
emWin contains a complete 2-D graphic library which should be sufficient for most applications. The routines supplied with emWin can be used with or without clipping (refer to the chapter "The Window Manager (WM)" on page 331) and are based on fast and efficient algorithms. Currently, only the GUI_DrawArc() function requires floating-point calculations.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
104
CHAPTER
2-D Graphic Library
7.1 Graphic API
The table below lists the available graphic-related routines in alphabetical order within their respective categories. Detailed descriptions can be found in the sections that follow.
Routine
Description
GUI_GetPixelIndex()
Returns the color index of a given position.
Drawing modes
GUI_GetDrawMode()
Returns the current drawing mode.
GUI_SetDrawMode()
Sets the drawing mode.
Pen size
GUI_GetPenSize()
Returns the current pen size in pixels.
GUI_SetPenSize()
Sets the pen size in pixels.
Query current client rectangle
GUI_GetClientRect()
Returns the current available drawing area.
Basic drawing routines
GUI_ClearRect()
Fills a rectangular area with the background color.
GUI_CopyRect()
Copies a rectangle area on the display
GUI_DrawGradientH() GUI_DrawGradientV() GUI_DrawGradientRoundedH()
Draws a rectangle filled with a horizontal color gradient.
Draws a rectangle filled with a vertical color gradient.
Draws a rectangle with rounded corners filled with a horizontal color gradient.
GUI_DrawGradientRoundedV()
Draws a rectangle with rounded corners filled with a vertical color gradient.
GUI_DrawPixel()
Draws a single pixel.
GUI_DrawPoint()
Draws a point.
GUI_DrawRect()
Draws a rectangle.
GUI_DrawRectEx()
Draws a rectangle.
GUI_DrawRoundedFrame()
Draws a frame with rounded corners.
GUI_DrawRoundedRect()
Draws a rectangle with rounded corners.
GUI_FillRect()
Draws a filled rectangle.
GUI_FillRectEx()
Draws a filled rectangle.
GUI_FillRoundedRect()
Draws a filled rectangle with rounded corners.
GUI_InvertRect()
Invert a rectangular area.
Alpha blending
GUI_EnableAlpha()
Enables/disables automatic alpha blending
GUI_RestoreUserAlpha() GUI_SetAlpha()
Restores the previous state of user alpha blending
Sets the current alpha blending value. (Obsolete)
GUI_SetUserAlpha()
Sets an additional value which is used to calculate the actual alpha blending value to be used.
Drawing bitmaps
GUI_DrawBitmap()
Draws a bitmap.
GUI_DrawBitmapEx()
Draws a scaled bitmap.
GUI_DrawBitmapHWAlpha()
Draws a bitmap with alpha blending information on a system with hardware alpha blending support.
GUI_DrawBitmapMag()
Draws a magnified bitmap.
Drawing streamed bitmaps
GUI_CreateBitmapFromStream() GUI_CreateBitmapFromStreamIDX()
Creates a bitmap from a given stream of any type.
Creates a bitmap from an index based bitmap stream.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
105
Routine
Description
GUI_CreateBitmapFromStreamRLE4()
Creates a bitmap from an RLE4 bitmap stream.
GUI_CreateBitmapFromStreamRLE8()
Creates a bitmap from an RLE8 bitmap stream.
GUI_CreateBitmapFromStream565()
Creates a bitmap from a 16bpp (565) bitmap stream.
GUI_CreateBitmapFromStreamM565()
Creates a bitmap from a 16bpp (M565) bitmap stream with red and blue swapped.
GUI_CreateBitmapFromStream555()
Creates a bitmap from a 16bpp (555) bitmap stream.
GUI_CreateBitmapFromStreamM555()
Creates a bitmap from a 16bpp (M555) bitmap stream with red and blue swapped.
GUI_CreateBitmapFromStreamRLE16()
Creates a bitmap from an RLE16 (565) bitmap stream.
GUI_CreateBitmapFromStreamRLEM16()
Creates a bitmap from an RLEM16 (M565) bitmap stream with red and blue swapped.
GUI_CreateBitmapFromStream24()
Creates a bitmap from a 24 bit bitmap stream.
GUI_CreateBitmapFromStreamAlpha()
Creates a bitmap from a 32 bit bitmap stream.
Creates a bitmap from an RLE compressed 8 bit
GUI_CreateBitmapFromStreamRLEAlpha() alpha bitmap stream.
GUI_CreateBitmapFromStreamRLE32()
Creates a bitmap from an RLE32 bitmap stream.
GUI_DrawStreamedBitmap()
Draws a bitmap from an indexed based bitmap stream (1 - 8bpp).
GUI_DrawStreamedBitmapAuto()
Draws a bitmap from a bitmap stream of any supported format.
GUI_DrawStreamedBitmapEx()
Draws a bitmap from an indexed based bitmap stream (1 - 8bpp) without loading the complete image.
GUI_DrawStreamedBitmapExAuto()
Draws a bitmap from a bitmap stream of any supported format without loading the complete image.
GUI_DrawStreamedBitmap555Ex()
Draws a bitmap from a 16bpp (555) bitmap stream without loading the complete image.
GUI_DrawStreamedBitmapM555Ex()
Draws a bitmap from a 16bpp (M555) bitmap stream without loading the complete image.
GUI_DrawStreamedBitmap565Ex()
Draws a bitmap from a 16bpp (565) bitmap stream without loading the complete image.
GUI_DrawStreamedBitmapM565Ex()
Draws a bitmap from a 16bpp (M565) bitmap stream without loading the complete image.
GUI_DrawStreamedBitmap24Ex()
Draws a bitmap from a 24bpp bitmap stream without loading the complete image.
GUI_GetStreamedBitmapInfo()
Returns information about the given stream.
GUI_GetStreamedBitmapInfoEx()
Returns information about the given stream which can be located on any kind of media.
GUI_SetStreamedBitmapHook()
Sets a hook function for GUI_DrawStreamedBitmapEx().
Drawing lines
GUI_DrawHLine() GUI_DrawLine()
GUI_DrawLineRel()
GUI_DrawLineTo() GUI_DrawPolyLine() GUI_DrawVLine() GUI_GetLineStyle() GUI_MoveRel() GUI_MoveTo() GUI_SetLineStyle()
Draws a horizontal line. Draws a line from a specified start point to a specified end point (absolute coordinates). Draws a line from the current position to an endpoint specified by X- and Y-distances (relative coordinates). Draws a line from the current position to a specified endpoint. Draws a polyline.
Draws a vertical line.
Returns the current line style. Moves the line pointer relative to its current position. Moves the line pointer to the given position.
Sets the current line style.
Drawing polygons
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
106
CHAPTER
2-D Graphic Library
Routine
Description
GUI_DrawPolygon() GUI_EnlargePolygon() GUI_FillPolygon() GUI_MagnifyPolygon() GUI_RotatePolygon()
Draws the outline of a polygon. Enlarges a polygon. Draws a filled polygon. Magnifies a polygon. Rotates a polygon by a specified angle.
Drawing circles
GUI_DrawCircle() GUI_FillCircle()
Draws the outline of a circle. Draws a filled circle.
Drawing ellipses
GUI_DrawEllipse() GUI_FillEllipse()
Draws the outline of an ellipse. Draws a filled ellipse.
Drawing arcs
GUI_DrawArc() GUI_DrawGraph() GUI_DrawPie()
Draws an arc.
Drawing a graph
Draws a graph.
Drawing a pie chart
Draws a circle sector.
Saving and restoring the GUI-context
GUI_RestoreContext() GUI_SaveContext()
Restores the GUI-context. Saves the GUI-context.
Clipping
GUI_SetClipRect()
Sets the rectangle used for clipping.
GUI_GetPixelIndex()
Description
Returns the color index of a given position.
Prototype
unsigned GUI_GetPixelIndex(int x, int y);
Parameter x y
absolute x-position of the pixel absolute y-position of the pixel
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
107
7.2 Drawing modes
emWin can draw in NORMAL mode or in XOR mode. The default is NORMAL mode, in which the content of the display is overdrawn by the graphic. In XOR mode, the content of the display is inverted when it is overdrawn.
Restrictions associated with GUI_DRAWMODE_XOR
· XOR mode is only useful when using two displayed colors inside the active window or screen.
· Some drawing functions of emWin do not work precisely with this drawing mode. Generally, this mode works only with a pen size of one pixel. That means before using functions like GUI_DrawLine(), GUI_DrawCircle(), GUI_DrawRect() and so on, you must make sure that the pen size is set to 1 when you are working in XOR mode.
· When drawing bitmaps with a color depth greater than 1 bit per pixel (bpp) this drawing mode takes no effect.
· When using drawing functions such as GUI_DrawPolyLine() or multiple calls of GUI_DrawLineTo(), the fulcrums are inverted twice. The result is that these pixels remain in the background color.
GUI_GetDrawMode()
Description
Returns the current drawing mode.
Prototype
GUI_DRAWMODE GUI_GetDrawMode(void);
Return value
The currently selected drawing mode.
GUI_SetDrawMode()
Description
Selects the specified drawing mode.
Prototype
GUI_DRAWMODE GUI_SetDrawMode(GUI_DRAWMODE mode);
Parameter mode
Description
Drawing mode to set. May be a value returned by any routine which sets the drawing mode or one of the constants below.
Permitted values for parameter mode
GUI_DM_NORMAL GUI_DM_XOR
Default: Draws points, lines, areas, bitmaps.
Inverts points, lines, areas when overwriting the color of another object on the display.
Return value
The selected drawing mode.
Additional information
In addition to setting the drawing mode, this routine may also be used to restore a drawing mode that has previously been changed. If using colors, an inverted pixel is calculated as follows: New pixel color = number of colors - actual pixel color - 1.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
108
CHAPTER
2-D Graphic Library
Example
// // Showing two circles, the second one XOR-combined with the first: // GUI_Clear(); GUI_SetDrawMode(GUI_DRAWMODE_NORMAL); GUI_FillCircle(120, 64, 40); GUI_SetDrawMode(GUI_DRAWMODE_XOR); GUI_FillCircle(140, 84, 40);
Screen shot of above example
7.3 Query current client rectangle
GUI_GetClientRect()
Description
The current client rectangle depends on using the Window Manager or not. If using the Window Manager the function uses WM_GetClientRect to retrieve the client rectangle. If not using the Window Manager the client rectangle corresponds to the complete LCD display.
Prototype
void GUI_GetClientRect(GUI_RECT * pRect);
Parameter
Description
pRect
Pointer to the GUI_RECT-structure to store result in.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
109
7.4 Pen size
The pen size determines the thickness of the following vector drawing operations: · GUI_DrawPoint() · GUI_DrawLine() · GUI_DrawLineRel() · GUI_DrawLineTo() · GUI_DrawPolyLine() · GUI_DrawPolygon() · GUI_DrawEllipse() · GUI_DrawArc()
Please note that it is not possible to combine line styles with a pen size > 1.
GUI_GetPenSize()
Description
Returns the current pen size.
Prototype
U8 GUI_GetPenSize(void);
GUI_SetPenSize()
Description
Sets the pen size to be used for further drawing operations.
Prototype
U8 GUI_SetPenSize(U8 PenSize);
Parameter
PenSize
Pen size in pixels to be used.
Return value
Previous pen size.
Add information
The pen size should be >= 1.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
110
CHAPTER
2-D Graphic Library
7.5 Basic drawing routines
The basic drawing routines allow drawing of individual points, horizontal and vertical lines and shapes at any position on the display. Any available drawing mode can be used. Since these routines are called frequently in most applications, they are optimized for speed as much as possible. For example, the horizontal and vertical line functions do not require the use of single-dot routines.
GUI_ClearRect()
Description
Clears a rectangular area at a specified position in the current window by filling it with the background color.
Prototype
void GUI_ClearRect(int x0, int y0, int x1, int y1);
Parameter x0 y0 x1 y1
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position.
Description
Related topics
GUI_InvertRect(), GUI_FillRect()
GUI_CopyRect()
Description
Copies the content of the given rectangular area to the specified position.
Prototype
void GUI_CopyRect(int x0, int y0, int x1, int y1, int xSize, int ySize);
Parameter x0 y0 x1 y1 xSize ySize
Description
Upper left X-position of the source rectangle. Upper left Y-position of the source rectangle. Upper left X-position of the destination rectangle. Upper left Y-position of the destination rectangle. X-size of the rectangle. Y-size of the rectangle.
Additional information
The source and destination rectangle may overlap each other.
GUI_DrawGradientH()
Description
Draws a rectangle filled with a horizontal color gradient.
Prototype
void GUI_DrawGradientH(int x0, int y0, int x1, int y1,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
111
GUI_COLOR Color0, GUI_COLOR Color1);
Parameter x0 y0 x1 y1 Color0 Color1
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Color to be drawn on the leftmost side of the rectangle. Color to be drawn on the rightmost side of the rectangle.
Example
GUI_DrawGradientH(0, 0, 99, 99, 0x0000FF, 0x00FFFF);
Screenshot of above example
GUI_DrawGradientV()
Description
Draws a rectangle filled with a vertical color gradient.
Prototype
void GUI_DrawGradientV(int x0, int y0, int x1, int y1, GUI_COLOR Color0, GUI_COLOR Color1);
Parameter x0 y0 x1 y1 Color0 Color1
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Color to be drawn on the topmost side of the rectangle. Color to be drawn on the bottommost side of the rectangle.
Example
GUI_DrawGradientV(0, 0, 99, 99, 0x0000FF, 0x00FFFF);
Screenshot of above example
GUI_DrawGradientRoundedH()
Description
Draws a rectangle with rounded corners filled with a horizontal color gradient.
Prototype
void GUI_DrawGradientRoundedH(int x0, int y0, int x1, int y1, int rd
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
112
CHAPTER
2-D Graphic Library
GUI_COLOR Color0, GUI_COLOR Color1);
Parameter x0 y0 x1 y1 rd Color0 Color1
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Radius to be used for the rounded corners. Color to be drawn on the leftmost side of the rectangle. Color to be drawn on the rightmost side of the rectangle.
Example
GUI_DrawGradientRoundedH(0, 0, 99, 99, 25, 0x0000FF, 0x00FFFF);
Screenshot of above example
GUI_DrawGradientRoundedV()
Description
Draws a rectangle with rounded corners filled with a vertical color gradient.
Prototype
void GUI_DrawGradientRoundedV(int x0, int y0, int x1, int y1, GUI_COLOR Color0, GUI_COLOR Color1);
Parameter x0 y0 x1 y1 Color0 Color1
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Color to be drawn on the leftmost side of the rectangle. Color to be drawn on the rightmost side of the rectangle.
Example
GUI_DrawGradientRoundedV(0, 0, 99, 99, 25, 0x0000FF, 0x00FFFF);
Screenshot of above example
GUI_DrawPixel()
Description
Draws a pixel at a specified position in the current window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
113
Prototype
void GUI_DrawPixel(int x, int y);
Parameter x y
X-position of pixel. Y-position of pixel.
Description
Related topics
GUI_DrawPoint()
GUI_DrawPoint()
Description
Draws a point with the current pen size at a specified position in the current window.
Prototype
void GUI_DrawPoint(int x, int y);
Parameter x y
X-position of point. Y-position of point.
Description
Related topics
GUI_DrawPixel()
GUI_DrawRect()
Description
Draws a rectangle at a specified position in the current window.
Prototype
void GUI_DrawRect(int x0, int y0, int x1, int y1);
Parameter x0 y0 x1 y1
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position.
Description
GUI_DrawRectEx()
Description
Draws a rectangle at a specified position in the current window.
Prototype
void GUI_DrawRectEx(const GUI_RECT * pRect);
Parameter
Description
pRect
Pointer to a GUI_RECT-structure containing the coordinates of the rectangle
GUI_DrawRoundedFrame()
Description
Draws a frame at a specified position in the current window with rounded corners an a specified width.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
114
CHAPTER
2-D Graphic Library
Prototype
void GUI_DrawRoundedFrame(int x0, int y0, int x1, int y1, int r, int w);
Parameter x0 y0 x1 y1 r w
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Radius to be used for the rounded corners. Width in which the frame is drawn.
GUI_DrawRoundedRect()
Description
Draws a rectangle at a specified position in the current window with rounded corners.
Prototype
void GUI_DrawRoundedRect(int x0, int y0, int x1, int y1, int r);
Parameter x0 y0 x1 y1 r
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Radius to be used for the rounded corners.
GUI_FillRect()
Description
Draws a filled rectangular area at a specified position in the current window.
Prototype
void GUI_FillRect(int x0, int y0, int x1, int y1);
Parameter x0 y0 x1 y1
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position.
Description
Additional information
Uses the current drawing mode, which normally means all pixels inside the rectangle are set.
Related topics
GUI_InvertRect(), GUI_ClearRect()
GUI_FillRectEx()
Description
Draws a filled rectangle at a specified position in the current window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
115
Prototype
void GUI_FillRectEx(const GUI_RECT * pRect);
Parameter
Description
pRect
Pointer to a GUI_RECT-structure containing the coordinates of the rectangle
GUI_FillRoundedRect()
Description
Draws a filled rectangle at a specified position in the current window with rounded corners.
Prototype
void GUI_FillRoundedRect(int x0, int y0, int x1, int y1, int r);
Parameter x0 y0 x1 y1 r
Description
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position. Radius to be used for the rounded corners.
GUI_InvertRect()
Description
Draws an inverted rectangular area at a specified position in the current window.
Prototype
void GUI_InvertRect(int x0, int y0, int x1, int y1);
Parameter x0 y0 x1 y1
Upper left X-position. Upper left Y-position. Lower right X-position. Lower right Y-position.
Related topics
GUI_FillRect(), GUI_ClearRect()
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
116
CHAPTER
2-D Graphic Library
7.6 Alpha blending
Alpha blending is a method of combining a foreground image with the background to create the appearance of semi transparency. An alpha value determines how much of a pixel should be visible and how much of the background should show through.
Color information
emWin internally works with 32 bits of color information:
· Bits 0-7: Red · Bits 8-15: Green · Bits 16-23: Blue · Bits 24-31: Alpha information
An alpha value of 0 means opaque and a value of 255 means completely transparent.
How it works
The alpha blending is done completely automatically once it is enabled by using the function GUI_EnableAlpha(). This makes emWin regard the upper 8 bits of the color information as alpha value. Enabling alpha blending is required only for functions which use the background or foreground color. Bitmaps which already contain alpha values (32bpp) are automatically displayed properly, so enabling alpha blending is not required in this case.
Example
The following small example shows how it works: GUI_EnableAlpha(1); GUI_SetBkColor(GUI_WHITE); GUI_Clear(); GUI_SetColor(GUI_BLACK); GUI_DispStringHCenterAt("Alphablending", 45, 41); GUI_SetColor((0x40uL << 24) | GUI_RED); GUI_FillRect(0, 0, 49, 49); GUI_SetColor((0x80uL << 24) | GUI_GREEN); GUI_FillRect(20, 20, 69, 69); GUI_SetColor((0xC0uL << 24) | GUI_BLUE); GUI_FillRect(40, 40, 89, 89);
Older versions
In older versions it was required to use the function GUI_SetAlpha() for blending the foreground with the current background color information. This also works but is no longer required.
GUI_EnableAlpha()
Description
Enables or disables automatic alpha blending.
Prototype
unsigned GUI_EnableAlpha(unsigned OnOff);
Parameter
Description
OnOff
1 enables automatic alpha blending, 0 disables it.
Return value
Old state.
Additional information
After enabling automatic alpha blending the color information of each object automatically determines its transparency.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
117
GUI_SetAlpha()
(Obsolete)
Description
Enables software alpha blending for all subsequent drawing operations.
Prototype
unsigned GUI_SetAlpha(U8 Value);
Parameter Alpha
Description
Alpha value to be used for all subsequent drawing operations. Default is 0 which means no alpha blending.
Return value
Previous value used for alpha blending.
Additional information
The function sets the alpha value to be used for all subsequent drawing operations. A value of 0 for parameter Alpha means opaque (alpha blending disabled) and a value of 255 means completely transparent (invisible). Note that software alpha blending increases the CPU load. Further it is strongly recommended to set the alpha value back to the default value after finishing the drawing operations.
Example
extern const GUI_BITMAP _LogoBitmap;
GUI_SetColor(GUI_BLUE);
GUI_FillCircle(100, 50, 49);
GUI_SetColor(GUI_YELLOW);
for (i = 0; i < 100; i++) {
U8 Alpha;
Alpha = (i * 255 / 100);
GUI_SetAlpha(Alpha);
GUI_DrawHLine(i, 100 - i, 100 + i);
}
GUI_SetAlpha(0x80);
GUI_DrawBitmap(&_LogoBitmap, 30, 30);
GUI_SetColor(GUI_MAGENTA);
GUI_SetFont(&GUI_Font24B_ASCII);
GUI_SetTextMode(GUI_TM_TRANS);
GUI_DispStringHCenterAt("Alphablending", 100, 3);
GUI_SetAlpha(0);
/* Set back to default (opaque) */
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
118
CHAPTER
2-D Graphic Library
GUI_SetUserAlpha()
Description
Sets an additional value which is used to calculate the actual alpha value to be used. The actual alpha value is calculated as follows:
Alpha = AlphaFromObject + ((255 - AlphaFromObject) * UserAlpha) / 255
Prototype
U32 GUI_SetUserAlpha(GUI_ALPHA_STATE * pAlphaState, U32 UserAlpha);
Parameter pAlphaState UserAlpha
Description
Pointer to an GUI_ALPHA_STATE structure to be used to save the current state. Value to be used.
Return value
Previous user alpha value.
Additional information
The following function GUI_RestoreUserAlpha() can be used to restore the previous state of the function.
GUI_RestoreUserAlpha()
Description
Restores the previous state of user alpha blending. saved in the structure pointed by.
Prototype
U32 GUI_RestoreUserAlpha(GUI_ALPHA_STATE * pAlphaState);
Parameter pAlphaState
Description
Pointer to an GUI_ALPHA_STATE structure containing information of the previous state to be restored.
Return value
Current user alpha value.
Example
{ GUI_ALPHA_STATE AlphaState;
GUI_EnableAlpha(1); GUI_SetBkColor(GUI_WHITE); GUI_Clear(); GUI_SetColor(GUI_BLACK); GUI_DispStringHCenterAt("Alphablending", 45, 41); GUI_SetUserAlpha(&AlphaState, 0xC0); GUI_SetColor(GUI_RED); GUI_FillRect(0, 0, 49, 49); GUI_SetColor(GUI_GREEN); GUI_FillRect(20, 20, 69, 69); GUI_SetColor(GUI_BLUE); GUI_FillRect(40, 40, 89, 89); GUI_RestoreUserAlpha(&AlphaState); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
119
7.7 Drawing bitmaps
Generally emWin is able to display any bitmap image at any display position. On 16 bit CPUs (sizeof(int) == 2), the size of one bitmap per default is limited to 64 kb. If larger bitmaps should be displayed with a 16 bit CPU, refer to the chapter "Configuration" on page 1039.
GUI_DrawBitmap()
Description
Draws a bitmap image at a specified position in the current window.
Prototype
void GUI_DrawBitmap(const GUI_BITMAP * pBM, int x, int y);
Parameter pBM x y
Description
Pointer to the bitmap to display. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Additional information
The picture data is interpreted as bit stream starting with the most significant bit (msb) of the first byte. A new line always starts at an even byte address, as the nth line of the bitmap starts at offset n*BytesPerLine. The bitmap can be shown at any point in the client area. Usually, the Bitmap Converter is used to generate bitmaps. For more information, refer to the chapter "Bitmap Converter" on page 177.
Example
extern const GUI_BITMAP bmSeggerLogoBlue; /* declare external Bitmap */
void main() { GUI_Init(); GUI_DrawBitmap(&bmSeggerLogoBlue, 45, 20);
}
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
120
CHAPTER
2-D Graphic Library
GUI_DrawBitmapEx()
Description
This routine makes it possible to scale and/or to mirror a bitmap on the display.
Prototype
void GUI_DrawBitmapEx(const GUI_BITMAP * pBitmap,
int x0,
int y0,
int xCenter, int yCenter,
int xMag, int yMag);
Parameter pBM x0 y0 xCenter yCenter xMag yMag
Description
Pointer to the bitmap to display. X-position of the anchor point in the display. Y-position of the anchor point in the display. X-position of the anchor point in the bitmap. Y-position of the anchor point in the bitmap. Scale factor of X-direction. Scale factor of Y-direction.
Additional information
A negative value of the xMag-parameter would mirror the bitmap in the X-axis and a negative value of the yMag-parameter would mirror the bitmap in the Y-axis. The unit of xMag- and yMag are thousandth. The position given by the parameter xCenter and yCenter specifies the pixel of the bitmap which should be displayed at the display at position x0/y0 independent of scaling or mirroring. This function can not be used to draw RLE-compressed bitmaps.
GUI_DrawBitmapHWAlpha()
Description
Draws a bitmap with alpha information on a multi layer system with hardware alpha blending support.
Prototype
void GUI_DrawBitmapHWAlpha(const GUI_BITMAP GUI_UNI_PTR * pBM, int x0, int y0);
Parameter pBM x0 y0
Description
Pointer to the bitmap to display. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Additional information
In emWin logical colors are handled as 32 bit values. The lower 24 bits are used for the color information and the upper 8 bits are used to manage the alpha value. An alpha value of 0 means the image is opaque and a value of 0xFF means completely transparent (invisible). On systems with hardware support for alpha blending the alpha values need to be written to the display controller which does the alpha blending. Normally the alpha format of the hardware is not the same as the alpha definition in emWin described above. Mostly a value of 0 means fully transparent and higher values means the pixel becomes more visible. Because of this in the most cases custom color conversion routines are required to translate a logical color to the required hardware format. The Sample folder contains the example ALPHA_DrawBitmapHWAlpha which shows how to consider the requirement of custom color conversion.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
121
GUI_DrawBitmapMag()
Description
This routine makes it possible to magnify a bitmap on the display.
Prototype
void GUI_DrawBitmapMag(const GUI_BITMAP * pBM, int x0, int y0, int XMul, int YMul);
Parameter pBM x0 y0 XMul YMul
Description
Pointer to the bitmap to display. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Magnification factor of X-direction. Magnification factor of Y-direction.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
122
CHAPTER
2-D Graphic Library
7.8 Drawing streamed bitmaps
Streamed bitmaps can be located in addressable area (RAM or ROM) as well as external memory (e.g. on removable devices).
Drawing from addressable memory
There are 2 possibilities to display streamed bitmaps which are located on addressable memory. The first one is to use the function GUI_DrawStreamedBitmap() or the function GUI_DrawStreamedBitmapAuto(). The second one is to create a GUI_BITMAP according to the streamed bitmap and use it for a regular call of e.g. GUI_DrawBitmap().
Drawing from external memory
Streamed bitmaps which are located on external memory can be drawn using the ...Ex() functions. ...Ex() functions require a pointer to a user defined GetData() function (see "Getting data with the ...Ex() functions" on page 174) in order to have emWin retrieve the stream self-dependently. If the format of the streamed bitmap is unknown at run-time, the function GUI_DrawStreamedBitmapExAuto() should be used.
Requirements
The ...Ex() functions require to have enough free memory which is assigned to emWin to store at least one line of pixel data. If there is not enough free memory, the function will return immediately without having anything drawn. Using the ...Auto() function causes the linker to add all functions referenced by the ...Auto() function. If there is not enough memory the according function for the specific format should be used (e.g. GUI_DrawStreamedBitmap565Ex()).
Available bitmap formats
The following table shows the currently supported formats and the availability of according ...Ex() functions:
Format
Description
IDX 555 M555 565 M565 24 Alpha RLEAlpha RLE4 RLE8 RLE16 RLEM16 RLE32
Index based* bitmaps 1-8bpp. 16bpp high color bitmaps, 5 bits blue, 5 bits green, 5 bits red. 16bpp high color bitmaps, 5 bits red, 5 bits green, 5 bits blue. 16bpp high color bitmaps, 5 bits blue, 6 bits green, 5 bits red. 16bpp high color bitmaps, 5 bits red, 6 bits green, 5 bits blue. 24bpp true color bitmaps, 8 bits blue, 8 bits green, 8 bits red. 32bpp true color bitmaps, 8 bits alpha, 8 bits blue, 8 bits green, 8 bits red. 8bpp alpha channel bitmaps, compressed. 4bpp index based bitmaps, RLE compressed. 8bpp index based bitmaps, RLE compressed. 16bpp (565) high color bitmaps, RLE compressed. 16bpp (M565) high color bitmaps, RLE compressed. 32bpp (8888) true color bitmaps with alpha channel, RLE compressed.
...Ex() function available
Yes Yes Yes Yes Yes Yes No No Yes Yes Yes Yes Yes
* Index based bitmaps consist of a palette of colors stated as 32bit values. All other bitmaps do not have a palette and therefore have the bitmap data stored in the format specified in the table.
GUI_CreateBitmapFromStream()
Description
The function creates a bitmap structure by passing any type of bitmap stream.
Prototype
int GUI_CreateBitmapFromStream(GUI_BITMAP
* pBMP,
GUI_LOGPALETTE * pPAL,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
123
const void
* p);
Parameter pBMP pPAL p
Description Pointer to a GUI_BITMAP structure to be initialized by the function. Pointer to a GUI_LOGPALETTE structure to be initialized by the function.
Pointer to the data stream.
Return value
0 on success, 1 on error.
Additional information
This function should be used if the data stream can consist of several kinds of bitmap formats or unknown. Disadvantage of using this function is that it has a significant memory footprint. If memory usage (ROM) is a concern, it may be better to use the format specific functions below.
Example
The following example shows how the GUI_CreateBitmapFromStream() - functions can be used to create and draw a bitmap:
void DrawBitmap(const void * pData, int xPos, int yPos) {
GUI_BITMAP
Bitmap;
GUI_LOGPALETTE Palette;
GUI_CreateBitmapFromStream(&Bitmap, &Palette, pData); GUI_DrawBitmap(&Bitmap, xPos, yPos); }
GUI_CreateBitmapFromStreamIDX(), GUI_CreateBitmapFromStreamRLE4(), GUI_CreateBitmapFromStreamRLE8(), GUI_CreateBitmapFromStream565(), GUI_CreateBitmapFromStreamM565(), GUI_CreateBitmapFromStream555(), GUI_CreateBitmapFromStreamM555(), GUI_CreateBitmapFromStreamRLE16(), GUI_CreateBitmapFromStreamRLEM16(), GUI_CreateBitmapFromStream24(), GUI_CreateBitmapFromStreamAlpha(), GUI_CreateBitmapFromStreamRLEAlpha(), GUI_CreateBitmapFromStreamRLE32()
Description
These functions create bitmap structures by passing bitmap streams of a known format.
Prototype
int GUI_CreateBitmapFromStream<FORMAT>(GUI_BITMAP
* pBMP,
GUI_LOGPALETTE * pPAL,
const void
* p);
Parameter pBMP pPAL p
Description Pointer to a GUI_BITMAP structure to be initialized by the function. Pointer to a GUI_LOGPALETTE structure to be initialized by the function.
Pointer to the data stream.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
124
CHAPTER
2-D Graphic Library
Supported data stream formats
The following table shows the supported data stream formats for each function:
Function
Supported stream format
GUI_CreateBitmapFromStreamIDX()
Streams of index based bitmaps.
GUI_CreateBitmapFromStreamRLE4()
Streams of RLE4 compressed bitmaps.
GUI_CreateBitmapFromStreamRLE8()
Streams of RLE8 compressed bitmaps.
GUI_CreateBitmapFromStream565()
Streams of high color bitmaps (565).
GUI_CreateBitmapFromStreamM565()
Streams of high color bitmaps (M565).
GUI_CreateBitmapFromStream555()
Streams of high color bitmaps (555).
GUI_CreateBitmapFromStreamM555()
Streams of high color bitmaps (M565).
GUI_CreateBitmapFromStreamRLE16()
Streams of RLE16 compressed bitmaps.
GUI_CreateBitmapFromStreamRLEM16()
Streams of RLE16 compressed bitmaps, red and blue swapped.
GUI_CreateBitmapFromStream24()
Streams of 24bpp bitmaps (true color).
GUI_CreateBitmapFromStreamAlpha()
Streams of 32bpp bitmaps (true color with alpha channel).
GUI_CreateBitmapFromStreamRLEAlpha() GUI_CreateBitmapFromStreamRLE32()
Streams of RLE compressed 8bpp alpha bitmaps.
Streams of RLE32 compressed bitmaps (true color with alpha channel).
Return value
0 on success, 1 on error.
Additional information
These functions should be used if the data stream consists of a known format. This avoids linking of unused code and keeps the binary code small.
GUI_DrawStreamedBitmap()
Description
Draws a bitmap from an indexed based bitmap data stream.
Prototype
void GUI_DrawStreamedBitmap(const void * p, int x, int y);
Parameter p x y
Description
Pointer to the data stream. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Additional information
The Bitmap Converter (see "Bitmap Converter" on page 177) can be used to create bitmap data streams. The format of these streams is not the same as the format of a bmp file.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
125
GUI_DrawStreamedBitmapAuto()
Description
Draws a bitmap from a bitmap data stream of any supported format.
Prototype
void GUI_DrawStreamedBitmapAuto(const void * p, int x, int y);
Parameter p x y
Description
Pointer to the data stream. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Additional information
Please refer to "GUI_DrawStreamedBitmap()" on page 124.
GUI_DrawStreamedBitmapEx()
Description
This function can be used for drawing index based bitmap data streams if not enough RAM or ROM is available to keep the whole file within the addressable memory (RAM or ROM). The GUI library calls the function pointed by the parameter pfGetData to read the data. This GetData function needs to return the number of read bytes.
Prototype
int GUI_DrawStreamedBitmapEx(GUI_GET_DATA_FUNC * pfGetData, const void * p, int x, int y);
Parameter
pfGetData p x y
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
0 on success, 1 on error.
Additional information
The function requires at least memory for one line of bitmap data. For more details please also refer to the function GUI_SetStreamedBitmapHook().
GUI_DrawStreamedBitmapExAuto()
Description
This function can be used for drawing bitmap data streams of any supported format if not enough RAM or ROM is available to keep the whole file within the addressable memory (RAM or ROM). The GUI library calls the function pointed by the parameter pfGetData to read the data. This GetData function needs to return the number of read bytes.
Prototype
int GUI_DrawStreamedBitmapExAuto(GUI_GET_DATA_FUNC * pfGetData, const void * p, int x, int y);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
126
CHAPTER
2-D Graphic Library
Parameter
pfGetData p x y
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
0 on success, 1 on error.
Additional information
The function requires at least memory for one line of bitmap data.
GUI_DrawStreamedBitmap555Ex() GUI_DrawStreamedBitmapM555Ex() GUI_DrawStreamedBitmap565Ex() GUI_DrawStreamedBitmapM565Ex() GUI_DrawStreamedBitmap24Ex()
Description
This function can be used for drawing bitmap data streams of the respective format if not enough RAM or ROM is available to keep the whole file within the addressable memory (RAM or ROM). The GUI library calls the function pointed by the parameter pfGetData to read the data. This GetData function needs to return the number of read bytes.
Prototype
int GUI_DrawStreamedBitmap<XXX>Ex(GUI_GET_DATA_FUNC * pfGetData, const void * p, int x, int y);
Parameter
pfGetData p x y
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
0 on success, 1 on error.
Additional information
The functions require at least memory for one line of bitmap data.
GUI_GetStreamedBitmapInfo()
Description
Returns a structure with information about the given data stream.
Prototype
void GUI_GetStreamedBitmapInfo(const void
* p,
GUI_BITMAPSTREAM_INFO * pInfo);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
127
Parameter p pInfo
Description
Pointer to the data stream.
Pointer to a GUI_BITMAPSTREAM_INFO structure to be filled by the function.
Elements of GUI_BITMAPSTREAM_INFO
Data type Element
int
XSize
int
YSize
int
BitsPerPixel
int
NumColors
int
HasTrans
Description
Pixel size in X of the image. Pixel size in Y of the image. Number of bits per pixel. Number of colors in case of an index based image. In case of an index based image 1 if transparency exist, 0 if not.
GUI_GetStreamedBitmapInfoEx()
Description
Returns a structure with information about the given data stream which does not need to be located in the addressable ROM or RAM area of the CPU.
Prototype
int GUI_GetStreamedBitmapInfoEx(GUI_GET_DATA_FUNC
* pfGetData,
const void
* p,
GUI_BITMAPSTREAM_INFO * pInfo);
Parameter pfGetData p pInfo
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData. Pointer to a GUI_BITMAPSTREAM_INFO structure to be filled by the function.
Return value
0 on success, 1 on error.
Elements of GUI_BITMAPSTREAM_INFO
Please refer to GUI_GetStreamedBitmapInfo().
GUI_SetStreamedBitmapHook()
Description
Sets a hook function to be able to manipulate the palette of a streamed bitmap which is not located in the addressable area of the CPU. The hook function is called when executing GUI_DrawStreamedBitmapEx().
Prototype
void GUI_SetStreamedBitmapHook( GUI_BITMAPSTREAM_CALLBACK pfStreamedBitmapHook);
Parameter
Description
pfStreamedBitmapHook Hook function to be called by GUI_DrawStreamedBitmapEx().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
128
CHAPTER
2-D Graphic Library
Prototype of hook function
void * Hook(GUI_BITMAPSTREAM_PARAM * pParam);
Parameter pParam
Description
Pointer to a GUI_BITMAPSTREAM_PARAM structure
Elements of GUI_BITMAPSTREAM_PARAM
Data type Element
int
Cmd
U32
v
void * p
Description
Command to be executed. Depends on the command to be executed. Depends on the command to be executed.
Supported values for parameter Cmd
GUI_BITMAPSTREAM_GET_BUFFER GUI_BITMAPSTREAM_RELEASE_BUFFER GUI_BITMAPSTREAM_MODIFY_PALETTE
When receiving this command the application can spend a buffer for the palette of a bitmap stream. Parameters: p - Pointer to the buffer or NULL v - Requested buffer size
If the application has spend a buffer for the palette here the buffer should be released. Parameters: p - Pointer to buffer to be released v - not used
This command is send after loading the palette and before drawing the image to be able to modify the palette of the streamed image. Parameters: p - Pointer to palette data v - Number of colors in palette
Example
static void * _cbStreamedBitmapHook(GUI_BITMAPSTREAM_PARAM * pParam) { void * p = NULL; int i, NumColors; U32 Color; U32 * pColor;
switch (pParam->Cmd) {
case GUI_BITMAPSTREAM_GET_BUFFER:
//
// Allocate buffer for palette data
//
p = malloc(pParam->v);
break;
case GUI_BITMAPSTREAM_RELEASE_BUFFER:
//
// Release buffer
//
free(pParam->p);
break;
case GUI_BITMAPSTREAM_MODIFY_PALETTE:
//
// Do something with the palette...
//
NumColors = pParam->v;
pColor = (U32 *)pParam->p;
Color
= *(pColor + pParam->v - 1);
for (i = NumColors - 2; i >= 0; i--) {
*(pColor + i + 1) = *(pColor + i);
}
*pColor = Color;
break;
}
return p;
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
129
7.9 Drawing lines
The most frequently used drawing routines are those that draw a line from one point to another.
GUI_DrawHLine()
Description
Draws a horizontal line one pixel thick from a specified starting point to a specified endpoint in the current window.
Prototype
void GUI_DrawHLine(int y, int x0, int x1);
Parameter y x0 x1
Y-position. X-starting position. X-end position.
Description
Additional information
If x1 < x0, nothing will be displayed. With most LCD controllers, this routine is executed very quickly because multiple pixels can be set at once and no calculations are needed. If it is clear that horizontal lines are to be drawn, this routine executes faster than the GUI_DrawLine() routine.
GUI_DrawLine()
Description
Draws a line from a specified starting point to a specified endpoint in the current window (absolute coordinates).
Prototype
void GUI_DrawLine(int x0, int y0, int x1, int y1);
Parameter x0 y0 x1 y1
X-starting position. Y-starting position. X-end position. Y-end position.
Description
Additional information
If part of the line is not visible because it is not in the current window or because part of the current window is not visible, this is due to clipping.
GUI_DrawLineRel()
Description
Draws a line from the current (x, y) position to an endpoint specified by X-distance and Y-distance in the current window (relative coordinates).
Prototype
void GUI_DrawLineRel(int dx, int dy);
Parameter dx dy
Description
Distance in X-direction to end of line to draw. Distance in Y-direction to end of line to draw.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
130
CHAPTER
2-D Graphic Library
GUI_DrawLineTo()
Description
Draws a line from the current (X,Y) position to an endpoint specified by X- and Ycoordinates in the current window.
Prototype
void GUI_DrawLineTo(int x, int y);
Parameter x y
X-end position. Y-end position.
Description
GUI_DrawPolyLine()
Description
Connects a predefined list of points with lines in the current window.
Prototype
void GUI_DrawPolyLine(const GUI_POINT * pPoint, int NumPoints, int x, int y);
Parameter pPoint NumPoints x y
Description
Pointer to the polyline to display. Number of points specified in the list of points. X-position of origin. Y-position of origin.
Additional information
The starting point and endpoint of the polyline need not be identical.
GUI_DrawVLine()
Description
Draws a vertical line one pixel thick from a specified starting point to a specified endpoint in the current window.
Prototype
void GUI_DrawVLine(int x, int y0, int y1);
Parameter x y0 y1
X-position. Y-starting position. Y-end position.
Description
Additional information
If y1 < y0, nothing will be displayed. With most LCD controllers, this routine is executed very quickly because multiple pixels can be set at once and no calculations are needed. If it is clear that vertical lines are to be drawn, this routine executes faster than the GUI_DrawLine() routine.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
131
GUI_GetLineStyle()
Description
Returns the current line style used by the function GUI_DrawLine.
Prototype
U8 GUI_GetLineStyle(void);
Return value
Current line style used by the function GUI_DrawLine.
GUI_MoveRel()
Description
Moves the current line pointer relative to its current position.
Prototype
void GUI_MoveRel(int dx, int dy);
Parameter dx dy
Distance to move in X. Distance to move in Y.
Description
Related topics
GUI_DrawLineTo(), GUI_MoveTo()
GUI_MoveTo()
Description
Moves the current line pointer to the given position.
Prototype
void GUI_MoveTo(int x, int y);
Parameter x y
New position in X. New position in Y.
Description
GUI_SetLineStyle()
Description
Sets the current line style used by the function GUI_DrawLine.
Prototype
U8 GUI_SetLineStyle(U8 LineStyle);
Parameter LineStyle
Description
New line style to be used. See table below.
Permitted values for parameter LineStyle
GUI_LS_SOLID
Lines would be drawn solid (default).
GUI_LS_DASH
Lines would be drawn dashed.
GUI_LS_DOT GUI_LS_DASHDOT GUI_LS_DASHDOTDOT
Lines would be drawn dotted.
Lines would be drawn alternating with dashes and dots. Lines would be drawn alternating with dashes and double dots.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
132
CHAPTER
2-D Graphic Library
Return value
Previous line style used by the function GUI_DrawLine.
Additional information
This function sets only the line style used by GUI_DrawLine. The style will be used only with a pen size of 1.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
133
7.10 Drawing polygons
The polygon drawing routines can be helpful when drawing vectorized symbols.
GUI_DrawPolygon()
Description
Draws the outline of a polygon defined by a list of points in the current window.
Prototype
void GUI_DrawPolygon(const GUI_POINT * pPoint, int NumPoints, int x, int y);
Parameter pPoint NumPoints x y
Description
Pointer to the polygon to display. Number of points specified in the list of points. X-position of origin. Y-position of origin.
Additional information
The polyline drawn is automatically closed by connecting the endpoint to the starting point.
GUI_EnlargePolygon()
Description
Enlarges a polygon on all sides by a specified length in pixels.
Prototype
void GUI_EnlargePolygon(GUI_POINT
* pDest,
const GUI_POINT * pSrc,
int
NumPoints,
int
Len);
Parameter pDest pSrc NumPoints Len
Description
Pointer to the destination polygon. Pointer to the source polygon. Number of points specified in the list of points. Length (in pixels) by which to enlarge the polygon.
Additional information
Make sure the destination array of points is equal to or larger than the source array.
Example
const GUI_POINT aPoints[] = { { 40, 20}, { 0, 20}, { 20, 0}
};
GUI_POINT aEnlargedPoints[GUI_COUNTOF(aPoints)];
void Sample(void) { int i; GUI_Clear(); GUI_SetDrawMode(GUI_DM_XOR); GUI_FillPolygon(aPoints, GUI_COUNTOF(aPoints), 140, 110); for (i = 1; i < 10; i++) { GUI_EnlargePolygon(aEnlargedPoints, aPoints, GUI_COUNTOF(aPoints), i * 5); GUI_FillPolygon(aEnlargedPoints, GUI_COUNTOF(aPoints), 140, 110); }
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
134
CHAPTER
Screen shot of above example
2-D Graphic Library
GUI_FillPolygon()
Description
Draws a filled polygon defined by a list of points in the current window.
Prototype
void GUI_FillPolygon(const GUI_POINT * pPoint, int NumPoints, int x, int y);
Parameter pPoint NumPoints x y
Description
Pointer to the polygon to display and to fill. Number of points specified in the list of points. X-position of origin. Y-position of origin.
Additional information
The polyline drawn is automatically closed by connecting the endpoint to the starting point. It is not required that the endpoint touches the outline of the polygon. Rendering a polygon is done by drawing one or more horizontal lines for each y-position of the polygon. Per default the maximum number of points used to draw the horizontal lines for one y-position is 12 (which means 6 lines per y-position). If this value needs to be increased, the macro GUI_FP_MAXCOUNT can be used to set the maximum number of points.
Example
#define GUI_FP_MAXCOUNT 50
GUI_MagnifyPolygon()
Description
Magnifies a polygon by a specified factor.
Prototype
void GUI_MagnifyPolygon(GUI_POINT *
pDest,
const GUI_POINT * pSrc,
int
NumPoints,
int
Mag);
Parameter pDest pSrc NumPoints Mag
Description
Pointer to the destination polygon. Pointer to the source polygon. Number of points specified in the list of points. Factor used to magnify the polygon.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
135
Additional information
Make sure the destination array of points is equal to or larger than the source array. Note the difference between enlarging and magnifying a polygon. Calling the function GUI_EnlargePolygon() with the parameter Len = 1 will enlarge the polygon by one pixel on all sides, whereas the call of GUI_MagnifyPolygon() with the parameter Mag = 1 will have no effect.
Example
const GUI_POINT aPoints[] = { { 0, 20}, { 40, 20}, { 20, 0}
}; GUI_POINT aMagnifiedPoints[GUI_COUNTOF(aPoints)]; void Sample(void) {
int Mag, y = 0, Count = 4; GUI_Clear(); GUI_SetColor(GUI_GREEN); for (Mag = 1; Mag <= 4; Mag *= 2, Count /= 2) {
int i, x = 0; GUI_MagnifyPolygon(aMagnifiedPoints, aPoints, GUI_COUNTOF(aPoints), Mag); for (i = Count; i > 0; i--, x += 40 * Mag) {
GUI_FillPolygon(aMagnifiedPoints, GUI_COUNTOF(aPoints), x, y); } y += 20 * Mag; } }
Screen shot of above example
GUI_RotatePolygon()
Description
Rotates a polygon by a specified angle.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
136
CHAPTER
2-D Graphic Library
Prototype
void GUI_RotatePolygon(GUI_POINT *
pDest,
const GUI_POINT * pSrc,
int
NumPoints,
float
Angle);
Parameter pDest pSrc NumPoints Angle
Description
Pointer to the destination polygon. Pointer to the source polygon. Number of points specified in the list of points. Angle in radian used to rotate the polygon.
Additional information
Make sure the destination array of points is equal to or larger than the source array.
Example
The following example shows how to draw a polygon. It is available as 2DGL_DrawPolygon.c in the examples shipped with emWin.
#include "gui.h"
/*******************************************************************
*
*
The points of the arrow
*/
static const GUI_POINT aPointArrow[] = {
{ 0, -5},
{-40, -35},
{-10, -25},
{-10, -85},
{ 10, -85},
{ 10, -25},
{ 40, -35},
};
/*******************************************************************
*
*
Draws a polygon
*/
static void DrawPolygon(void) {
int Cnt =0;
GUI_SetBkColor(GUI_WHITE);
GUI_Clear();
GUI_SetFont(&GUI_Font8x16);
GUI_SetColor(0x0);
GUI_DispStringAt("Polygons of arbitrary shape ", 0, 0);
GUI_DispStringAt("in any color", 120, 20);
GUI_SetColor(GUI_BLUE);
/* Draw filled polygon */
GUI_FillPolygon (&aPointArrow[0],7,100,100);
}
/*******************************************************************
*
*
main
*/
void main(void) {
GUI_Init();
DrawPolygon();
while(1)
GUI_Delay(100);
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
137
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
138
CHAPTER
2-D Graphic Library
7.11 Drawing circles
GUI_DrawCircle()
Description
Draws the outline of a circle of specified dimensions, at a specified position in the current window.
Prototype
void GUI_DrawCircle(int x0, int y0, int r);
Parameter x0 y0 r
Description
X-position of the center of the circle in pixels of the client window. Y-position of the center of the circle in pixels of the client window. Radius of the circle (half the diameter). Must be a positive value.
Example
// Draw concentric circles void ShowCircles(void) {
int i; for (i=10; i<50; i += 3)
GUI_DrawCircle(120, 60, i); }
Screen shot of above example
GUI_FillCircle()
Description
Draws a filled circle of specified dimensions at a specified position in the current window.
Prototype
void GUI_FillCircle(int x0, int y0, int r);
Parameter x0 y0 r
Description
X-position of the center of the circle in pixels of the client window. Y-position of the center of the circle in pixels of the client window. Radius of the circle (half the diameter). Must be a positive value.
Example
GUI_FillCircle(120,60,50);
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
139
7.12 Drawing ellipses
GUI_DrawEllipse()
Description
Draws the outline of an ellipse of specified dimensions, at a specified position in the current window.
Prototype
void GUI_DrawEllipse(int x0, int y0, int rx, int ry);
Parameter x0 y0 rx ry
Description
X-position of the center of the circle in pixels of the client window. Y-position of the center of the circle in pixels of the client window. X-radius of the ellipse (half the diameter). Must be a positive value. Y-radius of the ellipse (half the diameter). Must be a positive value.
Example
See the GUI_FillEllipse() example.
GUI_FillEllipse()
Description
Draws a filled ellipse of specified dimensions at a specified position in the current window.
Prototype
void GUI_FillEllipse(int x0, int y0, int rx, int ry);
Parameter x0 y0 rx ry
Description
X-position of the center of the circle in pixels of the client window. Y-position of the center of the circle in pixels of the client window. X-radius of the ellipse (half the diameter). Must be a positive value. Y-radius of the ellipse (half the diameter). Must be a positive value.
Example
// Demo ellipses GUI_SetColor(0xff); GUI_FillEllipse(100, 180, 50, 70); GUI_SetColor(0x0); GUI_DrawEllipse(100, 180, 50, 70); GUI_SetColor(0x000000); GUI_FillEllipse(100, 180, 10, 50);
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
140
CHAPTER
2-D Graphic Library
7.13 Drawing arcs
GUI_DrawArc()
Description
Draws an arc of specified dimensions at a specified position in the current window. An arc is a section of the outline of a circle.
Prototype
void GUI_DrawArc(int xCenter, int yCenter, int rx, int ry, int a0, int a1);
Parameter xCenter yCenter rx ry a0 a1
Description
Horizontal position of the center in pixels of the client window. Vertical position of the center in pixels of the client window. X-radius (pixels). Y-radius (pixels). Starting angle (degrees). Ending angle (degrees).
Limitations
Currently the ry parameter is not used. The rx parameter is used instead.
Example
void DrawArcScale(void) { int x0 = 160; int y0 = 180; int i; char ac[4]; GUI_SetBkColor(GUI_WHITE); GUI_Clear(); GUI_SetPenSize( 5 ); GUI_SetTextMode(GUI_TM_TRANS); GUI_SetFont(&GUI_FontComic18B_ASCII); GUI_SetColor( GUI_BLACK ); GUI_DrawArc( x0,y0,150, 150,-30, 210 ); GUI_Delay(1000); for (i=0; i<= 23; i++) { float a = (-30+i*10)*3.1415926/180; int x = -141*cos(a)+x0; int y = -141*sin(a)+y0; if (i%2 == 0) GUI_SetPenSize( 5 ); else GUI_SetPenSize( 4 ); GUI_DrawPoint(x,y); if (i%2 == 0) { x = -123*cos(a)+x0; y = -130*sin(a)+y0; sprintf(ac, "%d", 10*i); GUI_SetTextAlign(GUI_TA_VCENTER); GUI_DispStringHCenterAt(ac,x,y); } }
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
141
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
142
CHAPTER
2-D Graphic Library
7.14 Drawing graphs
GUI_DrawGraph()
Description
Draws a graph at once.
Prototype
void GUI_DrawGraph(I16 * paY, int NumPoints, int x0, int y0);
Parameter paY NumPoints x0 y0
Description
Pointer to an array containing the Y-values of the graph. Number of Y-values to be displayed. Starting point in x. Starting point in y.
Additional information
The function first sets the line-cursor to the position specified with x0, y0 and the first Y-value of the given array. Then it starts drawing lines to x0 + 1, y0 + *(paY + 1), x0 + 2, y0 + *(paY + 2) and so on.
Example
#include "GUI.h" #include <stdlib.h>
I16 aY[100];
void MainTask(void) { int i; GUI_Init(); for (i = 0; i < GUI_COUNTOF(aY); i++) { aY[i] = rand() % 50; } GUI_DrawGraph(aY, GUI_COUNTOF(aY), 0, 0);
}
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
143
7.15 Drawing pie charts
GUI_DrawPie()
Description
Draws a circle sector.
Prototype
void GUI_DrawPie(int x0, int y0, int r, int a0, int a1, int Type);
Parameter x0 y0 r a0 a1 Type
Description
X-position of the center of the circle in pixels of the client window. Y-position of the center of the circle in pixels of the client window. Radius of the circle (half the diameter). Starting angle (degrees). End angle (degrees). (reserved for future use, should be 0)
Example
int i, a0, a1; const unsigned aValues[] = { 100, 135, 190, 240, 340, 360}; const GUI_COLOR aColors[] = { GUI_BLUE, GUI_GREEN, GUI_RED,
GUI_CYAN, GUI_MAGENTA, GUI_YELLOW }; for (i = 0; i < GUI_COUNTOF(aValues); i++) {
a0 = (i == 0) ? 0 : aValues[i - 1]; a1 = aValues[i]; GUI_SetColor(aColors[i]); GUI_DrawPie(100, 100, 50, a0, a1, 0); }
Screen shot of above example
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
144
CHAPTER
2-D Graphic Library
7.16 Saving and restoring the GUI-context
GUI_RestoreContext()
Description
The function restores the GUI-context.
Prototype
void GUI_RestoreContext(const GUI_CONTEXT * pContext);
Parameter pContext
Description
Pointer to a GUI_CONTEXT structure containing the new context.
Additional information
The GUI-context contains the current state of the GUI like the text cursor position, a pointer to the current font and so on. Sometimes it could be useful to save the current state ant to restore it later. For this you can use these functions.
GUI_SaveContext()
Description
The function saves the current GUI-context. (See also GUI_RestoreContext)
Prototype
void GUI_SaveContext(GUI_CONTEXT * pContext);
Parameter pContext
Description
Pointer to a GUI_CONTEXT structure for saving the current context.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
145
7.17 Clipping
GUI_SetClipRect()
Description
Sets the clipping rectangle used for limiting the output.
Prototype
void GUI_SetClipRect(const GUI_RECT * pRect);
Parameter pRect
Description
Pointer to the rectangle which should be used for clipping. A NULL pointer should be used to restore the default value.
Additional information
The clipping area is per default limited to the configured (virtual) display size. Under some circumstances it can be useful to use a smaller clipping rectangle, which can be set using this function. The rectangle referred to should remain unchanged until the function is called again with a NULL pointer.
Example
The following example shows how to use the function:
GUI_RECT Rect = {10, 10, 100, 100}; GUI_SetClipRect(&Rect); . . /* Use the clipping area ... */ . GUI_SetClipRect(NULL);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
146
CHAPTER
2-D Graphic Library
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
147
Chapter 8
Displaying bitmap files
The recommended and most efficient way to display a bitmap known at compile time is to use the Bitmap Converter to convert it into a C file and add it to the project / makefile. For details about the Bitmap Converter, refer to the chapter "Bitmap Converter" on page 177. If the application needs to display images not known at compile time, the image needs to be available in a graphic file format supported by emWin. In this case, the image file can reside in memory or on an other storage device; it can be displayed even if the amount of available memory is less than the size of the image file. emWin currently supports BMP, JPEG, GIF and PNG file formats.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
148
CHAPTER
Displaying bitmap files
8.1 BMP file support
Although bitmaps which can be used with emWin are normally compiled and linked as C files with the application, there may be situations when using these types of structures is not desirable. A typical example would be an application that continuously references new images, such as bitmaps downloaded by the user. The following functions support bmp files which have been loaded into memory. For images that you plan to re-use (that is, a company logo) it is much more efficient to compile and link it as C file which can be used directly by emWin. This may be easily done with the Bitmap Converter.
8.1.1 Supported formats
The BMP file format has been defined by Microsoft. There are a number of different formats as shown in the table below:
Bits per pixel 1 4 4 8 8 16 24 32
Indexed yes yes yes yes yes no no no
Compression no no yes no yes no no no
Supported yes yes yes yes yes yes yes yes
8.1.2 BMP file API
The table below lists the available BMP file related routines in alphabetical order. Detailed descriptions follows:
Routine GUI_BMP_Draw() GUI_BMP_DrawEx() GUI_BMP_DrawScaled()
GUI_BMP_DrawScaledEx() GUI_BMP_GetXSize() GUI_BMP_GetXSizeEx() GUI_BMP_GetYSize() GUI_BMP_GetYSizeEx() GUI_BMP_Serialize() GUI_BMP_SerializeEx() GUI_BMP_SerializeExBpp()
Explanation
Draws a BMP file which has been loaded into memory.
Draws a BMP file which needs not to be loaded into memory. Draws a BMP file with scaling which has been loaded into memory. Draws a BMP file with scaling which needs not to be loaded into memory. Returns the X-size of a BMP file loaded into memory. Returns the X-size of a BMP file which needs not to be loaded into memory. Returns the Y-size of a bitmap loaded into memory. Returns the Y-size of a BMP file which needs not to be loaded into memory. Creates a BMP file.
Creates a BMP file from the given rectangle. Creates a BMP file from the given rectangle using the specified color depth.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
149
GUI_BMP_Draw()
Description
Draws a Windows bmp file, which has been loaded into memory, at a specified position in the current window.
Prototype
int GUI_BMP_Draw(const void * pFileData, int x0, int y0);
Parameter pFileData x0 y0
Description
Pointer to the start of the memory area in which the bmp file resides. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Additional information
The table at the beginning of the chapter shows the supported BMP file formats. The example 2DGL_DrawBMP.c shows how to use the function.
GUI_BMP_DrawEx()
Description
Draws a bmp file, which does not have to be loaded into memory, at a specified position in the current window.
Prototype
int GUI_BMP_DrawEx(GUI_GET_DATA_FUNC * pfGetData, void * p, int x0, int y0);
Parameter
pfGetData p x0 y0
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
Zero on success, nonzero if the function fails.
Additional information
This function is used for drawing bmp files if not enough RAM is available to load the whole file into memory. The GUI library then calls the function pointed by the parameter pfGetData to read the data. The GetData function needs to return the number of requested bytes. The maximum number of bytes requested by the GUI is the number of bytes needed for drawing one line of the image.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
150
CHAPTER
Displaying bitmap files
GUI_BMP_DrawScaled()
Description
Draws a bmp file, which has been loaded into memory, at a specified position in the current window using scaling.
Prototype
int GUI_BMP_DrawScaled(const void * pFileData, int x0, int y0, int Num, int Denom);
Parameter pFileData x0 y0 Num Denom
Description
Pointer to the start of the memory area in which the bmp file resides. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Numerator to be used for scaling. Denominator used for scaling.
Return value
Zero on success, nonzero if the function fails.
Additional information
The function scales the image by building a fraction with the given numerator and denominator. If for example an image should be shrunk to 2/3 of size the parameter Num should be 2 and Denom should be 3.
GUI_BMP_DrawScaledEx()
Description
Draws a bmp file, which does not have to be loaded into memory, at a specified position in the current window using scaling.
Prototype
int GUI_BMP_DrawScaledEx(GUI_GET_DATA_FUNC * pfGetData, void * p,
int
x0,
int y0,
int
Num,
int Denom);
Parameter
pfGetData
p x0 y0 Num Denom
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Numerator to be used for scaling. Denominator used for scaling.
Return value
Zero on success, nonzero if the function fails.
Additional information
The function scales the image by building a fraction with the given numerator and denominator. If for example an image should be shrunk to 2/3 of size the parameter Num should be 2 and Denom should be 3. For more details, refer to "GUI_BMP_DrawEx()" on page 149.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
151
GUI_BMP_GetXSize()
Description
Returns the X-size of a specified bitmap which has been loaded into memory.
Prototype
int GUI_BMP_GetXSize(const void * pFileData);
Parameter
Description
pFileData Pointer to the start of the memory area in which the bmp file resides.
Return value
X-size of the bitmap.
GUI_BMP_GetXSizeEx()
Description
Returns the X-size of a specified bmp file which does not have to be loaded into memory.
Prototype
int GUI_BMP_GetXSizeEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Return value
X-size of the bitmap.
GUI_BMP_GetYSize()
Description
Returns the Y-size of a specified bitmap which has been loaded into memory.
Prototype
int GUI_BMP_GetYSize(const void * pFileData);;
Parameter
Description
pFileData Pointer to the start of the memory area in which the bmp file resides.
Return value
Y-size of the bitmap.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
152
CHAPTER
Displaying bitmap files
GUI_BMP_GetYSizeEx()
Description
Returns the Y-size of a specified bmp file which does not have to be loaded into memory.
Prototype
int GUI_BMP_GetYSizeEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Return value
Y-size of the bitmap.
GUI_BMP_Serialize()
Description
The function creates a BMP file containing the complete content of the LCD. The BMP file is created using the color depth which is used in emWin at a maximum of 24 bpp. In case of using a color depth of less than 8bpp the color depth of the BMP file will be 8bpp. The currently selected device is used for reading the pixel data. If a Memory Device is selected it's content is written to the file.
Prototype
void GUI_BMP_Serialize(GUI_CALLBACK_VOID_U8_P * pfSerialize, void * p);
Parameter pfSerialize p
Description
Pointer to serialization function Pointer to user defined data passed to serialization function
Example
The following example shows how to create a BMP file under windows.
static void _DrawSomething(void) { /* Draw something */ GUI_DrawLine(10, 10, 100, 100);
}
static void _WriteByte2File(U8 Data, void * p) { U32 nWritten; WriteFile(*((HANDLE *)p), &Data, 1, &nWritten, NULL);
}
static void _ExportToFile(void) { HANDLE hFile = CreateFile("C:\\GUI_BMP_Serialize.bmp", GENERIC_WRITE, 0, 0, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0); GUI_BMP_Serialize(_WriteByte2File, &hFile); CloseHandle(hFile);
}
void MainTask(void) { GUI_Init(); _DrawSomething(); _ExportToFile();
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
153
GUI_BMP_SerializeEx()
Description
The function creates a BMP file containing the given area. The BMP file is created using the color depth which is used in emWin at a maximum of 24 bpp. In case of using a color depth of less than 8bpp the color depth of the BMP file will be 8bpp. The currently selected device is used for reading the pixel data. If a Memory Device is selected it's content is written to the file.
Prototype
void GUI_BMP_SerializeEx(GUI_CALLBACK_VOID_U8_P * pfSerialize, int x0, int y0, int xSize, int ySize, void * p);
Parameter pfSerialize x0 y0 xSize ySize p
Description
Pointer to user defined serialization function. See prototype below. Start position in X to create the BMP file. Start position in Y to create the BMP file. Size in X. Size in Y. Pointer to user defined data passed to serialization function.
Prototype of GUI_CALLBACK_VOID_U8_P
void GUI_CALLBACK_VOID_U8_P(U8 Data, void * p);
Additional information
An example can be found in the description of GUI_BMP_Serialize().
GUI_BMP_SerializeExBpp()
Description
The function creates a BMP file containing the given area using the specified color depth. In case of using a color depth of less than 8bpp the color depth of the BMP file will be 8bpp. The color depth should be a multiple of 8. In case of a system color depth of more than 8bpp the color depth needs to be 16bpp or more. The currently selected device is used for reading the pixel data. If a Memory Device is selected it's content is written to the file.
Prototype
void GUI_BMP_SerializeExBpp(GUI_CALLBACK_VOID_U8_P * pfSerialize,
int x0, int y0,
int xSize, int ySize,
void * p,
int BitsPerPixel);
Parameter
Description
pfSerialize x0 y0 xSize ySize p BitsPerPixel
Pointer to user defined serialization function. See prototype below. Start position in X to create the BMP file. Start position in Y to create the BMP file. Size in X. Size in Y. Pointer to user defined data passed to serialization function. Color depth.
Prototype of GUI_CALLBACK_VOID_U8_P
void GUI_CALLBACK_VOID_U8_P(U8 Data, void * p);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
154
CHAPTER
Displaying bitmap files
Additional information
An example can be found in the description of GUI_BMP_Serialize() above.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
155
8.2 JPEG file support
JPEG (pronounced "jay-peg") is a standardized compression method for full-color and gray-scale images. JPEG is intended for compressing "real-world" scenes; line drawings, cartoons and other non-realistic images are not its strong suit. JPEG is lossy, meaning that the output image is not exactly identical to the input image. Hence you must not use JPEG if you have to have identical output bits. However, on typical photographic images, very good compression levels can be obtained with no visible change, and remarkably high compression levels are possible if you can tolerate a low-quality image.
8.2.1 Supported JPEG compression methods
This software implements JPEG baseline, extended-sequential and progressive compression processes. Provision is made for supporting all variants of these processes, although some uncommon parameter settings aren't implemented yet. For legal reasons, code for the arithmetic-coding variants of JPEG is not distributed. It appears that the arithmetic coding option of the JPEG spec is covered by patents owned by IBM, AT&T, and Mitsubishi. Hence arithmetic coding cannot legally be used without obtaining one or more licenses. For this reason, support for arithmetic coding has not been included. (Since arithmetic coding provides only a marginal gain over the unpatented Huffman mode, it is unlikely that very many implementations will support it.) The JPEG file support does not contain provision for the hierarchical or lossless processes defined in the standard.
8.2.2 Converting a JPEG file to C source
Under some circumstances it can be useful to add a JPEG file as C file to the project. In this case the JPEG file first needs to be converted to a C file. This can be done using the tool Bin2C.exe shipped with emWin. It can be found in the Tools subfolder. It converts the given binary file (in this case the JPEG file) to a C file. The filename of the C file is the same as the binary file name with the file extension '.c'. The following steps will show how to embed a JPEG file using Bin2C: · Start Bin2C.exe and select the JPEG file to be converted to a C file, for example
'Image.jpeg' and convert it to a C file. · Add the C file to the project.
Example
The following example shows how to display the converted JPEG file: #include "GUI.h" #include "Image.c" /* Include the converted C file */
void MainTask(void) { GUI_Init(); GUI_JPEG_Draw(acImage, sizeof(acImage), 0, 0); ...
}
8.2.3 Displaying JPEG files
The graphic library first decodes the graphic information. If the image has to be drawn the decoding process takes considerable time. If a JPEG file is used in a frequently called callback routine of the Window Manager, the decoding process can take a considerable amount of time. The calculation time can be reduced by the use of memory devices. The best way would be to draw the image first into a memory device. In this case the decompression would be executed only one time. For more information about memory devices, refer to chapter "Memory Devices" on page 287.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
156
CHAPTER
Displaying bitmap files
8.2.4 Memory usage
The JPEG decompression uses app. 33Kb RAM for decompression independent of the image size and a size dependent amount of bytes. The RAM requirement can be calculated as follows:
App. RAM requirement = X-Size of image * 80 bytes + 33 Kbytes
The X-size dependent amount depends on the compression type of the JPEG file. The following table shows some examples:
Compression
H1V1 H2V2 GRAY
Size of image in pixels
160x120 160x120 160x120
RAM usage [Kbyte]
45 46 38
RAM usage, size dependent [Kbyte]
12 13 4
The memory required for the decompression is allocated dynamically by the emWin memory management system. After drawing the JPEG image the complete RAM will be released.
8.2.5 Progressive JPEG files
Contrary to baseline and extended-sequential JPEG files progressive JPEGs consist of multiple scans. Each of these scans is based on the previous scan(s) and refines the appearance of the JPEG image. This requires scanning the whole file even if only one line needs to be decompressed. If enough RAM is configured for the whole image data, the decompression needs only be done one time. If less RAM is configured, the JPEG decoder uses 'banding' for drawing the image. The more bands required the more times the image needs to be decompressed and the slower the performance. With other words: The more RAM the better the performance.
8.2.6 JPEG file API
The table below lists the available JPEG file related routines in alphabetical order. Detailed descriptions follows:
Routine GUI_JPEG_Draw() GUI_JPEG_DrawEx() GUI_JPEG_DrawScaled() GUI_JPEG_DrawScaledEx()
GUI_JPEG_GetInfo()
GUI_JPEG_GetInfoEx()
Explanation
Draws a JPEG file which has been loaded into memory.
Draws a JPEG file which needs not to be loaded into memory.
Draws a JPEG file with scaling which has been loaded into memory. Draws a JPEG file with scaling which needs not to be loaded into memory. Fills a GUI_JPEG_INFO structure from a JPEG file which has been loaded into memory. Fills a GUI_JPEG_INFO structure from a JPEG file which needs not to be loaded into memory.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
157
GUI_JPEG_Draw()
Description
Draws a jpeg file, which has been loaded into memory, at a specified position in the current window.
Prototype
int GUI_JPEG_Draw(const void * pFileData, int DataSize, int x0, int y0);
Parameter pFileData DataSize x0 y0
Description
Pointer to the start of the memory area in which the jpeg file resides. Number of bytes of the jpeg file. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
Zero on success, nonzero if the function fails. (The current implementation always returns 0)
Additional information
The Sample folder contains the example 2DGL_DrawJPG.c which shows how to use the function.
GUI_JPEG_DrawEx()
Description
Draws a jpeg file, which does not have to be loaded into memory, at a specified position in the current window.
Prototype
int GUI_JPEG_DrawEx(GUI_GET_DATA_FUNC * pfGetData, void * p,
int
x0,
int y0);
Parameter
pfGetData p x0 y0
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
Zero on success, nonzero if the function fails. (The current implementation always returns 0)
Additional information
This function is used for drawing jpegs if not enough RAM is available to load the whole file into memory. The JPEG library then calls the function pointed by the parameter pfGetData to read the data. The GetData function should return the number of available bytes. This could be less or equal the number of requested bytes. The function needs at least to return 1 new byte. The Sample folder contains the example 2DGL_DrawJPGScaled.c which shows how to use a GetData function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
158
CHAPTER
Displaying bitmap files
GUI_JPEG_DrawScaled()
Description
Draws a jpeg file, which has been loaded into memory, at a specified position in the current window using scaling.
Prototype
int GUI_JPEG_DrawScaled(const void * pFileData, int DataSize, int x0, int y0, int Num, int Denom);
Parameter pFileData DataSize x0 y0 Num Denom
Description
Pointer to the start of the memory area in which the jpeg file resides. Number of bytes of the jpeg file. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Numerator to be used for scaling. Denominator used for scaling.
Return value
Zero on success, nonzero if the function fails. (The current implementation always returns 0)
Additional information
The function scales the image by building a fraction with the given numerator and denominator. If for example an image should be shrunk to 2/3 of size the parameter Num should be 2 and Denom should be 3. The Sample folder contains the example 2DGL_DrawJPGScaled.c which shows how to draw scaled JPEGs.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
159
GUI_JPEG_DrawScaledEx()
Description
Draws a jpeg file, which does not have to be loaded into memory, at a specified position in the current window using scaling.
Prototype
int GUI_JPEG_DrawScaledEx(GUI_GET_DATA_FUNC * pfGetData, void * p, int x0, int y0, int Num, int Denom);
Parameter
pfGetData
p x0 y0 Num Denom
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Numerator to be used for scaling. Denominator used for scaling.
Return value
Zero on success, nonzero if the function fails. (The current implementation always returns 0)
Additional information
The function scales the image by building a fraction with the given numerator and denominator. If for example an image should be shrunk to 2/3 of size the parameter Num should be 2 and Denom should be 3. For more details, refer to "GUI_JPEG_DrawEx()" on page 157. The Sample folder contains the example 2DGL_DrawJPGScaled.c which shows how to use the function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
160
CHAPTER
Displaying bitmap files
GUI_JPEG_GetInfo()
Description
Fills a GUI_JPEG_INFO structure with information about a jpeg file, which has been loaded into memory.
Prototype
int GUI_JPEG_GetInfo(const void * pFileData, int DataSize, GUI_JPEG_INFO * pInfo);
Parameter pFileData DataSize pInfo
Description
Pointer to the start of the memory area in which the jpeg file resides. Number of bytes of the jpeg file. Pointer to a GUI_JPEG_INFO structure to be filled by the function.
Return value
Zero on success, nonzero if the function fails.
Elements of GUI_JPEG_INFO
Data type Element
Description
int int
XSize YSize
Pixel size in X of the image. Pixel size in Y of the image.
Additional information
The Sample folder contains the example 2DGL_DrawJPG.c which shows how to use the function.
GUI_JPEG_GetInfoEx()
Description
Fills a GUI_JPEG_INFO structure with information about a jpeg file, which does not have to be loaded into memory.
Prototype
int GUI_JPEG_GetInfoEx(GUI_GET_DATA_FUNC * pfGetData, void * p,
GUI_JPEG_INFO
* pInfo);
Parameter pfGetData p pInfo
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Pointer to a GUI_JPEG_INFO structure to be filled by the function.
Return value
Zero on success, nonzero if the function fails.
Additional information
For more details about the function and the parameters pfGetData and p, refer to "GUI_JPEG_GetInfo()" on page 160 and "GUI_JPEG_DrawEx()" on page 157. The Sample folder contains the example 2DGL_DrawJPGScaled.c which shows how to use the function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
161
8.3 GIF file support
The GIF file format (Graphic Interchange Format) has been developed by the CompuServe Information Service in the 1980s. It has been designed to transmit images across data networks. The GIF standard supports interlacing, transparency, application defined data, animations and rendering of raw text. Unsupported data like raw text or application specific data will be ignored by emWin. GIF files uses the LZW (Lempel-Zif-Welch) file compression method for compressing the image data. This compression method works without loosing data. The output image is exactly identical to the input image.
8.3.1 Converting a GIF file to C source
Under some circumstances it can be useful to add a GIF file as C file to the project. This can be done by exactly the same way as described before under 'JPEG file support'.
8.3.2 Displaying GIF files
The graphic library first decodes the graphic information. If the image has to be drawn the decoding process takes considerable time. If a GIF file is used in a frequently called callback routine of the Window Manager, the decoding process can take a considerable amount of time. The calculation time can be reduced by the use of memory devices. The best way would be to draw the image first into a memory device. In this case the decompression would be executed only one time. For more information about memory devices, refer to the chapter "Memory Devices" on page 287.
8.3.3 Memory usage
The GIF decompression routine of emWin needs about 16Kbytes of dynamically allocated RAM for decompression. After drawing an image the RAM used for decompressing will be released.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
162
CHAPTER
Displaying bitmap files
8.3.4 GIF file API
The table below lists the available GIF file related routines in alphabetical order. Detailed descriptions follows:
Routine GUI_GIF_Draw() GUI_GIF_DrawEx() GUI_GIF_DrawSub() GUI_GIF_DrawSubEx() GUI_GIF_DrawSubScaled() GUI_GIF_DrawSubScaledEx() GUI_GIF_GetComment() GUI_GIF_GetCommentEx() GUI_GIF_GetImageInfo() GUI_GIF_GetImageInfoEx() GUI_GIF_GetInfo() GUI_GIF_GetInfoEx() GUI_GIF_GetXSize() GUI_GIF_GetXSizeEx() GUI_GIF_GetYSize() GUI_GIF_GetYSizeEx()
Explanation
Draws the first image of a GIF file which has been loaded into memory. Draws the first image of a GIF file which needs not to be loaded into memory. Draws the given sub image of a GIF file which has been loaded into memory. Draws the given sub image of a GIF file which needs not to be loaded into memory. Draws the given sub image of a GIF file with scaling which has been loaded into memory. Draws the given sub image of a GIF file with scaling which needs not to be loaded into memory. Returns the given comment of a GIF file which has been loaded into memory. Returns the given comment of a GIF file which needs not to be loaded into memory. Returns information about the given sub image of a GIF file which has been loaded into memory. Returns information about the given sub image of a GIF file which needs not to be loaded into memory. Returns information about a GIF file which has been loaded into memory. Returns information about a GIF file which needs not to be loaded into memory.
Returns the X-size of a bitmap loaded into memory.
Returns the X-size of a bitmap which needs not to be loaded into memory.
Returns the Y-size of a bitmap loaded into memory.
Returns the Y-size of a bitmap which needs not to be loaded into memory.
GUI_GIF_Draw()
Description
Draws the first image of a gif file, which has been loaded into memory, at a specified position in the current window.
Prototype
int GUI_GIF_Draw(const void * pGIF, U32 NumBytes, int x0, int y0);
Parameter pGIF NumBytes x0 y0
Description
Pointer to the start of the memory area in which the gif file resides. Number of bytes of the gif file. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
0 on success, != 0 on error.
Additional information
If the file contains more than one image, the function shows only the first image of the file. Transparency and interlaced images are supported.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
163
GUI_GIF_DrawEx()
Description
Draws a gif file, which does not have to be loaded into memory, at a specified position in the current window.
Prototype
int GUI_GIF_DrawEx(GUI_GET_DATA_FUNC * pfGetData, void * p, int x0, int y0);
Parameter
pfGetData p x0 y0
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
Zero on success, nonzero if the function fails.
Additional information
This function is used for drawing gif files if not enough RAM is available to load the whole file into memory. The library calls the function pointed by the parameter pfGetData to read the data. The GetData function should return the number of available bytes. This could be less or equal the number of requested bytes. The function needs at least to return 1 new byte.
GUI_GIF_DrawSub()
Description
Draws the given sub image of a gif file, which has been loaded into memory, at a specified position in the current window.
Prototype
int GUI_GIF_DrawSub(const void * pGIF, U32 NumBytes, int x0, int y0, int Index);
Parameter pGIF NumBytes x0 y0 Index
Description
Pointer to the start of the memory area in which the gif file resides. Number of bytes of the gif file. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Zero-based index of sub image to be shown.
Return value
0 on success, != 0 on error.
Additional information
The function manages the background pixels between the current and the previous image. If for example sub image #3 should be drawn at offset x20/y20 with a size of w10/h10 and the previous sub image was shown at x15/y15 with a size of w20/h20 and the background needs to be redrawn, the function fills the pixels between the images with the background color. The file 2DGL_DrawGIF.c of the Sample folder shows how to use the function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
164
CHAPTER
Displaying bitmap files
GUI_GIF_DrawSubEx()
Description
Draws the given sub image of a gif file, which does not have to be loaded into memory, at a specified position in the current window.
Prototype
int GUI_GIF_DrawSubEx(GUI_GET_DATA_FUNC * pfGetData, void * p, int x0, int y0, int Index);
Parameter
pfGetData
p x0 y0 Index
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Zero-based index of sub image to be shown.
Return value
Zero on success, nonzero if the function fails.
Additional information
This function is used for drawing gif images if not enough RAM is available to load the whole file into memory. The GUI library then calls the function pointed by the parameter pfGetData to read the data. For more details, refer to the "GUI_GIF_DrawEx()" on page 163.
GUI_GIF_DrawSubScaled()
Description
Draws the given sub image of a gif file, which has been loaded into memory, at a specified position in the current window using scaling.
Prototype
int GUI_GIF_DrawSubScaled(const void * pGIF, U32 NumBytes, int x0, int y0, int Index, int Num, int Denom);
Parameter pGif NumBytes x0 y0 Index Num Denom
Description
Pointer to the start of the memory area in which the gif file resides. Number of bytes of the gif file. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Zero-based index of sub image to be shown. Numerator to be used for scaling. Denominator used for scaling.
Return value
Zero on success, nonzero if the function fails.
Additional information
The function scales the image by building a fraction with the given numerator and denominator. If for example an image should be shrunk to 2/3 of size the parameter Num should be 2 and Denom should be 3.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
165
GUI_GIF_DrawSubScaledEx()
Description
Draws the given sub image of a gif file, which does not have to be loaded into memory, at a specified position in the current window using scaling.
Prototype
int GUI_GIF_DrawSubScaledEx(GUI_GET_DATA_FUNC * pfGetData,
void * p,
int x0, int y0,
int Index, int Num, int Denom);
Parameter
pfGetData
p x0 y0 Index Num Denom
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display. Zero-based index of sub image to be shown. Numerator to be used for scaling. Denominator used for scaling.
Return value
Zero on success, nonzero if the function fails.
Additional information
The function scales the image by building a fraction with the given numerator and denominator. If for example an image should be shrunk to 2/3 of size the parameter Num should be 2 and Denom should be 3.
GUI_GIF_GetComment()
Description
Returns the given comment from a GIF image, which has been loaded into memory.
Prototype
int GUI_GIF_GetComment(const void * pGIF, U32 NumBytes, U8 * pBuffer, int MaxSize, int Index);
Parameter pGIF NumBytes pBuffer MaxSize Index
Description Pointer to the start of the memory area in which the gif file resides.
Number of bytes of the gif file. Pointer to a buffer to be filled with the comment. Size of the buffer. Zero based index of comment to be returned.
Return value
0 on success, != 0 on error.
Additional information
A GIF file can contain 1 or more comments. The function copies the comment into the given buffer. If the comment is larger than the given buffer only the bytes which fit into the buffer will be copied. The file 2DGL_DrawGIF.c of the Sample folder shows how to use the function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
166
CHAPTER
Displaying bitmap files
GUI_GIF_GetCommentEx()
Description
Returns the given comment from a GIF image, which does not have to be loaded into memory.
Prototype
int GUI_GIF_GetCommentEx(GUI_GET_DATA_FUNC * pfGetData, void * p, U8 * pBuffer, int MaxSize, int Index);
Parameter
pfGetData
p pBuffer MaxSize Index
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Pointer to a buffer to be filled with the comment. Size of the buffer. Zero based index of comment to be returned.
Return value
0 on success, != 0 on error.
Additional information
For details, refer to "GUI_GIF_GetComment()" on page 165.
GUI_GIF_GetImageInfo()
Description
Returns information about the given sub image of a GIF file, which has been loaded into memory.
Prototype
int GUI_GIF_GetImageInfo(const void * pGIF, U32 NumBytes, GUI_GIF_IMAGE_INFO * pInfo, int Index);
Parameter pGIF NumBytes pInfo Index
Description Pointer to the start of the memory area in which the gif file resides.
Number of bytes of the gif file.
Pointer to a GUI_GIF_IMAGE_INFO structure which will be filled by the function.
Zero based index of sub image.
Return value
0 on success, != 0 on error.
Elements of GUI_GIF_IMAGE_INFO
Data type Element
Description
int int int int int
xPos yPos xSize ySize Delay
X position of the last drawn image. Y position of the last drawn image. X size of the last drawn image. Y size of the last drawn image. Time in 1/100 seconds the image should be shown in a movie.
Additional information
If an image needs be shown as a movie this function should be used to get the time the sub image should be visible and the next sub image should be shown. If the delay member is 0 the image should be visible for 1/10 second.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
167
GUI_GIF_GetImageInfoEx()
Description
Returns information about the given sub image of a GIF file, which needs not to be loaded into memory.
Prototype
int GUI_GIF_GetImageInfoEx(GUI_GET_DATA_FUNC * pfGetData, void * p, GUI_GIF_IMAGE_INFO * pInfo, int Index);
Parameter
pfGetData p pInfo Index
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData. Pointer to a GUI_GIF_IMAGE_INFO structure which will be filled by the function.
Zero based index of sub image.
Return value
0 on success, != 0 on error.
Additional information
For more details, refer to "GUI_GIF_GetImageInfo()" on page 166.
GUI_GIF_GetInfo()
Description
Returns an information structure with information about the size and the number of sub images within the given GIF file, which has been loaded into memory.
Prototype
int GUI_GIF_GetInfo(const void * pGIF, U32 NumBytes, GUI_GIF_INFO * pInfo);
Parameter pGIF NumBytes pInfo
Description Pointer to the start of the memory area in which the gif file resides.
Number of bytes of the gif file.
Pointer to a GUI_GIF_INFO structure which will be filled by this function.
Return value
0 on success, != 0 on error.
Elements of GUI_GIF_INFO
Data type int int int
Element XSize YSize NumImages
Description
Pixel size in X of the image. Pixel size in Y of the image. Number of sub images in the file.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
168
CHAPTER
Displaying bitmap files
GUI_GIF_GetInfoEx()
Description
Returns an information structure with information about the size and the number of sub images within the given GIF file, which needs not to be loaded into memory.
Prototype
int GUI_GIF_GetInfoEx(GUI_GET_DATA_FUNC * pfGetData, void * p, GUI_GIF_INFO * pInfo);;
Parameter pfGetData p pInfo
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData. Pointer to a GUI_GIF_INFO structure which will be filled by this function.
Return value
0 on success, != 0 on error.
Elements of GUI_GIF_INFO
Data type int int int
Element XSize YSize NumImages
Description
Pixel size in X of the image. Pixel size in Y of the image. Number of sub images in the file.
GUI_GIF_GetXSize()
Description
Returns the X-size of a specified GIF image, which has been loaded into memory.
Prototype
int GUI_GIF_GetXSize(const void * pGIF);
Parameter
Description
pGIF
Pointer to the start of the memory area in which the gif file resides.
Return value
X-size of the GIF image.
GUI_GIF_GetXSizeEx()
Description
Returns the X-size of a specified GIF image, which needs not to be loaded into memory.
Prototype
int GUI_GIF_GetXSizeEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Return value
X-size of the GIF image.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
169
GUI_GIF_GetYSize()
Description
Returns the Y-size of a specified GIF image, which has been loaded into memory.
Prototype
int GUI_GIF_GetYSize(const void * pGIF);;
Parameter
Description
pGIF
Pointer to the start of the memory area in which the bmp file resides.
Return value
Y-size of the GIF image.
GUI_GIF_GetYSizeEx()
Description
Returns the Y-size of a specified GIF image, which needs not to be loaded into memory.
Prototype
int GUI_GIF_GetYSizeEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a function which is called for getting data. For details about the GetData
function, please refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Return value
Y-size of the GIF image.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
170
CHAPTER
Displaying bitmap files
8.4 PNG file support
The PNG (Portable Network Graphics) format is an image format which offers lossless data compression and alpha blending by using a non-patented data compression method. Version 1.0 of the PNG specification has been released in 1996. Since the end of 2003 PNG is an international standard (ISO/IEC 15948). The emWin implementation of PNG support is based on the 'libpng' library from Glenn Randers-Pehrson, Guy Eric Schalnat and Andreas Dilger which is freely available under www.libpng.org. It is used in emWin under the copyright notice in GUI\PNG\png.h which allows using the library without any limitation. The PNG library of emWin is available under www.segger.com/link/emwin_png.zip.
8.4.1 Converting a PNG file to C source
Under some circumstances it can be useful to add a PNG file as C file to the project. This can be done by exactly the same way as described before under 'JPEG file support'. Further the Bitmap Converter is able to load PNG files and can convert them into C bitmap files.
8.4.2 Displaying PNG files
The graphic library first decodes the graphic information. If the image has to be drawn the decoding process takes considerable time. If a PNG file is used in a frequently called callback routine of the Window Manager, the decoding process can take a considerable amount of time. The calculation time can be reduced by the use of memory devices. The best way would be to draw the image first into a memory device. In this case the decompression would be executed only one time. For more information about memory devices, refer to the chapter "Memory Devices" on page 287.
8.4.3 Memory usage
The PNG decompression uses app. 21Kbytes of RAM for decompression independent of the image size and a size dependent amount of bytes. The RAM requirement can be calculated as follows:
App. RAM requirement = (xSize + 1) * ySize * 4 + 54Kbytes
8.4.4 PNG file API
The table below lists the available PNG file related routines in alphabetical order. Detailed descriptions follows:
Routine GUI_PNG_Draw() GUI_PNG_DrawEx() GUI_PNG_GetXSize() GUI_PNG_GetXSizeEx() GUI_PNG_GetYSize() GUI_PNG_GetYSizeEx()
Explanation
Draws the PNG file which has been loaded into memory. Draws the PNG file which needs not to be loaded into memory.
Returns the X-size of a bitmap loaded into memory. Returns the X-size of a bitmap which needs not to be loaded into memory. Returns the Y-size of a bitmap loaded into memory. Returns the Y-size of a bitmap which needs not to be loaded into memory.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
171
GUI_PNG_Draw()
Description
Draws a png file, which has been loaded into memory, at a specified position in the current window.
Prototype
int GUI_PNG_Draw(const void * pFileData, int FileSize, int x0, int y0);
Parameter pFileData FileSize x0 y0
Description
Pointer to the start of the memory area in which the png file resides. Number of bytes of the png file. X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
Zero on success, nonzero if the function fails. (The current implementation always returns 0)
Additional information
The Sample folder contains the example 2DGL_DrawPNG.c which shows how to use the function.
GUI_PNG_DrawEx()
Description
Draws a png file, which does not have to be loaded into memory, at a specified position in the current window.
Prototype
int GUI_PNG_DrawEx(GUI_GET_DATA_FUNC * pfGetData, void * p, int x0, int y0);
Parameter
pfGetData p x0 y0
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
X-position of the upper left corner of the bitmap in the display. Y-position of the upper left corner of the bitmap in the display.
Return value
Zero on success, nonzero if the function fails.
Additional information
This function is used for drawing png if not enough RAM is available to load the whole file into memory. The PNG library then calls the function pointed by the parameter pfGetData to read the data. The GetData function should return the number of available bytes. This could be less or equal the number of requested bytes. The function needs at least to return 1 new byte. Note that the PNG library internally allocates a buffer for the complete image. This can not be avoided by using this function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
172
CHAPTER
Displaying bitmap files
GUI_PNG_GetXSize()
Description
Returns the X-size of a specified PNG image, which has been loaded into memory.
Prototype
int GUI_PNG_GetXSize(const void * pFileData, int FileSize);
Parameter pFileData FileSize
Description Pointer to the start of the memory area in which the png file resides.
Size of the file in bytes.
Return value
X-size of the PNG image.
GUI_PNG_GetXSizeEx()
Description
Returns the X-size of a specified PNG image, which needs not to be loaded into memory.
Prototype
int GUI_PNG_GetXSizeEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Return value
X-size of the PNG image.
GUI_PNG_GetYSize()
Description
Returns the Y-size of a specified PNG image, which has been loaded into memory.
Prototype
int GUI_PNG_GetYSize(const void * pFileData, int FileSize);
Parameter pFileData FileSize
Description Pointer to the start of the memory area in which the png file resides.
Size of the file in bytes.
Return value
Y-size of the PNG image.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
173
GUI_PNG_GetYSizeEx()
Description
Returns the X-size of a specified PNG image, which needs not to be loaded into memory.
Prototype
int GUI_PNG_GetYSizeEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a function which is called for getting data. For details about the GetData
function, refer to "Getting data with the ...Ex() functions" on page 174.
Void pointer passed to the function pointed by pfGetData.
Return value
Y-size of the PNG image.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
174
CHAPTER
Displaying bitmap files
8.5 Getting data with the ...Ex() functions
As well as streamed bitmaps, using BMP, GIF, JPEG and PNG files also works without loading the whole image into RAM. For this case the ...Ex() functions can be used. Common for all of these functions is the use of a 'GetData' function. Please note that the 'GetData' function has to work slightly different depending on the actual task it is used for. See table of parameters and examples below.
Prototype of the 'GetData' function
int GUI_GET_DATA_FUNC(void * p, const U8 ** ppData, unsigned NumBytes, U32 Off);
Parameter p
ppData
NumBytes Off
Description
Application defined void pointer. BMP, GIF & JPEG: The 'GetData' function has to set the pointer to the location the requested data resides in.
Streamed bitmaps & PNG: The location the pointer points to has to be filled by the 'GetData' function. Number of requested bytes. Defines the offset to use for reading the source data.
Additional information
"...Ex()"-functions require the 'GetData'-function to fetch at least one pixel line of data. It is recommended to make sure that the 'GetData'-function is able to fetch at least one pixel line of the biggest image used by the application.
Internal use of the function
In general the 'GetData'-function is called one time at the beginning to retrieve overhead information and, after this, several times to retrieve the actual image data.
Return value
The number of bytes which were actually read. If the number of read bytes does not match, the drawing function will return immediately.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
175
Example (BMP, GIF and JPEG)
The following code excerpt shows how to implement a 'GetData' function for usage with BMP, GIF and JPEG data:
int APP_GetData(void * p, const U8 ** ppData, unsigned NumBytes, U32 Off) {
static char _acBuffer[0x200];
HANDLE
* phFile;
DWORD
NumBytesRead;
phFile = (HANDLE *)p; // // Check buffer size // if (NumBytes > sizeof(acBuffer)) {
NumBytes = sizeof(acBuffer); } // // Set file pointer to the required position // SetFilePointer(*phFile, Off, 0, FILE_BEGIN); // // Read data into buffer // ReadFile(*phFile, acBuffer, NumBytes, &NumBytesRead, NULL); // // Set data pointer to the beginning of the buffer // *ppData = acBuffer; // // Return number of available bytes // return NumBytesRead; }
Example (PNG and streamed bitmap)
The following code excerpt shows how to implement a 'GetData' function for usage with PNG and streamed bitmap data:
int APP_GetData(void * p, const U8 ** ppData, unsigned NumBytes, U32 Off) {
HANDLE * phFile;
DWORD NumBytesRead;
U8
* pData;
pData = (U8 *)*ppData; phFile = (HANDLE *)p; // // Set file pointer to the required position // SetFilePointer(*phFile, Off, 0, FILE_BEGIN); // // Read data into buffer // ReadFile(*phFile, pData, NumBytes, &NumBytesRead, NULL); // // Return number of available bytes // return NumBytesRead; }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
176
CHAPTER
Displaying bitmap files
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
177
Chapter 9 Bitmap Converter
The Bitmap Converter is a Windows program which is easy to use. Simply load a bitmap (in the form of a bmp or a gif file) into the application. Convert the color format if you want or have to, and convert it into a C file by saving it in the appropriate format. The C file may then be compiled, allowing the image to be shown on your display with emWin.
Screenshot of the Bitmap Converter
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
178
CHAPTER
Bitmap Converter
9.1 What it does
The Bitmap Converter is primarily intended as a tool to convert bitmaps from a PC format to a C file. Bitmaps which can be used with emWin are normally defined as GUI_BITMAP structures in C. The structures -- or rather the picture data which is referenced by these structures -- can be quite large. It is time-consuming and inefficient to generate these bitmaps manually. We therefore recommend using the Bitmap Converter, which automatically generates C files from bitmaps. An other useful feature is the ability to save images as C stream files. The advantage against a normal C file is, that these data streams can be located anywhere on any media whereas C files need to be located in the addressable CPU area. It also features color conversion, so that the resulting C code is not unnecessarily large. You would typically reduce the number of bits per pixel in order to reduce memory consumption. The Bitmap Converter displays the converted image. A number of simple functions can be performed with the Bitmap Converter, including scaling the size, flipping the bitmap horizontally or vertically, rotating it, and inverting the bitmap indices or colors (these features can be found under the Image menu). Any further modifications to an image must be made in a bitmap manipulation program such as Adobe Photoshop or Corel Photopaint. It usually makes the most sense to perform any image modifications in such a program, using the Bitmap Converter for converting purposes only.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
179
9.2 Loading a bitmap
9.2.1 Supported input file formats
The Bitmap Converter basically supports Windows bitmap files (*.bmp), "Graphic Interchange Format" (*.gif) and "Portable Network Graphics" (*.png):
Windows Bitmap Files (BMP)
The Bitmap Converter supports the most common bitmap file formats. Bitmap files of the following formats can be opened by the Bitmap Converter:
· 1, 4 or 8 bits per pixel (bpp) with palette; · 16, 24 or 32 bpp without palette (full-color mode, in which each color is assigned
an RGB value); · RLE4 and RLE8.
Trying to read bitmap files of other formats will cause an error message of the Bitmap Converter.
Graphic Interchange Format (GIF)
The Bitmap Converter supports reading GIF files. For general editing only the first image of the GIF file is used. GIF image consisting of several images may be converted to animated sprites and animated cursors. Transparency and interlaced GIF images are supported by the converter.
Portable Network Graphic (PNG)
The PNG format is the most recommended format to create images with alpha blending. The Bitmap Converter supports reading PNG images with alpha channel.
9.2.2 Loading from a file
An image file of one of the supported formats may be opened directly in the Bitmap Converter by selecting File/Open.
9.2.3 Using the clipboard
Any other type of bitmap (that is, .jpg, .jpeg, .png, .tif) may be opened with another program, copied to the clipboard, and pasted into the Bitmap Converter. This process will achieve the same effect as loading directly from a file.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
180
CHAPTER
Bitmap Converter
9.3 Color conversion
The primary reason for converting the color format of a bitmap is to reduce memory consumption. The most common way of doing this is by using the option Best palette as in the above example, which customizes the palette of a particular bitmap to include only the colors which are used in the image. It is especially useful with fullcolor bitmaps in order to make the palette as small as possible while still fully supporting the image. Once a bitmap file has been opened in the Bitmap Converter, simply select Image/Convert Into/Best palette from the menu. If it is necessary to keep transparency select Image/Convert Into/Best palette + transparency. For certain applications, it may be more efficient to use a fixed color palette, chosen from the menu under Image/Convert Into. For example, suppose a bitmap in fullcolor mode is to be shown on a display which supports only four grayscales. It would be a waste of memory to keep the image in the original format, since it would only appear as four grayscales on the display. The full-color bitmap can be converted into a four-grayscale, 2bpp bitmap for maximum efficiency. The procedure for conversion would be as follows:
The Bitmap Converter is opened and the same file is loaded as in steps 1 and 2 of the previous example.
The Bitmap Converter displays the loaded bitmap.
Choose Image/Convert Into/Gray4.
The Bitmap Converter displays the converted bitmap.
In this example, the image uses less memory since a palette of only 4 grayscales is used instead of the full-color mode. If the target display supports only 4 grayscales, there is no use in having a higher pixel depth as it would only waste memory.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
181
9.4 Using a custom palette
Converting bitmaps to a custom palette and saving them without palette information can save memory and can increase the performance of bitmap drawing operations.
More efficient memory utilization
Per default each bitmap contains its own palette. Even the smallest bitmaps can contain a large palette with up to 256 colors. In many cases only a small fraction of the palette is used by the bitmap. If using many of these bitmaps the amount of memory used by the palettes can grow rapidly. So it can save much ROM if converting the bitmaps used by emWin to the available hardware palette and saving them as (D)evice (D)ependent (B)itmaps without palette information.
Better bitmap drawing performance
Before emWin draws a bitmap, it needs to convert each device independent bitmap palette to the available hardware palette. This is required because the pixel indices of the bitmap file are indices into the device independent bitmap palette and not to the available hardware palette. Converting the bitmap to a DDB means that color conversion at run time is not required and speeds up the drawing.
9.4.1 Saving a palette file
The Bitmap Converter can save the palette of the currently loaded bitmap into a palette file which can be used for converting other bitmaps with the command Image/ Convert Into/Custom palette. This requires that the current file is a palette based file and not a RGB file. To save the palette the command File/Save palette... can be used.
9.4.2 Palette file format
Custom palette files are simple files defining the available colors for conversion. They contain the following:
· Header (8 bytes). · NumColors (U32, 4 bytes). · 0 (4 bytes). · U32 Colors[NumColors] (NumColors*4 bytes, type GUI_COLOR).
Total file size is therefore: 16 + (NumColors * 4) bytes. A custom palette file with 8 colors would be 16 + (8 * 4) = 48 bytes. At this point, a binary editor must be used in order to create such a file. The maximum number of colors supported is 256; the minimum is 2.
Example
This example file would define a palette containing 2 colors -- red and white:
0000: 65 6d 57 69 6e 50 61 6c 02 00 00 00 00 00 00 00 0010: ff 00 00 00 ff ff ff 00
The 8 headers make up the first eight bytes of the first line. The U32 is stored lsb first (big endian) and represents the next four bytes, followed by the four 0 bytes. Colors are stored 1 byte per color, where the 4th byte is 0 as follows: RRGGBB00. The second line of code defines the two colors used in this example.
9.4.3 Palette files for fixed palette modes
Using the custom palette feature can even make sense with the most common used fixed palette modes, not only with custom hardware palettes. For the most palette based fixed palette modes a palette file can be found in the folder Sample\Palette.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
182
CHAPTER
Bitmap Converter
9.4.4 Converting a bitmap
The command Image/Convert Into/Custom palette should be used for converting the currently loaded bitmap to a custom palette. The Bitmap Converter tries to find the nearest color of the palette file for each pixel of the currently loaded bitmap.
9.5 Generating C files from bitmaps
The main function of the Bitmap Converter is to convert PC-formatted bitmaps into C files which can be used by emWin. Before doing so, however, it is often desirable to modify the color palette of an image so that the generated C file is not excessively large. The bitmap may be saved as a bmp or a gif file (which can be reloaded and used or loaded into other bitmap manipulation programs) or as a C file. A C file will serve as an input file for your C compiler. It may contain a palette (device-independent bitmap, or DIB) or be saved without (device-dependent bitmap, or DDB). DIBs are recommended, as they will display correctly on any display; a DDB will only display correctly on a display which uses the same palette as the bitmap. C files may be generated as "C with palette", "C without palette", "C with palette, compressed" or "C without palette, compressed". For more information on compressed files, see the section "Compressed bitmaps" as well as the example at the end of the chapter.
9.5.1 Supported bitmap formats
The following table shows the currently available output formats for C files:
Format
Color depth
1 bit per pixel 2 bits per pixel 4 bits per pixel 8 bits per pixel Compressed, RLE4 Compressed, RLE8 High color 555 High color 555, red and blue swapped High color 565 High color 565, red and blue swapped High color 565, compressed High color 565, red and blue swapped, compressed True color 888 True color 8888 with alpha channel True color 8888 with alpha channel, compressed Alpha channel, compressed
1bpp 2bpp 4bpp 8bpp 4bpp 8bpp 15bpp 15bpp 16bpp 16bpp 16bpp 16bpp 24bpp 32bpp 32bpp 8bpp
Compression
no no no no yes yes no no no no yes yes no no yes yes
Tr a n s parency
yes yes yes yes yes yes no no no no no no no yes yes yes
Palette
yes yes yes yes yes yes no no no no no no no no no no
9.5.2 Palette information
A bitmap palette is an array of 24 bit RGB color entries. Bitmaps with a color depth from 1 - 8 bpp can be saved with (device independent bitmap, DIB) or without palette information (device dependent bitmap DDB).
Device independent bitmaps (DIB)
The color information is stored in the form of an index into the color array. Before emWin draws a DIB, it converts the 24 bit RGB colors of the bitmap palette into color indices of the hardware palette. The advantage of using DIBs is that they are hardware independent and can be drawn correctly on systems with different color configurations. The disadvantages are the additional ROM requirement for the palette and the slower performance because of the color conversion.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
183
Device dependent bitmaps (DDB)
The pixel information of a DDB is the index of the displays hardware palette. No conversion needs to be done before drawing a DDB. The advantages are less ROM requirement and a better performance. The disadvantage is that these bitmaps can not be displayed correctly on systems with other color configurations.
9.5.3 Transparency
A palette based bitmap can be converted to a transparent bitmap. Transparency means each pixel with index 0 will not produce any output. The command Image/ Transparency can be used to select the color which should be used for transparency. After selecting the transparent color, the pixel indices of the image will be recalculated, so that the selected color is on position 0 of the bitmap palette. When saving the bitmap file as C file, it will be saved with the transparency attribute.
9.5.4 Alpha blending
Alpha blending is a method of combining an image with the background to create the effect of semi transparency. The alpha value of a pixel determines its transparency. The color of a pixel after drawing the bitmap is a blend of the former color and the color value in the bitmap. In emWin, logical colors are handled as 32 bit values. The lower 24 bits are used for the color information and the upper 8 bits are used to manage the alpha value. An alpha value of 0 means the image is opaque and a value of 0xFF means completely transparent. Whereas BMP and GIF files do not support alpha blending PNG files support alpha blending. So the easiest way to create bitmap files with alpha blending is to load a PNG file. When working with BMP and/or GIF files the Bitmap Converter initially has no information about the alpha values.
Loading a PNG file
This is the most recommended way for creating bitmaps with an alpha mask:
After loading
The PNG file contains all required information.
Loading the alpha values from an alpha mask bitmap
This method loads the alpha values from a separate file. Black pixels of the alpha mask file means opaque and white means transparent. The following table shows an example:
Starting point
Alpha mask
Result
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
184
CHAPTER
Bitmap Converter
The command File/Load Alpha Mask can be used for loading an alpha mask.
Creating the alpha values from two bitmaps
This method uses the difference between the pixels of two pictures to calculate the alpha values. The first image should show the item on a black background. The second image should show the same on a white background. The following table shows an example of how to create the alpha values using the command File/Create Alpha:
Starting point
Black background White background
Result
The command File/Create Alpha can be used tor creating the alpha values.
9.5.5 Selecting the best format
emWin supports various formats for the generated C file. It depends on several conditions which will be the 'best' format and there is no general rule to be used. Color depth, compression, palette and transparency affect the drawing performance and/or ROM requirement of the bitmap.
Color depth
In general the lower the color depth the smaller the ROM requirement of the bitmap. Each display driver has been optimized for drawing 1bpp bitmaps (text) and bitmaps with the same color depth as the display.
Compression
The supported RLE compression method has the best effect on bitmaps with many horizontal sequences of equal-colored pixels. Details later in this chapter. The performance is typically slightly slower than drawing uncompressed bitmaps.
Palette
The ROM requirement of a palette is 4 bytes for each color. So a palette of 256 colors uses 1 Kbyte. Furthermore emWin needs to convert the colors of the palette before drawing the bitmap. Advantage: Bitmaps are device independent meaning they can be displayed on any display, independent of its color depth and format.
Transparency
The ROM requirement of transparent bitmaps is the same as without transparency. The performance is with transparency slightly slower than without.
High color and true color bitmaps
Special consideration is required for bitmaps in these formats. Generally the use of these formats only make sense on displays with a color depth of 15 bits and above. Further it is strongly recommended to save the C files in the exact same format used by the hardware. Note that using the right format will have a positive effect on the drawing performance. If a high color bitmap for example should be shown on a system with a color depth of 16bpp which has the red and blue components swapped, the best format is 'High color 565, red and blue swapped'. Already a slightly other format has the effect, that each pixel needs color conversion, whereas a bitmap in the right format can be rendered very fast without color conversion. The difference of drawing performance in this case can be factor 10 and more.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
185
9.5.6 Saving the file
The basic procedure for using the Bitmap Converter is illustrated below:
Step 1: Start the application. The Bitmap Converter is opened showing an empty window.
Step 2: Load a bitmap into the Bitmap Converter.
Choose File/Open.
Locate the document you want to open and click
Open (must be a bmp file). In this example, the file Logo200.bmp is cho-
sen.
The Bitmap Converter displays the loaded bitmap. Step 3: Convert the image if necessary.
In this example, the loaded bitmap is in full-color mode. It must be converted to a palette format before a C file can be generated.
Choose Image/Convert Into.
Select the desired palette.
In this example, the option Best palette is
chosen.
The Bitmap Converter displays the converted bitmap.
The image is unchanged in terms of appearance, but uses less memory since a palette of only 15 colors is used instead of the full-color mode. These 15 colors are the only ones actually required to display this particular image.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
186
CHAPTER
Bitmap Converter
Step 4: Save the bitmap as a C file.
Choose File/Save As.
Select a destination and a name for the C file. Select the file type. In this example, the file is saved as C bitmap file."
Click Save.
Step 5: Specify bitmap format.
If the bitmap should be saved as C file the format should now be specified. Use one of the available formats shown in the dialog. If the bitmap should be saved without palette, activate the check box "Without palette"
The Bitmap Converter will create a separate file in the specified destination, containing the C source code for the bitmap.
9.6 Generating C stream files
A C stream file consists of the same information as a C file. Contrary to a C file a data stream can be located anywhere and does not need to be compiled or linked with the project. All supported output formats described for C files are also available for C stream files. emWin supports creating bitmaps from data streams and drawing data streams directly. For details about C stream file support please refer to "Drawing bitmaps" on page 119.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
187
9.7 Compressed bitmaps
The Bitmap Converter and emWin support run-length encoding (RLE) compression of bitmaps in the resulting source code files. The RLE compression method works most efficiently if your bitmap contains many horizontal sequences of equal-colored pixels. An efficiently compressed bitmap will save a significant amount of space. However, compression is not recommended for photographic images since they do not normally have sequences of identical pixels. It should also be noted that a compressed image may take slightly longer to display. If you want to save a bitmap using RLE compression, you can do so by selecting one of the compressed output formats when saving as a C file: "C with palette, compressed" or "C without palette, compressed". There are no special functions needed for displaying compressed bitmaps; it works in the same way as displaying uncompressed bitmaps.
Compression ratios
The ratio of compression achieved will vary depending on the bitmap used. The more horizontal uniformity in the image, the better the ratio will be. A higher number of bits per pixel will also result in a higher degree of compression. In the bitmap used in the previous examples, the total number of pixels in the image is (200*94) = 18,800. Since 2 pixels are stored in 1 byte, the total uncompressed size of the image is 18,800/2 = 9,400 bytes. The total compressed size for this particular bitmap is 3,803 bytes for 18,800 pixels (see the example at the end of the chapter). The ratio of compression can therefore be calculated as 9,400/3,803 = 2.47.
9.8 Creating animated sprites / cursors
The Bitmap Converter can be used to convert animated GIF files to animated sprites / cursors in C file format. This functionality is offered by the entries in the file menu which are shown below:
After clicking one of the according file menu entries, a file dialog appears and an animated GIF file can be chosen. Once this is done the name of the resulting C file needs to be specified. Converting animated GIF files to animated sprites / cursors does not require any further parameters. The process is performed automatically. Since the effort depends on the input GIF file, completing this task may take a moment. The Bitmap Converter can be used again as soon as the mouse cursor is changed to the simple arrow again.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
188
CHAPTER
Bitmap Converter
Animated Sprite example
The following shows the structure of an animated sprite C file as it is generated by the Bitmap Converter. Although animations consist of several images, the palette and pixel data structures are shown only once here. Variable data is described using place holders.
File header
/*********************************************************************
*
SEGGER Microcontroller GmbH & Co. KG
*
*
Solutions for real time microcontroller applications
*
*
www.segger.com
*
**********************************************************************
*
*
* C-file generated by
*
*
*
*
Bitmap converter for emWin %_VERSION_%.
*
*
Compiled %_COMPILE_DATE_%
*
*
(C) 1998 - 2013 Segger Microcontroller GmbH & Co. KG
*
*
*
**********************************************************************
*
*
* Source file: %_FILENAME_%.gif (Animated Sprite)
*
* Dimensions: %_X_SIZE_% * %_Y_SIZE_%
*
* NumImages: %_NUMBER_OF_IMAGES_%
*
* Duration: %_OVERALL_DURATION_%
*
*
*
**********************************************************************
*
* %_USAGE_EXAMPLE_%
*/
#include <stdlib.h>
#include "GUI.h"
#ifndef GUI_CONST_STORAGE #define GUI_CONST_STORAGE const
#endif
Palette and pixel data
static GUI_CONST_STORAGE GUI_COLOR%_FILENAME_%%_INDEX_%[] = { %_COLOR_DATA_%
};
static GUI_CONST_STORAGE GUI_LOGPALETTE _Pal%_FILENAME_%%_INDEX_% = { %_NUMBER_OF_COLORS_%, // Number of entries %_TRANSPARENCY_FLAG_%, // No transparency &_Colors%_FILENAME_%%_INDEX_%[0]
};
static GUI_CONST_STORAGE unsigned char _ac%_FILENAME_%%_INDEX_%[] = { %_PIXEL_DATA_%
};
General data
static GUI_CONST_STORAGE GUI_BITMAP _abm%_FILENAME_%[] = {
{ %_X_SIZE_%,
%_Y_SIZE_%,
%_BYTES_PER_LINE_%,
%_BITS_PER_PIXEL_%,
_ac%_FILENAME_%%_INDEX_%, &_Pal%_FILENAME_%%_INDEX_%
},
[...]
};
const GUI_BITMAP * apbm%_FILENAME_%[] = { &_abm%_FILENAME_%[0], [...]
};
const unsigned aDelay%_FILENAME_%[] = { %_DELAY_DATA_%
};
/*************************** End of file ****************************/
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
189
Animated Cursor example
The file structure for animated cursors almost equals the structure for animated sprites. Therefor only the differences are mentioned here:
The array of bitmap pointers is defined as static:
static const GUI_BITMAP * _apbm%_FILENAME_%[] = { [...]
};
The array of delays is defined as static: static const unsigned _aDelay%_FILENAME_%[] = { [...] };
A non-static definition of a GUI_CURSOR_ANIM structure is added at the end.
const GUI_CURSOR_ANIM Cursor%_FILENAME_% = {
_apbm%_FILENAME_%, // Pointer to an array of bitmaps
0,
// x coordinate of the hot spot
0,
// y coordinate of the hot spot
0,
// Period, should be 0 here
_aDelay%_FILENAME_%, // Pointer to an array of periods
%_NUMBER_OF_IMAGES_% // Number of images
};
Additional information
The hot spot coordinate define the position which is recognized by emWin when PID events occur. If the hot spot should not be represented by the topmost leftmost pixel, the according values in the GUI_CURSOR_ANIM structure may be modified. The array of delays is always created. In case every image uses the same delay, the forth value in the GUI_CURSOR_ANIM structure may be set accordingly. In this case the array of delays may be deleted after the fifth value of the GUI_CURSOR_ANIM structure was set to NULL.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
190
CHAPTER
Bitmap Converter
9.9 Command line usage
It is also possible to work with the Bitmap Converter using the command prompt. All conversion functions available in the Bitmap Converter menu are available as commands, and any number of functions may be performed on a bitmap in one command line.
9.9.1 Format for commands
Commands are entered using the following format:
BmpCvt <filename>.bmp <-command>
(If more than one command is used, one space is typed between each.) For example, a bitmap with the name logo.bmp is converted into Best palette format and saved as a C file named logo.bmp all at once by entering the following at the command prompt:
BmpCvt logo.bmp -convertintobestpalette -saveaslogo,1 -exit
Note that while the file to be loaded into the Bitmap Converter always includes its bmp extension, no file extension is written in the -saveas command. An integer is used instead to specify the desired file type. The number 1 in the -saveas command above designates "C with palette". The -exit command automatically closes the program upon completion. See the table below for more information.
9.9.2 Valid command line options
The following table lists all permitted Bitmap Converter commands. It can also be viewed at any time by entering BmpCvt -? at the command prompt.
Command
Explanation
-convertintobw
Convert to BW.
-convertintogray4
Convert to Gray4.
-convertintogray16
Convert to Gray16.
-convertintogray64
Convert to Gray64.
-convertintogray256
Convert to Gray256.
-convertinto111
Convert to 111.
-convertinto222
Convert to 222.
-convertinto233
Convert to 233.
-convertinto323
Convert to 323.
-convertinto332
Convert to 332.
-convertinto8666
Convert to 8666.
-convertintorgb
Convert to RGB.
-convertintobestpalette
Convert to best palette.
-convertintotranspalette
Convert to best palette with transparency.
-convertintocustompalette<filename>
Convert to a custom palette.
<filename> User-specified filename of desired custom
palette.
-exit -fliph -flipv -help -invertindices -invertpalette -rotate90cw
Terminate PC program automatically. Flip image horizontally. Flip image vertically. Display this box. Invert indices. Invert palette entries. Rotate image by 90 degrees clockwise.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
191
Command
Explanation
-rotate90ccw
Rotate image by 90 degrees counterclockwise.
-rotate180
Rotate image by 180 degrees.
-saveas<filename>,<type>[,<fmt>[,<noplt>]] Save file as filename.
User-specified file name including the file
<filename> extension.
Must be an integer from 1 to 4 as follows:
1: C with palette (.c file)
<type> 2: Windows Bitmap file (bmp file)
3: C stream (.dta file)
4: GIF format (gif file)
Specifies the bitmap format (only if type == 1): 1: 1 bit per pixel* 2: 2 bits per pixel* 4: 4 bits per pixel* 5: 8 bits per pixel* 6: RLE4 compression* 7: RLE8 compression* 8: High color 565 9: High color 565, red and blue swapped 10: High color 555 11: High color 555, red and blue swapped 12: RLE16 compression 13: RLE16 compression, red and blue
<fmt> swapped
15: True color 32bpp, compressed 16: True color 32bpp 17: True color 24bpp 18: Alpha channel 8bpp, compressed
-transparency<RGB-Color> -?
If this parameter is not given, the Bitmap Converter uses the following default formats in dependence of the number of colors of the bitmap: Number of colors <= 2: 1 bit per pixel Number of colors <= 4: 2 bits per pixel Number of colors <= 16: 4 bits per pixel Number of colors <= 256: 8 bits per pixel RGB: High color 565
<noplt> Saves the bitmap with or without palette
(only if type == 1) 0: Save bitmap with palette (default) 1: Save bitmap without palette
Sets the transparent color.
RGB color which should be used as trans-
<RGB-Color> parent color.
Displays the command line table.
* Images need to be converted to an according format before they can be stored in a format of 8 or less bpp.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
192
CHAPTER
Bitmap Converter
9.10 Example of a converted bitmap
A typical example for the use of the Bitmap Converter would be the conversion of your company logo into a C bitmap. Take another look at the example bitmap pictured below:
The bitmap is loaded into the Bitmap Converter, converted to Best palette, and saved as "C with palette". The resulting C source code is displayed below (some data is not shown to conserve space).
Resulting C code (generated by the Bitmap Converter)
/*********************************************************************
*
SEGGER MICROCONTROLLER SYSTEME GmbH
*
*
Solutions for real time microcontroller applications
*
*
www.segger.com
*
**********************************************************************
*
* C-file generated by
*
*
Bitmap Converter for emWin V5.05.
*
Compiled Feb 26 2010, 14:49:28
*
(C) 1998 - 2013 Segger Microcontroller Systeme GmbH
*
**********************************************************************
*
* Source file: SeggerLogo200
* Dimensions: 200 * 100
* NumColors: 33
*
**********************************************************************
*/
#include <stdlib.h>
#include "GUI.h"
#ifndef GUI_CONST_STORAGE #define GUI_CONST_STORAGE const
#endif
static GUI_CONST_STORAGE GUI_COLOR ColorsSeggerLogo200[] = { 0xFFFFFF,0x353537,0x9C4B37,0xCDCDCD, [...]
};
static GUI_CONST_STORAGE GUI_LOGPALETTE PalSeggerLogo200 = { 33,/* number of entries */ 0, /* No transparency */ &ColorsSeggerLogo200[0]
};
static GUI_CONST_STORAGE unsigned char acSeggerLogo200[] = {
0x00, 0x00,
/* Not all data is shown in this example */
0x00, 0x92,
[...]
0xC6, 0x22,
0x0A, 0x22
};
extern GUI_CONST_STORAGE GUI_BITMAP bmSeggerLogo200;
GUI_CONST_STORAGE GUI_BITMAP bmSeggerLogo200 = { 200, /* XSize */ 100, /* YSize */ 200, /* BytesPerLine */ 8, /* BitsPerPixel */ acSeggerLogo200, /* Pointer to picture data (indices) */ &PalSeggerLogo200 /* Pointer to palette */
};
/*************************** End of file ****************************/
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
193
Compressing the file
We can use the same bitmap image to create a compressed C file, which is done simply by loading and converting the bitmap as before, and saving it as "C with palette, compressed". The source code is displayed below (some data is not shown to conserve space).
The compressed image size can be seen towards the end of the file as 3,730 bytes for 18,800 pixels.
Resulting compressed C code (generated by the Bitmap Converter)
/*********************************************************************
*
SEGGER MICROCONTROLLER SYSTEME GmbH
*
*
Solutions for real time microcontroller applications
*
*
www.segger.com
*
**********************************************************************
*
* C-file generated by
*
*
Bitmap Converter for emWin V5.05.
*
Compiled Feb 26 2010, 14:49:28
*
(C) 1998 - 2013 Segger Microcontroller Systeme GmbH
*
**********************************************************************
*
* Source file: SeggerLogo200_comp
* Dimensions: 200 * 100
* NumColors: 33
*
**********************************************************************
*/
#include <stdlib.h>
#include "GUI.h"
#ifndef GUI_CONST_STORAGE #define GUI_CONST_STORAGE const
#endif
static GUI_CONST_STORAGE GUI_COLOR ColorsSeggerLogo200_comp[] = { 0xFFFFFF, 0x353537, 0x9C4B37, 0xCDCDCD, [...]
};
static GUI_CONST_STORAGE GUI_LOGPALETTE PalSeggerLogo200_comp = { 33,/* number of entries */ 0, /* No transparency */ &ColorsSeggerLogo200_comp[0]
};
static GUI_CONST_STORAGE unsigned char acSeggerLogo200_comp[] = { /* RLE: 006 Pixels @ 000,000*/ 6, 0x00, /* RLE: 188 Pixels @ 006,000*/ 188, 0x01, [...] /* RLE: 188 Pixels @ 006,099*/ 188, 0x01, /* RLE: 006 Pixels @ 194,099*/ 6, 0x00, 0
}; /* 3730 for 20000 pixels */
extern GUI_CONST_STORAGE GUI_BITMAP bmSeggerLogo200_comp;
GUI_CONST_STORAGE GUI_BITMAP bmSeggerLogo200_comp = { 200, /* XSize */ 100, /* YSize */ 200, /* BytesPerLine */ GUI_COMPRESS_RLE8, /* BitsPerPixel */ acSeggerLogo200_comp, /* Pointer to picture data (indices) */ &PalSeggerLogo200_comp /* Pointer to palette */
,GUI_DRAW_RLE8 };
/*************************** End of file ****************************/
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
194
CHAPTER
Bitmap Converter
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
195
Chapter 10
Fonts
This chapter describes the various methods of font support in emWin. The most common fonts are shipped with emWin as C font files. All of them contain the ASCII character set and most of them also the characters of ISO 8859-1. In fact, you will probably find that these fonts are fully sufficient for your application. For detailed information about the individual fonts, refer to "Standard fonts" on page 220. emWin is compiled for 8-bit characters, allowing for a maximum of 256 different character codes out of which the first 32 are reserved as control characters. The characters that are available depend on the selected font. For accessing the full Unicode area of 65536 possible characters emWin supports UTF8 decoding which is described in the chapter "Language Support" on page 903.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
196
CHAPTER
Fonts
10.1 Introduction
The first way of font support was the possibility to use C files with font definitions containing bitmaps with 1bpp pixel information for each character. This kind of font support was limited to use only the fonts which are compiled with the application. Over time, the font support has been improved regarding font quality, ROM requirement, performance, scalability and the ability to add further fonts at run time. In the meantime emWin fonts cover antialiasing, drawing of compound characters like required in Thai language, fonts located on external non addressable media and TrueType support. Except the TrueType font format, which is a vector font, all other kinds of fonts are bitmap fonts.
10.2 Font types
emWin supports different internal types of fonts defined by emWin and the commonly used TrueType fonts.
Monospaced bitmap fonts
Each character of a monospaced bitmap font has the same size. In a proportional font each character has its own width, whereas in a monospaced font the width is defined only one time. The pixel information is saved with 1bpp and covers the whole character area.
Proportional bitmap fonts
Each character of a proportional bitmap font has the same height and its own width. The pixel information is saved with 1bpp and covers the whole character area.
Antialiased fonts with 2 bpp antialiasing information
Each character has the same height and its own width. The pixel information is saved with 2bpp antialiasing information and covers the whole character area.
Antialiased fonts with 4 bpp antialiasing information
Each character has the same height and its own width. The pixel information is saved with 4bpp antialiasing information and covers the whole character area.
Extended proportional bitmap fonts
Each character of an extended proportional bitmap font has its own height and its own width. The pixel information is saved with 1bpp and covers only the areas of the glyph bitmaps.
Extended proportional bitmap fonts with 2 bpp antialiasing information
Each character has the same height and its own width. The pixel information is saved with 2bpp antialiasing information and covers only the areas of the glyph bitmaps.
Extended proportional bitmap fonts with 4 bpp antialiasing information
Each character has the same height and its own width. The pixel information is saved with 4bpp antialiasing information and covers only the areas of the glyph bitmaps.
Extended proportional bitmap fonts, framed
In some cases, for example in situations, where the background color is unknown at compile time, it can make sense to use a framed font. A framed font is always drawn in transparent mode regardless of the current settings. The character pixels are drawn in the currently selected foreground color and the frame is drawn in background color. A good contrast between foreground and background color makes sure, that the text can be read regardless of the background. Note that this type of font is not suitable for compound characters like in Thai language. It is also not suitable for Arabic fonts. The picture below shows some framed text in front of a photo:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
197
Table of font types
The following table shows the difference between the font types. The pictures only show the pixel information saved in the font file:
Prop. bitmap font
Prop. bitmap font, AA2
Prop. bitmap font, AA2
Ext. prop. bitmap font
Ext. prop. bitmap font,
framed
Ext. prop. bitmap font,
AA2
Ext. prop. bitmap font,
AA4
TrueType vector fonts
The TrueType font support of emWin means support for the TrueType font file format described later in this chapter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
198
CHAPTER
Fonts
10.3 Font formats
The following explains the differences between the supported font formats, when to use them and what is required to be able to use them.
10.3.1 C file format
This is the most common way of using fonts. When using fonts in form of C files, we recommend compiling all available fonts and linking them as library modules or putting all of the font object files in a library which you can link with your application. This way you can be sure that only the fonts which are needed by your application are actually linked. The Font Converter may be used to create additional fonts.
When to use
This format should be used if the fonts are known at compile time and if there is enough addressable memory available for the font data.
Requirements
In order to be able to use a font C file in your application, the following requirements must be met:
· The font file is in a form compatible with emWin as C file, object file or library. · The font file is linked with your application. · The font declaration is contained in the application.
Format description
A font C file contains at first the pixel information of all characters included by the font. It is followed by a character information table with size information about each character. This table is followed by range information structures for each contiguous area of characters contained in the font file, whereas each structure points to the next one. Note that this method can enlarge a font file a lot if using many separate characters. After the range information structures a GUI_FONT structure follows with the main information like type, pixel size and so on of the font.
10.3.2 System Independent Font (SIF) format
System independent fonts are binary data blocks containing the font information. The Font Converter can be used to create system independent fonts. This tool is not part of the basic package. A short description follows later in this chapter.
When to use
This format should be used if the fonts are not known at compile time and if there is enough addressable memory available for the font data.
Requirements
In order to be able to use a SIF font file in your application, it is required that the whole file reside in addressable memory (ROM or RAM).
Format description
The structure of a SIF file is nearly the same as of a C file. It contains the same information in binary format. The sequence of the file components is vice versa: General font information followed by range information structures, character information table and at least pixel information of all characters.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
199
10.3.3 External Bitmap Font (XBF) format
As well as SIF fonts XBF fonts are binary data blocks containing the font information and the Font Converter can be used to create XBF files. The Font Converter is not part of the emWin basic package. For details about how to create external binary fonts, please refer to the chapter "Font Converter" on page 243.
Advantages
Contrary to other fonts, XBF fonts do not have to reside in memory when they are used, whereas all other kinds of emWin fonts need to reside completely in memory. The XBF font file can remain on any external media while it is used. Data access is done by a 'GetData' callback function. The advantage of XBF fonts is that it is possible to use very large fonts on systems with little memory. XBF fonts offer a performance advantage when using fonts including lots of characters which do not follow each other directly in sequence. This kind of character set would cause the Font Converter to create a C file font containing many GUI_FONT_PROP structures having a pointer to the according next one. The more GUI_FONT_PROP structures exist in a font the longer it might take to display a character. XBF fonts just use a memory offset so each character can be found in the same amount of time.
When to use
This format should be used if there is not enough addressable memory available for the font data and if there is any kind of external media available for storing the fonts.
Requirements
In order to be able to use a XBF font in your application, a 'GetData' callback function is required which is responsible for getting font data.
Format description
This format differs in general from SIF and C file format. At first it contains a small block of general font information including the lowest character code and the highest character code. It is followed by an access table containing offset and data size information for each character between lowest and highest character code. If a character does not exist, this information is zero for the according character. The access table is followed by the character information of all characters containing pixel data and character size information.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
200
CHAPTER
Fonts
10.3.4 iType font engine support
Since version V5.20 emWin also supports using the iType® font engine. The iType® font engine is a font rendering subsystem developed by Monotype Imaging. It offers a host of advanced capabilities including font linking, font management and discovery, support for various industry standards and font formats in a small memory footprint. iType can be implemented into various platforms. Based on OpenType®, TrueType® and PostScript® font formats and packaged as ANSI C code for broad, flexible integration, iType meets stringent size requirements for any applications, including those that support East Asian languages requiring thousands of characters. The glue code to be able to use the iType® font engine is freely available under www.segger.com/link/emwin_itype.zip
Screenshot
Licensing
The emWin library of Segger does not provide the iType® font engine itself. It provides only the glue code required to be able to use the iType library. Please contact Monotype Imaging under monotypeimaging.com for a licence request if required.
When to use
This format could be used if high quality fonts need to be scaleable at run-time and/ or advanced font effects are required.
Requirements
In general the requirements are similar to the requirements of the true type font support described on the next page. For detailed information about requirements and performance please also contact Monotype Imaging under monotypeimaging.com.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
201
10.3.5 TrueType Font (TTF) format
TrueType is an outline font standard developed by Apple Computer. It offers font developers a high degree of control over how their fonts are displayed at various font heights. Contrary to bitmap fonts which are based on bitmaps for each character, TrueType fonts are based on vector graphics. The advantage of the vector representation is the loss-free scalability. This implies that each character first needs to be rasterized into a bitmap before it is drawn. To avoid rasterization each time a character is drawn the bitmap data normally is cached by the font engine. This requires a fast CPU and enough RAM. The emWin TTF package is not part of the shipment. It is freely available under www.segger.com/link/emwin_freetype.zip.
Licensing
The emWin implementation of the TTF support is based on the FreeType font library from David Turner, Robert Wilhelm and Werner Lemberg which is freely available under www.freetype.org. It is used in emWin under the FreeType license which can be found under GUI\TrueType\FTL.txt. It has been slightly adapted and a 'glue' layer with GUI-functions has been added.
When to use
This format should be used if fonts need to be scaleable at run-time.
Requirements
· CPU: TTF support works only on 32 bit CPUs. Our definition of a 32bit CPU: sizeof(int) = 4.
· ROM: The ROM requirement of the TTF engine is app. 250K. The exact size depends on the CPU, the compiler and the optimization level of the compiler.
· RAM: The RAM requirement of the library depends a lot on the used fonts. The basic RAM requirement of the TTF engine is app. 50K. When creating a GUI font with GUI_TTF_CreateFont() the font engine loads all font tables defined in the TTF file required to generate the characters. The table sizes varies a lot between the fonts. The additional required amount of RAM for creating a font can be between a few KB up to more than 1MB. For typical fonts 80-300 Kbytes are required. It depends on the used font file how much RAM is required. At least the TTF engine requires a bitmap cache. Per default the engine uses 200K for the cache. This should be enough for most applications. The TTF engine allocates its memory via the non emWin functions malloc() and free(). It must be made sure that these functions work before using the TTF engine.
Format description
For details about the TTF format, refer to the information available under www.apple.com.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
202
CHAPTER
Fonts
10.4 Converting a TTF file to C source
Under some circumstances it can be useful to add a TTF file as 'C' file to the project, for example if no file system is available. This can be done by using the tool Bin2C.exe shipped with emWin. It can be found in the Tools subfolder. It converts the given binary file (in this case the TTF file) to a 'C' file.
10.5 Declaring custom fonts
The most recommended way of declaring the prototypes of custom fonts is to put them into an application defined header file. This should be included from each application source file which uses these fonts. It could look like the following example:
#include "GUI.h"
extern GUI_CONST_STORAGE GUI_FONT GUI_FontApp1; extern GUI_CONST_STORAGE GUI_FONT GUI_FontApp2;
Note that this kind of declaring prototypes does not work if the fonts should be used with emWin configuration macros like BUTTON_FONT_DEFAULT or similar. In this case the fonts need to be declared in the configuration file GUIConf.h. The declaration in this case can look like the following example:
typedef struct GUI_FONT GUI_FONT;
extern const GUI_FONT GUI_FontApp1;
#define BUTTON_FONT_DEFAULT &GUI_FontApp1 #define EDIT_FONT_DEFAULT &GUI_FontApp1
The typedef is required because the structure GUI_FONT has not been defined at the early point where GUIConf.h is included by emWin.
10.6 Selecting a font
emWin offers different fonts, one of which is always selected. This selection can be changed by calling the function GUI_SetFont() or one of the GUI_XXX_CreateFont() functions, which select the font to use for all text output to follow for the current task. If no font has been selected by your application, the default font is used. This default is configured in GUIConf.h and can be changed. You should make sure that the default font is one that you are actually using in your application because the default font will be linked with your application and will therefore use up ROM memory.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
203
10.7 Font API
The table below lists the available font-related routines in alphabetical order within their respective categories. Detailed descriptions can be found in the sections that follow.
Routine
Explanation
C file related font functions
GUI_SetDefaultFont()
Sets the default font
GUI_SetFont() GUI_SIF_CreateFont()
Sets the current font
'SIF' file related font functions
Creates and selects a font by passing a pointer to system independent font data.
GUI_SIF_DeleteFont()
Deletes a font created by GUI_SIF_CreateFont() 'TTF' file related font functions
GUI_TTF_CreateFont()
Creates a GUI font from a TTF font file.
GUI_TTF_DestroyCache()
Destroys the cache of the TTF engine.
GUI_TTF_Done()
Frees all dynamically allocated memory of the TTF engine.
GUI_TTF_GetFamilyName()
Returns the family name of the font.
GUI_TTF_GetStyleName()
Returns the style name of the font.
GUI_TTF_SetCacheSize() GUI_XBF_CreateFont()
Can be used to set the default size of the TTF cache.
'XBF' file related font functions
Creates and selects a font by passing a pointer to a callback function, which is responsible for getting data from the XBF font file.
GUI_XBF_DeleteFont()
GUI_GetCharDistX() GUI_GetFont()
Deletes a font created by GUI_XBF_CreateFont() Common font-related functions
Returns the width in pixels (X-size) of a specified character in the current font. Returns a pointer to the currently selected font.
GUI_GetFontDistY()
Returns the Y-spacing of the current font.
GUI_GetFontInfo()
Returns a structure containing font information.
GUI_GetFontSizeY() GUI_GetLeadingBlankCols() GUI_GetStringDistX()
Returns the height in pixels (Y-size) of the current font. Returns the number of leading blank pixel columns of the given character. Returns the X-size of a text using the current font.
GUI_GetTextExtend()
Evaluates the size of a text using the current font
Returns the number of trailing blank pixel columns of the given
GUI_GetTrailingBlankCols() character.
GUI_GetYDistOfFont()
Returns the Y-spacing of a particular font.
GUI_GetYSizeOfFont()
Returns the Y-size of a particular font.
GUI_IsInFont()
Evaluates whether a specified character is in a particular font.
GUI_SetDefaultFont()
Sets the default font to be used after GUI_Init().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
204
CHAPTER
Fonts
10.8 C file related font functions
GUI_SetDefaultFont()
Description
Sets the font to be used by default for text output.
Prototype
void GUI_SetDefaultFont(const GUI_FONT GUI_UNI_PTR * pFont);
Parameter pFont
Description
Pointer to the font to be selected as default
Additional information
This function is intended to be used in GUI_X_Config(). Defining GUI_DEFAULT_FONT is not mandatory anymore. If there is neither defined GUI_DEFAULT_FONT nor GUI_SetDefaultFont is called, GUI_Font6x8 will be set as the default Font. If none of the emWin fonts shall be used, GUI_DEFAULT_FONT has to be defined by NULL and a custom font needs to be set as default with this function.
GUI_SetFont()
Description
Sets the font to be used for text output.
Prototype
const GUI_FONT * GUI_SetFont(const GUI_FONT * pNewFont);
Parameter pFont
Description
Pointer to the font to be selected and used.
Return value
Returns a pointer to the previously selected font so that it may be buffered.
Examples
Displays example text in 3 different sizes, restoring the former font afterwards:
const GUI_FONT GUI_FLASH * OldFont;
OldFont = GUI_SetFont(&GUI_Font8x16);
// Buffer old font
GUI_DispStringAt("This text is 8 by 16 pixels",0,0);
GUI_SetFont(&GUI_Font6x8);
GUI_DispStringAt("This text is 6 by 8 pixels",0,20);
GUI_SetFont(&GUI_Font8);
GUI_DispStringAt("This text is proportional",0,40);
GUI_SetFont(OldFont);
// Restore old font
Screen shot of above example:
Displays text and value in different fonts:
GUI_SetFont(&GUI_Font6x8);
GUI_DispString("The result is: "); // Disp text
GUI_SetFont(&GUI_Font8x8);
GUI_DispDec(42,2);
// Disp value
Screen shot of above example:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
205
10.9 'SIF' file related font functions
GUI_SIF_CreateFont()
Description
Sets the font to be used by passing a pointer to system independent font data.
Prototype
void GUI_SIF_CreateFont(void
* pFontData,
GUI_FONT
* pFont,
const GUI_SIF_TYPE * pFontType);
Parameter pFontData pFont pFontType
Description
Pointer to the system independent font data.
Pointer to a GUI_FONT structure in RAM filled by the function.
See table below.
Permitted values for element pFontType
GUI_SIF_TYPE_PROP GUI_SIF_TYPE_PROP_EXT GUI_SIF_TYPE_PROP_FRM GUI_SIF_TYPE_PROP_AA2 GUI_SIF_TYPE_PROP_AA4 GUI_SIF_TYPE_PROP_AA2_EXT GUI_SIF_TYPE_PROP_AA4_EXT
Should be used if the parameter pFont
points to a proportional font.
Should be used if the parameter pFont
points to an extended proportional font.
Should be used if the parameter pFont
points to an extended proportional framed font.
Should be used if the parameter pFont
points to a proportional font, which uses 2bpp antialiasing.
Should be used if the parameter pFont
points to a proportional font, which uses 4bpp antialiasing.
Should be used if the parameter pFont
points to an extended proportional font, which uses 2bpp antialiasing.
Should be used if the parameter pFont
points to an extended proportional font, which uses 4bpp antialiasing.
Additional information
Contrary to the emWin standard fonts which must be compiled and linked with the application program, system independent fonts (SIF) are binary data blocks containing the font information. The Font Converter can be used to create system independent fonts. This tool is not part of the basic package. A short description follows later in this chapter. For details about how to create system independent fonts, refer to the chapter "Font Converter" on page 243. When using this function emWin needs to fill a GUI_FONT structure with the font information. The user needs to pass a pointer to this structure in the parameter pFont. The contents of this structure must remain valid during the use of the font. The function does not know what kind of font should be created. To tell the function the type of the font to be created it must be passed in the parameter pFontType. This has been done to avoid linkage of code which is not required.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
206
CHAPTER
Fonts
Example
static GUI_FONT _Font; /* Font structure in RAM */
void MainTask(void) { GUI_Init(); GUI_SIF_CreateFont(_DownloadedFont, &_Font, GUI_SIF_TYPE_PROP); GUI_DispString("Hello World!"); while (1) { GUI_Exec(); }
}
GUI_SIF_DeleteFont()
Description
Deletes a font pointed by the parameter pFont.
Prototype
void GUI_SIF_DeleteFont(GUI_FONT * pFont);
Parameter pFont
Description
Pointer to the font to be deleted.
Additional information
After using a font created with GUI_SIF_CreateFont() the font should be deleted if not used anymore.
Example
GUI_FONT _Font; /* Font structure in RAM */ GUI_SIF_CreateFont(_DownloadedFont, &_Font, GUI_SIF_TYPE_PROP); /*
Use the font */ GUI_SIF_DeleteFont(&_Font);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
207
10.10 'TTF' file related font functions
The emWin implementation of TTF file support is based on the FreeType font library from David Turner, Robert Wilhelm and Werner Lemberg. For details, refer to "TrueType Font (TTF) format" on page 201.
GUI_TTF_CreateFont()
Description
Creates and selects an emWin font by using a TTF font file.
Prototype
int GUI_TTF_CreateFont(GUI_FONT * pFont, GUI_TTF_CS * pCS);
Parameter pFont pCS
Description Pointer to a GUI_FONT structure in RAM filled by the function. Pointer to a GUI_TTF_CS structure containing the creation parameters.
Return value
0 on success, 1 on error.
Elements of GUI_TTF_CS
Data type
Element
GUI_TTF_DATA * pTTF
PixelHeight
PixelHeight
FaceIndex
FaceIndex
Elements of GUI_TTF_DATA
Description
Pointer to GUI_TTF_DATA structure which contains location
and size of the font file to be used. Pixel height of new font. It means the height of the surrounding rectangle between the glyphs 'g' and 'f'. Note that it is not the distance between two lines of text. With other words the
value returned by GUI_GetFontSizeY() is not identical
with this value. Some font files can contain more than one font face. In case of more than one face this index specifies the zero based face index to be used to create the font. Usually 0.
Data type
Element
Description
const void * NumBytes
pData NumBytes
Pointer to TTF font file in addressable memory area. Size of file in bytes.
Additional information
When using the function the first time it initializes the TTF engine and the internal cache system. If the cache should use other values as defined per default it needs to be configured before the first call of this function. For details how to configure the cache, refer to "GUI_TTF_SetCacheSize()" on page 209. The internal data cache manages the complete mechanism of creating fonts and caching bitmap data. Font faces are uniquely identified from the cache by the address given in parameter pTTF and the parameter FaceIndex, which normally is 0. If the same font file for example should be used for creating fonts of different sizes the parameter pTTF should point to the same location of a GUI_TTF_DATA structure. The parameter PixelHeight specifies the height of the surrounding rectangle between the glyphs 'g' and 'f'. The value PixelHeight does not represent the offset between lines.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
208
CHAPTER
Fonts
Example
GUI_TTF_CS Cs0, Cs1;
GUI_TTF_DATA Data;
GUI_FONT
Font0, Font1;
/* Set parameters for accessing the font file */
Data.pData
= aTTF;
/* Address */
Data.NumBytes = sizeof(aTTF); /* Size */
/* Set creation parameters of first font */
Cs0.pTTF
= &Data;
/* Use address of GUI_TTF_DATA */
Cs0.PixelHeight = 24;
/* Pixel height */
Cs0.FaceIndex = 0;
/* Initialize to 0 */
/* Set creation parameters of second font */
Cs1.pTTF
= &Data;
/* Use address of GUI_TTF_DATA */
Cs1.PixelHeight = 48;
/* Pixel height */
Cs1.FaceIndex = 0;
/* Initialize to 0 */
/* Create 2 fonts */
GUI_TTF_CreateFont(&Font0, &Cs0);
GUI_TTF_CreateFont(&Font1, &Cs1);
/* Draw something using the fonts */
GUI_SetFont(&Font0);
GUI_DispString("Hello world\n");
GUI_SetFont(&Font1);
GUI_DispString("Hello world");
GUI_TTF_DestroyCache()
Description
This function frees all memory allocated by the TTF cache system and destroys the cache.
Prototype
void GUI_TTF_DestroyCache(void);
Additional information
The next time GUI_TTF_CreateFont() is used emWin automatically creates and initializes a new cache.
GUI_TTF_Done()
Description
This function frees all memory allocated by the TTF engine and its internal cache system.
Prototype
void GUI_TTF_Done(void);
Additional information
The next time GUI_TTF_CreateFont() is used emWin automatically initializes the TTF engine and creates and initializes a new cache.
GUI_TTF_GetFamilyName()
Description
The function returns the font family name defined in the font file.
Prototype
int GUI_TTF_GetFamilyName(GUI_FONT * pFont, char * pBuffer, int NumBytes);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
209
Parameter pFont pBuffer NumBytes
Description
Pointer to a GUI_FONT structure which has been created using
GUI_TTF_CreateFont().
Buffer to be filled with the family name. Size of buffer in bytes.
Return value
0 on success, 1 on error.
GUI_TTF_GetStyleName()
Description
The function returns the style name (bold, regular, ...) defined in the font file.
Prototype
int GUI_TTF_GetStyleName(GUI_FONT * pFont, char * pBuffer, int NumBytes);
Parameter pFont pBuffer NumBytes
Description
Pointer to a GUI_FONT structure which has been created using
GUI_TTF_CreateFont().
Buffer to be filled with the style name. Size of buffer in bytes.
Return value
0 on success, 1 on error.
GUI_TTF_SetCacheSize()
Description
Sets the size parameters used to create the cache on the first call of GUI_TTF_CreateFont().
Prototype
void GUI_TTF_SetCacheSize(unsigned MaxFaces, unsigned MaxSizes, U32 MaxBytes);
Parameter MaxFaces MaxSizes MaxBytes
Description
Maximum number of font faces the cache should be able to handle simultaneously. 0 selects default value. Maximum number of size objects the cache should be able to handle simultaneously. 0 selects default value.
Maximum number of bytes used for the bitmap cache. 0 selects default value.
Additional information
If for example 3 font faces should be used, each with 2 sizes, the cache should be able to manage 6 size objects. The default values used by the TTF engine are: 2 faces, 4 size objects and 200K of bitmap data cache.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
210
CHAPTER
Fonts
10.11 'XBF' file related font functions
GUI_XBF_CreateFont()
Description
Creates and selects a font by passing a pointer to a callback function, which is responsible for getting data from the XBF font file.
Prototype
int GUI_XBF_CreateFont(GUI_FONT
* pFont,
GUI_XBF_DATA
* pXBF_Data,
const GUI_XBF_TYPE * pFontType,
GUI_XBF_GET_DATA_FUNC * pfGetData,
void
* pVoid);
Parameter pFont pXBF_Data pFontType
pfGetData
pVoid
Description
Pointer to a GUI_FONT structure in RAM filled by the function. Pointer to a GUI_XBF_DATA structure in RAM filled by the function.
See table below. Pointer to a callback function which is responsible for getting data from the font file. See prototype below. Application defined pointer passed to the 'GetData' callback function.
Permitted values for element pFontType
GUI_XBF_TYPE_PROP GUI_XBF_TYPE_PROP_EXT GUI_XBF_TYPE_PROP_FRM GUI_XBF_TYPE_PROP_AA2_EXT GUI_XBF_TYPE_PROP_AA4_EXT
Should be used if the parameter pFont
points to a proportional font.
Should be used if the parameter pFont
points to an extended proportional font.
Should be used if the parameter pFont
points to an extended framed proportional font.
Should be used if the parameter pFont
points to an extended proportional font, which uses 2bpp antialiasing.
Should be used if the parameter pFont
points to an extended framed proportional font, which uses 4bpp antialiasing.
GUI_XBF_GET_DATA_FUNC
int GUI_XBF_GET_DATA_FUNC(U32 Off, U16 NumBytes, void * pVoid, void * pBuffer);
The function has to set pBuffer to point to the location the requested data resides in.
Additional information
The parameter pfGetData should point to an application defined callback routine, which is responsible for getting data from the font. Parameter pVoid is passed to the callback function when requesting font data. It can be used for example to pass a file handle to the callback function. The function requires pointers to a GUI_FONT structure and a GUI_XBF_DATA structure. The function will fill these structures with font information. It is required, that the contents of these structures remain valid during the usage of the font. The function does not know what kind of XBF font has to be created, so the parameter pFontType has to be used to tell the function the type of the font to be created. This has been done to avoid unnecessary linkage of code. The maximum number of data bytes per character is limited to 200 per default. This should cover the most requirements. If loading a character with more bytes a warning will be generated in the debug version. The default value can be increased by adding the following define to the file GUIConf.h:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
211
#define GUI_MAX_XBF_BYTES 500 // Sets the maximum number of bytes/chars to 500
Example
static GUI_FONT
Font;
/* GUI_FONT structure in RAM */
static GUI_XBF_DATA XBF_Data; /* GUI_XBF_DATA structure in RAM */
static int _cbGetData(U32 Off, U16 NumBytes, void * pVoid, void * pBuffer) { /* The pVoid pointer may be used to get a file handle */ .../* TBD */ /* Set file pointer to the given position */ .../* TBD */ /* Read the required number of bytes into the given buffer */ .../* TBD */ /* Return 0 on success. Return 1 if the function fails. */
}
void CreateXBF_Font(void * pVoid) {
GUI_XBF_CreateFont(&Font,
/* Pointer to GUI_FONT structure */
&XBF_Data,
/* Pointer to GUI_XBF_DATA structure */
GUI_XBF_TYPE_PROP, /* Font type to be created */
_cbGetData,
/* Pointer to callback function */
pVoid);
/* Pointer to be passed to callback */
}
GUI_XBF_DeleteFont()
Description
Deletes an XBF font pointed by the parameter pFont.
Prototype
void GUI_XBF_DeleteFont(GUI_FONT * pFont);
Parameter pFont
Description
Pointer to the font to be deleted.
Additional information
After using a font created with GUI_XBF_CreateFont() the font should be deleted if not used anymore.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
212
CHAPTER
Fonts
10.12 Common font-related functions
GUI_GetFont()
Description
Returns a pointer to the currently selected font.
Prototype
const GUI_FONT * GUI_GetFont(void)
GUI_GetCharDistX()
Description
Returns the width in pixels (X-size) used to display a specified character in the currently selected font.
Prototype
int GUI_GetCharDistX(U16 c);
Parameter c
Description
Character to calculate width from.
GUI_GetFontDistY()
Description
Returns the Y-spacing of the currently selected font.
Prototype
int GUI_GetFontDistY(void);
Additional information
The Y-spacing is the vertical distance in pixels between two adjacent lines of text. The returned value is the YDist value of the entry for the currently selected font. The returned value is valid for both proportional and monospaced fonts.
GUI_GetFontInfo()
Description
Calculates a pointer to a GUI_FONTINFO structure of a particular font.
Prototype
void GUI_GetFontInfo(const GUI_FONT*pFont, GUI_FONTINFO* pfi);
Parameter pFont pfi
Description
Pointer to the font. Pointer to a GUI_FONTINFO structure.
Additional information
The definition of the GUI_FONTINFO structure is as follows: typedef struct {
U16 Flags; } GUI_FONTINFO;
The member variable flags can take the following values: GUI_FONTINFO_FLAG_PROP GUI_FONTINFO_FLAG_MONO GUI_FONTINFO_FLAG_AA GUI_FONTINFO_FLAG_AA2 GUI_FONTINFO_FLAG_AA4
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
213
Example
Gets the info of GUI_Font6x8. After the calculation, FontInfo.Flags contains the flag GUI_FONTINFO_FLAG_MONO. GUI_FONTINFO FontInfo; GUI_GetFontInfo(&GUI_Font6x8, &FontInfo);
GUI_GetFontSizeY()
Description
Returns the height in pixels (Y-size) of the currently selected font.
Prototype
int GUI_GetFontSizeY(void);
Additional information
The returned value is the YSize value of the entry for the currently selected font. This value is less than or equal to the Y-spacing returned by the function GUI_GetFontDistY(). The returned value is valid for both proportional and monospaced fonts.
GUI_GetLeadingBlankCols()
Description
Returns the number of leading blank pixel columns in the currently selected font for the given character.
Prototype
int GUI_GetLeadingBlankCols(U16 c);
Parameter c
Example
Character to be used.
Description
The result for the character 'B' shown in the screenshot above should be 2.
GUI_GetStringDistX()
Description
Returns the X-size used to display a specified string in the currently selected font.
Prototype
int GUI_GetStringDistX(const char GUI_FAR *s);
Parameter s
Pointer to the string.
Description
GUI_GetTextExtend()
Description
Calculates the size of a given string using the current font.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
214
CHAPTER
Fonts
Prototype
void GUI_GetTextExtend(GUI_RECT* pRect, const char* s, int Len);
Parameter pRect s Len
Description
Pointer to GUI_RECT-structure to store result. Pointer to the string. Number of characters of the string.
GUI_GetTrailingBlankCols()
Description
Returns the number of trailing blank pixel columns in the currently selected font for the given character.
Prototype
int GUI_GetTrailingBlankCols(U16 c);
Parameter c
Example
Character to be used.
Description
The result for the character 'B' shown in the screenshot above should be 1.
GUI_GetYDistOfFont()
Description
Returns the Y-spacing of a particular font.
Prototype
int GUI_GetYDistOfFont(const GUI_FONT* pFont);
Parameter pFont
Pointer to the font.
Description
Additional information
(see GUI_GetFontDistY())
GUI_GetYSizeOfFont()
Description
Returns the Y-size of a particular font.
Prototype
int GUI_GetYSizeOfFont(const GUI_FONT* pFont);
Parameter pFont
Pointer to the font.
Additional information
(see GUI_GetFontSizeY())
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
215
GUI_IsInFont()
Description
Evaluates whether a particular font contains a specified character or not.
Prototype
char GUI_IsInFont(const GUI_FONT * pFont, U16 c);
Parameter pFont c
Pointer to the font. Character to be searched for.
Description
Additional information
If the pointer pFont is set to 0, the currently selected font is used.
Example
Evaluates whether the font GUI_FontD32 contains an "X": if (GUI_IsInFont(&GUI_FontD32, 'X') == 0) {
GUI_DispString("GUI_FontD32 does not contain 'X'"); }
Return value
1, if the character was found. 0, if the character was not found.
GUI_SetDefaultFont()
Description
Sets the default font to be used after GUI_Init().
Prototype
void GUI_SetDefaultFont(const GUI_FONT GUI_UNI_PTR * pFont);
Parameter pFont
Pointer to the font to be used.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
216
CHAPTER
Fonts
10.13 Character sets
10.13.1 ASCII
emWin supports the full set of ASCII characters. These are the following 96 characters from 32 to 127:
Hex 0 1 2 3 4 5 6 7 8 9 A B C D E F
2x
!
"# $ % &
'( ) * + , - . /
3x 0 1 2 3
4567
89
:
;
<=>?
4x @ A B C D E F G H I J K L M N O
5x P Q R S T U V W X Y Z
[
\
]
^_
6x
`a b c d e f g h i j k l m n o
7x p q r s t u v w x y z { | } ~
Unfortunately, as ASCII stands for American Standard Code for Information Interchange, it is designed for American needs. It does not include any of the special characters used in European languages, such as Ä, Ö, Ü, á, à, and others. There is no single standard for these "European extensions" of the ASCII set of characters; several different ones exist. The one used on the Internet and by most Windows programs is ISO 8859-1, a superset of the ASCII set of characters.
10.13.2 ISO 8859-1 Western Latin character set
emWin supports the ISO 8859-1, which defines characters as listed below:
Code
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
Description
non-breaking space inverted exclamation cent sign pound sterling general currency sign yen sign broken vertical bar section sign umlaut (dieresis) copyright feminine ordinal left angle quote, guillemotleft not sign soft hyphen registered trademark macron accent degree sign plus or minus superscript two superscript three acute accent micro sign paragraph sign middle dot cedilla superscript one masculine ordinal right angle quote, guillemot right fraction one-fourth fraction one-half
Char
¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬
® ¯ ° ± ² ³ ´ µ ¶ · ¸ ¹ º » ¼ ½
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Code
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
Description
fraction three-fourth inverted question mark capital A, grave accent capital A, acute accent capital A, circumflex accent capital A, tilde capital A, dieresis or umlaut mark capital A, ring capital A, diphthong (ligature) capital C, cedilla capital E, grave accent capital E, acute accent capital E, circumflex accent capital E, dieresis or umlaut mark capital I, grave accent capital I, acute accent capital I, circumflex accent capital I, dieresis or umlaut mark Eth, Icelandic N, tilde capital O, grave accent capital O, acute accent capital O, circumflex accent capital O, tilde capital O, dieresis or umlaut mark multiply sign capital O, slash capital U, grave accent capital U, acute accent capital U, circumflex accent capital U, dieresis or umlaut mark capital Y, acute accent THORN, Icelandic sharp s, German (s-z ligature) small a, grave accent small a, acute accent small a, circumflex accent small a, tilde small a, dieresis or umlaut mark small a, ring small ae diphthong (ligature) cedilla small e, grave accent small e, acute accent small e, circumflex accent small e, dieresis or umlaut mark small i, grave accent small i, acute accent small i, circumflex accent small i, dieresis or umlaut mark small eth, Icelandic small n, tilde small o, grave accent small o, acute accent small o, circumflex accent small o, tilde small o, dieresis or umlaut mark division sign small o, slash
UM03001 User & Reference Guide for emWin V5.20
217
Char
¾ ¿ À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ð Ñ Ò Ó Ô Õ Ö × Ø Ù Ú Û Ü Ý Þ ß à á â ã ä å æ ç è é ê ë ì í î ï ð ñ ò ó õ õ ö ÷ ø
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
218
CHAPTER
Fonts
Code
249 250 251 252 253 254 255
Description
small u, grave accent small u, acute accent small u, circumflex accent small u, dieresis or umlaut mark small y, acute accent small thorn, Icelandic small y, dieresis or umlaut mark
Char
ù ú û ü ý þ ÿ
10.13.3 Unicode
Unicode is the ultimate in character coding. It is an international standard based on ASCII and ISO 8859-1. Contrary to ASCII, UNICODE requires 16-bit characters because all characters have their own code. Currently, more than 30,000 different characters are defined. However, not all of the character images are defined in emWin. It is the responsibility of the user to define these additional characters.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
219
10.14 Font Converter
Fonts which can be used with emWin must be defined as GUI_FONT structures in C. The structures -- or rather the font data which is referenced by these structures -can be rather large. It is very time-consuming and inefficient to generate these fonts manually. We therefore recommend using the Font Converter, which automatically generates C files from fonts. The Font Converter is a simple Windows program. You need only to load an installed Windows font into the program, edit it if you want or have to, and save it as a C file. The C file may then be compiled, allowing the font to be shown on your display with emWin on demand. The character codes 0x00 - 0x1F and 0x80 - 0x9F are disabled by default. The following is a example screen shot of the Font Converter with a font loaded
10.14.1 Adding fonts
Once you have created a font file and linked it to the project, declare the linked font as extern const GUI_FONT, as shown in the example below.
Example
extern const GUI_FONT GUI_FontNew;
int main(void) { GUI_Init(); GUI_Clear(); GUI_SetFont(&GUI_FontNew); GUI_DispString("Hello world\n"); return 0;
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
220
CHAPTER
Fonts
10.15 Standard fonts
emWin is shipped with a selection of fonts which should cover most of your needs. The standard font package contains monospaced and proportional fonts in different sizes and styles. Monospaced fonts are fonts with a fixed character width, in which all characters have the same width in pixels. Proportional fonts are fonts in which each character has its own individual pixel-width. This chapter provides an overview of the standard emWin fonts.
10.15.1 Font identifier naming convention
All standard fonts are named as follows. The elements of the naming convention are then explained in the table: GUI_Font[<style>][<width>x]<height>[x<MagX>x<MagY>][H][B][_<characterset>]
Element
Description
GUI_Font
Standard prefix for all fonts shipped with emWin.
<style>
Specifies a non-standard font style. Example: Comic style in GUI_FontComic18B_ASCII.
<width>
Width of characters, contained only in monospaced fonts.
<height>
Height of the font in pixels.
<MagX>
Factor of magnification in X, contained only in magnified fonts.
<MagY>
Factor of magnification in Y, contained only in magnified fonts.
H
Abbreviation for "high". Only used if there is more than one font with the same height. It means that the font appears "higher" than other fonts.
B
Abbreviation for "bold". Used in bold fonts.
<characterset>
Specifies the contents of characters: ASCII: Only ASCII characters 0x20-0x7E (0x7F). 1: ASCII characters and European extensions 0xA0 - 0xFF. HK: Hiragana and Katakana. 1HK: ASCII, European extensions, Hiragana and Katakana. D: Digit fonts, character set: +-.0123456789.
Example 1
GUI_Font16_ASCII
Element GUI_Font 16 ASCII
Description
Standard font prefix. Height in pixels. Font contains ASCII characters only.
Example 2
GUI_Font8x15B_ASCII
Element GUI_Font 8 x15 B ASCII
Description
Standard font prefix. Width of characters. Height in pixels. Bold font. Font contains ASCII characters only.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
221
Example 3
GUI_Font8x16x1x2
Element GUI_Font 8 x16 x1 x2
Standard font prefix. Width of characters. Height in pixels. Magnification factor in X. Magnification factor in Y.
Description
10.15.2 Font file naming convention
The names for the font files are similar to the names of the fonts themselves. The files are named as follows: F[<width>]<height>[H][B][<characterset>]
Element
Description
F
Standard prefix for all fonts files shipped with emWin.
<width>
Width of characters, contained only in monospaced fonts.
<height>
Height of the font in pixels.
Abbreviation for "high". Only used if there is more than one font with the same
H
height. It means that the font appears "higher" than other fonts.
B
Abbreviation for "bold". Used in bold fonts.
<characterset>
Specifies the contents of characters: ASCII: Only ASCII characters 0x20-0x7E (0x7F). 1: ASCII characters and European extensions 0xA0 - 0xFF. HK: Hiragana and Katakana. 1HK: ASCII, European extensions, Hiragana and Katakana. D: Digit fonts.
10.15.3 Measurement, ROM-size and character set of fonts
The following pages describe the standard fonts shipped with emWin. For each font there is a measurement diagram, an overview of all characters included and a table containing the ROM size in bytes and the font files required for use. The following parameters are used in the measurement diagrams:
Element F B C L U
Description
Size of font in Y. Distance of base line from the top of the font. Height of capital characters. Height of lowercase characters. Size of underlength used by letters such as "g", "j" or "y".
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
222
CHAPTER
Fonts
10.15.4 Proportional fonts
10.15.4.1Overview
The following screenshot gives an overview of all available proportional fonts:
10.15.4.2Measurement, ROM size and used files
The following table shows the measurement, ROM size and used files of the fonts:
Font name
GUI_Font8_ASCII GUI_Font8_1 GUI_Font10S_ASCII
Measurement
F: 8, B: 7, C: 7, L: 5, U: 1 F: 8, B: 7, C: 7, L: 5, U: 1 F: 10, B: 8, C: 6, L: 4, U: 2
ROM size in bytes
1562
1562+ 1586
1760
Used files
F08_ASCII.c F08_ASCII.c F08_1.c F10S_ASCII.c
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
223
Font name
Measurement
GUI_Font10S_1 GUI_Font10_ASCII GUI_Font10_1 GUI_Font13_ASCII GUI_Font13_1 GUI_Font13B_ASCII GUI_Font13B_1 GUI_Font13H_ASCII GUI_Font13H_1 GUI_Font13HB_ASCII GUI_Font13HB_1 GUI_Font16_ASCII GUI_Font16_1 GUI_Font16_HK
F: 10, B: 8, C: 6, L: 4, U: 2 F: 10, B: 9, C: 8, L: 6, U: 1 F: 10, B: 9, C: 8, L: 6, U: 1 F: 13, B: 11, C: 8, L: 6, U: 2 F: 13, B: 11, C: 8, L: 6, U: 2 F: 13, B: 11, C: 8, L: 6, U: 2 F: 13, B: 11, C: 8, L: 6, U: 2 F: 13, B: 11, C: 9, L: 7, U: 2 F: 13, B: 11, C: 9, L: 7, U: 2 F: 13, B: 11, C: 9, L: 7, U: 2 F: 13, B: 11, C: 9, L: 7, U: 2 F: 16, B: 13, C: 10, L: 7, U: 3 F: 16, B: 13, C: 10, L: 7, U: 3 F: 16, B: 13, C: 10, L: 7, U: 3
GUI_Font16_1HK
F: 16, B: 13, C: 10, L: 7, U: 3
GUI_Font16B_ASCII
F: 16, B: 13, C: 10, L: 7, U: 3
GUI_Font16B_1
F: 16, B: 13, C: 10, L: 7, U: 3
GUI_FontComic18B_ASCII F: 18, B: 15, C: 12, L: 9, U: 3
GUI_FontComic18B_1
F: 18, B: 15, C: 12, L: 9, U: 3
GUI_Font20_ASCII
F: 20, B: 16, C: 13, L: 10, U: 4
GUI_Font20_1
F: 20, B: 16, C: 13, L: 10, U: 4
GUI_Font20B_ASCII
F: 20, B: 16, C: 13, L: 10, U: 4
GUI_Font20B_1
F: 20, B: 16, C: 13, L: 10, U: 4
GUI_Font24_ASCII
F: 24, B: 20, C: 17, L: 13, U: 4
GUI_Font24_1
F: 24, B: 20, C: 17, L: 13, U: 4
GUI_Font24B_ASCII
F: 24, B: 19, C: 15, L: 11, U: 5
GUI_Font24B_1
F: 24, B: 19, C: 15, L: 11, U: 5
GUI_FontComic24B_ASCII F: 24, B: 20, C: 17, L: 13, U: 4
ROM size in bytes
1760+ 1770
1800
1800+ 2456
2076
2076+ 2149
2222
2222+ 2216
2232
2232+ 2291
2690
2690+ 2806
2714
2714+ 3850
6950
120+ 6950+ 2714+ 3850
2690
2690+ 2790
3572
3572+ 4334
4044
4044+ 4244
4164
4164+ 4244
4786
4786+ 5022
4858
4858+ 5022
6146
Used files
F10_ASCII.c F10_1.c
F10_ASCII
F10_ASCII.c F10_1.c
F13_ASCII.c
F13_ASCII.c F13_1.c
F13B_ASCII.c
F13B_ASCII.c F13B_1.c
F13H_ASCII.c
F13H_ASCII.c F13H_1.c
F13HB_ASCII.c
F13HB_ASCII.c F13HB_1.c
F16_ASCII.c
F16_ASCII.c F16_1.c
F16_HK.c
F16_1HK.c F16_HK.c F16_ASCII.c F16_1.c
F16B_ASCII.c
F16B_ASCII.c F16B_1.c
FComic18B_ASCII.c
FComic18B_ASCII.c FComic18B_1.c
F20_ASCII.c
F20_ASCII.c F20_1.c
F20B_ASCII.c
F20B_ASCII.c F20B_1.c
F24_ASCII.c
F24_ASCII.c F24_1.c
F24B_ASCII.c
F24B_ASCII.c F24B_1.c
FComic24B_ASCII
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
224
CHAPTER
Fonts
Font name
GUI_FontComic24B_1 GUI_Font32_ASCII GUI_Font32_1 GUI_Font32B_ASCII GUI_Font32B_1
Measurement
F: 24, B: 20, C: 17, L: 13, U: 4 F: 32, B: 26, C: 20, L: 15, U: 6 F: 32, B: 26, C: 20, L: 15, U: 6 F: 32, B: 25, C: 20, L: 15, U: 7 F: 32, B: 25, C: 20, L: 15, U: 7
ROM size in bytes
6146+ 5598
7234
7234+ 7734
7842
7842+ 8118
Used files
FComic24B_ASCII FComic24B_1 F32_ASCII.c F32_ASCII.c F32_1.c F32B_ASCII.c F32B_ASCII.c F32B_1.c
10.15.4.3Characters
The following shows all characters of all proportional standard fonts:
GUI_Font8_ASCII
GUI_Font8_1
GUI_Font10S_ASCII GUI_Font10S_1
GUI_Font10_ASCII GUI_Font10_1
GUI_Font13_ASCII GUI_Font13_1
GUI_Font13B_ASCII
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
225
GUI_Font13B_1 GUI_Font13H_ASCII GUI_Font13H_1 GUI_Font13HB_ASCII GUI_Font13HB_1 GUI_Font16_ASCII GUI_Font16_1
GUI_Font16_HK
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
226
CHAPTER
Fonts
GUI_Font16_1HK
GUI_Font16B_ASCII GUI_Font16B_1 GUI_FontComic18B_ASCII GUI_FontComic18B_1
GUI_Font20_ASCII GUI_Font20_1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
227
GUI_Font20B_ASCII GUI_Font20B_1
GUI_Font24_ASCII GUI_Font24_1
GUI_Font24B_ASCII GUI_Font24B_1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
228
CHAPTER
Fonts
GUI_FontComic24B_ASCII
GUI_FontComic24B_1
GUI_Font32_ASCII GUI_Font32_1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
229
GUI_Font32B_ASCII
GUI_Font32B_1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
230
CHAPTER
Fonts
10.15.5 Proportional fonts, framed
10.15.5.1Overview
The following screenshot shows the currently available framed proportional fonts:
10.15.5.2Measurement, ROM size and used files
The following table shows the measurement, ROM size and used file of the font:
Font name
Measurement
GUI_Font20F_ASCII
F: 20, B: 19, C: 19, L: 19, U: 1
10.15.5.3Characters
The following shows all characters of the font:
GUI_Font20F_ASCII
ROM size in bytes
5248
Used files
F20F_ASCII.c
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
231
10.15.6 Monospaced fonts
10.15.6.1Overview
The following screenshot gives an overview of all available monospaced fonts:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
232
CHAPTER
Fonts
10.15.6.2Measurement, ROM size and used files
The following table shows the measurement, ROM size and used files of the fonts:
Font name
GUI_Font4x6 GUI_Font6x8 GUI_Font6x8_ASCII GUI_Font6x8_1
GUI_Font6x9 GUI_Font8x8 GUI_Font8x8_ASCII GUI_Font8x8_1
GUI_Font8x9 GUI_Font8x10_ASCII GUI_Font8x12_ASCII GUI_Font8x13_ASCII GUI_Font8x13_1 GUI_Font8x15B_ASCII GUI_Font8x15B_1 GUI_Font8x16 GUI_Font8x17
GUI_Font8x18
GUI_Font8x16x1x2
GUI_Font8x16x2x2
GUI_Font8x16x3x3 GUI_Font8x16_ASCII GUI_Font8x16_1
Measurement
F: 6, B: 5, C: 5, L: 4, U: 1 F: 8, B: 7, C: 7, L: 5, U: 1 F: 8, B: 7, C: 7, L: 5, U: 1 F: 8, B: 7, C: 7, L: 5, U: 1
F: 9, B: 7, C: 7, L: 5, U: 2 F: 8, B: 7, C: 7, L: 5, U: 1 F: 8, B: 7, C: 7, L: 5, U: 1 F: 8, B: 7, C: 7, L: 5, U: 1
F: 9, B: 7, C: 7, L: 5, U: 2 F: 10, B: 9, C: 9, L: 7, U: 1 F: 12, B: 10, C: 9, L: 6, U: 2 F: 13, B: 11, C: 9, L: 6, U: 2 F: 13, B: 11, C: 9, L: 6, U: 2 F: 15, B: 12, C: 9, L: 7, U: 3 F: 15, B: 12, C: 9, L: 7, U: 3 F: 16, B: 12, C: 10, L: 7, U: 4 F: 17, B: 12, C: 10, L: 7, U: 5
F: 18, B: 12, C: 10, L: 7, U: 6
F: 32, B: 24, C: 20, L: 14, U: 8
F: 32, B: 24, C: 20, L: 14, U: 8
F: 48, B: 36, C: 30, L: 21, U: 12 F: 16, B: 12, C: 10, L: 7, U: 4 F: 16, B: 12, C: 10, L: 7, U: 4
ROM size in bytes
Used files
620
1840
1568
1568+ 1584
1840 (same ROM location as GUI_Font6x8)
1840
1568
1568+ 1584
1840 (same ROM location as GUI_Font8x8)
1770
1962
2058
2058+ 2070
2250
2250+ 2262
3304
3304 (same ROM location as GUI_Font8x16)
3304 (same ROM location as GUI_Font8x16)
3304 (same ROM location as GUI_Font8x16)
3304 (same ROM location as GUI_Font8x16)
3304 (same ROM location as GUI_Font8x16)
2328
2328+ 2352
F4x6.c F6x8.c F6x8_ASCII.c F6x8_ASCII.c F6x8_1.c
F6x8.c
F8x8.c F8x8_ASCII.c F8x8_ASCII.c F8x8_1.c
F8x8.c
F8x10_ASCII.c F8x12_ASCII.c F8x13_ASCII.c F8x13_ASCII.c F8x13_1.c F8x15_ASCII.c F8x15B_ASCII.c F8x15B_1.c F8x16.c
F8x16.c
F8x16.c
F8x16.c
F8x16.c
F8x16.c
F8x16_ASCII.c F8x16_ASCII.c F8x16_1.c
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
233
10.15.6.3Characters
The following shows all characters of all monospaced standard fonts:
GUI_Font4x6 GUI_Font6x8 GUI_Font6x8_ASCII GUI_Font6x8_1 GUI_Font6x9
GUI_Font8x8
GUI_Font8x8_ASCII GUI_Font8x8_1
GUI_Font8x9
GUI_Font8x10_ASCII GUI_Font8x12_ASCII
GUI_Font8x13_ASCII
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
234
CHAPTER
Fonts
GUI_Font8x13_1
GUI_Font8x15B_ASCII GUI_Font8x15B_1
GUI_Font8x16
GUI_Font8x17
GUI_Font8x18
GUI_Font8x16x1x2
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
235
GUI_Font8x16x2x2
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
236
CHAPTER
Fonts
GUI_Font8x16x3x3
GUI_Font8x16_ASCII
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
237
GUI_Font8x16_1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
238
CHAPTER
Fonts
10.15.7 Digit fonts (proportional)
10.15.7.1Overview
The following screenshot gives an overview of all available proportional digit fonts:
10.15.7.2Measurement, ROM size and used files
The following table shows the measurement, ROM size and used files of the fonts:
Font name
GUI_FontD32 GUI_FontD48 GUI_FontD64 GUI_FontD80
Measurement
F: 32, C: 31 F: 48, C: 47 F: 64, C: 63 F: 80, C: 79
ROM size in bytes
1574 3512 5384 8840
10.15.7.3Characters
The following shows all characters of all proportional digit fonts:
GUI_FontD32
Used files
FD32.c FD48.c FD64.c FD80.c
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
239
GUI_FontD48 GUI_FontD64
GUI_FontD80
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
240
CHAPTER
Fonts
10.15.8 Digit fonts (monospaced)
10.15.8.1Overview
The following screenshot gives an overview of all available monospaced digit fonts:
10.15.8.2Measurement, ROM size and used files
The following table shows the measurement, ROM size and used files of the fonts:
Font name
GUI_FontD24x32 GUI_FontD36x48 GUI_FontD48x64 GUI_FontD60x80
Measurement
F: 32, C: 31 F: 48, C: 47 F: 64, C: 63 F: 80, C: 79
ROM size in bytes
1606 3800 5960 9800
10.15.8.3Characters
The following shows all characters of all monospaced digit fonts:
Used files
FD24x32.c FD36x48.c FD48x60.c FD60x80.c
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
241
GUI_FontD24x32 GUI_FontD36x48 GUI_FontD48x64
GUI_FontD60x80
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
242
CHAPTER
Fonts
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
243
Chapter 11
Font Converter
The Font Converter is a Windows program which allows convenient converting of existing Windows fonts to emWin (bitmap) fonts which can be easily integrated into emWin based applications. emWin fonts should be defined either as GUI_FONT structures in C files or should exist as binary files containing System Independent Fonts (SIF) or External Bitmap Font (XBF). Manual creation of those fonts is possible, but since this would be very time-consuming and inefficient, it is recommended to use the Font Converter instead. The Font Converter is not part of the emWin Basic package. The full version has to be purchased separately. The emWin Basic package comes with the demo version of the Font Converter which provides full functionality but accurate storage of pixel data. Nevertheless the structure of C file fonts is stored well, so one might have a look at it in order to estimate the possibly saved effort by using the Font Converter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
244
CHAPTER
Font Converter
11.1 Requirements
The Font Converter is a Windows program, so it can be used only within a windows environment. The source fonts need to meet the following requirements: - The font is installed in Windows. - The font is usable in Windows. (e.g. in MS Word) - The font consists of TrueType outlines.
The following is a sample screen shot of the Font Converter with a font loaded:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
245
11.2 Using the Font Converter
The Font Converter can create an emWin font file from an installed Windows font or it can be used to edit the font data of a existing C font file.
11.2.1 Creating an emWin font file from a Windows font
The basic procedure for using the Font Converter for creating an emWin font file from an installed Windows font is illustrated below. The steps are explained in detail in the sections that follow.
Step 1: Start the application. The Font Converter is opened and automatically displays the Font generation options dialog box. The same dialog box appears if File/New is chosen from the Font Converter menu at any point.
Step 2: Specify font generation options. In this example, a font is to be generated in extended mode and with Unicode 16 Bit encoding. (The antialiasing option is irrelevant here since an antialiased mode was not selected.) Click OK.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
246
CHAPTER
Step 3: Specify font options. In this example, a regular-style, 16 pixel Arial font is chosen. Click OK.
Step 4: Edit the font as necessary. See section "User Interface" for more information on working with the Font Converter user interface.
Step 5: Save the emWin font file. Choose File/Save As. Select the desired format of the font data file, C file, system independent font or external bitmap font. Select a destination and a name for the font file. Click Save. The Font Converter will create a separate file in the specified destination, containing the currently loaded font data.
Font Converter
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
247
11.2.2 Font generation options dialog
After starting the program or when choosing the menu point File/New, the following dialog automatically occurs:
The selections made here will determine the output mode of the generated font, how it is to be encoded, and how it will be antialiased (if an antialiased output mode is selected).
11.2.2.1 Type of font to generate
Standard
Creates a 1 bit per pixel font without antialiasing.
Antialiased, 2bpp
Creates an antialiased font using 2 bits per pixel.
Antialiased, 4bpp
Creates an antialiased font using 4 bits per pixel.
Extended
Creates a non antialiased 1 bit per pixel font with extended character information. This type supports compound characters like they are used in Thai language.
Extended, framed
Creates a non antialiased 1 bit per pixel font with extended character information with a surrounding frame. A framed font is always drawn in transparent mode regardless of the current settings. The character pixels are drawn in the currently selected foreground color and the frame is drawn in background color. For more details please refer to the emWin user manual.
Extended, antialiased, 2bpp
Creates an antialiased 2 bit per pixel font with extended character information. Each character has the same height and its own width. The pixel information is saved with 2bpp antialiasing information and covers only the areas of the glyph bitmaps.
Extended, antialiased, 4bpp
Creates an antialiased 4 bit per pixel font with extended character information. Each character has the same height and its own width. The pixel information is saved with 4bpp antialiasing information and covers only the areas of the glyph bitmaps.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
248
CHAPTER
Font Converter
11.2.2.2 Encoding
Unicode 16 Bit
With Unicode encoding, you have access to all characters of a font. Windows font files contain a maximum of 65536 characters. All character codes of the C file are the same as those in the Windows font file.
ASCII 8 Bit + ISO 8859
This encoding mode includes the ASCII codes (0x20 - 0x7F) and the ISO 8859 characters (0xA0 - 0xFF).
SHIFT JIS 8/16 Bit
Shift JIS (Japanese Industry Standard) enables mapping from Unicode to Shift JIS in accordance with the Unicode standard 2. For example, the Katakana letter "KU" is shifted from its Unicode value of 0x30AF to the Shift JIS value of 0x834E, the Kanji character 0x786F is shifted to 0x8CA5 and so on.
11.2.2.3 Antialiasing
You can choose between two ways of antialiasing. This choice only applies when an antialiased font type has been selected.
Using OS
The operating system is used to do the antialiasing. The resulting characters appear exactly the same as in any other windows application where antialiased characters are displayed.
Internal
The internal antialiasing routines of the Font Converter are used to do the antialiasing. The resulting characters are more exact with regard to proportions.
11.2.3 Font Dialog
After clicking OK in the Font generation options dialog box, a second dialog is displayed as follows:
This is where the font to be converted into a C file is selected. Be sure that you do not violate any copyright laws by converting a font with the Font Converter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
249
11.2.3.1 Font, Font Style, and Size
These menus are used to select the particular font to be converted. The size of the font is specified in pixels.
11.2.3.2 Script
The Script box is used to select the character set which should be mapped down from Unicode into the first 256 characters in accordance with ISO 8859. It only applies when using the 8 Bit ASCII + ISO 8859 encoding mode.
11.2.3.3 Unit of Size
This option button can be used to set 'Points' or 'Pixels' as measuring unit. Please note that emWin does not know something about the unit 'Points' whereas most of other PC applications use the point size for specifying the font size. The Font Converter uses the operating system for getting the desired font resource. Please note that the font mapper of the operating system is not able to create each font in each desired pixel height. In these cases the font mapper of the operating system creates the nearest possible pixel height. This is not a bug of the Font Converter.
11.2.4 User Interface
After clicking OK in the Font dialog box, the main user interface of the Font Converter appears, loaded with the previously selected font. You may convert the font into a C file immediately if you wish or edit its appearance first. The Font Converter is divided into two areas. In the upper area, all font characters appear scaled 1:1 as they will be displayed on your target device. Disabled characters are shown with a gray background. Per default all character codes which are not included in the chosen font are disabled. For example, many fonts do not include character codes from 0x00 to 0x1F and 0x7F to 0x9F, so these codes are grayed. The current character is displayed in a magnified scale on the left side of the lower area. Additional information about the font and the current character can be seen on the right side. If you want to modify the character data, you must first activate the lower area, either by pressing the <TAB> key or by simply clicking in the area.
11.2.4.1 Selecting the current character
Characters may be selected: · by using the keys <UP>, <DOWN>, <LEFT>, <RIGHT>,
<POS1>, or <END>; · by using the scroll bars; or · by clicking a character with the left mouse button.
<PGUP>,
<PGDOWN>,
11.2.4.2 Toggling character status
Use the right mouse button to toggle the status of a specific character or to enable/disable an entire row of characters. The menu point Edit/Toggle activation as well as the <SPACE> key will toggle the status of the current character.
If you need to change the status of a particular range of characters, choose Edit/ Enable range of characters or Edit/Disable range of characters from the menu. The range to be enabled or disabled is then specified in a dialog box using hexadecimal character values. To disable all characters, select Edit/Disable all characters from the menu.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
250
CHAPTER
Font Converter
11.2.4.3 Selecting pixels
When the lower area of the user interface is activated, you can move through the pixels with the cursor, either by using the <UP>, <DOWN>, <LEFT> and <RIGHT> keys or by clicking on the pixels with the left mouse button.
11.2.4.4 Modifying character bits
In the lower area you can use the <SPACE> key to invert the currently selected bit. In antialiased mode, you can increase and decrease the intensity of a pixel with the keys <+> and <->. The status bar displays the intensity of the current pixel as follows
11.2.4.5 Operations
The following size / shift / move operations are available:
Size operations
The size of a character (the font) may be modified by selecting Edit/Insert/Right, Left, Top, Bottom or Edit/Delete/Right, Left, Top, Bottom from the menu, or by using the toolbar:
Add one pixel to the right.
Add one pixel to the left.
Add one pixel at the top
Add one pixel at the bottom Delete one pixel from the right.
Delete one pixel from the left
Delete one pixel at the top Delete one pixel at the bottom
Shift operations
Choose Edit/Shift/Right, Left, Up, Down from the menu to shift the bits of the current character in the respective direction, or use the toolbar:
Shift all pixels right.
Shift all pixels left. Shift all pixels up.
Shift all pixels down.
Move operations (extended font format only)
Choose Edit/Move/Right, Left, Up, Down from the menu to move the character position in the respective direction, or use the toolbar:
Move image to the right.
Move image to the left.
Move image up.
Move image down.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
251
Change cursor distance (extended font format only)
Choose Edit/Cursor distance/Increase, Decrease from the menu to move the character position in the respective direction, or use the toolbar:
Increase cursor distance.
Decrease cursor distance.
Change font height (extended font format only)
Choose Edit/Font height/[Insert, Delete] [top, bottom] from the menu to add or remove a row to or from the font, or use the toolbar:
Insert a row at the top of the font
Insert a row at the bottom of the font
Delete a row from the top of the font
Delete a row from the bottom of the font
11.2.4.6 Modifying the viewing mode
The view mode may be changed by selecting the following options from the menu:
View/All Characters
If enabled (standard), all characters are shown. If disabled, only the rows with at least one enabled character are shown.
Toggles viewing mode.
11.3 Options
Compatibility options
The Font Converter is able to create font files for all versions of emWin. Because there have been a few small changes of the font format from the emWin version 3.50 to the version 3.52, the C font files for these versions should be slightly different to avoid compiler warnings or compiler errors. Use the command Options/Compatibility to get into the following dialog:
Magnification options
The Font Converter is able to save the font data in a magnified format. Use the command Options/Magnification to get into the following dialog:
A magnification factor for the X and the Y axis can be specified here. If for example the magnification factor for the Y axis is 2 and the height of the current font data is 18, the font height in the font file will be 36. The magnification in X works similar.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
252
CHAPTER
Font Converter
After saving the font in a magnified format a short message is shown to inform the user, that the saved font is magnified:
Logging
Logging of commands can be enabled or disabled using the command Options/Logging:
When logging is enabled the C files contain a history of the commands which has been used to modify the font file.
Antialiasing
When using 'Internal antialiasing' it is recommended to enable Suppress optimization. This makes sure, that the horizontal and vertical alignment of the characters fits to each other:
The option Enable gamma correction for AA2 and AA4 should be disabled. When the option is enabled the antialiased pixels of the characters will appear a little more darker.
11.3.1 Saving the font
The Font Converter can create C font files or system independent font data files. Details about the SIF format can be found under "System Independent Font (SIF) format" on page 198.
11.3.1.1 Creating a C file
When you are ready to generate a C file, simply select File/Save As from the Font Converter menu, specify a destination and name for the file, choose the C file format and click Save. A C file will automatically be created.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
253
The default setting for the filename is built by the name of the source font and the current height in pixels. For example, if the name of the source font is "Example" and the pixel height is 10, the default filename would be Example10.c. If you keep this default name when generating a C file, the resulting name of the font will be GUI_FontExample10.c. Examples of C files generated from fonts can be found in the sub chapter "Font Examples" on page 260.
11.3.1.2 Creating a System Independent Font (SIF)
When you are ready to generate the file, simply select File/Save As from the Font Converter menu, specify a destination and name for the file, choose the System independent font format and click Save. A system independent font file will automatically be created. This file does not contain C structures which can be compiled with emWin but binary font data, which can be used as described in "System Independent Font (SIF) format" on page 198.
11.3.1.3 Creating an External Binary Font (XBF)
When you are ready to generate the file, simply select File/Save As from the Font Converter menu, specify a destination and name for the file, choose the External binary font format and click Save. An external binary font file will automatically be created. This file does not contain C structures which can be compiled with emWin but binary font data, which can be used as described in "External Bitmap Font (XBF) format" on page 199.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
254
CHAPTER
Font Converter
11.3.2 Modifying an existing C font file
The Font Converter is able to open existing font files and to modify their font data. The tool can only open C font files generated by the Font Converter. If the C font files have been modified manually, it can not be guaranteed, that they can be opened by the Font Converter.
Step 1: Start the application. The Font Converter is opened and automatically displays the Font generation options dialog box.
Press Cancel.
Step 2: Use the command File\Load C file.
Select the desired C font file to be opened
and click OK.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
255
11.3.3 Merging fonts with existing C font files
The Font Converter is able to add the content of an existing C font file to the current font data. Once a font is loaded via "File" -> "Load 'C' file..." or created by "File" -> "New" a C font file can be merged to it using "File" -> "Merge 'C' file...". The Font Converter requires the fonts to be of the same size, so the merging can be processed properly.
Step 1: Load an existing font or create a new one as described above. In this example the existing font contains the characters A-F (0x41 - 0x46).
Step 2: Use the command File\Merge C file....
Select the desired C font file to be merged
and click OK.
The merged font file contains the characters a-f (0x61 - 0x66). Now the font can be edited and saved as a new font file.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
256
CHAPTER
Font Converter
11.4 Pattern files
If you need to create fonts with a special set of characters (often for displaying a specific text), it can be very time consuming to enable every character by hand. In these cases, pattern files can be used to enable your character codes. A pattern file is nothing but a simple text file which contains the characters to be included in the font file. It can be used by the Font Converter to enable only the characters you need.
11.4.1 Creating pattern files using Notepad
One option for creating a pattern file is to use Notepad, which is part of the Windows accessories: · Copy the text you want to display into the clipboard. · Open Notepad.exe. · Insert the contents of the clipboard into the Notepad document. · Use Format/Font to choose a font which contains all characters of the text. You
can skip this step if you do not want to see the characters. · Use File/Save As to save the pattern file. It is very important that you save the
file in text format:
11.4.2 Creating pattern files using the Font Converter
A pattern file may also be created directly in the Font Converter. Select Edit/Save pattern file from the menu to create a text file which includes all currently enabled characters.
11.4.3 Enabling characters using a pattern file
It is usually helpful to begin by disabling all characters. Select Edit/Disable all characters from the menu if you need to do so. Now choose Edit/Read pattern file. After opening the appropriate pattern file, all characters included in the file are enabled. If the pattern file contains characters which are not included in the currently loaded font, a message box will appear.
11.5 Supported output modes
There are three modes supported by the Font Converter: standard, 2-bit antialiased and 4-bit antialiased. If you are using a black and white LCD display, only the standard mode makes sense. If using a grayscale or color display, it is possible to improve the appearance of a font through antialiasing. Antialiasing smoothes curves and diagonal lines by blending the background color with that of the foreground. The higher the number of shades used between background and foreground colors, the better the antialiasing result. The general purpose of using antialiased fonts is to improve the appearance of text. While the effect of using high-quality antialiasing will be more visually pleasing than low-quality, computation time and memory consumption will increase proportionally.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
257
Low-quality (2bpp) fonts require twice the memory of non antialiased (1bpp) fonts; high-quality (4bpp) fonts require four times the memory. The following table shows the difference between the modes by displaying the magnified character C in each:
Font Type
Black On White
White On Black
Standard (no antialiasing) 1 bpp 2 shades
Low-quality (antialiased) 2 bpp 4 shades
High-quality (antialiased) 4 bpp 16 shades
11.5.1 Standard mode
When using this mode, a pixel can either be set or not. The memory requirement for one pixel is one bit. If a pixel is set, it is displayed in the current foreground color.
11.5.2 Antialiased modes
These modes are recommended if you want to display characters with smoothed edges. Every pixel is stored as a 2- or 4-bit value which describes the foreground intensity. For example, when using 4-bit antialiasing, a value of 15 displays the pixel in the current foreground color. An intensity of 10 means that the pixel color is a mixture of 10 shares of foreground color and 5 shares of background color. Before using one of these modes, the feature must be activated in your operating system. Choose the effects sheet of the display properties dialog and activate smooth edges of screen fonts.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
258
CHAPTER
Font Converter
11.6 Command line options
11.6.1 Table of commands
The following table shows the available command line options:
Command
Description
Create font: <FONTNAME> Name of the font to be used
<STYLE>
REGULAR
- Creates a normal font
BOLD
- Creates a bold font
REGULAR_ITALIC - Creates an italic font
BOLD_ITALIC - Creates an italic bold font
<HEIGHT> Height in pixels of the font to be created <TYPE> STD - Standard 1 bpp font create<FONTNAME>,<STYLE>, AA2 - Antialiased font (2bpp) <HEIGHT>,<TYPE>, AA4 - Antialiased font (4bpp) <ENCODING>[,<METHOD>] EXT - Extended font EXT_FRM - Extended framed font EXT_AA2 - Extended font using 2bpp antialiasing EXT_AA4 - Extended font using 4bpp antialiasing
<ENCODING>
UC16 - 16 bit Unicode encoding
ISO8859 - 8 bit ASCII + ISO8859
JIS
- Shift JIS
<METHOD>
OS
- Antialiasing of operating system (default)
INTERNAL - Internal antialiasing method
edit<ACTION>, <DETAIL>[,<CNT>]
Equivalent to the 'Edit' menu: <ACTION> DEL - Deletes pixels INS - Inserts pixels <DETAIL> TOP - Delete/insert from top BOTTOM - Delete/insert from bottom <CNT> Number of operations, default is 1
enable[FIRST-LAST>, <STATE>
Enables or disables the given range of characters: <FIRST-LAST> Hexadecimal values separated by a '-'
defining the range of characters <STATE> 1 - Enables the given range 0 - Disables the given range
exit merge<FILENAME>
Exits the application after the job is done Merges the given 'C' file to the current content.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
259
Command readpattern<FILENAME>
Description
Reads a pattern file: <FILENAME> Name of the pattern file to be read
saveas<FILENAME>,<TYPE>
Saves the font data in a specific format: <FILENAME> File name including extension <TYPE> C - Saves as 'C' file SIF - Saves as System independent font file XBF - Saves as external binary font file
Shows all available commands ?
· All commands are processed from left to right. · If using -exit Font Converter will stop execution if any error occurs. The return
code in this case is != 0.
11.6.2 Execution examples
FontCvt -create"Cordia New",BOLD,32,EXT,UC16
Creates an extended bold font of 32 pixels height with Unicode encoding using the font "Cordia New".
FontCvt FontFile.c -enable0-ffff,0 readpattern"data.txt" Reads the C font file "FontFile.c", disables all characters and reads a pattern file.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
260
CHAPTER
Font Converter
11.7 Font Examples
These sections provide examples of C files generated by the Font Converter in standard, 2bpp antialiased and 4bpp antialiased modes, respectively.
11.7.1 Resulting C code, standard mode
The following is an example of a C file in standard mode:
/*
C-file generated by Font Converter for emWin version 3.04
Compiled:
Dec 13 2005 at 12:51:50
C-file created: Dec 21 2005 at 12:42:57
Copyright (C) 1998-2005
Segger Microcontroller Systeme GmbH
www.segger.com
Solutions for real time microcontroller applications
Source file: Sample10.c
Font:
Arial
Height:
10
*/
#include "GUI.H"
#ifndef GUI_CONST_STORAGE
#define GUI_CONST_STORAGE const
#endif
/* The following line needs to be included in any file selecting the
font. A good place would be GUIConf.H
*/
extern GUI_CONST_STORAGE GUI_FONT GUI_FontSample10;
/* Start of unicode area <Basic Latin> */
GUI_CONST_STORAGE unsigned char acFontSample10_0041[10] = { /* code 0041 */
________,
___X____,
__X_X___,
__X_X___,
__X_X___,
_X___X__,
_XXXXX__,
X_____X_,
X_____X_,
________};
GUI_CONST_STORAGE unsigned char acFontSample10_0061[10] = { /* code 0061 */
________,
________,
________,
_XXX____,
X___X___,
_XXXX___,
X___X___,
X__XX___,
_XX_X___,
________};
GUI_CONST_STORAGE GUI_CHARINFO GUI_FontSample10_CharInfo[2] = {
{ 8, 8, 1, acFontSample10_0041 } /* code 0041 */
,{ 6, 6, 1, acFontSample10_0061 } /* code 0061 */
};
GUI_CONST_STORAGE GUI_FONT_PROP GUI_FontSample10_Prop2 = {
97
/* first character
*/
,97
/* last character
*/
,&GUI_FontSample10_CharInfo[1] /* address of first character */
,(GUI_CONST_STORAGE GUI_FONT_PROP*)0 /* pointer to next GUI_FONT_PROP */
};
GUI_CONST_STORAGE GUI_FONT_PROP GUI_FontSample10_Prop1 = {
65
/* first character
*/
,65
/* last character
*/
,&GUI_FontSample10_CharInfo[0] /* address of first character */
,&GUI_FontSample10_Prop2
/* pointer to next GUI_FONT_PROP */
};
GUI_CONST_STORAGE GUI_FONT GUI_FontSample10 = {
GUI_FONTTYPE_PROP /* type of font */
,10
/* height of font */
,10
/* space of font y */
,1
/* magnification x */
,1
/* magnification y */
,&GUI_FontSample10_Prop1
};
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
261
11.8 Resulting C code, 2 bpp antialiased mode
The following is an example of a C file in 2 bpp antialiased mode:
/*
C-file generated by Font Converter for emWin version 3.04
Compiled:
Dec 13 2005 at 12:51:50
C-file created: Dec 21 2005 at 12:42:57
Copyright (C) 1998-2005
Segger Microcontroller Systeme GmbH
www.segger.com
Solutions for real time microcontroller applications
Source file: Sample10.c
Font:
Arial
Height:
14
*/
#include "GUI.H"
#ifndef GUI_CONST_STORAGE
#define GUI_CONST_STORAGE const
#endif
/* The following line needs to be included in any file selecting the
font. A good place would be GUIConf.H
*/
extern GUI_CONST_STORAGE GUI_FONT GUI_FontSample10;
/* Start of unicode area <Basic Latin> */
GUI_CONST_STORAGE unsigned char acFontSample10_0041[ 28] = { /* code 0041 */
0x00, 0x00,
0x00, 0x00,
0x00, 0x00,
0x0B, 0xC0,
0x1F, 0xD0,
0x2E, 0xE0,
0x3C, 0xF0,
0x78, 0xB4,
0xBF, 0xF8,
0xE0, 0x78,
0xE0, 0x3C,
0x00, 0x00,
0x00, 0x00,
0x00, 0x00
};
GUI_CONST_STORAGE unsigned char acFontSample10_0061[ 28] = { /* code 0061 */
0x00, 0x00,
0x00, 0x00,
0x00, 0x00,
0x00, 0x00,
0x00, 0x00,
0x6F, 0x40,
0x93, 0xC0,
0x2B, 0xC0,
0xB7, 0xC0,
0xF7, 0xC0,
0x7B, 0xC0,
0x00, 0x00,
0x00, 0x00,
0x00, 0x00
};
GUI_CONST_STORAGE GUI_CHARINFO GUI_FontSample10_CharInfo[2] = {
{ 8, 8, 2, acFontSample10_0041 } /* code 0041 */
,{ 6, 6, 2, acFontSample10_0061 } /* code 0061 */
};
GUI_CONST_STORAGE GUI_FONT_PROP GUI_FontSample10_Prop2 = {
0x0061 /* first character */
,0x0061 /* last character */
,&GUI_FontSample10_CharInfo[ 1] /* address of first character */
,(GUI_CONST_STORAGE GUI_FONT_PROP*)0 /* pointer to next GUI_FONT_PROP */
};
GUI_CONST_STORAGE GUI_FONT_PROP GUI_FontSample10_Prop1 = {
0x0041 /* first character */
,0x0041 /* last character */
,&GUI_FontSample10_CharInfo[ 0] /* address of first character */
,&GUI_FontSample10_Prop2 /* pointer to next GUI_FONT_PROP */
};
GUI_CONST_STORAGE GUI_FONT GUI_FontSample10 = {
GUI_FONTTYPE_PROP_AA2 /* type of font */
,14 /* height of font */
,14 /* space of font y */
,1 /* magnification x */
,1 /* magnification y */
,&GUI_FontSample10_Prop1
};
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
262
CHAPTER
Font Converter
11.9 Resulting C code, 4 bpp antialiased mode
The following is an example of a C file in 4 bpp antialiased mode:
/*
C-file generated by Font Converter for emWin version 3.04
Compiled:
Dec 13 2005 at 12:51:50
C-file created: Dec 21 2005 at 12:42:57
Copyright (C) 1998-2005
Segger Microcontroller Systeme GmbH
www.segger.com
Solutions for real time microcontroller applications
Source file: Sample10.c
Font:
Arial
Height:
10
*/
#include "GUI.H"
#ifndef GUI_CONST_STORAGE
#define GUI_CONST_STORAGE const
#endif
/* The following line needs to be included in any file selecting the
font. A good place would be GUIConf.H
*/
extern GUI_CONST_STORAGE GUI_FONT GUI_FontSample10;
/* Start of unicode area <Basic Latin> */
GUI_CONST_STORAGE unsigned char acFontSample10_0041[ 40] = { /* code 0041 */
0x00, 0x00, 0x00, 0x00,
0x00, 0xCF, 0xF2, 0x00,
0x03, 0xFF, 0xF6, 0x00,
0x09, 0xFB, 0xFB, 0x00,
0x0E, 0xE2, 0xFE, 0x00,
0x5F, 0x90, 0xCF, 0x40,
0xBF, 0xFF, 0xFF, 0x90,
0xFC, 0x00, 0x6F, 0xC0,
0xF8, 0x00, 0x2F, 0xF2,
0x00, 0x00, 0x00, 0x00
};
GUI_CONST_STORAGE unsigned char acFontSample10_0061[ 30] = { /* code 0061 */
0x00, 0x00, 0x00,
0x00, 0x00, 0x00,
0x00, 0x00, 0x00,
0x3D, 0xFE, 0x60,
0xD3, 0x0F, 0xE0,
0x29, 0xCF, 0xF0,
0xDF, 0x4F, 0xF0,
0xFF, 0x3F, 0xF0,
0x6F, 0xAF, 0xF0,
0x00, 0x00, 0x00
};
GUI_CONST_STORAGE GUI_CHARINFO GUI_FontSample10_CharInfo[2] = {
{ 8, 8, 4, acFontSample10_0041 } /* code 0041 */
,{ 6, 6, 3, acFontSample10_0061 } /* code 0061 */
};
GUI_CONST_STORAGE GUI_FONT_PROP GUI_FontSample10_Prop2 = {
0x0061 /* first character */
,0x0061 /* last character */
,&GUI_FontSample10_CharInfo[ 1] /* address of first character */
,(GUI_CONST_STORAGE GUI_FONT_PROP*)0 /* pointer to next GUI_FONT_PROP */
};
GUI_CONST_STORAGE GUI_FONT_PROP GUI_FontSample10_Prop1 = {
0x0041 /* first character */
,0x0041 /* last character */
,&GUI_FontSample10_CharInfo[ 0] /* address of first character */
,&GUI_FontSample10_Prop2 /* pointer to next GUI_FONT_PROP */
};
GUI_CONST_STORAGE GUI_FONT GUI_FontSample10 = {
GUI_FONTTYPE_PROP_AA4 /* type of font */
,10 /* height of font */
,10 /* space of font y */
,1 /* magnification x */
,1 /* magnification y */
,&GUI_FontSample10_Prop1
};
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
263
11.10 Resulting C code, extended mode
/*
C-file generated by Font Converter for emWin version 3.04
Compiled:
Dec 13 2005 at 12:51:50
C-file created: Dec 21 2005 at 12:45:52
Copyright (C) 1998-2005
Segger Microcontroller Systeme GmbH
www.segger.com
Solutions for real time microcontroller applications
Source file: Arial16.c
Font:
Arial
Height:
16
*/
#include "GUI.H"
#ifndef GUI_CONST_STORAGE
#define GUI_CONST_STORAGE const
#endif
/* The following line needs to be included in any file selecting the
font. A good place would be GUIConf.H
*/
extern GUI_CONST_STORAGE GUI_FONT GUI_Font16;
/* Start of unicode area <Basic Latin> */
GUI_CONST_STORAGE unsigned char acGUI_Font16_0041[ 20] = { /* code 0041 */
____X___,________,
___X_X__,________,
___X_X__,________,
___X_X__,________,
__X___X_,________,
__X___X_,________,
_XXXXXXX,________,
_X_____X,________,
X_______,X_______,
X_______,X_______};
GUI_CONST_STORAGE unsigned char acGUI_Font16_0061[ 7] = { /* code 0061 */
_XXX____,
X___X___,
____X___,
_XXXX___,
X___X___,
X__XX___,
_XX_X___};
GUI_CONST_STORAGE GUI_CHARINFO_EXT GUI_Font16_CharInfo[2] = {
{ 9, 10, 0, 3, 9, acGUI_Font16_0041 } /* code 0041 */
,{ 5, 7, 1, 6, 7, acGUI_Font16_0061 } /* code 0061 */
};
GUI_CONST_STORAGE GUI_FONT_PROP_EXT GUI_Font16_Prop2 = {
0x0061 /* first character */
,0x0061 /* last character */
,&GUI_Font16_CharInfo[ 1] /* address of first character */
,(GUI_CONST_STORAGE GUI_FONT_PROP_EXT *)0
};
GUI_CONST_STORAGE GUI_FONT_PROP_EXT GUI_Font16_Prop1 = {
0x0041 /* first character */
,0x0041 /* last character */
,&GUI_Font16_CharInfo[ 0] /* address of first character */
,&GUI_Font16_Prop2 /* pointer to next GUI_FONT_PROP_EXT */
};
GUI_CONST_STORAGE GUI_FONT GUI_Font16 = {
GUI_FONTTYPE_PROP_EXT /* type of font */
,16 /* height of font */
,16 /* space of font y */
,1 /* magnification x */
,1 /* magnification y */
,{&GUI_Font16_Prop1}
,13 /* Baseline */
,7 /* Height of lowercase characters */
,10 /* Height of capital characters */
};
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
264
CHAPTER
Font Converter
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
265
Chapter 12
Colors
emWin supports black/white, grayscale (monochrome with different intensities) and color displays. The same user program can be used with any display; only the LCDconfiguration needs to be changed. The color management tries to find the closest match for any color that should be displayed. Logical colors are the colors the application deals with. A logical colors is always defined as an RGB value. This is a 24-bit value containing 8 bits per color as follows: 0xBBGGRR. Therefore, white would be 0xFFFFFF, black would be 0x000000, bright red 0xFF. Physical colors are the colors which can actually be displayed by the display. They are specified in the same 24-bit RGB format as logical colors. At run-time, logical colors are mapped to physical colors. For displays with few colors (such as monochrome displays or 8/16-color LCDs), emWin converts them by using an optimized version of the "least-square deviation search". It compares the color to display (the logical color) with all the available colors that the LCD can actually show (the physical colors) and uses the one that the LCD-metric considers closest.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
266
CHAPTER
Colors
12.1 Predefined colors
In addition to self-defined colors, some standard colors are predefined in emWin, as shown in the following table:
Example
/* Set background color to magenta */ GUI_SetBkColor(GUI_MAGENTA); GUI_Clear();
12.2 The color bar test routine
The color bar example program is used to show 13 color bars as follows:
Black -> Red, White -> Red, Black -> Green, White -> Green, Black -> Blue, White > Blue, Black -> White, Black -> Yellow, White -> Yellow, Black -> Cyan, White -> Cyan, Black -> Magenta and White -> Magenta.
This little routine may be used on all displays in any color format. Of course, the results vary depending on the colors that can be displayed; the routine requires a display size of 320*240 in order to show all colors. The routine is used to demonstrate the effect of the different color settings for displays. It may also be used by a test program to verify the functionality of the display, to check available colors and grayscales, as well as to correct color conversion. The screen shots are taken from the windows simulation and will look exactly like the actual output on your display if your settings and hardware are working properly. The routine is available as COLOR_ShowColorBar.c in the examples shipped with emWin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
267
12.3 Fixed palette modes
The following table lists the available fixed palette color modes and the necessary identifiers which need to be used when creating a driver- or a memory device. Detailed descriptions follow.
Identifier
GUICC_1 GUICC_2 GUICC_4 GUICC_5 GUICC_16 GUICC_1616I GUICC_111 GUICC_M111 GUICC_222 GUICC_M222 GUICC_233 GUICC_M233 GUICC_323 GUICC_M323 GUICC_332 GUICC_M332 GUICC_444_12 GUICC_M444_12 GUICC_444_12_1 GUICC_444_16 GUICC_M444_16 GUICC_M4444I GUICC_555 GUICC_M555 GUICC_M1555I GUICC_556 GUICC_M556 GUICC_565 GUICC_M565 GUICC_655 GUICC_M655
No. available colors
2 (black and white)
4 (grayscales)
16 (grayscales)
0x01 0x03 0x0F
32 (grayscales) 16 16 + 4 bit alpha blending 8 8
0x1F 0x0F 0xFF 0x07 0x07
64
0x3F
64
0x3F
256
0xFF
256
0xFF
256
0xFF
256
0xFF
256
0xFF
256
0xFF
4096 4096
0x0FFF 0x0FFF
4096 4096
0xFFF0 0x7BDE
4096
4096 + 4 bit alpha blending
32768
0x7BDE 0xFFFF 0x7FFF
32768
32768 + 1 bit transparency
65536
0x7FFF 0xFFFF 0xFFFF
65536 65536
0xFFFF 0xFFFF
65536 65536
0xFFFF 0xFFFF
65536
0xFFFF
Mask
-> 00000001 -> 00000011 -> 00001111 -> 00011111 -> 00001111 -> 11111111 -> 00000BGR -> 00000RGB -> 00BBGGRR -> 00RRGGBB -> BBGGGRRR -> RRGGGBBB -> BBBGGRRR -> RRRGGBBB -> BBBGGGRR -> RRRGGGBB -> 0000BBBBGGGGRRRR -> 0000RRRRGGGGBBBB -> BBBBGGGGRRRR0000 -> 0BBBB0GGGG0RRRR0 -> 0RRRR0GGGG0BBBB0 -> AAAARRRRGGGGBBBB -> 0BBBBBGGGGGRRRRR -> 0RRRRRGGGGGBBBBB -> TRRRRRGGGGGBBBBB -> BBBBBGGGGGRRRRRR -> RRRRRGGGGGBBBBBB -> BBBBBGGGGGGRRRRR -> RRRRRGGGGGGBBBBB -> BBBBBBGGGGGRRRRR -> RRRRRRGGGGGBBBBB
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
268
CHAPTER
Colors
Identifier
GUICC_666 GUICC_M666 GUICC_666_9 GUICC_M666_9 GUICC_822216 GUICC_84444 GUICC_8666
GUICC_8666_1
GUICC_88666I
GUICC_888 GUICC_M888
GUICC_8888
GUICC_M8888
GUICC_M8888I GUICC_0 GUICC_1_2 GUICC_1_4 GUICC_1_5 GUICC_1_8 GUICC_1_16 GUICC_1_24
No. available colors
Mask
262144
262144
262144
262144
256
240
232 233 (232 + transparency) 232 + 8 bits alpha blending 16M
16M 16M + 8 bit alpha blending 16M + 8 bit alpha blending
0x0003FFFF -> BBBBBBGGGGGGRRRRRR 0x0003FFFF -> RRRRRRGGGGGGBBBBBB 0x01FF01FF -> 0000000BBBBBBGGG0000000GGGRRRRRR 0x01FF01FF -> 0000000RRRRRRGGG0000000GGGBBBBBB 0xFF - Bits are not explicitly assigned to a color. 0xFF - Bits are not explicitly assigned to a color. 0xFF - Bits are not explicitly assigned to a color.
0xFF - Bits are not explicitly assigned to a color.
0xFFFF
-> AAAAAAAACCCCCCCC
0x00FFFFFF -> BBBBBBBBGGGGGGGGRRRRRRRR 0x00FFFFFF -> RRRRRRRRGGGGGGGGBBBBBBBB
0xFFFFFFFF -> AAAAAAAABBBBBBBBGGGGGGGGRRRRRRRR
0xFFFFFFFF -> AAAAAAAARRRRRRRRGGGGGGGGBBBBBBBB
-
2 (black and white)
CUSTOM DEFINED FIXED PALETTE MODE
0x00000001 0x00000003 0x0000001F 0x000000FF 0x0000FFFF 0x00FFFFFF
R - Red G - Green B - Blue C - Color (in case of no explicit bit assignment to colors) T - Transparency bit A - Alpha mask
12.4 Detailed fixed palette mode description
The following gives a detailed description of the available colors in each predefined fixed palette mode.
GUICC_1: 1 bpp (black and white)
Use of this mode is necessary for monochrome displays with 1 bit per pixel.
Available colors: 2: UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
269
GUICC_2: 2 bpp (4 grayscales)
Use of this mode is necessary for monochrome displays with 2 bits per pixel.
Available colors: 2 x 2 = 4:
GUICC_4: 4 bpp (16 grayscales)
Use of this mode is necessary for monochrome displays with 4 bits per pixel.
Available colors: 2 x 2 x 2 x 2 = 16:
GUICC_5: 5 bpp (32 grayscales)
Use of this mode is necessary for monochrome displays with 5 bits per pixel.
Available colors: 2 x 2 x 2 x 2 x 2 = 32:
GUICC_111: 3 bpp (2 levels per color)
Use this mode if the basic 8 colors are enough, if your hardware supports only one bit per pixel and color or if you do not have sufficient video memory for a higher color depth. Color mask: BGR
Available colors: 2 x 2 x 2 = 8:
GUICC_M111: 3 bpp (2 levels per color), red and blue swapped
Use this mode if the basic 8 colors are enough, if your hardware supports only one bit per pixel and color or if you do not have sufficient video memory for a higher color depth. The available colors are the same as those in 111 mode. Color mask: RGB Available colors: 2 x 2 x 2 = 8:
GUICC_16: 4 bpp (16 colors)
This mode can be used if the basic 16 colors are enough, if the hardware supports only 4 bits per pixel or if you do not have sufficient video memory for a higher color depth.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
270
CHAPTER
Available colors: 2 x 2 x 2 x 2 = 16:
GUICC_1616I: 8 bpp (16 colors + 4 bits alpha mask)
Same colors as in GUICC_16. The lower 4 bits contain the color and the upper 4 bits are used for alpha blending. Color mask: AAAACCCC (AAAA = 0xF - opaque) (AAAA = 0x0 - transparent) Available colors: 2 x 2 x 2 x 2 = 16:
GUICC_222: 6 bpp (4 levels per color)
This mode is a good choice if your hardware does not have a palette for every individual color. 2 bits per pixel and color are reserved; usually 1 byte is used to store one pixel. Color mask: BBGGRR
Available colors: 4 x 4 x 4 = 64:
Colors
GUICC_M222: 6 bpp (4 levels per color), red and blue swapped
This mode is a good choice if your hardware does not have a palette for every individual color. 2 bits per pixel and color are reserved; usually 1 byte is used to store one pixel. The available colors are the same as those in 222 mode. Color mask: RRGGBB Available colors: 4 x 4 x 4 = 64:
GUICC_233: 8 bpp
This mode supports 256 colors. 3 bits are used for the red and green components of the color and 2 bits for the blue component. As shown in the picture, the result is 8 grades for green and red and 4 grades for blue. We discourage the use of this mode because it do not contain real shades of gray. Color mask: BBGGGRRR Available colors: 4 x 8 x 8 = 256:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
271
GUICC_M233: 8 bpp, red and blue swapped
This mode supports 256 colors. 3 bits are used for the red and green components of the color and 2 bits for the blue component. The result is 8 grades for green and blue and 4 grades for red. We discourage the use of this mode because it do not contain real shades of gray. Color mask: RRGGGBBB Available colors: 4 x 8 x 8 = 256:
GUICC_323: 8 bpp
This mode supports 256 colors. 3 bits are used for the red and blue components of the color and 2 bits for the green component. As shown in the picture, the result is 8 grades for blue and red and 4 grades for green. We discourage the use of this mode because it do not contain real shades of gray. Color mask: BBBGGRRR Available colors: 8 x 4 x 8 = 256:
GUICC_M323: 8 bpp, red and blue swapped
This mode supports 256 colors. 3 bits are used for the red and blue components of the color and 2 bits for the green component. The available colors are the same as those in 323 mode. The result is 8 grades for red and blue and 4 grades for green. We discourage the use of this mode because it do not contain real shades of gray. Color mask: RRRGGBBB
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
272
CHAPTER
Available colors: 8 x 4 x 8 = 256:
Colors
GUICC_332: 8 bpp
This mode supports 256 colors. 3 bits are used for the blue and green components of the color and 2 bits for the red component. As shown in the picture, the result is 8 grades for green and blue and 4 grades for red. We discourage the use of this mode because it do not contain real shades of gray. Color mask: BBBGGGRR
Available colors: 8 x 8 x 4 = 256:
GUICC_M332: 8 bpp, red and blue swapped
This mode supports 256 colors. 3 bits are used for the red and green components of the color and 2 bits for the blue component. The result is 8 grades for red and green and only 4 grades for blue. We discourage the use of this mode because it do not contain real shades of gray. Color mask: RRRGGGBB
Available colors: 8 x 8 x 4 = 256:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
273
GUICC_444_12:
The red, green and blue components are each 4 bits. Color mask: 0000BBBBGGGGRRRR Available colors: 16 x 16 x 16 = 4096.
GUICC_444_16:
The red, green and blue components are each 4 bits. One bit between the color components is not used. The available colors are the same as those in 44412 mode. Color mask: 0BBBB0GGGG0RRRR0 Available colors: 16 x 16 x 16 = 4096.
GUICC_M444_12: red and blue swapped
The red, green and blue components are each 4 bits. The available colors are the same as those in 44412 mode. Available colors: 16 x 16 x 16 = 4096. Color mask: RRRRGGGGBBBB
GUICC_M444_16: red and blue swapped
The red, green and blue components are each 4 bits. One bit between the color components is not used. The available colors are the same as those in 44412 mode. Color mask: 0RRRR0GGGG0BBBB0 Available colors: 16 x 16 x 16 = 4096.
GUICC_M444_12_1:
The red, green and blue components are each 4 bits. The lower 4 bits of the color mask are not used. The available colors are the same as those in 44412 mode. Color mask: BBBBGGGGRRRR0000 Available colors: 16 x 16 x 16 = 4096.
GUICC_M4444I: 12 bits colors + 4 bits alpha mask
The red, green and blue components are each 4 bits, the upper 4 bits are used for alpha blending. Color mask: AAAARRRRGGGGBBBB (AAAA = 0xF - opaque) (AAAA = 0x0 - transparent) Available colors: 16 x 16 x 16 = 4096.
GUICC_555: 15 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 15 bpp. The red, green and blue components are each 5 bits. Color mask: BBBBBGGGGGRRRRR Available colors: 32 x 32 x 32 = 32768.
GUICC_M555: 15 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 15 bpp. The red, green and blue components are each 5 bits. The available colors are the same as those in 555 mode. Color mask: RRRRRGGGGGBBBBB Available colors: 32 x 32 x 32 = 32768.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
274
CHAPTER
GUICC_M1555I: 15 bits colors + 1 bit transparency
The red, green and blue components are each 5 bits, the upper bit is used for transparency. Color mask: ARRRRRGGGGGBBBBB (A = 1 - opaque) (A = 0 - transparent) Available colors: 32 x 32 x 32 = 32768.
GUICC_565: 16 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 16 bpp. The red and the blue component is 5 bits and the green component is 6 bit. Color mask: BBBBBGGGGGGRRRRR Available colors: 32 x 64 x 32 = 65536.
Colors
GUICC_M565: 16 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 16 bpp. The available colors are the same as those in 565 mode. Color sequence: RRRRRGGGGGGBBBBB Available colors: 32 x 64 x 32 = 65536.
GUICC_556: 16 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 16 bpp. The blue and the green component is 5 bit and the red component is 6 bit. Color mask: BBBBBGGGGGRRRRRR Available colors: 32 x 32 x 64 = 65536.
GUICC_M556: 16 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 16 bpp. The red and the green component is 5 bit and the blue component is 6 bit. Color mask: RRRRRGGGGGBBBBBB Available colors: 32 x 32 x 64 = 65536.
GUICC_655: 16 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 16 bpp. The red and green component is 5 bit and the blue component is 6 bit. Color mask: BBBBBBGGGGGRRRRR Available colors: 64 x 32 x 32 = 65536.
GUICC_M655: 16 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 16 bpp. The blue and green component is 5 bit and the red component is 6 bit. Color mask: RRRRRRGGGGGBBBBB Available colors: 64 x 32 x 32 = 65536.
GUICC_666: 18 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 18 bpp. The red, green and blue component is 6 bit.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
275
Color mask: BBBBBBGGGGGGRRRRRR Available colors: 64 x 64 x 64 = 262144.
GUICC_M666: 18 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 18 bpp. The red, green and the blue component is 6 bit. Color mask: RRRRRRGGGGGGBBBBBB Available colors: 64 x 64 x 64 = 262144.
GUICC_666_9: 18 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 18 bpp. The red, green and blue component is 6 bit. Color mask: 0000000BBBBBBGGG0000000GGGRRRRRR Available colors: 64 x 64 x 64 = 262144.
GUICC_M666_9: 18 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color-depth of 18 bpp. The red, green and blue component is 6 bit. Color mask: RRRRRRGGGGGGBBBBBB Available colors: 64 x 64 x 64 = 262144.
GUICC_822216: 8 bpp, 2 levels per color + 8 grayscales + 16 levels of alpha blending
This mode can be used with a programmable color lookup table (LUT), supporting a total of 256 possible colors and alpha blending support. It supports the 8 basic colors, 8 grayscales and 16 levels of alpha blending for each color / grayscale. With other words it can be used if only a few colors are required but more levels of alpha blending. Available colors: (2 x 2 x 2 + 8) * 16 = 256
GUICC_84444: 8 bpp, 4 levels per color + 16 grayscales + 4(3) levels of alpha blending
This mode can be used with a programmable color lookup table (LUT), supporting a total of 240 possible colors and alpha blending support. 4 levels of intensity are available for each color, in addition to 16 grayscales and 4 levels of alpha blending for each color / grayscale. With other words it can be used if only a few levels of alpha blending are required and different shades of colors.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
276
CHAPTER
Available colors: (4 x 4 x 4 + 16) * 3 = 240
Colors
GUICC_8666: 8bpp, 6 levels per color + 16 grayscales
This mode is most frequently used with a programmable color lookup table (LUT), supporting a total of 256 possible colors using a palette. The screen shot gives an idea of the available colors; this mode contains the best choice for general purpose applications. Six levels of intensity are available for each color, in addition to 16 grayscales. Available colors: 6 x 6 x 6 + 16 = 232:
GUICC_8666_1: 8bpp, 6 levels per color + 16 grayscales + transparency
This mode is most frequently used with multi layer configurations and a programmable color lookup table (LUT), supporting a total of 256 possible colors using a palette. The difference between 8666 and 86661 is, that the first color indices of the 86661 mode are not used. So the color conversion routine GUI_Color2Index does never return 0 which is used for transparency. Available colors: 6 x 6 x 6 + 16 = 232.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
277
GUICC_88666I: 16bpp - 8 bits color (6 levels per color + 16 grayscales) + 8 bits alpha blending
The available colors of this mode are exactly the same as described under GUICC_8666. The upper 8 bits are used for alpha blending. Color mask: AAAAAAAACCCCCCCC (AAAAAAAA = 0xFF - opaque) (AAAAAAAA = 0x00 - transparent)
GUICC_888: 24 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color depth of 24 bpp. The red, green and blue components are each 8 bits. Color mask: BBBBBBBBGGGGGGGGRRRRRRRR Available colors: 256 x 256 x 256 = 16777216.
GUICC_M888: 24 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color depth of 24 bpp. The red, green and blue components are each 8 bits. Color mask: RRRRRRRRGGGGGGGGBBBBBBBB Available colors: 256 x 256 x 256 = 16777216.
GUICC_8888: 32 bpp
Use of this mode is necessary for a display controller that supports RGB colors with a color depth of 32 bpp, where the lower 3 bytes are used for the color components and the upper byte is used for alpha blending. The red, green, blue and alpha blending components are each 8 bits. Color mask: AAAAAAAABBBBBBBBGGGGGGGGRRRRRRRR Available colors: 256 x 256 x 256 = 16777216.
GUICC_M8888: 32 bpp, red and blue swapped
Use of this mode is necessary for a display controller that supports RGB colors with a color depth of 32 bpp, where the lower 3 bytes are used for the color components and the upper byte is used for alpha blending. The red, green, blue and alpha blending components are each 8 bits. Color mask: AAAAAAAARRRRRRRRGGGGGGGGBBBBBBBB Available colors: 256 x 256 x 256 = 16777216.
GUICC_M8888I: 32 bpp, red and blue swapped
The color mode is exactly the same as described under GUICC_M8888 with the difference, that alpha blending is inverted. Color mask: AAAAAAAARRRRRRRRGGGGGGGGBBBBBBBB (AAAAAAAA = 0xFF - opaque) (AAAAAAAA = 0x00 - transparent)
GUICC_0: Custom palette mode
Will be explained later in this chapter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
278
CHAPTER
Colors
GUICC_1_2, GUICC_1_4, ... GUICC_1_24
These color conversion routines make it possible, to use display drivers which require a color depth of more than 1bpp, with emWin packages containing no support for colors or grayscales. The routines ensure that each color of the whole palette of possible colors will be converted into black or white.
Example
If the available emWin package does not contain color- or gray scale support and only a driver, which requires index values of 16 bits is available, GUICC_1_16 can be used. This color conversion scheme ensures that each color of the whole 16 bit palette will be converted into 0xFFFF (normally white) or 0x0000 (normally black).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
279
12.5 Application defined color conversion
If none of the fixed palette modes matches the need of color conversion this mode makes it possible to use application defined color conversion routines. The purpose of these routines is converting an RGB value into an index value for the hardware and vice versa.
Example of defining custom color conversion routines
The following example should explain how it works:
static unsigned _Color2Index_User(LCD_COLOR Color) { unsigned Index; /* Add code for converting the RGB value to an index value for the hardware */ return Index;
}
static LCD_COLOR _Index2Color_User(unsigned Index) { LCD_COLOR Color; /* Add code for converting the index value into an RGB value */ return Color;
}
static unsigned _GetIndexMask_User(void) { return 0xffff; /* Example for using 16 bits */
}
const LCD_API_COLOR_CONV LCD_API_ColorConv_User = { _Color2Index_User, _Index2Color_User, _GetIndexMask_User
};
The function LCD_Color2Index_User() is called by emWin if a RGB value should be converted into an index value for the display controller whereas the function LCD_Index2Color_User() is called if an index value should be converted into a RGB value. LCD_GetIndexMask_User() should return a bit mask value, which has each bit set to 1 which is used by the display controller and unused bits should be set to 0. For example the index mask of GUICC_44416 mode is 0BBBB0GGGG0RRRR0, where 0 stands for unused bits. The bit mask for this mode is 0x7BDE.
Example of using custom color conversion routines
As described in the chapter 'Configuration' a pointer to an API table is required for creating the display driver device. As shown in the example above the API table consists of function pointers to the color conversion routines. A good location for the API table and the color conversion routines is the configuration file LCDConf.c located in the Config folder. The routines can be used as follow in the function LCD_X_Config() which is responsible to create the display driver device:
void LCD_X_Config(void) { // // Set display driver and color conversion for 1st layer // GUI_DEVICE_CreateAndLink(GUIDRV_LIN_16, &LCD_API_ColorConv_User, 0, 0); . . .
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
280
CHAPTER
Colors
12.6 Custom palette mode
If none of the fixed palette modes fulfils the requirements of the application emWin is able to use a custom palette. A custom palette simply lists all the available colors in the same order as they are used by the hardware. This means that no matter what colors your LCD controller/display combination is able to display, emWin will be able to simulate them in the PC simulation and handle these colors correctly in your target system. Working with a custom palette requires a color depth <= 8 bpp. A custom palette is typically used during the initialization in the function LCD_X_Config() which is responsible for creating and configuring the display driver device.
Example
The following example should show how a custom palette can be used. It passes the palette to the function:
static const LCD_COLOR _aColors_16[] = { 0x000000, 0x0000FF, 0x00FF00, 0x00FFFF, 0xFF0000, 0xFF00FF, 0xFFFF00, 0xFFFFFF, 0x000000, 0x000080, 0x008000, 0x008080, 0x800000, 0x800080, 0x808000, 0x808080,
};
static const LCD_PHYSPALETTE _aPalette_16 = { COUNTOF(_aColors_16), _aColors_16
};
void LCD_X_Config(void) { // // Set display driver and color conversion for 1st layer // . . . // // Set user palette data (only required if no fixed palette is used) // LCD_SetLUTEx(0, _aPalette_16);
}
12.7 Gamma correction
Gamma correction can simply be achieved with custom color conversion routines. The trick is converting the colors twice. Please note that gamma correction does not work within the simulation.
Color2Index - conversion
It should first make the gamma correction of the color to be converted. The result of the gamma correction then should be passed to the Color2Index-function of the desired fixed palette mode, whose result then should be returned.
Index2Color - conversion
It should first convert the index to a color with the Color2Index-function of the desired fixed palette mode. The result then should be passed to the gamma correction routine whose result then should be returned.
Example
The sample folder LCDConf\Common\ contains the sample file LCDConf_GammaCorrection.c. It shows in detail how gamma correction can be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
281
12.8 Color API
The following table lists the available color-related functions in alphabetical order within their respective categories. Detailed description of the routines can be found in the sections that follow.
Routine
Description
Basic color functions
GUI_GetBkColor()
Return the current background color.
GUI_GetBkColorIndex()
Return the index of the current background color.
GUI_GetColor()
Return the current foreground color.
GUI_GetColorIndex()
Return the index of the current foreground color.
GUI_SetBkColor()
Set the current background color.
GUI_SetBkColorIndex()
Set the index of the current background color.
GUI_SetColor()
Set the current foreground color.
GUI_SetColorIndex()
Set the index of the current foreground color.
Index & color conversion functions
GUI_CalcColorDist()
Returns the difference between 2 colors
GUI_CalcVisColorError() Returns the difference to the next available color
GUI_Color2Index()
Convert color into color index.
GUI_Color2VisColor()
Returns the nearest available color
GUI_ColorIsAvailable() Checks if given color is available
GUI_Index2Color()
Convert color index into color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
282
CHAPTER
12.8.1 Basic color functions
GUI_GetBkColor()
Description
Returns the current background color.
Prototype
GUI_COLOR GUI_GetBkColor(void);
Return value
The current background color.
GUI_GetBkColorIndex()
Description
Returns the index of the current background color.
Prototype
int GUI_GetBkColorIndex(void);
Return value
The current background color index.
GUI_GetColor()
Description
Returns the current foreground color.
Prototype
GUI_COLOR GUI_GetColor(void);
Return value
The current foreground color.
GUI_GetColorIndex()
Description
Returns the index of the current foreground color.
Prototype
int GUI_GetColorIndex(void);
Return value
The current foreground color index.
Colors
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
283
GUI_SetBkColor()
Description
Sets the current background color.
Prototype
GUI_COLOR GUI_SetBkColor(GUI_COLOR Color);
Parameter Color
Description
Color for background, 24-bit RGB value.
Return value
The selected background color.
GUI_SetBkColorIndex()
Description
Sets the index of the current background color.
Prototype
int GUI_SetBkColorIndex(int Index);
Parameter Index
Description
Index of the color to be used.
Return value
The selected background color index.
GUI_SetColor()
Description
Sets the current foreground color.
Prototype
void GUI_SetColor(GUI_COLOR Color);
Parameter Color
Description
Color for foreground, 24-bit RGB value.
Return value
The selected foreground color.
GUI_SetColorIndex()
Description
Sets the index of the current foreground color.
Prototype
void GUI_SetColorIndex(int Index);
Parameter Index
Description
Index of the color to be used.
Return value
The selected foreground color index.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
284
CHAPTER
Colors
12.8.2 Index & color conversion
GUI_CalcColorDist()
Calculates the distance between 2 colors. The distance will be calculated by the sum of the square value from the distances of the red, green and the blue component:
Difference = (Red1 - Red0)² + (Green1 - Green0)² + (Blue1 - Blue0)²
Prototype
U32 GUI_CalcColorDist(GUI_COLOR Color0, GUI_COLOR Color1))
Parameter Color0 Color1
Description
RGB value of the first color. RGB value of the second color.
Return value
The distance as described above.
GUI_CalcVisColorError()
Calculates the distance to the next available color. For details about the calculation, refer to "GUI_CalcColorDist()" on page 284.
Prototype
U32 GUI_CalcVisColorError(GUI_COLOR color)
Parameter Color
Description
RGB value of the color to be calculated.
Return value
The distance to the next available color.
GUI_Color2Index()
Returns the index of a specified RGB color value.
Prototype
int GUI_Color2Index(GUI_COLOR Color)
Parameter Color
Description
RGB value of the color to be converted.
Return value
The color index.
GUI_Color2VisColor()
Returns the next available color of the system as an RGB color value.
Prototype
GUI_COLOR GUI_Color2VisColor(GUI_COLOR color)
Parameter Color
RGB value of the color.
Description
Return value
The RGB color value of the nearest available color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
285
GUI_ColorIsAvailable()
Checks if the given color is available.
Prototype
char GUI_ColorIsAvailable(GUI_COLOR color)
Parameter Color
RGB value of the color.
Description
Return value
1 if color is available, 0 if not.
GUI_Index2Color()
Returns the RGB color value of a specified index.
Prototype
int GUI_Index2Color(int Index)
Parameter Index
Description
Index of the color. to be converted
Return value
The RGB color value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
286
CHAPTER
Colors
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
287
Chapter 13
Memory Devices
Memory Devices can be used in a variety of situations, mainly to prevent the display from flickering when using drawing operations for overlapping items. The basic idea is quite simple. Without the use of a Memory Device, drawing operations write directly to the display. The screen is updated as drawing operations are executed, which gives it a flickering appearance as the various updates are made. For example, if you want to draw a bitmap in the background and some transparent text in the foreground, you would first have to draw the bitmap and then the text. The effect would be a flickering of the text. If a Memory Device is used for such a procedure, however, all drawing operations are executed in memory. The final result is displayed on the screen only when all operations have been carried out, with the advantage of no flickering. This difference can be seen in the example in the following section, which illustrates a sequence of drawing operations both with and without the use of a Memory Device. The distinction may be summarized as follows: If no Memory Device is used, the effects of drawing operations can be seen step by step, with the disadvantage of a flickering display. With a Memory Device, the effects of all routines are made visible as a single operation. No intermediate steps can actually be seen. The advantage, as explained above, is that display flickering is completely eliminated, and this is often desirable. Memory Devices are an additional (optional) software item and are not shipped with the emWin basic package. The software for Memory Devices is located in the subdirectory GUI\Memdev.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
288
CHAPTER
Memory Devices
13.1 Using Memory Devices: an illustration
The following table shows screen shots of the same operations handled with and without a Memory Device. The objective in both cases is identical: a work piece is to be rotated and labeled with the respective angle of rotation (here, 10 degrees). In the first case (without a Memory Device) the screen must be cleared, then the polygon is redrawn in the new position and a string with the new label is written. In the second case (with a Memory Device) the same operations are performed in memory, but the screen is not updated during this time. The only update occurs when the routine GUI_MEMDEV_CopyToLCD() is called, and this update reflects all the operations at once. Note that the initial states and final outputs of both procedures are identical.
API function
Without Memory Device With Memory Device
Step 0: Initial state
Step 1: GUI_Clear()
Step 2: GUI_DrawPolygon()
Step 3: GUI_DispString()
Step 4:
GUI_MEMDEV_CopyToLCD()
(only when using Memory Device)
13.2 Supported color depth (bpp)
Memory Devices are available in 4 different color depth: 1 bpp, 8 bpp, 16 bpp and 32 bpp.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
289
Creating Memory Devices "compatible" to the display
There are two ways to create Memory Devices. If they are use to avoid flickering, a Memory Device compatible to the display is created. This "compatible" Memory Device needs to have the same or a higher color depth as the display. emWin automatically selects the "right" type of Memory Device for the display if the functions GUI_MEMDEV_Create(), GUI_MEMDEV_CreateEx() are used. The Window Manager, which also has the ability to use Memory Devices for some or all windows in the system, also uses these functions. This way, the Memory Device with the lowest color depth (using the least memory) is automatically used.
Creating Memory Devices for other purposes
Memory Devices of any type can be created using GUI_MEMDEV_CreateFixed(). A typical application would be the use of a Memory Device for printing as described later in this chapter.
13.3 Memory Devices and the Window Manager
The Window Manager works seamlessly with Memory Devices. Every window has a flag which tells the Window Manager if a Memory Device should be used for rendering. This flag can be specified when creating the window or set/reset at any time. If the Memory Device flag is set for a particular window, the WM automatically uses a Memory Device when drawing the window. It creates a Memory Device before drawing a window and deletes it after the drawing operation. If enough memory is available, the whole window fits into the size of the Memory Device created by the WM. If not enough memory is available for the complete window in one Memory Device, the WM uses 'banding' for drawing the window. Details about 'banding' are described in the documentation, chapter 'Memory Devices \ Banding Memory Device'. The memory used for the drawing operation is only allocated during the drawing operation. If there is not enough memory available when (re-)drawing the window, the window is redrawn without Memory Device.
13.4 Memory Devices and multiple layers
The Memory Device API functions do not have any option to specify a layer. Please note that when creating a Memory Device the Memory Device is associated with the currently selected layer. The Memory Devices also use automatically the color conversion settings of the currently selected layer.
Example
// // Create a Memory Device associated with layer 1 // GUI_SelectLayer(1); hMem = GUI_MEMDEV_Create(0, 0, 100, 100); GUI_MEMDEV_Select(hMem); GUI_DrawLine(0, 0, 99, 99); GUI_MEMDEV_Select(0); // // Select layer 0 // GUI_SelectLayer(0); // // The following line copies the Memory Device to layer 1 and not to layer 0 // GUI_MEMDEV_CopyToLCD(hMem);
13.5 Memory requirements
If creating a Memory Device the required number of bytes depends on the color depth of the Memory Device and whether transparency support is needed or not.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
290
CHAPTER
Memory Devices
Memory usage without transparency support
The following table shows the memory requirement in dependence of the system color depth for Memory Devices without transparency support.
Color depth of Memory Device
1 bpp 8 bpp 16 bpp
32 bpp
System color depth (LCD_BITSPERPIXEL)
1 bpp 2, 4 and 8 bpp 12 and 16 bpp
18, 24 and 32 bpp
Memory usage
1 byte / 8 pixels: (XSIZE + 7) / 8 * YSIZE
XSIZE * YSIZE
2 bytes / pixel: XSIZE * YSIZE * 2
4 bytes / pixel: XSIZE * YSIZE * 4
Example:
A Memory Device of 111 pixels in X and 33 pixels in Y should be created. It should be compatible to a display with a color depth of 12 bpp and should support transparency. The required number of bytes can be calculated as follows:
Number of required bytes = (111 * 2 + (111 + 7) / 8) * 33 = 7788 bytes
Memory usage with transparency support
If a Memory Device should support transparency it needs one additional byte / 8 pixels for internal management.
Color depth of Memory Device
1 bpp
8 bpp
16 bpp
32 bpp
System color depth (LCD_BITSPERPIXEL)
1 bpp
2, 4 and 8 bpp
12 and 16 bpp
18, 24 and 32 bpp
Memory usage
2 byte / 8 pixels: (XSIZE + 7) / 8 * YSIZE * 2
1 bytes / pixel + 1 byte / 8 pixels: (XSIZE + (XSIZE + 7) / 8) * YSIZE
2 bytes / pixel + 1 byte / 8 pixels: (XSIZE * 2 + (XSIZE + 7) / 8) * YSIZE
4 bytes / pixel + 1 byte / 8 pixels: (XSIZE * 4 + (XSIZE + 7) / 8) * YSIZE
Example:
A Memory Device of 200 pixels in X and 50 pixels in Y should be created. It should be compatible to a display with a color depth of 4bpp and should support transparency. The required number of bytes can be calculated as follows:
Number of required bytes = (200 + (200 + 7) / 8) * 50 = 11250 bytes
13.6 Performance
Using Memory Devices typically does not significantly affect performance. When Memory Devices are used, the work of the driver is easier: It simply transfers bitmaps to the display controller. On systems with slow drivers (for example displays connected via serial interface), the performance is better if Memory Devices are used; on systems with a fast driver (such as memory mapped display memory, GUIDRV_Lin and others) the use of Memory Devices costs some performance. If 'banding' is needed, the used time to draw a window increases with the number of bands. The more memory available for Memory Devices, the better the performance.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
291
13.7 Basic functions
The following routines are those that are normally called when using Memory Devices. Basic usage is rather simple:
1. Create the Memory Device (using GUI_MEMDEV_Create()). 2. Activate it (using GUI_MEMDEV_Select()). 3. Execute drawing operations. 4. Copy the result into the display (using GUI_MEMDEV_CopyToLCD()). 5. Delete the Memory Device if you no longer need it (using
GUI_MEMDEV_Delete()).
13.8 In order to be able to use Memory Devices...
Memory Devices are enabled by default. In order to optimize performance of the
software, support for Memory Devices can be switched off in the configuration file
GUIConf.h by including the following line:
#define GUI_SUPPORT_MEMDEV
0
If this line is in the configuration file and you want to use Memory Devices, either
delete the line or change the define to 1.
13.9 Multi layer / multi display configurations
As explained earlier in this chapter Memory Devices "compatible" to the display needs to have the same or a higher color depth as the display. When creating a Memory Device compatible to the display emWin "knows" the color depth of the currently selected layer/display and automatically uses the lowest color depth.
13.10 Configuration options
Type
Macro
B GUI_USE_MEMDEV_1BPP_FOR_SCREEN
Default
1
Description
Enables the use of 1bpp Memory Devices with displays of 1bpp color depth.
13.10.1 GUI_USE_MEMDEV_1BPP_FOR_SCREEN
On systems with a display color depth <= 8bpp the default color depth of Memory Devices compatible to the display is 8bpp. To enable the use of 1bpp Memory Devices with displays of 1bpp color depth the following line should be added to the configuration file GUIConf.h:
#define GUI_USE_MEMDEV_1BPP_FOR_SCREEN 0
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
292
CHAPTER
Memory Devices
13.11 Memory device API
The table below lists the available routines of the emWin Memory Device API. All functions are listed in alphabetical order within their respective categories. Detailed descriptions of the routines can be found in the sections that follow.
Routine
Description
Basic functions
GUI_MEMDEV_Clear()
Marks the Memory Device contents as unchanged
GUI_MEMDEV_CopyFromLCD()
Copies contents of LCD to Memory Device
GUI_MEMDEV_CopyToLCD()
Copies contents of Memory Device to LCD
GUI_MEMDEV_CopyToLCDAA() GUI_MEMDEV_CopyToLCDAt() GUI_MEMDEV_Create() GUI_MEMDEV_CreateEx() GUI_MEMDEV_CreateFixed()
Copies the contents of Memory Device antialiased. Copies contents of Memory Device to LCD at the given. position Creates the Memory Device (first step). Creates the Memory Device with additional creation flags. Creates a Memory Device with a given color depth.
GUI_MEMDEV_Delete() GUI_MEMDEV_DrawPerspectiveX() GUI_MEMDEV_GetDataPtr() GUI_MEMDEV_GetXSize()
Frees the memory used by the Memory Device.
Draws the given Memory Device perspectively distorted into the current selected device. Returns a pointer to the data area for direct manipulation.
Returns the X-size (width) of Memory Device.
GUI_MEMDEV_GetYSize()
Returns the Y-size (height) of Memory Device.
GUI_MEMDEV_MarkDirty()
Marks a rectangle area as dirty.
GUI_MEMDEV_ReduceYSize() GUI_MEMDEV_Rotate() GUI_MEMDEV_RotateHQ()
GUI_MEMDEV_RotateHQT() GUI_MEMDEV_Select() GUI_MEMDEV_SerializeBMP()
Reduces Y-size of Memory Device.
Rotates and scales a Memory Device and writes the result into a Memory Device using the 'nearest neighbor' method.
Rotates and scales a Memory Device and writes the result into a Memory Device using the 'high quality' method.
Rotates and scales a Memory Device and writes the result into a Memory Device using the 'high quality' method. (Optimized for images with a large amount of transparent pixels)
Selects a Memory Device as target for drawing operations.
Creates a BMP file from the given Memory Device.
GUI_MEMDEV_SetOrg() GUI_MEMDEV_Write() GUI_MEMDEV_WriteAlpha() GUI_MEMDEV_WriteAlphaAt() GUI_MEMDEV_WriteAt() GUI_MEMEDV_WriteEx()
GUI_MEMDEV_WriteExAt() GUI_SelectLCD()
Changes the origin of the Memory Device on the LCD.
Writes the contents of a Memory Device into a Memory Device. Writes the contents of a Memory Device into a Memory Device using alpha blending. Writes the contents of a Memory Device into a Memory Device using the given position and alpha blending. Writes the contents of a Memory Device into a Memory Device to the given position. Writes the contents of a Memory Device into a Memory Device using alpha blending and scaling. Writes the contents of a Memory Device into a Memory Device to the given position using alpha blending and scaling.
Selects the LCD as target for drawing operations.
Banding Memory Device
GUI_MEMDEV_Draw()
Use a Memory Device for drawing.
Auto device object functions
GUI_MEMDEV_CreateAuto()
Creates an auto device object.
GUI_MEMDEV_DeleteAuto()
Deletes an auto device object.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
293
Routine
Description
GUI_MEMDEV_DrawAuto()
Uses a GUI_AUTODEV object for drawing.
Measurement device object functions
GUI_MEASDEV_ClearRect()
Clears the measurement rectangle.
GUI_MEASDEV_Create()
Creates a measurement device.
GUI_MEASDEV_Delete()
Deletes a measurement device.
GUI_MEASDEV_GetRect()
Retrieves the measurement result.
GUI_MEASDEV_Select()
Selects a measurement device as target for drawing operations.
Animation functions
GUI_MEMDEV_FadeDevices()
Performs fading from one to another Memory Device.
Sets a user defined function to be called while anima-
GUI_MEMDEV_SetAnimationCallback() tions are processed.
Animation functions (Window Manager required)
GUI_MEMDEV_FadeInWindow()
Fades in a window by decreasing the alpha value.
GUI_MEMDEV_FadeOutWindow()
Fades out a window by increasing the alpha value.
GUI_MEMDEV_MoveInWindow()
Moves in a Window from a specified to its actual position by magnification (optionally with rotation).
GUI_MEMDEV_MoveOutWindow()
Moves out a Window from its actual to a specified position by demagnification (optionally with rotation).
GUI_MEMDEV_ShiftInWindow()
Shifts a Window in a specified direction into the screen to its actual position.
GUI_MEMDEV_ShiftOutWindow()
Shifts a Window in a specified direction from its actual position out of the screen.
GUI_MEMDEV_SwapWindow()
Swaps a window with the old content of the target area.
13.12 Basic functions
GUI_MEMDEV_Clear()
Description
Marks the entire contents of a Memory Device as "unchanged".
Prototype
void GUI_MEMDEV_Clear(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to a Memory Device.
Description
Additional information
The next drawing operation with GUI_MEMDEV_CopyToLCD() will then write only the bytes modified between GUI_MEMDEV_Clear() and GUI_MEMDEV_CopyToLCD().
GUI_MEMDEV_CopyFromLCD()
Description
Copies the contents of a Memory Device from LCD data (video memory) to the Memory Device. In other words: Read back the contents of the LCD to the Memory Device.
Prototype
void GUI_MEMDEV_CopyFromLCD(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to a Memory Device.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
294
CHAPTER
Memory Devices
GUI_MEMDEV_CopyToLCD()
Description
Copies the contents of a Memory Device from memory to the LCD.
Prototype void GUI_MEMDEV_CopyToLCD(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to a Memory Device.
Description
Additional information
Do not use this function within a paint callback function called by the Window Manager, because it deactivates the clipping area of the Window Manager. The function GUI_MEMDEV_WriteAt should be used instead.
GUI_MEMDEV_CopyToLCDAA()
Description
Copies the contents of a Memory Device (antialiased) to the LCD.
Prototype
void GUI_MEMDEV_CopyToLCDAA(GUI_MEMDEV_Handle MemDev);
Parameter hMem
Handle to a Memory Device.
Description
Additional information
The device data is handled as antialiased data. A matrix of 2x2 pixels is converted to 1 pixel. The intensity of the resulting pixel depends on how many pixels are set in the matrix.
Example
Creates a Memory Device and selects it for output. A large font is then set and a text is written to the Memory Device: GUI_MEMDEV_Handle hMem = GUI_MEMDEV_Create(0,0,60,32); GUI_MEMDEV_Select(hMem); GUI_SetFont(&GUI_Font32B_ASCII); GUI_DispString("Text"); GUI_MEMDEV_CopyToLCDAA(hMem);
Screen shot of above example
GUI_MEMDEV_CopyToLCDAt()
Description
Copies the contents of a Memory Device to the LCD at the given position.
Prototype
void GUI_MEMDEV_CopyToLCDAt(GUI_MEMDEV_Handle hMem, int x, int y);
Parameter hMem x y
Handle to a Memory Device. Position in X Position in Y
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
295
GUI_MEMDEV_Create()
Description
Creates a Memory Device.
Prototype
GUI_MEMDEV_Handle GUI_MEMDEV_Create(int x0, int y0, int xSize, int ySize);
Parameter x0 y0 xSize ySize
Description
X-position of the Memory Device. Y-position of the Memory Device. X-size of the Memory Device. Y-size of the Memory Device.
Return value
Handle of the created Memory Device. If the routine fails the return value is 0.
GUI_MEMDEV_CreateEx()
Description
Creates a Memory Device.
Prototype
GUI_MEMDEV_Handle GUI_MEMDEV_CreateEx(int x0, int y0, int xSize, int xSize int Flags);
Parameter x0 y0 xsize ysize Flags
Description
x-position of the Memory Device. y-position of the Memory Device. x-size of the Memory Device. y-size of the Memory Device. See table below.
Permitted values for parameter Flags
GUI_MEMDEV_HASTRANS
(recommended)
GUI_MEMDEV_NOTRANS
Default: The Memory Device is created with a transparency flag which ensures that the background will be drawn correctly.
Creates a Memory Device without transparency. The user must make sure that the background is drawn correctly. This way the Memory Device can be used for nonrectangular areas. An other advantage is the higher speed: Using this flag accelerates the Memory Device app. 30 - 50%.
Return value
Handle of the created Memory Device. If the routine fails the return value is 0.
GUI_MEMDEV_CreateFixed()
Description
Creates a Memory Device of fixed size, color depth (bpp) and specified color conversion.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
296
CHAPTER
Memory Devices
Prototype
GUI_MEMDEV_Handle GUI_MEMDEV_CreateFixed( int x0, int y0, int xSize, int ySize, int Flags, const tLCDDEV_APIList * pMemDevAPI, const LCD_API_COLOR_CONV * pColorConvAPI);
Parameter x0 y0 xsize ysize Flags pMemDevAPI pColorConvAPI
X-position of Memory Device. Y-position of Memory Device. X-size of Memory Device. Y-size of Memory Device. See table below. See table below. See table below.
Description
Permitted values for parameter Flags
GUI_MEMDEV_HASTRANS
(recommended)
GUI_MEMDEV_NOTRANS
Default: The Memory Device is created with a transparency flag which ensures that the background will be drawn correctly.
Creates a Memory Device without transparency. The user must make sure that the background is drawn correctly. This way the Memory Device can be used for non-rectangular areas. An other advantage is the higher speed: Using this flag accelerates the Memory Device app. 30 - 50%.
Parameter pMemDevAPI
Defines the color depth of the Memory Device in bpp. The color depth of the Memory Device should be equal or greater than the required bits for the color conversion routines.
A Memory Device with a 1bpp color conversion (GUI_COLOR_CONV_1) for
example requires at least a Memory Device with 1bpp color depth. The available Memory Devices are 1bpp, 8bpp, 16bpp and 32bpp Memory Devices. So an 1bpp Memory Device should be used.
If using a 4 bit per pixel color conversion (GUI_COLOR_CONV_4) at least 4bpp
are needed for the Memory Device. In this case an 8bpp Memory Device should be used.
Permitted values
GUI_MEMDEV_APILIST_1 GUI_MEMDEV_APILIST_8 GUI_MEMDEV_APILIST_16 GUI_MEMDEV_APILIST_32
Create Memory Device with 1bpp color depth (1 byte per 8 pixels) Use if the specified color conversion requires 1bpp.
Create Memory Device with 8bpp color depth (1 byte per pixel) Use if the specified color conversion requires 8bpp or less.
Create Memory Device with 16bpp color depth (1 U16 per pixel) Use if the specified color conversion requires more than 8 bpp. (High color modes)
Create Memory Device with 32bpp color depth (1 U32 per pixel) Use if the specified color conversion requires more than 16 bpp. (True color modes)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
297
Parameter pColorConvAPI
This parameter defines the desired color conversion. For more details about the used bits per pixel and the color conversion, refer to the chapter "Colors" on page 265.
Permitted values
GUICC_1 GUICC_2
Fixed palette mode 1. (black/white) Fixed palette mode 2. (4 gray scales)
GUICC_4 GUICC_565 GUICC_M565
Fixed palette mode 4. (16 gray scales) Fixed palette mode 565. Fixed palette mode M565.
GUICC_8666 GUICC_888 GUICC_8888
Fixed palette mode 8666. Fixed palette mode 888. Fixed palette mode 8888.
Return value
Handle for created Memory Device. If the routine fails the return value is 0.
Additional information
This function can be used if a Memory Device with a specified color conversion should be created. This could make sense if for example some items should be printed on a printer device. The Sample folder contains the code example MEMDEV_Printing.c which shows how to use the function to print something in 1bpp color conversion mode.
Example
The following example shows how to create a Memory Device with 1bpp color depth:
GUI_MEMDEV_Handle hMem; hMem = GUI_MEMDEV_CreateFixed(0, 0, 128, 128, 0,
GUI_MEMDEV_APILIST_1, /* Used API list */ GUI_COLOR_CONV_1); /* Black/white color conversion */ GUI_MEMDEV_Select(hMem);
GUI_MEMDEV_Delete()
Description
Deletes a Memory Device.
Prototype
void GUI_MEMDEV_Delete(GUI_MEMDEV_Handle MemDev);
Parameter hMem
Handle to Memory Device.
Description
Return value
Handle for deleted Memory Device.
GUI_MEMDEV_DrawPerspectiveX()
Description
Draws the given Memory Device perspectively distorted into the currently selected device.
Prototype
void GUI_MEMDEV_DrawPerspectiveX(GUI_MEMDEV_Handle hMem, int x, int y, int h0, int h1, int dx, int dy);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
298
CHAPTER
Memory Devices
Parameter hMem x y h0 h1 dx dy
Description
Handle to source Memory Device with the image to be drawn. Horizontal start position in pixels. Vertical start position in pixels. Height of the leftmost edge of the image to be drawn. Height of the rightmost edge of the image to be drawn. Width of the image to be drawn. Position in y from the topmost pixel at the right relative to the topmost pixel at the left.
The picture below explains the parameters more detailed:
x
dx
y
dy
h0
h1
Image to be drawn
Destination device
Additional information
The function draws the contents of the given Memory Device into the currently selected device. The origin of the source device should be (0, 0). Size and distortion of the new image is defined by the parameters dx, dy, h0 and h1. Note that the function currently only works with Memory Devices with 32-bpp color depth and a system color depth of 32 bpp.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
299
Example
The following example shows how to use the function: GUI_MEMDEV_Handle hMem0, hMem1, hMem2; hMem0 = GUI_MEMDEV_CreateFixed(0, 0, 150, 150, GUI_MEMDEV_NOTRANS,
GUI_MEMDEV_APILIST_32, GUI_COLOR_CONV_888); hMem1 = GUI_MEMDEV_CreateFixed(0, 0, 75, 150, GUI_MEMDEV_HASTRANS, GUI_MEMDEV_APILIST_32, GUI_COLOR_CONV_888); hMem2 = GUI_MEMDEV_CreateFixed(0, 0, 75, 150, GUI_MEMDEV_HASTRANS, GUI_MEMDEV_APILIST_32, GUI_COLOR_CONV_888); GUI_MEMDEV_Select(hMem0); GUI_JPEG_Draw(_aJPEG, sizeof(_aJPEG), 0, 0); GUI_MEMDEV_Select(hMem1); GUI_MEMDEV_DrawPerspectiveX(hMem0, 0, 0, 150, 110, 75, 20); GUI_MEMDEV_Select(hMem2); GUI_MEMDEV_DrawPerspectiveX(hMem0, 0, 20, 110, 150, 75, -20); GUI_MEMDEV_CopyToLCDAt(hMem0, 0, 10); GUI_MEMDEV_CopyToLCDAt(hMem1, 160, 10); GUI_MEMDEV_CopyToLCDAt(hMem2, 245, 10);
Screenshot of the above example
GUI_MEMDEV_GetDataPtr()
Description
Returns a pointer to the data area (image area) of a Memory Device. This data area can then be manipulated without the use of GUI functions; it can for example be used as output buffer for a JPEG or video decompression routine.
Prototype
void * GUI_MEMDEV_GetDataPtr(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to Memory Device.
Description
Additional information
The device data is stored from the returned address onwards. An application modifying this data has to take extreme caution that it does not overwrite memory outside of this data area. If this data area is used with emWins default memory management, the memory area must remain locked as long as the pointer is in use.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
300
CHAPTER
Memory Devices
Organization of the data area:
The pixels are stored in the mode "native" to the display (or layer) for which they are intended. For layers with 8 bpp or less, 8 bits (1 byte) are used per pixel; for layers with more than 8 and less or equal 16 bpp, a 16 bit value (U16) is used for one pixel. The memory is organized in reading order which means: First byte (or U16), stored at the start address, represents the color index of the pixel in the upper left corner (y=0, x=0); the next pixel, stored right after the first one, is the one to the left at (y=0, x=1). (Unless the Memory Device area is only 1 pixel wide). The next line is stored right after the first line in memory, without any kind of padding. Endian mode is irrelevant, it is assumed that 16 bit units are accessed as 16 bit units and not as 2 separate bytes. The data area is comprised of (xSize * ySize) pixels, so xSize * ySize bytes for 8bpp or lower Memory Devices, 2 * xSize * ySize bytes (accessed as xSize * ySize units of 16 bits) for 16 bpp Memory Devices.
GUI_MEMDEV_GetXSize()
Description
Returns the X-size (width) of a Memory Device.
Prototype
int GUI_MEMDEV_GetXSize(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to Memory Device.
Description
GUI_MEMDEV_GetYSize()
Description
Returns the Y-size (height) of a Memory Device in pixels.
Prototype
int GUI_MEMDEV_GetYSize(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to Memory Device.
Description
GUI_MEMDEV_MarkDirty()
Description
Marks a rectangle area as dirty.
Prototype
void GUI_MEMDEV_MarkDirty(GUI_MEMDEV_Handle hMem, int x0, int y0, int x1, int y1);
Parameter hMem x0 y0 x1 y1
Description
Handle to the Memory Device. x-coordinate of the upper left corner. y-coordinate of the upper left corner. x-coordinate of the lower right corner. y-coordinate of the lower right corner.
GUI_MEMDEV_ReduceYSize()
Description
Reduces the Y-size of a Memory Device.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
301
Prototype
void GUI_MEMDEV_ReduceYSize(GUI_MEMDEV_Handle hMem, int YSize);
Parameter hMem YSize
Description
Handle to Memory Device. New Y-size of the Memory Device.
Additional information
Changing the size of the Memory Device is more efficient than deleting and then recreating it.
GUI_MEMDEV_Rotate(), GUI_MEMDEV_RotateHQ(), GUI_MEMDEV_RotateHQT()
Description
The functions rotate and scale the given source Memory Device. The source device will be rotated and scaled around its center and then shifted by the given amount of pixels. The result is saved into the given destination Memory Device. The difference between the functions GUI_MEMDEV_Rotate() and GUI_MEMDEV_RotateHQ() both functions is the algorithm for calculating the destination pixel data. GUI_MEMDEV_Rotate() uses the 'nearest neighbor' method which is fast but less accurate. GUI_MEMDEV_RotateHQ() uses a more complex method which is quite accurate but not as fast as the 'nearest neighbor' method. For a more detailed impression of the difference between the functions there are two screenshots at the end of this function description. The performance of the function GUI_MEMDEV_RotateHQT() has been optimized for images with a large amount of completely transparent pixels. It could get a better performance result if the image has more than 10% completely transparent pixels.
Prototypes
void GUI_MEMDEV_Rotate (GUI_MEMDEV_Handle hSrc, GUI_MEMDEV_Handle hDst,
int dx, int dy, int a, int Mag);
void GUI_MEMDEV_RotateHQ (GUI_MEMDEV_Handle hSrc, GUI_MEMDEV_Handle hDst, int dx, int dy, int a, int Mag);
void GUI_MEMDEV_RotateHQT(GUI_MEMDEV_Handle hSrc, GUI_MEMDEV_Handle hDst, int dx, int dy, int a, int Mag);
Parameter hSrc hDst dx dy a Mag
Description
Handle of Memory Device to be rotated and scaled. Handle of destination device. Distance in pixels for shifting the image in X. Distance in pixels for shifting the image in Y. Angle to be used for rotation in degrees * 1000. Magnification factor * 1000
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
302
CHAPTER
Memory Devices
The following picture gives a more detailed impression of the parameters:
Image to be drawn
@
dx Destination device
dy
a
Additional information
Both Memory Devices, source and destination, need to be created using a color depth of 32bpp. Further GUI_MEMDEV_NOTRANS should be used as Flags parameter when creating the devices. The Sample folder also contains the example MEMDEV_ZoomAndRotate.c which shows how the function can be used in detail.
Performance advantage of GUI_MEMDEV_RotateHQT()
The following table shows an approximation of the performance in comparison to
GUI_MEMDEV_RotateHQ() in dependence of the percentage of transparent pixels:
Percentage of transparent pixels 0%
10% 50% 90%
Performance advantage - 3% 0% +21% +74%
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
303
Example
GUI_MEMDEV_Handle hMemSource; GUI_MEMDEV_Handle hMemDest; GUI_RECT RectSource = {0, 0, 69, 39}; GUI_RECT RectDest = {0, 0, 79, 79}; hMemSource = GUI_MEMDEV_CreateFixed(RectSource.x0, RectSource.y0,
RectSource.x1 - RectSource.x0 + 1, RectSource.y1 - RectSource.y0 + 1, GUI_MEMDEV_NOTRANS, GUI_MEMDEV_APILIST_32, GUI_COLOR_CONV_888); hMemDest = GUI_MEMDEV_CreateFixed(RectDest.x0, RectDest.y0, RectDest.x1 - RectDest.x0 + 1, RectDest.y1 - RectDest.y0 + 1, GUI_MEMDEV_NOTRANS, GUI_MEMDEV_APILIST_32, GUI_COLOR_CONV_888); GUI_MEMDEV_Select(hMemSource); GUI_DrawGradientV(RectSource.x0, RectSource.y0, RectSource.x1, RectSource.y1, GUI_WHITE, GUI_DARKGREEN); GUI_SetColor(GUI_BLUE); GUI_SetFont(&GUI_Font20B_ASCII); GUI_SetTextMode(GUI_TM_TRANS); GUI_DispStringInRect("emWin", &RectSource, GUI_TA_HCENTER | GUI_TA_VCENTER); GUI_DrawRect(0, 0, RectSource.x1, RectSource.y1); GUI_MEMDEV_RotateHQ(hMemSource, hMemDest, (RectDest.x1 - RectSource.x1) / 2, (RectDest.y1 - RectSource.y1) / 2, 30 * 1000, 1000); GUI_MEMDEV_CopyToLCDAt(hMemSource, 10, (RectDest.y1 - RectSource.y1) / 2); GUI_MEMDEV_CopyToLCDAt(hMemDest, 100, 0);
Screenshot of the above example using GUI_MEMDEV_RotateHQ()
Screenshot of the above example using GUI_MEMDEV_Rotate()
GUI_MEMDEV_Select()
Description
Activates a Memory Device (or activates LCD if handle is 0)
Prototype void GUI_MEMDEV_Select(GUI_MEMDEV_Handle hMem)
Parameter hMem
Handle to Memory Device.
Description
GUI_MEMDEV_SerializeBMP()
Description
Creates a BMP file from the given Memory Device.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
304
CHAPTER
Memory Devices
Prototype
void GUI_MEMDEV_SerializeBMP(GUI_MEMDEV_Handle
hDev,
GUI_CALLBACK_VOID_U8_P * pfSerialize,
void
* p);
Parameter hDev pfSerialize p
Description
Handle to Memory Device. Pointer to a user defined serialization function. See prototype below. Pointer to user defined data passed to the serialization function.
Prototype of GUI_CALLBACK_VOID_U8_P
void GUI_CALLBACK_VOID_U8_P(U8 Data, void * p);
Additional information
To create a BMP file the color depth of the given Memory Device is used. In case it is 32bpp the resulting BMP file will consist of valid alpha data which is recognized by the Bitmap Converter. An example for serialization can be found in the description of "GUI_BMP_Serialize()" on page 152.
GUI_MEMDEV_SetOrg()
Description
Changes the origin of the Memory Device on the LCD.
Prototype
void GUI_MEMDEV_SetOrg(GUI_MEMDEV_Handle hMem, int x0, int y0);
Parameter hMem x0 y0
Description
Handle to Memory Device. Horizontal position (of the upper left pixel). Vertical position (of the upper left pixel).
Additional information
This routine can be helpful when the same device is used for different areas of the screen or when the contents of the Memory Device are to be copied into different areas. Changing the origin of the Memory Device is more efficient than deleting and then recreating it.
GUI_MEMDEV_Write()
Description
Writes the contents of the given Memory Device into the currently selected device.
Prototype
void GUI_MEMDEV_Write(GUI_MEMDEV_Handle hMem);
Parameter hMem
Handle to Memory Device.
Description
GUI_MEMDEV_WriteAlpha()
Description
Writes the contents of the given Memory Device into the currently selected device using alpha blending.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
305
Prototype
void GUI_MEMDEV_WriteAlpha(GUI_MEMDEV_Handle hMem, int Alpha);
Parameter hMem Alpha
Handle to Memory Device. Alpha blending factor, 0 - 255
Description
Additional information
Alpha blending means mixing 2 colors with a given intensity. This function makes it possible to write semi-transparent from one Memory Device into an other Memory Device. The Alpha-parameter specifies the intensity used when writing to the currently selected Memory Device.
GUI_MEMDEV_WriteAlphaAt()
Description
Writes the contents of the given Memory Device into the currently selected device at the specified position using alpha blending.
Prototype
void GUI_MEMDEV_WriteAlphaAt(GUI_MEMDEV_Handle hMem, int Alpha, int x, int y);
Parameter hMem Alpha x y
Handle to Memory Device. Alpha blending factor, 0 - 255 Position in X Position in Y
Description
Additional information
(See GUI_MEMDEV_WriteAlpha)
GUI_MEMDEV_WriteAt()
Description
Writes the contents of the given Memory Device into the currently selected device at the specified position.
Prototype
void GUI_MEMDEV_WriteAt(GUI_MEMDEV_Handle hMem, int x, int y);
Parameter hMem x y
Handle to Memory Device. Position in X Position in Y
Description
GUI_MEMDEV_WriteEx()
Description
Writes the contents of the given Memory Device into the currently selected device at position (0, 0) using alpha blending and scaling.
Prototype
void GUI_MEMDEV_WriteEx(GUI_MEMDEV_Handle hMem,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
306
CHAPTER
Memory Devices
int xMag, int yMag, int Alpha);
Parameter hMem xMag yMag Alpha
Handle to Memory Device. Scaling factor for X-axis * 1000. Scaling factor for Y-axis * 1000. Alpha blending factor, 0 - 255.
Description
Additional information
A negative scaling factor mirrors the output. Also Refer to "GUI_MEMDEV_WriteExAt()" below.
GUI_MEMDEV_WriteExAt()
Description
Writes the contents of the given Memory Device into the currently selected device at the specified position using alpha blending and scaling.
Prototype
void GUI_MEMDEV_WriteExAt(GUI_MEMDEV_Handle hMem, int x, int y, int xMag, int yMag, int Alpha);
Parameter hMem x y xMag yMag Alpha
Handle to Memory Device. Position in X. Position in Y. Scaling factor for X-axis * 1000. Scaling factor for Y-axis * 1000. Alpha blending factor, 0 - 255.
Description
Additional information
A negative scaling factor mirrors the output.
Example
The following example creates 2 Memory Devices: hMem0 (40x10) and hMem1 (80x20). A small white text is drawn at the upper left position of hMem0 and hMem1. Then the function GUI_MEMDEV_WriteEx() writes the contents of hMem0 to hMem1 using mirroring and magnifying:
GUI_MEMDEV_Handle hMem0, hMem1; GUI_Init(); hMem0 = GUI_MEMDEV_Create(0, 0, 40, 10); hMem1 = GUI_MEMDEV_Create(0, 0, 80, 20); GUI_MEMDEV_Select(hMem0); GUI_SetTextMode(GUI_TM_TRANS); GUI_DispString("Text"); GUI_MEMDEV_Select(hMem1); GUI_SetBkColor(GUI_RED); GUI_Clear(); GUI_DispStringAt("Text", 0, 0); GUI_MEMDEV_WriteExAt(hMem0, 0, 0, -2000, -2000, 160); GUI_MEMDEV_CopyToLCD(hMem1);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
307
Screenshot of the above example
GUI_SelectLCD()
Description
Selects the LCD as target for drawing operations.
Prototype
void GUI_SelectLCD(void))
Example for using a Memory Device
The Sample folder contains the following example which shows how Memory Devices can be used: · MEMDEV_MemDev.c This example demonstrates the use of a Memory Device. Some items are written to a Memory Device and then copied to the display. Note that several other examples also make use of Memory Devices and may also be helpful to get familiar with them.
Screenshot of the above example:
13.13 Banding Memory Device
A Memory Device is first filled by executing the specified drawing functions. After filling the device, the contents are drawn to the LCD. There may be note enough memory available to store the complete output area at once, depending on your configuration. A banding Memory Device divides the drawing area into bands, in which each band covers as many lines as possible with the currently available memory.
GUI_MEMDEV_Draw()
Description
Drawing function to avoid flickering.
Prototype
int GUI_MEMDEV_Draw(GUI_RECT * pRect, GUI_CALLBACK_VOID_P * pfDraw,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
308
CHAPTER
Memory Devices
void int
* pData, int Flags)
NumLines,
Parameter pRect pfDraw pData NumLines Flags
Description
Pointer to a GUI_RECT structure for the used LCD area. Pointer to a callback function for executing the drawing. Pointer to a data structure used as parameter for the callback function. 0 (recommended) or number of lines for the Memory Device. See table below.
Permitted values for parameter Flags
GUI_MEMDEV_HASTRANS
GUI_MEMDEV_NOTRANS (recommended)
Default: The Memory Device is created with a transparency flag which ensures that the background will be drawn correctly.
Creates a Memory Device without transparency. The user must make sure that the background is drawn correctly. Should be used for optimization purposes only.
Return value
0 if successful, 1 if the routine fails.
Additional information
If the parameter NumLines is 0, the number of lines in each band is calculated automatically by the function. The function then iterates over the output area band by band by moving the origin of the Memory Device.
Example for using a banding Memory Device
The Sample folder contains the following example which shows how the function can be used: · MEMDEV_Banding.c
Screen shot of above example
13.14 Auto device object
Memory Devices are useful when the display must be updated to reflect the movement or changing of items, since it is important in such applications to prevent the LCD from flickering. An auto device object is based on the banding Memory Device, and may be more efficient for applications such as moving indicators, in which only a small part of the display is updated at a time. The device automatically distinguishes which areas of the display consist of fixed objects and which areas consist of moving or changing objects that must be updated. When the drawing function is called for the first time, all items are drawn. Each further call updates only the space used by the moving or changing objects. The actual
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
309
drawing operation uses the banding Memory Device, but only within the necessary space. The main advantage of using an auto device object (versus direct usage of a banding Memory Device) is that it saves computation time, since it does not keep updating the entire display.
GUI_MEMDEV_CreateAuto()
Description
Creates an auto device object.
Prototype
int GUI_MEMDEV_CreateAuto(GUI_AUTODEV * pAutoDev);
Parameter pAutoDev
Description
Pointer to a GUI_AUTODEV object.
Return value
Currently 0, reserved for later use.
GUI_MEMDEV_DeleteAuto()
Description
Deletes an auto device object.
Prototype
void GUI_MEMDEV_DeleteAuto(GUI_AUTODEV * pAutoDev);
Parameter pAutoDev
Description
Pointer to a GUI_AUTODEV object.
GUI_MEMDEV_DrawAuto()
Description
Executes a specified drawing routine using a banding Memory Device.
Prototype
int GUI_MEMDEV_DrawAuto(GUI_AUTODEV
* pAutoDev,
GUI_AUTODEV_INFO * pAutoDevInfo,
GUI_CALLBACK_VOID_P * pfDraw,
void
* pData);
Parameter
Description
pAutoDev pAutoDevInfo pfDraw pData
Pointer to a GUI_AUTODEV object. Pointer to a GUI_AUTODEV_INFO object. Pointer to the user-defined drawing function which is to be executed. Pointer to a data structure passed to the drawing function.
Return value
0 if successful, 1 if the routine fails.
Additional information
The GUI_AUTODEV_INFO structure contains the information about what items must be drawn by the user function:
typedef struct { char DrawFixed;
} GUI_AUTODEV_INFO;
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
310
CHAPTER
Memory Devices
DrawFixed is set to 1 if all items have to be drawn. It is set to 0 when only the moving or changing objects have to be drawn. We recommend the following procedure when using this feature:
typedef struct { GUI_AUTODEV_INFO AutoDevInfo; /* Information about what has to be drawn */ /* Additional data used by the user function */ ...
} PARAM;
static void Draw(void * p) { PARAM * pParam = (PARAM *)p; if (pParam->AutoDevInfo.DrawFixed) { /* Draw fixed background */ ... } /* Draw moving objects */ ... if (pParam->AutoDevInfo.DrawFixed) { /* Draw fixed foreground (if needed) */ ... }
}
void main(void) {
PARAM Param;
/* Parameters for drawing routine */
GUI_AUTODEV AutoDev;
/* Object for banding Memory Device */
/* Set/modify informations for drawing routine */
...
GUI_MEMDEV_CreateAuto(&AutoDev); /* Create GUI_AUTODEV-object */
GUI_MEMDEV_DrawAuto(&AutoDev, /* Use GUI_AUTODEV-object for drawing */
&Param.AutoDevInfo,
&Draw,
&Param);
GUI_MEMDEV_DeleteAuto(&AutoDev); /* Delete GUI_AUTODEV-object */
}
Example for using an auto device object
The example MEMDEV_AutoDev.c demonstrates the use of an auto device object. It can be found as MEMDEV_AutoDev.c. A scale with a moving needle is drawn in the background and a small text is written in the foreground. The needle is drawn with the antialiasing feature of emWin. High-resolution antialiasing is used here to improve the appearance of the moving needle. For more information, see the chapter "Antialiasing" on page 889.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
311
Screen shot of above example
13.15 Measurement device object
Measurement devices are useful when you need to know the area used to draw something. Creating and selecting a measurement device as target for drawing operations makes it possible to retrieve the rectangle used for drawing operations.
GUI_MEASDEV_ClearRect()
Description
Call this function to clear the measurement rectangle of the given measurement device.
Prototype
void GUI_MEASDEV_ClearRect(GUI_MEASDEV_Handle hMem);
Parameter hMem
Handle to measurement device.
Description
GUI_MEASDEV_Create()
Description
Creates a measurement device.
Prototype
GUI_MEASDEV_Handle GUI_MEASDEV_Create(void);
Return value
The handle of the measurement device.
GUI_MEASDEV_Delete()
Description
Deletes a measurement device.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
312
CHAPTER
Memory Devices
Prototype
void GUI_MEASDEV_Delete (GUI_MEASDEV_Handle hMem);
Parameter hMem
Handle to measurement device.
Description
GUI_MEASDEV_GetRect()
Description
Retrieves the result of the drawing operations.
Prototype
void GUI_MEASDEV_GetRect(GUI_MEASDEV_Handle hMem, GUI_RECT *pRect);
Parameter hMem pRect
Description
Handle to measurement device. Pointer to GUI_RECT-structure to store result.
GUI_MEASDEV_Select()
Description
Selects a measurement device as target for drawing operations.
Prototype
void GUI_MEASDEV_Select (GUI_MEASDEV_Handle hMem);
Parameter hMem
Handle to measurement device.
Description
Example
The following example shows the use of a measurement device. It creates a measurement device, draws a line and displays the result of the measurement device:
void MainTask(void) { GUI_MEASDEV_Handle hMeasdev; GUI_RECT Rect; GUI_Init(); hMeasdev = GUI_MEASDEV_Create(); GUI_MEASDEV_Select(hMeasdev); GUI_DrawLine(10, 20, 30, 40); GUI_SelectLCD(); GUI_MEASDEV_GetRect(hMeasdev, &Rect); GUI_MEASDEV_Delete(hMeasdev); GUI_DispString("X0:"); GUI_DispDec(Rect.x0, 3); GUI_DispString(" Y0:"); GUI_DispDec(Rect.y0, 3); GUI_DispString(" X1:"); GUI_DispDec(Rect.x1, 3); GUI_DispString(" Y1:"); GUI_DispDec(Rect.y1, 3);
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
313
Screenshot of the above example:
13.16 Animation functions
Animations can be used to inject some life into the application. They will always help to let the user's eye smoothly capture what happens. All animation functions require 32-bit devices.
GUI_MEMDEV_FadeDevices()
Description
Performs fading from one to another Memory Device.
Prototype
int GUI_MEMDEV_FadeDevices(GUI_MEMDEV_Handle hMem0,
GUI_MEMDEV_Handle hMem1,
int
Period);
Parameter hMem0 hMem1 Period
Description
Handle to the Memory Device which has to be faded out. Handle to the Memory Device which has to be faded in. Time period in which the fading is processed.
Return value
0 if successful, 1 if the function fails.
Additional Information
Please note that this function only processes if hMem0 and hMem1 are of the same size and are located at the same position on the screen.
Example
For an example on using the fading functions, please refer to "MEMDEV_FadingPerformance.c" which can be found in "emWin\Sample\Tutorial".
Screenshots
GUI_MEMDEV_SetAnimationCallback()
Description
Sets a user defined callback function to be called while animations are processed. The function should contain code to determine whether processing of the current animation shall go on or abort.
Prototype
void GUI_MEMDEV_SetAnimationCallback(
GUI_ANIMATION_CALLBACK_FUNC * pCbAnimation,
void
* pVoid);
Parameter
Description
pCbAnimation Pointer to the user defined callback function.
pVoid
Data pointer.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
314
CHAPTER
Memory Devices
Additional Information
The callback function is called every time an animation function has just copied the actual step to the screen.
Example
The following example shows the use of a GUI_ANIMATION_CALLBACK_FUNC, which gives the possibility to react on PID events:
static int _cbAnimation(int TimeRem, void * pVoid) {
int
Pressed;
if (TimeRem /* Insert Condition */) {
/* ... React on remaining Time ... */
}
Pressed = _GetButtonState();
if (Pressed) {
return 1; // Button was
pressed, stop
animation
} else {
return 0; // Button was not pressed, continue animation
}
}
void main(void) { GUI_Init(); GUI_MEMDEV_SetAnimationCallback(_cbAnimation, (void *)&_Pressed); while (1) { /* Do animations... */ }
}
13.17 Animation functions (Window Manager required)
The following animation functions require usage of the Window Manager.
GUI_MEMDEV_FadeInWindow()
GUI_MEMDEV_FadeOutWindow()
Description
Fades in/out a window by decreasing/increasing the alpha value
Prototype
int GUI_MEMDEV_FadeInWindow (WM_HWIN hWin, int Period); int GUI_MEMDEV_FadeOutWindow(WM_HWIN hWin, int Period);
Parameter hWin Period
Description
Handle to the window which has to be faded in/out Time period in which the fading is processed
Return value
0 if successful, 1 if the function fails.
Additional Information
Please note that the state of the current desktop and its child windows is 'valid' after calling this function.
Example
For an example on using the fading functions, please refer to "SKINNING_NestedModal.c" which can be found in your "emWin\Sample" folder.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
315
Screenshots
GUI_MEMDEV_MoveInWindow()
GUI_MEMDEV_MoveOutWindow()
Description
Moves a window into/out of the screen. First the window is drawn minimized/maximized at the specified position/its actual position and then moved to its actual position/the specified position while magnifying to its actual size/demagnifying. The window can be spun clockwise as well as counterclockwise while it is moving.
Prototype
int GUI_MEMDEV_MoveInWindow (WM_HWIN hWin, int x, int y, int a180, int Period);
int GUI_MEMDEV_MoveOutWindow(WM_HWIN hWin, int x, int y, int a180, int Period);
Parameter hWin x y
a180
Period
Description
Handle to the window which has to be moved
Position in x from/to where the window is moved
Position in y from/to where the window is moved Count of degrees the window will be spun for: a180 = 0 -> no spinning a180 > 0 -> clockwise a180 < 0 -> counterclockwise Time period in which the moving is processed
Return value
0 if successful, 1 if the function fails.
Additional Information
Please note that the state of the current desktop and its child windows is 'valid' after calling this function. GUI_MEMDEV_MoveInWindow() / GUI_MEMDEV_MoveOutWindow() requires approximately 1 MB of dynamic memory to run properly in QVGA mode.
Example
For
an
example
on
using
GUI_MEMDEV_MoveInWindow()
and
GUI_MEMDEV_MoveOutWindow(), please refer to "SKINNING_NestedModal.c" which
can be found in your "emWin\Sample" folder.
Screenshots
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
316
CHAPTER
Memory Devices
GUI_MEMDEV_ShiftInWindow()
GUI_MEMDEV_ShiftOutWindow()
Description
Shifts a Window in a specified direction into/out of the screen to/from its actual position.
Prototype
int GUI_MEMDEV_ShiftInWindow (WM_HWIN hWin, int Period, int Direction); int GUI_MEMDEV_ShiftOutWindow(WM_HWIN hWin, int Period, int Direction);
Parameter hWin Period Direction
Description
Handle to the window which has to be shifted. Time period in which the shifting is processed. See permitted values for this parameter below.
Permitted values for parameter Direction
GUI_MEMDEV_EDGE_LEFT Shift window to the left.
GUI_MEMDEV_EDGE_RIGHT GUI_MEMDEV_EDGE_TOP GUI_MEMDEV_EDGE_BOTTOM
Shift window to the right. Shift window to the top. Shift window to the bottom.
Return value
0 if successful, 1 if the function fails.
Additional Information
Please note that the state of the current desktop and its child windows is 'valid' after
a window has been shifted. GUI_MEMDEV_ShiftInWindow()
and
GUI_MEMDEV_ShiftOutWindow() require approximately 1 MB of dynamic memory to
run properly in QVGA mode.
Example
For
an
example
on
using
GUI_MEMDEV_ShiftInWindow()
and
GUI_MEMDEV_ShiftOutWindow(), please refer to "SKINNING_Notepad.c" which can
be found in your "emWin\Sample" folder.
Screenshots
GUI_MEMDEV_SwapWindow()
Description
Swaps a window with the old content of the target area.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
317
Prototype
int GUI_MEMDEV_SwapWindow(WM_HWIN hWin, int Period, int Edge);
Parameter hWin Period Edge
Description
Handle to the window which has to be shifted. Time period in which the shifting is processed. See permitted values for this parameter below.
Permitted values for parameter Direction
GUI_MEMDEV_EDGE_LEFT GUI_MEMDEV_EDGE_RIGHT GUI_MEMDEV_EDGE_TOP GUI_MEMDEV_EDGE_BOTTOM
Shift window to the left. Shift window to the right. Shift window to the top. Shift window to the bottom.
Return value
0 if successful, 1 if the function fails.
Additional Information
Please note that the state of the current desktop and its child windows is 'valid' after a window has been swapped. GUI_MEMDEV_SwapWindow() requires approximately 1 MB of dynamic memory to run properly in QVGA mode.
Screenshots
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
318
CHAPTER
Memory Devices
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
319
Chapter 14 Execution Model: Single Task / Multitask
emWin has been designed from the beginning to be compatible with different types of environments. It works in single task and in multitask applications, with a proprietary operating system or with any commercial RTOS such as embOS or uC/OS.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
320
CHAPTER
Execution Model: Single Task / Multitask
14.1 Supported execution models
We have to basically distinguish between 3 different execution models:
Single task system (superloop)
The entire program runs in one superloop. Normally, all software components are periodically called. Interrupts must be used for real time parts of the software since no real time kernel is used.
Multitask system: one task calling emWin
A real time kernel (RTOS) is used, but only one task calls emWin functions. From the graphic software's point of view, it is the same as being used in a single task system.
Multitask system: multiple tasks calling emWin
A real time kernel (RTOS) is used, and multiple tasks call emWin functions. This works without a problem as long as the software is made thread-safe, which is done by enabling multitask support in the configuration and adapting the kernel interface routines. For popular kernels, the kernel interface routines are readily available.
14.2 Single task system (superloop)
14.2.1 Description
The entire program runs in one superloop. Normally, all components of the software are periodically called. No real time kernel is used, so interrupts must be used for real time parts of the software. This type of system is primarily used in smaller systems or if real time behavior is not critical.
14.2.2 Superloop example (without emWin)
void main (void) { HARDWARE_Init();
/* Init software components */ XXX_Init(); YYY_Init();
/* Superloop: call all software components regularily */ while (1) {
/* Exec all compontents of the software */ XXX_Exec(); YYY_Exec(); } }
14.2.3 Advantages
No real time kernel is used (-> smaller ROM size, just one stack -> less RAM for stacks), no preemption/synchronization problems.
14.2.4 Disadvantages
The superloop type of program can become hard to maintain if it exceeds a certain program size. Real time behavior is poor, since one software component cannot be interrupted by any other component (only by interrupts). This means that the reaction time of one software component depends on the execution time of all other components in the system.
14.2.5 Using emWin
There are no real restrictions regarding the use of emWin. As always, GUI_Init() has to be called before you can use the software. From there on, any API function can be used. If the Window Manager's callback mechanism is used, then an emWin update function has to be called regularly. This is typically done by calling the
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
321
GUI_Exec() from within the superloop. Blocking functions such as GUI_Delay() and GUI_ExecDialog() should not be used in the loop since they would block the other software modules. The default configuration, which does not support multitasking (#define GUI_OS 0) can be used; kernel interface routines are not required.
14.2.6 Superloop example (with emWin)
void main (void) { HARDWARE_Init();
/* Init software components */
XXX_Init();
YYY_Init();
GUI_Init();
/* Init emWin */
/* Superloop: call all software components regularily */
while (1) {
/* Exec all compontents of the software */
XXX_Exec();
YYY_Exec();
GUI_Exec();
/* Exec emWin for functionality like updating windows */
}
}
14.3 Multitask system: one task calling emWin
14.3.1 Description
A real time kernel (RTOS) is used. The user program is split into different parts, which execute in different tasks and typically have different priorities. Normally the real time critical tasks (which require a certain reaction time) will have the highest priorities. One single task is used for the user interface, which calls emWin functions. This task usually has the lowest priority in the system or at least one of the lowest (some statistical tasks or simple idle processing may have even lower priorities). Interrupts can, but do not have to be used for real time parts of the software.
14.3.2 Advantages
The real time behavior of the system is excellent. The real time behavior of a task is affected only by tasks running at higher priority. This means that changes to a program component running in a low priority task do not affect the real time behavior at all. If the user interface is executed from a low priority task, this means that changes to the user interface do not affect the real time behavior. This kind of system makes it easy to assign different components of the software to different members of the development team, which can work to a high degree independently from each other.
14.3.3 Disadvantages
You need to have a real time kernel (RTOS), which costs money and uses up ROM and RAM (for stacks). In addition, you will have to think about task synchronization and how to transfer information from one task to another.
14.3.4 Using emWin
If the Window Manager's callback mechanism is used, then an emWin update function (typically GUI_Exec(), GUI_Delay()) has to be called regularly from the task calling emWin. Since emWin is only called by one task, to emWin it is the same as being used in a single task system. The default configuration, which does not support multitasking (#define GUI_OS 0) can be used; kernel interface routines are not required. You can use any real time kernel, commercial or proprietary.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
322
CHAPTER
Execution Model: Single Task / Multitask
14.4 Multitask system: multiple tasks calling emWin
14.4.1 Description
A real time kernel (RTOS) is used. The user program is split into different parts, which execute in different tasks with typically different priorities. Normally the real time critical tasks (which require a certain reaction time) will have the highest priorities. Multiple tasks are used for the user interface, calling emWin functions. These tasks typically have low priorities in the system, so they do not affect the real time behavior of the system. Interrupts can, but do not have to be used for real time parts of the software.
14.4.2 Advantages
The real time behavior of the system is excellent. The real time behavior of a task is affected only by tasks running at higher priority. This means that changes of a program component running in a low priority task do not affect the real time behavior at all. If the user interface is executed from a low priority task, this means that changes on the user interface do not affect the real time behavior. This kind of system makes it easy to assign different components of the software to different members of the development team, which can work to a high degree independently from each other.
14.4.3 Disadvantages
You have to have a real time kernel (RTOS), which costs money and uses up some ROM and RAM (for stacks). In addition, you will have to think about task synchronization and how to transfer information from one task to another.
14.4.4 Using emWin
If the Window Manager's callback mechanism is used, then an emWin update function (typically GUI_Exec(), GUI_Delay()) has to be called regularly from one or more tasks calling emWin. The default configuration, which does not support multitasking (#define GUI_OS 0) can NOT be used. The configuration needs to enable multitasking support and define a maximum number of tasks from which emWin is called (excerpt from GUIConf.h):
#define GUI_OS
1
#define GUI_MAXTASK 5
// Enable multitasking support // Max. number of tasks that may call emWin
Kernel interface routines are required, and need to match the kernel being used. You can use any real time kernel, commercial or proprietary. Both the macros and the routines are discussed in the following chapter sections.
14.4.5 Recommendations
· Call the emWin update functions (that is, GUI_Exec(), GUI_Delay()) from just one task. It will help to keep the program structure clear. If you have sufficient RAM in your system, dedicate one task (with the lowest priority) to updating emWin. This task will continuously call GUI_Exec() as shown in the example below and will do nothing else.
· Keep your real time tasks (which determine the behavior of your system with respect to I/O, interface, network, etc.) separate from tasks that call emWin. This will help to assure best real time performance.
· If possible, use only one task for your user interface. This helps to keep the program structure simple and simplifies debugging. (However, this is not required and may not be suitable in some systems.)
14.4.6 Example
This excerpt shows the dedicated emWin update task. It is taken from the example MT_Multitasking, which is included in the examples shipped with emWin:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
323
/*******************************************************************
*
*
GUI background processing
*
* This task does the background processing.
* The main job is to update invalid windows, but other things such as
* evaluating mouse or touch input may also be done.
*/
void GUI_Task(void) {
while(1) {
GUI_Exec();
/* Do the background work ... Update windows etc.) */
GUI_X_ExecIdle();
/* Nothing left to do for the moment ... Idle processing */
}
}
14.5 Configuration functions for multitasking support
The following table shows the configuration functions available for a multitask system with multiple tasks calling emWin:
Routine
Description
GUI_SetSignalEventFunc()
Sets a function that signals an event.
GUI_SetWaitEventFunc()
Sets a function that waits for an event.
GUI_SetWaitEventTimedFunc() Sets a function that waits for an event for a given period of time.
GUI_SetSignalEventFunc()
Description
Sets a function that signals an event.
Prototype
void GUI_SetSignalEventFunc(GUI_SIGNAL_EVENT_FUNC pfSignalEvent);
Parameter pfSignalEvent
Description
Pointer to a function that signals an event.
Definition of GUI_SIGNAL_EVENT_FUNC
typedef void (* GUI_SIGNAL_EVENT_FUNC)(void);
Additional information
Per default the GUI needs to periodically check for events unless a function is defined which waits and one that triggers an event. This function sets the function which triggers an event. It makes only sense in combination with GUI_SetWaitEventFunc(). and GUI_SetWaitEventTimedFunc(). The advantage of using these functions instead of polling is the reduction of CPU load of the waiting task to 0% while it waits for input. If the function has been specified as recommended and the user gives the system any input (keyboard or pointer input device) the specified function should signal an event. It is recommended to specify the function GUI_X_SignalEvent() for the job.
Example
GUI_SetSignalEventFunc(GUI_X_SignalEvent);
GUI_SetWaitEventFunc()
Description
Sets a function which waits for an event.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
324
CHAPTER
Execution Model: Single Task / Multitask
Prototype
void GUI_SetWaitEventFunc(GUI_WAIT_EVENT_FUNC pfWaitEvent);
Parameter
Description
pfWaitEvent Pointer to a function that waits for an event.
Definition of GUI_SIGNAL_EVENT_FUNC
typedef void (* GUI_WAIT_EVENT_FUNC)(void);
Additional information
Per default the GUI needs to periodically check for events unless a function is defined which waits and one that triggers an event. This function sets the function which waits for an event. Makes only sense in combination with GUI_SetSignalEventFunc() and GUI_SetWaitEventTimedFunc(). The advantage of using these functions instead of polling is the reduction of CPU load of the waiting task to 0% while it waits for input. If the function has been specified as recommended and the system waits for user input the defined function should wait for an event signaled from the function specified by GUI_SetSignalEventFunc(). It is recommended to specify the function GUI_X_WaitEvent() for the job.
Example
GUI_SetWaitEventFunc(GUI_X_WaitEvent);
GUI_SetWaitEventTimedFunc()
Description
Defines a function which waits for an event for a dedicated period of time.
Prototype
void GUI_SetWaitEventTimedFunc(GUI_WAIT_EVENT_TIMED_FUNC pfWaitEventTimed);
Parameter
Description
pfWaitEventTimed Pointer to a function that waits for an event.
Definition of GUI_WAIT_EVENT_TIMED_FUNC
typedef void (* GUI_WAIT_EVENT_TIMED_FUNC)(int Period);
Parameter
Description
Period
Period in ms to wait for an event.
Additional information
Per default the GUI needs to periodically check for events unless a function is defined which waits and one that triggers an event. This function sets the function which waits for an event if a timer is active. Makes only sense in combination with GUI_SetSignalEventFunc() and GUI_SetWaitEventFunc(). If the function has been specified as recommended and the system waits for user input during a timer is active the defined function should wait until the timer expires or an event signaled from the function set by GUI_SetSignalEventFunc(). It is recommended to specify the function GUI_X_WaitEventTimed() for the job.
Example
GUI_SetWaitEventTimedFunc(GUI_X_WaitEventTimed);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
325
14.6 Configuration macros for multitasking support
The following table shows the configuration macros used for a multitask system with multiple tasks calling emWin:
Type
Macro
Default
N
GUI_MAXTASK
4
B
GUI_OS
0
F
GUI_X_SIGNAL_EVENT
-
F
GUI_X_WAIT_EVENT
GUI_X_ExecIdle
F
GUI_X_WAIT_EVENT_TIMED -
Explanation
Defines the maximum number of tasks from which emWin is called when multitasking support is enabled.
Activate to enable multitasking support.
Defines a function that signals an event. (Obsolete) Defines a function that waits for an event. (Obsolete) Defines a function that waits for an event for a dedicated period of time. (Obsolete)
GUI_MAXTASK
Description
Defines the maximum number of tasks from which emWin is called to access the display.
Type
Numerical value.
Additional information
This symbol is only relevant when GUI_OS is activated. If working with a pre-compiled library the function GUITASK_SetMaxTask() should be used instead. For further information, please refer to "GUITASK_SetMaxTask()" on page 1043.
GUI_OS
Description
Enables multitasking support by activating the module GUITask.
Type
Binary switch 0: inactive, multitask support disabled (default) 1: active, multitask support enabled
GUI_X_SIGNAL_EVENT
Description
Defines a function that signals an event.
Type
Function replacement
Additional information
Per default the GUI needs to periodically check for events unless a function is defined which waits and one that triggers an event. This macro defines the function which triggers an event. It makes only sense in combination with GUI_X_WAIT_EVENT. The advantage of using the macros GUI_X_SIGNAL_EVENT and GUI_X_WAIT_EVENT instead of polling is the reduction of CPU load of the waiting task to 0% while it waits for input. If the macro has been defined as recommended and the user gives the system any input (keyboard or pointer input device) the defined function should signal an event. It is recommended to specify the function GUI_X_SignalEvent() for the job.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
326
CHAPTER
Execution Model: Single Task / Multitask
Example
#define GUI_X_SIGNAL_EVENT GUI_X_SignalEvent
GUI_X_WAIT_EVENT
Description
Defines a function which waits for an event.
Type
Function replacement
Additional information
Per default the GUI needs to periodically check for events unless a function is defined which waits and one that triggers an event. This macro defines the function which waits for an event. Makes only sense in combination with GUI_X_SIGNAL_EVENT. The advantage of using the macros GUI_X_SIGNAL_EVENT and GUI_X_WAIT_EVENT instead of polling is the reduction of CPU load of the waiting task to 0% while it waits for input. If the macro has been defined as recommended and the system waits for user input the defined function should wait for an event signaled from the function defined by the macro GUI_X_SIGNAL_EVENT. It is recommended to specify the function GUI_X_WaitEvent() for the job.
Example
#define GUI_X_WAIT_EVENT GUI_X_WaitEvent
GUI_X_WAIT_EVENT_TIMED
Description
Defines a function which waits for an event for a dedicated period of time.
Type
Function replacement
Additional information
Per default the GUI needs to periodically check for events unless a function is defined which waits and one that triggers an event. This macro defines the function which waits for an event if a timer is active. Makes only sense in combination with GUI_X_SIGNAL_EVENT. If the macro has been defined as recommended and the system waits for user input during a timer is active the defined function should wait until the timer expires or an event signaled from the function defined by the macro GUI_X_SIGNAL_EVENT. It is recommended to specify the function GUI_X_WaitEventTimed() for the job.
Example
#define GUI_X_WAIT_EVENT_TIMED GUI_X_WaitEventTimed
14.7 Kernel interface API
An RTOS usually offers a mechanism called a resource semaphore, in which a task using a particular resource claims that resource before actually using it. The display is an example of a resource that needs to be protected with a resource semaphore. emWin uses the macro GUI_USE to call the function GUI_Use() before it accesses the display or before it uses a critical internal data structure. In a similar way, it calls GUI_Unuse() after accessing the display or using the data structure. This is done in the module GUITask.c.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
327
GUITask.c in turn uses the GUI kernel interface routines shown in the table below. These routines are prefixed GUI_X_ since they are high-level (hardware-dependent) functions. They must be adapted to the real time kernel used in order to make the emWin task (or thread) safe. Detailed descriptions of the routines follow, as well as examples of how they are adapted for different kernels.
Routine GUI_X_GetTaskId()
GUI_X_InitOS()
GUI_X_Lock() GUI_X_SignalEvent() GUI_X_Unlock() GUI_X_WaitEvent()
Explanation
Return a unique, 32-bit identifier for the current task/thread. Initialize the kernel interface module (create a resource semaphore/ mutex). Lock the GUI (block resource semaphore/mutex). Signals an event. Unlock the GUI (unblock resource semaphore/mutex). Waits for an event.
GUI_X_GetTaskID()
Description
Returns a unique ID for the current task.
Prototype
U32 GUI_X_GetTaskID(void);
Return value
ID of the current task as a 32-bit integer.
Additional information
Used with a real-time operating system. It does not matter which value is returned, as long as it is unique for each task/ thread using the emWin API and as long as the value is always the same for each particular thread.
GUI_X_InitOS()
Description
Creates the resource semaphore or mutex typically used by GUI_X_Lock() and GUI_X_Unlock().
Prototype
void GUI_X_InitOS(void)
GUI_X_Lock()
Description
Locks the GUI.
Prototype
void GUI_X_Lock(void);
Additional information
This routine is called by the GUI before it accesses the display or before using a critical internal data structure. It blocks other threads from entering the same critical section using a resource semaphore/mutex until GUI_X_Unlock() has been called. When using a real time operating system, you normally have to increment a counting resource semaphore.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
328
CHAPTER
Execution Model: Single Task / Multitask
GUI_X_SignalEvent()
Description
Signals an event.
Prototype
void GUI_X_SignalEvent(void);
Additional information
This function is optional, it is used only via the macro GUI_X_SIGNAL_EVENT or the function GUI_SetSignalEventFunc().
GUI_X_Unlock()
Description
Unlocks the GUI.
Prototype
void GUI_X_Unlock(void);
Additional information
This routine is called by the GUI after accessing the display or after using a critical internal data structure. When using a real time operating system, you normally have to decrement a counting resource semaphore.
GUI_X_WaitEvent()
Description
Waits for an event.
Prototype
void GUI_X_WaitEvent(void);
Additional information
This function is optional, it is used only via the macro GUI_X_WAIT_EVENT or the function GUI_SetWaitEventFunc().
GUI_X_WaitEventTimed()
Description
Waits for an event for the given period.
Prototype
void GUI_X_WaitEventTimed(int Period);
Parameter Period
Period in ms to be used.
Description
Additional information
This function is optional, it is used only via the macro GUI_X_WAIT_EVENT_TIMED or the function GUI_SetWaitEventTimedFunc().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
329
14.7.1 Examples
Kernel interface routines for embOS
The following example shows an adaption for embOS (excerpt from file GUI_X_embOS.c located in the folder Sample\GUI_X):
#include "RTOS.H"
static OS_TASK* _pGUITask; static OS_RSEMA _RSema;
void GUI_X_InitOS(void) { OS_CreateRSema(&_RSema); }
void GUI_X_Unlock(void) { OS_Unuse(&_RSema);
}
void GUI_X_Lock(void)
{ OS_Use(&_RSema);
}
U32 GUI_X_GetTaskId(void) { return (U32)OS_GetTaskID(); }
void GUI_X_WaitEvent(void) { _pGUITask = OS_GetpCurrentTask(); OS_WaitEvent(1);
}
void GUI_X_SignalEvent(void) { if (_pGUITask) { OS_SignalEvent(1, _pGUITask); }
}
void GUI_X_WaitEventTimed(int Period) { static OS_TIMER Timer; static int Initialized;
if (Period > 0) { if (Initialized != 0) { OS_DeleteTimer(&Timer); } Initialized = 1; OS_CreateTimer(&Timer, GUI_X_SignalEvent, Period); OS_StartTimer(&Timer); GUI_X_WaitEvent();
} }
Kernel interface routines for uC/OS
The following example shows an adaption for uC/OS (excerpt from file GUI_X_uCOS.c located in the folder Sample\GUI_X):
#include "INCLUDES.H"
static OS_EVENT * pDispSem; static OS_EVENT * pGUITask;
U32 GUI_X_GetTaskId(void) { return ((U32)(OSTCBCur->OSTCBPrio)); }
void GUI_X_Unlock(void) { OSSemPost(pDispSem);
}
void GUI_X_InitOS(void) { pDispSem = OSSemCreate(1); pGUITask = OSSemCreate(0);
}
void GUI_X_Lock(void)
{
INT8U err;
OSSemPend(pDispSem, 0, &err);
}
Kernel interface routines for Win32
The following is an excerpt from the Win32 simulation for emWin. (When using the emWin simulation, there is no need to add these routines, as they are already in the library.) Note: cleanup code has been omitted for clarity.
/*********************************************************************
*
*
emWin - Multitask interface for Win32
*
**********************************************************************
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
330
CHAPTER
Execution Model: Single Task / Multitask
The following section consisting of 4 routines is used to make emWin thread safe with WIN32 */
static HANDLE hMutex;
void GUI_X_InitOS(void) { hMutex = CreateMutex(NULL, 0, "emWinSim - Mutex");
}
unsigned int GUI_X_GetTaskId(void) { return GetCurrentThreadId();
}
void GUI_X_Lock(void) { WaitForSingleObject(hMutex, INFINITE);
}
void GUI_X_Unlock(void) { ReleaseMutex(hMutex);
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
331
Chapter 15
The Window Manager (WM)
When using the emWin Window Manager (WM), everything which appears on the display is contained in a window -- a rectangular area on the screen. A window can be of any size, and you can display multiple windows on the screen at once, even partially or entirely in front of other windows. The Window Manager supplies a set of routines which allow you to easily create, move, resize, and otherwise manipulate any number of windows. It also provides lower-level support by managing the layering of windows on the display and by alerting your application to display changes that affect its windows. The emWin Window Manager is a separate (optional) software item and is not included in the emWin basic package. The software for the Window Manager is located in the subdirectory GUI\WM.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
332
CHAPTER
The Window Manager (WM)
15.1 Description of terms
Windows are rectangular in shape, defined by their origin (the X- and Y-coordinates of the upper left corner) as well as their X- and Y-sizes (width and height, respectively). A window in emWin:
· is rectangular. · has a Z-position. · may be hidden or shown. · may have valid and/or invalid areas. · may or may not have transparency. · may or may not have a callback routine.
Active window
The window which is currently being used for drawing operations is referred to as the active window. It is not necessarily the same as the topmost window.
Callback routines
Callback routines are defined by the user program, instructing the graphic system to call a specific function when a specific event occurs. Normally they are used to automatically redraw a window when its content has changed.
Child/parent windows, siblings
A child window is one that is defined relative to another window, called the parent. Whenever a parent window moves, its child or children move correspondingly. A child window is always completely contained within its parent, and will be clipped if necessary. Multiple child windows with the same parent are considered "siblings" to one another.
Client area
The client area of a window is simply its usable area. If a window contains a frame or title bar, then the client area is the rectangular inner area. If there is no such frame, then the coordinates of the client area are identical to those of the window itself.
Clipping, clip area
Clipping is the process of limiting output to a window or part of it. The clip area of a window is its visible area. This is the window area minus the area obstructed by siblings of higher Z-order, minus any part that does not fit into the visible area of the parent window.
Coordinates
Coordinates are usually 2 dimensional coordinates, expressed in units of pixels. A coordinate consists of 2 values. The first value specifies the horizontal component (also called the x-coordinate), the second value specifies the vertical component (also called the y-coordinate).
Desktop coordinates
Desktop coordinates are coordinates of the desktop window. The upper left position (the origin) of the display is (0,0).
Desktop window
The desktop window is automatically created by the Window Manager, and always covers the entire display area. It is always the bottommost window, and when no other window has been defined, it is the default (active) window. All windows are descendants (children, grandchildren, etc.) of the desktop window.
Handle
When a new window is created, the WM assigns it a unique identifier called a handle. The handle is used in any further operations performed on that particular window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
333
Hiding/showing windows
A hidden window is not visible, although it still exists (has a handle). When a window is created, it is hidden by default if no create flag is specified. Showing a window makes it visible; hiding it makes it invisible.
Parent coordinates
Parent coordinates are window coordinates relative to the parent window. The upper left position (the origin) of the window is (0,0).
Transparency
A window that has transparency contains areas that are not redrawn with the rest of the window. These areas operate as though the window behind "shows through" them. In this case, it is important that the window behind is redrawn before the window with transparency. The WM automatically handles redrawing in the correct order.
Validation/invalidation
A valid window is a fully updated window which does not need redrawing. An invalid window does not yet reflect all updates and therefore needs to be redrawn, either completely or partially. When changes are made that affect a particular window, the WM marks that window as invalid. The next time the window is redrawn (either manually or by a callback routine) it will be validated.
Window coordinates
Window coordinates are coordinates of a window. The upper left position (the origin) of the window is (0,0).
Z-position, bottom/top
Although a window is displayed on a two-dimensional screen in terms of X and Y, the WM also manages what is known as a Z-position, or depth coordinate -- a position in a virtual third dimension which determines its placement from background to foreground. Windows can therefore appear on top of or beneath one another. Setting a window to the bottom will place it "underneath" all of its sibling windows (if any); setting it to the top will place it "on top of" its siblings. When a window is created, it is set to the top by default if no create flag is specified.
15.2 Callback mechanism, invalidation, rendering and keyboard input
The WM may be used with or without callback routines. In most cases, using callbacks is preferable. The idea behind the callback mechanism that emWin offers for windows and window objects (widgets) is that of an event-driven system. As in most windowing systems, the principle is that the flow of control is not just from the user program to the graphic system, but also from the user program to the graphic system and back up to the user program by means of the callback routines provided by the user program. This mechanism -- often characterized as the Hollywood principle ("Don't call us, we'll call you!") -- is needed by the Window Manager mainly in order to trigger the redrawing of windows. This contrasts with classical programming, but it makes it possible to exploit the invalidation logic of the Window Manager.
15.2.1 Rendering without callbacks
You do not have to use callback routines, but in doing so, the WM loses the ability to manage redrawing (updating) of the windows. It is also possible to mix; for example, having some windows use callbacks and others not. However, if a window does not use the callback mechanism, your application is responsible for updating its contents.
Warning: When not using the callback mechanism, it is user responsibility to manage screen updates!
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
334
CHAPTER
The Window Manager (WM)
15.2.2 Rendering using callbacks
In order to create a window with a callback, you must have a callback routine. The routine is used as part of the WM_CreateWindow() function when creating the window (the cb parameter). All callback routines must have the following prototype:
Prototype
void Callback(WM_MESSAGE * pMsg);
Parameter pMsg
Description
Pointer to a data structure of type WM_MESSAGE.
The action performed by the callback routine depends on the type of message it receives. The prototype above is usually followed by a switch statement, which defines different behaviors for different messages using one or more case statements (typically at least WM_PAINT).
Processing the WM_PAINT message
When a window receives a WM_PAINT message, it should repaint itself. Before sending this message to the window, the WM makes sure it is selected. A non transparent window (default!) has to repaint its entire invalid area. The easiest way is to repaint the entire area of the window. The clipping mechanism of the WM makes sure that only the invalid area will be redrawn. In order to accelerate the drawing process, it can make sense to only repaint the invalid area. How to get the invalid area is described later in this chapter (Information is part of the message). A transparent window on the other hand does not have to redraw the entire invalid area; it can leave the window area partially untouched. This untouched area will then be transparent. Before the WM sends a WM_PAINT message to a transparent window, the area below has been redrawn (by sending a WM_PAINT message to the window(s) below).
Warning: Certain things should not be done when processing WM_PAINT
When processing the WM_PAINT message, the callback routine should do nothing but redrawing the contents of the window. When processing the WM_PAINT event, the following functions may not be called: WM_SelectWindow(), WM_Paint(), WM_DeleteWindow() and WM_CreateWindow(). Also any other functions which changes the properties of a window may not be called: WM_Move(), WM_Resize(), ...
Example
Creates a callback routine to automatically redraw a window: void WinHandler(WM_MESSAGE * pMsg) {
switch (pMsg->MsgId) { case WM_PAINT:
GUI_SetBkColor(0xFF00); GUI_Clear(); GUI_DispStringAt("Hello world",0,0); break; default: WM_DefaultProc(pMsg); } }
Please note that a WM_PRE_PAINT and a WM_POST_PAINT message is processed directly before and after WM_PAINT messages are sent.
15.2.3 Overwriting callback functions
The default behavior of widgets and windows in emWin is defined in their callback functions. If the behavior of a widget has to be changed, or if the functionality of a window needs to be enhanced to meet custom needs, it is recommended to overwrite the internal callback function. This is done in a few simple steps:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
335
Step 1: Creating a custom callback function
The first step is to implement a function using the following prototype:
void Callback(WM_MESSAGE * pMsg);
Step 2: Messages
The second step is to implement a reaction to certain messages. Since custom callback functions do not need to handle all possible messages, it is recommended to make use of a switch / case condition. This makes it possible to easily add or remove one message specific code, without affecting another. The parameter pMsg contains the Id of the message (pMsg->MsgId). A complete list of messages handled by the Window Manager may be reviewed under "List of messages" on page 341.
Step 3: Processing the default callback
The third step is to make sure all messages which are not handled by the custom callback function, are handled by the internal (default) callback function. The recommended way to do this is to use the default case of the switch / case condition to call the internal callback function.
Internal callback functions are different for each type of window. The internal callback functions for widgets are named <WIDGET>_Callback(). All other types of windows use the function WM_DefaultProc() for message handling.
switch (pMsg->MsgId) { case WM_CREATE:
. . . break; case WM_PAINT: . . . break; case WM_SIZE: . . . break; default: <WIDGET>_Callback(pMsg); }
Step 4: Setting the custom callback function to be used
The last step to do is setting the newly created callback function to be used by a window or widget. This is done with a simple call of WM_SetCallback(). For detailed information about this function, please refer to the function description on page 376.
15.2.4 Background window redrawing and callback
During initialization of the Window Manager, a window containing the whole LCD area is created as a background window. The handle of this window is WM_HBKWIN. The WM does not redraw areas of the background window automatically, because there is no default background color. That means if you create a further window and then delete it, the deleted window will still be visible. The routine WM_SetDesktopColor() needs to be specified in order to set a color for redrawing the background window. You can also set a callback function to take care of this problem. If a window is created and then deleted as before, the callback routine will trigger the WM to recognize that the background window is no longer valid and redraw it automatically. For more information on using a callback routine to redraw the background, see the example at the end of the chapter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
336
CHAPTER
The Window Manager (WM)
15.2.5 Invalidation
Invalidation of a window or a part of it tells the WM that the invalid area of the window should be redrawn the next time GUI_Exec() or GUI_Delay() is called. The invalidation routines of emWin do not redraw the invalid part of a window. They only manage the invalid areas of the windows.
The invalid area of a window
The WM uses just one rectangle per window to store the smallest rectangle containing the entire invalid area. If for example a small part in the upper left corner and a small part in the lower right corner becomes invalid, the complete window is invalidated.
Why using invalidation
The advantage of using window invalidation in opposite of drawing each window immediately is that the window will be drawn only one time even if it is invalidated more than one time. If for example several properties of a window need to be changed (for example the background color, the font and the size of the window) it takes more time to draw the window immediately after each property has been changed than drawing the window only one time after all properties have been changed.
Redrawing of invalid windows
The function GUI_Exec() redraws all invalid windows. This is done by sending one or more WM_PAINT messages to each invalid window.
15.2.6 Rendering of transparent windows
If a transparent window needs to be drawn, the WM automatically makes sure, that the background of the window is drawn before the transparent window receives a WM_PAINT message. This is done by redrawing all window areas below the invalid area of the transparent window first before sending a WM_PAINT message to the transparent window. To make sure the Window Manager can handle the redrawing of transparent windows it is necessary to redraw the window in reaction to the WM_PAINT message. Otherwise it can not be guaranteed that the appearance of a transparent window will be correctly. The use of transparent windows is more CPU-intensive than the use of non transparent windows. If performance is a problem, trying to avoid transparent windows may be an option.
15.2.7 Automatic use of memory devices
The default behavior of the Window Manager is sending a WM_PAINT to each window which needs to be redrawn. This can cause flickering effects. To suppress these 'per window' flickering effects memory devices can be used automatically for the drawing operation. This can be achieved by setting the flag WM_CF_MEMDEV when creating the window, by setting the default creation flags with WM_SetCreateFlags() or by using the function WM_EnableMemdev(). The WM then redirects the output of the WM_PAINT message into a memory device which is then copied to the display. If not enough memory for the whole window is available banding is used automatically. The memory device is only used temporarily and will be removed after the drawing operation. For more information please also refer to chapter "Memory Devices" on page 287.
15.2.8 Automatic use of multiple frame buffers
The WM is able to use automatically multiple frame buffers if they are available. This can be achieved by the function WM_MULTIBUF_Enable(). If enabled the Window Manager redirects the output of all drawing functions to the invisible back buffer before it draws the invalid windows. After the last invalid window has been drawn the WM makes the back buffer visible. Please note that feature is only available if the display
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
337
driver supports multiple buffers and if there is enough RAM for at least 2 frame buffers. For more information please also refer to chapter "Multiple buffering" on page 825.
15.2.9 Automatic use of display driver cache
The WM automatically uses the display driver cache if available. If available it locks the buffer before it starts to draw the invalid windows. After the last window has been drawn the WM unlocks the cache.
15.2.10 Keyboard input
The Window Manager handles keyboard input automatically. It polls the keyboard buffer and sends according keyboard messages to the currently focussed window. The keyboard buffer can be filled using the function GUI_StoreKeyMsg() which is described on page 871.
15.3 Motion support
Motion support enables the ability to move windows by gestures. It can be used with any pointer input device (PID) like a touch screen, a mouse or a joystick. If motion support is enabled the respective window can be put into movement simply with a gesture. After releasing the PID the movement is decelerated within a specified period. Movement operations can be also initiated by API functions instead of gestures.
15.3.1 Enabling motion support of the WM
First of all motion support needs to be enabled before it can be used. This can be done by calling the function WM_MOTION_Enable() once. Without calling this function once the motion support functions won't work.
15.3.2 Basic motion support for a window
To be able to use motion support for a window it needs to be enabled for each window which should be moveable. In case of a moveable parent window with several child windows motion support needs only be enabled for the parent window. There are 2 possibilities to achieve basic motion support for a window:
15.3.2.1 Using creation flags
To achieve moveability for a window it can be created with one or more or-combined creation flags. The following table shows the available creation flags:
Flag WM_CF_MOTION_X WM_CF_MOTION_Y
Description
Enables moveability for the X axis. Enables moveability for the Y axis.
Example
WM_HWIN hWin; hWin = WM_CreateWindowAsChild(0, 0, 40, 40, hParent,
WM_CF_SHOW | WM_CF_MOTION_X | WM_CF_MOTION_Y, cbWin, 0);
Of course the motion flags can also be used with widget creation functions.
15.3.2.2 Using API function
To achieve moveability for a window after it has been created without moveability flags the function WM_MOTION_SetMoveable() explained later in this chapter can be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
338
CHAPTER
The Window Manager (WM)
15.3.3 Advanced motion support
To be able to use advanced features like user defined motion operations like circular moves or snapping the callback function of the moveable window should be used. In case of a moving operation of the PID the WM sends a WM_MOTION message to the window. This message can be used to achieve advanced motion support.
15.3.3.1 WM_MOTION message and WM_MOTION_INFO
As explained in the message description "WM_MOTION" on page 346 the Data.p element of the WM_MOTION message points to a WM_MOTION_INFO structure. The element Cmd of this structure contains information about the current operation. The following table shows the possible values of the element Cmd:
Flag WM_MOTION_INIT WM_MOTION_MOVE WM_MOTION_GETPOS
Description
Send to a window to initiate a motion operation. Send to a window to achieve custom moving operations. Send to get the current position of custom moving operations.
WM_MOTION_INIT
If a PID move has been detected by the WM it first checks if there is any visible window available under the PID position which is already 'moveable'. This makes it possible to achieve moving operations for windows which are partially or totally covered by child windows. If the WM does not find an already moveable window it sends the command to the 'top window' of the PID position. If the window is not already 'moveable' when receiving this command the element Flags of the WM_MOTION_INFO structure can be used to enable motion support. The creation flags explained earlier can be used here to achieve automatic motion support. The Flags element simply needs to be OR-combined with the desired flag(s).
WM_MOTION_INIT and custom motion support
Custom motion support means that the moving operations are not done automatically by the WM but by the callback routine of the window. This can be useful if for example radial motions are required. To achieve custom motion support the Flags element needs to be OR-combined with the flag WM_MOTION_MANAGE_BY_WINDOW.
WM_MOTION_MOVE
Send to a window with custom motion support enabled. The elements dx and dy of the WM_MOTION_INFO structure can be used to achieve the custom moving operation.
WM_MOTION_GETPOS
Send to a window with custom motion support enabled. The task of the callback routine here is returning the current position. This needs to be done with the elements xPos and yPos of the WM_MOTION_INFO structure.
Snapping
The elements SnapX and SnapY of the WM_MOTION_INFO structure can be used to achieve snapping. These values determine a kind of grid for snapping. This means that the deceleration of the movement operation will stop exactly on a grid position. Also if there currently is no movement and the window is only released it will snap into the next grid position.
Examples
The sample folder contains the sample WM_RadialMenu.c which can be used to get an overview about how advanced motion support can be used. A second sample WM_Motion.c shows how to use simple motion support.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
339
15.4 ToolTips
A ToolTip in emWin is a small window with one line of text, which appears in conjunction with a pointer input device (PID), usually a mouse. The user hovers the PID over a 'tool', without clicking it, and a small ToolTip window with information about the item being hovered over may appear. After a short time the window disappears automatically. ToolTips make sense for active elements like any kind of button or similar widgets/windows, which can be used as tool for changing something. But they can be used with any kind of window.
15.4.1 How they work
A ToolTip belongs to a particular parent (or grandparent) window. When the PID hovers over a tool window without any motion, after a specified time (PERIOD_FIRST) the ToolTip window occurs. If the PID remains over the tool without motion, the ToolTip automatically disappears after a specified period of no motion (PERIOD_SHOW). It remains until the PID does not move for this period. If the PID is clicked or hovers out of the tool window the ToolTip disappears. If the PID remains in the parent area and the PID then hovers again over a tool of the same parent, the ToolTip occurs immediately after a very short period (PERIOD_NEXT) of no motion. If the PID moves out of the parent area, the next time a ToolTip occurs is again after PERIOD_FIRST. Appearance and timing can be configured at runtime.
15.4.2 Creating ToolTips
(The functions and structures mentioned in the following are described in detail later in this chapter under "WM API: ToolTip related functions" on page 389.) The function WM_TOOLTIP_Create() should be used for creating a ToolTip object. It requires a handle to the parent (or grand parent) window. Optional a pointer to an array of TOOLTIP_INFO structures can be passed which is used for adding the desired tools to the ToolTip object. These structures should contain the IDs of the tools and the text to be shown. Alternatively the function WM_TOOTIP_AddTool() can be used to add the tools. This makes sense if the tool window does not have an Id.
15.4.2.1 Creating ToolTips for dialog items
As mentioned above the TOOLTIP_INFO structure is used to address the desired tools by its IDs. Because the items of a dialog normally have an Id this is quite easy.
Example
The following sample shows how it works:
#include "DIALOG.h"
#define ID_BUTTON_0 (GUI_ID_USER + 0x01) #define ID_BUTTON_1 (GUI_ID_USER + 0x02)
static const GUI_WIDGET_CREATE_INFO _aDialogCreate[] = {
{ FRAMEWIN_CreateIndirect, "Framewin",
0, 0, 0, 320, 240, 0, 0, 0 },
{ BUTTON_CreateIndirect, "Button 0", ID_BUTTON_0, 5, 5, 80, 20, 0, 0, 0 },
{ BUTTON_CreateIndirect, "Button 1", ID_BUTTON_1, 5, 30, 80, 20, 0, 0, 0 },
};
static const TOOLTIP_INFO _aInfo[] = { { ID_BUTTON_0, "I am Button 0" }, { ID_BUTTON_1, "I am Button 1" },
};
static void _ShowDialog(void) { WM_HWIN hWin; WM_TOOLTIP_HANDLE hInfo;
hWin = GUI_CreateDialogBox(_aDialogCreate, GUI_COUNTOF(_aDialogCreate), 0, WM_HBKWIN, 0, 0); hInfo = WM_TOOLTIP_Create(hWin, _aInfo, GUI_COUNTOF(_aInfo)); while (1) {
GUI_Delay(100); } }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
340
CHAPTER
The Window Manager (WM)
15.4.2.2 Creating ToolTips for simple windows
Because simple windows normally do not have an Id, there exists a function for adding tools without using IDs. The function WM_TOOLTIP_AddTool() can be used to do this by passing the tool window handle and the required text to be shown.
Example
The following example shows how it works:
#include <stddef.h>
#include "WM.h"
static void _cbParent(WM_MESSAGE * pMsg) { switch (pMsg->MsgId) { case WM_PAINT: GUI_SetBkColor(GUI_BLUE); GUI_Clear(); GUI_DispString("Parent window"); break; }
}
static void _cbTool(WM_MESSAGE * pMsg) { switch (pMsg->MsgId) { case WM_PAINT: GUI_SetBkColor(GUI_RED); GUI_Clear(); GUI_DispString("Tool window"); break; }
}
void MainTask(void) { WM_HWIN hTool, hParent; WM_TOOLTIP_HANDLE hToolTip;
GUI_Init(); WM_SetDesktopColor(GUI_BLACK); hParent = WM_CreateWindow(0, 0, 200, 100, WM_CF_SHOW, _cbParent, 0); hTool = WM_CreateWindowAsChild(20, 20, 100, 50, hParent, WM_CF_SHOW, _cbTool, 0); hToolTip = WM_TOOLTIP_Create(hParent, NULL, 0); WM_TOOLTIP_AddTool(hToolTip, hTool, "I am a ToolTip"); while (1) {
GUI_Delay(100); } }
15.5 Messages
The following section shows which system messages are used by emWin, how to use the message data and how to use application defined messages.
15.5.1 Message structure
When a callback routine is called, it receives the message specified as its pMsg parameter. This message is actually a WM_MESSAGE data structure, with elements defined as follows.
Elements of WM_MESSAGE
Data type int WM_HWIN WM_HWIN union
Element MsgId hWin hWinSrc Data
void *
p
int
v
Description
Type of message. See list of messages below. Destination window. Source window. Data union. See elements below.
Elements of Data
Data pointer. Data value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
341
15.5.2 List of messages
The following messages are defined by emWin.
Message Id (MsgId)
Description
WM_CREATE
WM_DELETE WM_GET_ACCEPT_FOCUS WM_GET_ID WM_INIT_DIALOG WM_KEY WM_MOVE WM_NOTIFY_PARENT WM_NOTIFY_VIS_CHANGED WM_PAINT WM_POST_PAINT WM_PRE_PAINT WM_SET_FOCUS
System defined messages
Sent immediately after a window has been created, giving the window the chance to initialize and create any child windows. Sent just before a window is deleted, telling the window to free its data structures (if any). Sent to a window to determine if the window is able to receive the input focus.
Sent to a window to request the Id of the window.
Sent to a dialog window immediately after the creation of the dialog. Sent to the window currently containing the focus if a key has been pressed.
Sent to a window immediately after it has been moved.
Informs a parent window that something has occurred in one of its child windows.
Sent to a window if its visibility has been changed.
Sent to a window after it has become invalid and it should be redrawn. Sent to a window after the last WM_PAINT message was processed. Sent to a window before the first WM_PAINT message is sent.
Sent to a window if it gains or looses the input focus.
WM_SET_ID
Sent to a window to change the window Id.
WM_SIZE
Sent to a window after its size has changed.
WM_TIMER
Sent to a window after a timer has expired.
Pointer input device (PID) messages
WM_MOTION
Sent to a window to achieve advanced motion support.
WM_MOUSEOVER
Sent to a window if a pointer input device touches the outline of a window. Only send if mouse support is enabled.
WM_MOUSEOVER_END
Sent to a window if a pointer input device has been moved out of the outline of a window. Only sent if mouse support is enabled.
WM_PID_STATE_CHANGED
Sent to the window pointed by the pointer input device when the pressed state has been changed.
WM_TOUCH
Sent to a window once a pointer input device is pressed, pressed and moved or released over its area.
WM_TOUCH_CHILD
Sent to a parent window if a child window has been touched by the pointer input device.
Notification codes
WM_NOTIFICATION_CHILD_DELETED
This notification message will be sent from a window to its parent before it is deleted.
WM_NOTIFICATION_CLICKED
This notification message will be sent when the window has been clicked.
WM_NOTIFICATION_GOT_FOCUS
This notification message will be sent once a window receives and accepts the focus.
WM_NOTIFICATION_LOST_FOCUS
This notification message will be sent when the window has lost the focus.
WM_NOTIFICATION_MOVED_OUT
This notification message will be sent when the pointer was moved out of the window while it is clicked.
WM_NOTIFICATION_RELEASED
This notification message will be sent when a clicked widget has been released.
WM_NOTIFICATION_SCROLL_CHANGED
This notification message will be sent when the scroll position of an attached SCROLLBAR widget has changed.
This notification message will be sent when a SCROLLBAR
WM_NOTIFICATION_SCROLLBAR_ADDED widget has been added to the window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
342
CHAPTER
The Window Manager (WM)
Message Id (MsgId)
Description
WM_NOTIFICATION_SEL_CHANGED
This notification message will be sent when the selection of a widget has changed.
WM_NOTIFICATION_VALUE_CHANGED
This notification message will be sent when a widget specific value has changed.
User defined messages
WM_USER
The WM_USER constant could be used by applications to define private messages, usually of the form (WM_USER + X), where X is an integer value.
15.5.3 System-defined messages
These kind of messages are send by the GUI library. Do not send system defined messages from the user application to a window or a widget.
WM_CREATE
Description
This message is sent immediately after a window has been created, giving the window the chance to initialize and create any child windows.
Data
This message contains no data.
WM_DELETE
Description
This message is sent just before a window is deleted, telling the window to free its data structures (if any).
Data
This message contains no data.
WM_GET_ID
Description
This message is sent to a window to request it's Id. All emWin widgets handle this message. Application defined windows should handle this message in their callback routine. Otherwise this message will be ignored.
Data
The callback routine of the window should store the Id in the Data.v value.
WM_INIT_DIALOG
Description
This message is sent to a window immediately after the creation of the dialog and before the dialog is displayed. Dialog procedures typically use this message to initialize widgets and carry out any other initialization tasks that affect the appearance of the dialog box.
Data
This message contains no data.
WM_KEY
Description
Sent to the window currently containing the focus if a key has been pressed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
343
Data
The Data.p pointer of the message points to a WM_KEY_INFO structure.
Elements of WM_KEY_INFO
Data type Element
Description
int int
Key
The key which has been pressed.
PressedCount > 0 if the key has been pressed, 0 if the key has been released.
WM_MOVE
Description
This message is sent to a window immediately after it has been moved. If the window has any child windows, they will be moved first. Also each child window will receive this message after it has been moved. The message is sent regardless if the window is visible or not.
Data
The Data.p pointer of the message points to a WM_KEY_INFO structure.
Elements of WM_MOVE_INFO
Data type Element
int
dx
int
dy
Description
Difference between old and new position on the x-axis. Difference between old and new position on the y-axis.
WM_NOTIFY_PARENT
Description
Informs a parent window that something has occurred in one of its child window. These messages are typically send by widgets to their parent windows to give them a chance to react on the event.
Data
The Data.v value of the message contains the notification code of the message. For more information about the notification codes, refer to the appropriate widget.
WM_NOTIFY_VIS_CHANGED
Description
This message is sent to a window if its visibility is changed and the configuration switch WM_SUPPORT_NOTIFY_VIS_CHANGED is set to 1. The visibility of a window changes if · obstruction changes: The window is partially or totally covered or uncovered by a
higher level window (a window which is displayed on top of the window), · the window is deleted or · the window changes from not hidden to hidden or reverse.
Typical application
Applications which show a video in a window using a hardware decoder. The hardware decoder can write directly into the display, bypassing emWin, if the window containing the video is completely visible. If the visibility changes, the hardware decoder needs to be reprogrammed.
Example
The following shows a typical reaction on this message: case WM_NOTIFY_VIS_CHANGED:
if (WM_IsCompletelyVisible(WM_GetClientWindow(pMsg->hWin))) { ...
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
344
CHAPTER
The Window Manager (WM)
The Sample folder of emWin contains the example WM_Video.c which shows how to use the message.
Data
This message contains no data.
WM_PAINT
Description
The WM sends this message to a window if it has become invalid (partially or complete) and needs to be drawn. When a window receives a WM_PAINT message, it should repaint itself. Before sending this message to the window, the WM makes sure it is selected. More details about how to react on the WM_PAINT message is described earlier in this chapter under "Using callback routines".
Data
The Data.p pointer of the message points to a GUI_RECT structure containing the invalid rectangle of the window in screen coordinates. This information could be used to optimize the paint function.
WM_POST_PAINT
Description
The WM sends this message to a window right after the last WM_PAINT message was processed.
Data
This message contains no data.
WM_PRE_PAINT
Description
The WM sends this message to a window before the first WM_PAINT is sent.
Data
This message contains no data.
WM_SET_FOCUS
Description
Send to a window if it gains or looses the input focus.
Data
If the window gains the input focus, the Data.v value is set to 1. If the window 'accepts' the input focus, it should set the Data.v value to 0 in reaction on this message. If the window looses the input focus, the Data.v value is set to 0.
WM_SET_ID
Description
Send to a window to change the Id. All emWin widgets handle this message. Application defined windows should handle this message in their callback routine. Otherwise this message will be ignored.
Data
The Data.v value contains the new Id of the window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
345
WM_SIZE
Description
Sent to a window after its size has changed. Gives the window the chance to reposition its child windows (if any).
Data
This message contains no data.
WM_TIMER
Description
This message will be send to a window when a timer created by WM_CreateTimer() has expired.
Data
The Data.v value contains the handle of the expired timer.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
346
CHAPTER
The Window Manager (WM)
15.5.4 Pointer input device (PID) messages
These kind of messages are send by the GUI library in reaction of PID input. Do not send this messages from the user application to a window or a widget.
WM_MOTION
Description
A WM_MOTION message is send to a window to achieve advanced motion support. It is send if a pointer input device is moved over a moveable window and to initiate a moving operation. For more details about motion support please also refer to sub chapter "Motion support" on page 337.
Data
The Data.p pointer of the message points to a WM_MOTION_INFO structure.
Elements of WM_MOTION_INFO
Data type Element
int
Cmd
int
dx
int
dy
int
xPos
int
yPos
int
Period
int
SnapX
int
SnapY
int
FinalMove
U32
Flags
Description
For details please refer to subcategory "Motion support" on page 337. Distance in X to be used to move the window. Distance in Y to be used to move the window. Used to return the current position in X for custom moving operations. Used to return the current position in Y for custom moving operations. Duration of the moving operation after the PID has been released. Raster size in X for snapping operations, 0 if no snapping is required. Raster size in Y for snapping operations, 0 if no snapping is required. Set to 1 on the final moving operation. To be used to enable motion support.
WM_MOUSEOVER
Description
A WM_MOUSEOVER message is send to a window if a pointer input device touches the outline of a window. It is send only if mouse support is enabled. This message is not sent to disabled windows. To enable mouse support, add the following line to the file GUIConf.h:
#define GUI_SUPPORT_MOUSE 1
Data
The Data.p pointer of the message points to a GUI_PID_STATE structure.
Elements of GUI_PID_STATE
Data type Element
int
x
int
y
U8
Pressed
Description
Horizontal position of the PID in window coordinates. Vertical position of the PID in window coordinates. Is always set to 0 when receiving a WM_MOUSEOVER message.
WM_MOUSEOVER_END
Description
A WM_MOUSEOVER_END message is sent to a window if the mouse pointer has been moved out of the window. It is send only if mouse support is enabled. This message is not sent to disabled windows.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
347
Data
The Data.p pointer of the message points to a GUI_PID_STATE structure. For details about this structure, refer to the message WM_MOUSEOVER.
WM_PID_STATE_CHANGED
Description
Sent to the window affected by the pointer input device when the pressed state has changed. The affected window is the visible window at the input position. With other words: If the user releases for example the touch screen over a window, the pressed state changes from 1 (pressed) to 0 (unpressed). In this case a WM_PID_STATE_CHANGED message is send to the window. This message is send before the touch message is send. An invisible window does not receive this message. Transparent windows are handled the same way as visible windows. This message is not sent to disabled windows.
Data
The Data.p pointer of the message points to a WM_PID_STATE_CHANGED_INFO structure.
Elements of WM_PID_STATE_CHANGED_INFO
Data type Element
int
x
int
y
U8
State
U8
StatePrev
Description
Horizontal position of the PID in window coordinates. Vertical position of the PID in window coordinates. Pressed state (> 0 if PID is pressed). Previous pressed state
WM_TOUCH
Description
A WM_TOUCH message is send to a window once the PID · is pressed. · is moved in pressed state. · is released. Windows receive this message, if one of the actions above happens over the visible area and if they are not disabled.
Data
The Data.p pointer of the message points to a GUI_PID_STATE structure.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
348
CHAPTER
The Window Manager (WM)
Elements of GUI_PID_STATE
Data type Element
int
x
int
y
U8
Pressed
Description
Horizontal position of the PID in window coordinates.
Vertical position of the PID in window coordinates.
If the message is originated by a touch screen this value can be 0 (unpressed) or 1 (pressed). If the message is originated by a mouse each bit represents a mouse button (0 for unpressed and 1 for pressed state): - Bit 0 represents the first button (normally the left button) - Bit 1 represents the second button (normally the right button) - Bit 2 represents the third button (normally the middle button) The remaining bits can be used for further buttons.
WM_TOUCH_CHILD
Description
This message is send to the parent window if the outline of a child window has been touched with a pointer input device in pressed or unpressed state. This message is not sent to disabled windows.
Data
The Data.p pointer of the message points to the touch message sent to the child window. For details about the message data, please refer to "WM_TOUCH" on page 347.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
349
Example
The following example explains what happens if a pointer input device is dragged over a dialog with a button:
1
2
3
Position 1 2 3
Description
The pointer input device (PID) is pressed at this position. This causes the WM to send
the following WM_PID_STATE_CHANGED message to the window at this position:
x = Horizontal position in desktop coordinates. y = Vertical position in desktop coordinates. State = 1 StatePrev = 0
The WM also sends a WM_TOUCH message with the same x and y coordinates to the
window: x = Horizontal position in desktop coordinates. y = Vertical position in desktop coordinates. Pressed = 1 The PID is dragged to this position. The window below (the button) will receive no
WM_PID_STATE_CHANGED message, because the PID remains in pressed state.
The WM only sends a WM_TOUCH message to the window: x = Horizontal position in desktop coordinates. y = Vertical position in desktop coordinates. Pressed = 1 The PID is released at this position. This causes the WM to send the following
WM_PID_STATE_CHANGED message to the window at this position:
x = Horizontal position in desktop coordinates. y = Vertical position in desktop coordinates. State = 0 StatePrev = 1
The WM also sends a WM_TOUCH message with the same x and y coordinates to the
window: x = Horizontal position in desktop coordinates. y = Vertical position in desktop coordinates. Pressed = 0
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
350
CHAPTER
The Window Manager (WM)
15.5.5 System-defined notification codes
A message of this type is sent from a window to its parent window to notify it of a change in the child window. This gives the parent window the chance to react on this event. The message contains a hWinSrc element which is a handle to the widget which caused the message. For more information on which notification messages can be sent by the various widgets, please refer to the appropriate widget in the Chapter "Widgets".
Note: Do not send system defined notification codes from the user application to a window.
WM_NOTIFICATION_CHILD_DELETED
This notification message will be sent from a window to its parent before it is deleted.
WM_NOTIFICATION_CLICKED
This notification message will be sent when the window has been clicked.
WM_NOTIFICATION_LOST_FOCUS
This notification message will be sent when the window has lost the focus.
WM_NOTIFICATION_MOVED_OUT
This notification message will be sent when the pointer was moved out of the window while it is clicked.
WM_NOTIFICATION_RELEASED
This notification message will be sent when a clicked widget has been released.
WM_NOTIFICATION_SCROLL_CHANGED
This notification message will be sent when the scroll position of an attached SCROLLBAR widget has changed.
WM_NOTIFICATION_SCROLLBAR_ADDED
This notification message will be sent when a SCROLLBAR widget has been added to the window.
WM_NOTIFICATION_SEL_CHANGED
This notification message will be sent when the selection of a widget has changed.
WM_NOTIFICATION_VALUE_CHANGED
This notification message will be sent when a widget specific value has changed.
15.5.6 Application-defined messages
The application program can define additional messages for its own usage. In order to ensure that they custom message Ids do not equal the Ids which are predefined in emWin, user-defined messages start numbering at WM_USER. Defining custom messages is recommended as follows: #define MY_MESSAGE_AAA (WM_USER + 0) #define MY_MESSAGE_BBB (WM_USER + 1)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
351
15.6 Configuration options
Type
Macro
Default
B WM_SUPPORT_NOTIFY_VIS_CHANGED 0
B WM_SUPPORT_TRANSPARENCY
1
Description
Enables the WM to send a
WM_NOTIFY_VIS_CHANGED message
to a window if its visibility is changed. Enable support for transparent windows. If set to 0 the additional code for transparency support is not included.
WM_SUPPORT_NOTIFY_VIS_CHANGED
Per default emWin does not inform windows if their visibility has changed. If enabled, the WM sends WM_NOTIFY_VIS_CHANGED messages.
WM_SUPPORT_TRANSPARENCY
Per default emWin supports transparent windows. This means per default the additional code used to handle transparent windows is linked if the WM is used. If the application does not use transparent windows the memory requirement of the application can be reduced if WM_SUPPORT_TRANSPARENCY is set to 0.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
352
CHAPTER
The Window Manager (WM)
15.7 WM API
The following table lists the available routines of the emWin Window Manager API. All functions are listed in alphabetical order within their respective categories. Detailed descriptions of the routines can be found later in the chapter.
Routine
WM_Activate() WM_AttachWindow() WM_AttachWindowAt() WM_BroadcastMessage() WM_BringToBottom() WM_BringToTop() WM_ClrHasTrans() WM_CreateWindow() WM_CreateWindowAsChild() WM_Deactivate() WM_DefaultProc() WM_DeleteWindow() WM_DetachWindow() WM_DisableWindow() WM_EnableWindow() WM_Exec()
WM_Exec1()
WM_ForEachDesc() WM_GetActiveWindow() WM_GetCallback() WM_GetClientRect() WM_GetClientRectEx() WM_GetDesktopWindow() WM_GetDesktopWindowEx() WM_GetDialogItem() WM_GetFirstChild() WM_GetFocussedWindow() WM_GetHasTrans() WM_GetInvalidRect() WM_GetNextSibling() WM_GetOrgX() WM_GetOrgY() WM_GetParent() WM_GetPrevSibling() WM_GetStayOnTop() WM_GetUserData() WM_GetWindowOrgX() WM_GetWindowOrgY() WM_GetWindowRect() WM_GetWindowRectEx() WM_GetWindowSizeX() WM_GetWindowSizeY()
WM_HasCaptured()
WM_HasFocus()
Description Basic functions
Activates the Window Manager. Attaches a window to a new parent window. Attaches a window to a new parent window at the given position. Sends a message to all existing windows. Places a window behind its siblings. Places a window in front of its siblings.
Clears the has transparency flag.
Creates a window. Creates a child window. Deactivates the Window Manager. Default routine to handle messages. Deletes a window. Detaches a window from its parent window. Sets the widget state to disabled. Sets the window state to enabled (default). Redraws invalid windows by executing callbacks (all jobs). Redraws one invalid window by executing one callback (one job only). Iterates over all descendants of a window. Returns handle of the active window. Returns a pointer to the callback function of a window. Returns the size of the active window. Returns the size of a window. Returns the window handle of the desktop window Returns the window handle of the specified desktop window Returns the window handle of a dialog box item (widget). Returns handle of a window's first child window. Returns the handle of the window with the input focus.
Returns current value of the has transparency flag.
Returns the invalid rectangle of the given window. Returns the handle of a window's next sibling. Returns the origin in X of the active window. Returns the origin in Y of the active window. Returns handle of a window's parent window. Returns the handle of a window's previous sibling.
Returns current value of the stay on top flag.
Retrieves the user data of a window Returns the origin in X of a window. Returns the origin in Y of a window. Returns the screen coordinates of the active window. Returns the screen coordinates of a window. Returns the horizontal size (width) of a window. Returns the vertical size (height) of a window. Checks if the given window has captured mouse- and touchscreen-input. Checks if the given window has the input focus.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
353
Routine WM_HideWindow() WM_InvalidateArea() WM_InvalidateRect() WM_InvalidateWindow() WM_IsCompletelyCovered() WM_IsCompletelyVisible() WM_IsEnabled() WM_IsVisible() WM_IsWindow() WM_MakeModal() WM_MoveChildTo() WM_MoveTo() WM_MoveWindow()
WM_NotifyParent()
WM_Paint() WM_PaintWindowAndDescs() WM_ReleaseCapture() WM_ResizeWindow() WM_Screen2hWin()
WM_Screen2hWinEx()
WM_SelectWindow() WM_SendMessage() WM_SendMessageNoPara()
WM_SendToParent()
WM_SetCallback() WM_SetCapture() WM_SetCaptureMove()
WM_SetCreateFlags()
WM_SetDesktopColor() WM_SetDesktopColorEx() WM_SetFocus() WM_SetHasTrans() WM_SetId() WM_SetpfPollPID() WM_SetSize() WM_SetWindowPos() WM_SetXSize() WM_SetYSize() WM_SetStayOnTop()
WM_SetTransState()
WM_SetUserClipRect() WM_SetUserData() WM_ShowWindow() WM_Update()
WM_UpdateWindowAndDescs()
WM_ValidateRect() WM_ValidateWindow()
Description
Makes a window invisible. Invalidates a certain section of the display. Invalidates a part of a window. Invalidates a window. Checks if a window is completely covered or not. Checks if a window is completely visible or not. Returns if a window is enabled or not. Returns if a window is visible or not. Determine whether a specified handle is a valid window handle. Changes the window to a 'modal' window. Sets the position of a window in window coordinates. Sets the position of a window in desktop coordinates. Moves a window to another position. Sends a WM_NOTIFY_PARENT message to the parent of the given window. Draws or redraws a window immediately. Draws a given window and all descendant windows immediately. Stops capturing mouse- and touch screen-input. Changes the size of the given window. Returns the window which lies at the specified position. Returns the window which lies at the specified position using a window handle to stop at. Sets the active window to be used for drawing operations. Sends a message to a window. Sends a message without parameters to a window. Sends the given message to the parent window of the given window. Sets the callback routine for a window. Routes all PID-messages to the given window. Moves a window according to the current PID state. Sets the flags to be used by default when creating new windows. Sets desktop window color. Sets desktop window color of the given desktop. Sets input focus to a specified window.
Sets the has transparency flag. Sends a WM_SET_ID message to the given window.
Sets a function to be called by the WM for polling the PID. Sets the new size of a window. Sets size and position of a window. Sets the new X-size of a window. Sets the new Y-size of a window.
Sets the stay on top flag. Sets or clears the WM_CF_HASTRANS and WM_CF_CONST_OUTLINE flags.
Reduces the clipping area temporarily. Sets the user data of the given window. Makes a window visible. Draws the invalid part of the given window. Draws the invalid part of a given window and the invalid part of all descendant windows. Validates parts of a window. Validates a window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
354
CHAPTER
The Window Manager (WM)
Routine
Description
Motion support
WM_MOTION_Enable()
Enables motion support of the WM.
WM_MOTION_SetDeceleration() Sets the deceleration for the current movement.
WM_MOTION_SetDefaultPeriod() Sets the default period for movements.
WM_MOTION_SetMotion()
Sets speed and deceleration for the desired movement.
WM_MOTION_SetMoveable()
Sets movability flags for the given window.
WM_MOTION_SetMovement()
Sets speed and distance for the desired movement.
WM_MOTION_SetSpeed()
Sets the speed for the desired movement.
ToolTip related functions
WM_TOOLTIP_AddTool()
Adds a tool to an existing ToolTip object.
WM_TOOLTIP_Create()
Creates a ToolTip.
WM_TOOLTIP_Delete()
Deletes the given ToolTip.
WM_TOOLTIP_SetDefaultFont() Sets the default font to be used for drawing ToolTip windows.
WM_TOOLTIP_SetDefaultColor() Sets the default colors to be used for drawing ToolTip windows.
WM_TOOLTIP_SetDefaultPeriod( Sets the default timing periods to be used for ToolTips. Memory device support (optional)
WM_DisableMemdev()
Disables usage of memory devices for redrawing.
WM_EnableMemdev()
Enables usage of memory devices for redrawing.
Timer related
WM_CreateTimer()
Creates a timer which sends a WM_TIMER message to a window.
WM_DeleteTimer()
Deletes a timer.
WM_GetTimerId()
Gets the Id of the given timer.
WM_RestartTimer()
Restarts a timer.
Widget related functions
WM_GetClientWindow()
Returns the handle of the client window.
WM_GetId()
Returns the ID of a widget.
WM_GetInsideRect()
Returns the size of the active window less the border.
WM_GetInsideRectEx()
Returns the size of a window less the border.
WM_GetScrollPosH()
Returns the horizontal scroll position of a window.
WM_GetScrollPosV()
Returns the vertical scroll position of a window.
WM_GetScrollState()
Gets the state of a SCROLLBAR widget.
WM_SetScrollPosH()
Sets the horizontal scroll position of a window.
WM_SetScrollPosV()
Sets the vertical scroll position of a window.
WM_SetScrollState()
Sets the state of a SCROLLBAR widget.
15.7.1 Using the WM API functions
Many of the WM functions have window handles as parameters. Observe the following rules when using handles: · Window handles can be 0. In this case functions usually return immediately.
Functions which do not follow this rule are described accordingly. · If a window handle is != 0, it should be a valid handle. The WM does not check if
the given handle is valid. If an invalid handle is given to a function it fails or may even cause the application to crash.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
355
15.8 WM API: Basic functions
WM_Activate()
Description
Activates the Window Manager.
Prototype
void WM_Activate(void);
Additional information
The WM is activated by default after initialization. This function only needs to be called if there has been a previous call of WM_Deactivate().
WM_AttachWindow()
Description
The given window will be detached from its parent window and attached to the new parent window. The new origin in window coordinates of the new parent window will be the same as the old origin in window coordinates of the old parent window.
Prototype
void WM_AttachWindow(WM_HWIN hWin, WM_HWIN hParent);
Parameter hWin hWinParent
Description
Window handle. Window handle of the new parent.
Additional information
If the given window handle is 0 or both handles are the same the function returns immediately. If only the given parent window handle is 0 the function detaches the given window and returns; the window remains unattached.
WM_AttachWindowAt()
Description
The given window will be detached from its parent window and attached to the new parent window. The given position will be used to set the origin of the window in window coordinates of the parent window.
Prototype
void WM_AttachWindowAt(WM_HWIN hWin, WM_HWIN hParent, int x, int y);
Parameter hWin hWinParent x y
Description
Window handle. Window handle of the new parent. X position of the window in window coordinates of the parent window. Y position of the window in window coordinates of the parent window.
Additional information
If the given window handle is 0 or both handles are the same the function returns immediately. If only the given parent window handle is 0 the function detaches the given window, moves it to the new position and returns; the window remains unattached.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
356
CHAPTER
The Window Manager (WM)
WM_BringToBottom()
Description
Places a specified window underneath its siblings.
Prototype
void WM_BringToBottom(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
The window will be placed underneath all other sibling windows, but will remain in front of its parent.
WM_BringToTop()
Description
Places a specified window on top of its siblings.
Prototype
void WM_BringToTop(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
The window will be placed on top of all other sibling windows and its parent.
WM_BroadcastMessage()
Description
Sends the given message to all existing windows.
Prototype
int WM_BroadcastMessage(WM_MESSAGE * pMsg);
Parameter pMsg
Pointer to message to be send.
Description
Additional information
A window should not delete itself or a parent window in reaction of a broadcasted message.
WM_ClrHasTrans()
Description
Clears the has transparency flag (sets it to 0).
Prototype
void WM_ClrHasTrans(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
357
Additional information
When set, this flag tells the Window Manager that a window contains sections which are not redrawn and will therefore be transparent. The WM then knows that the background needs to be redrawn prior to redrawing the window in order to make sure the transparent sections are restored correctly. When the flag is cleared with WM_ClrHasTrans(), the WM will not automatically redraw the background before redrawing the window.
WM_CreateWindow()
Description
Creates a window of a specified size at a specified location.
Prototype
WM_HWIN WM_CreateWindow(int x0, int width, U32 Style, int NumExtraBytes);
int
y0,
int
height,
WM_CALLBACK * cb
Parameter x0 y0 width height Style cb NumExtraBytes
Description
Upper left X-position in desktop coordinates. Upper left Y-position in desktop coordinates. X-size of window. Y-size of window. Window create flags, listed below. Pointer to callback routine, or NULL if no callback used.
Number of extra bytes to be allocated, normally 0.
Permitted values for parameter Style (OR-combinable)
WM_CF_ANCHOR_BOTTOM WM_CF_ANCHOR_LEFT WM_CF_ANCHOR_RIGHT WM_CF_ANCHOR_TOP WM_CF_BGND
WM_CF_CONST_OUTLINE
Anchors the bottom edge of the new window relative to the bottom edge of the parent window. If the position of the parent windows bottom edge will be adjusted due to a size change, the position of new window will also be adjusted.
Anchors the left edge of the new window relative to the left edge of the parent window (default). If the position of the parent windows left edge will be adjusted due to a size change, the position of new window will also be adjusted.
Anchors the right edge of the new window relative to the right edge of the parent window. If the position of the parent windows right edge will be adjusted due to a size change, the position of new window will also be adjusted.
Anchors the top edge of the new window relative to the top edge of the parent window (default). If the position of the parent windows top edge will be adjusted due to a size change, the position of new window will also be adjusted.
Put window in background after creation.
This flag is an optimization for transparent windows. It gives the Window Manager a chance to optimize redraw and invalidation of a transparent window. A transparent window is normally redrawn as part of the background, which is less efficient than redrawing the window separately. However, this flag may NOT be used if the window has semi transparency (alpha blending / antialiasing with background) or the outline (the shape) changes. Can normally be used; in case of doubt do not use it.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
358
CHAPTER
The Window Manager (WM)
Permitted values for parameter Style (OR-combinable)
WM_CF_FGND
Put window in foreground after creation (default).
WM_CF_HASTRANS
Has transparency flag. Must be defined for
windows whose client area is not entirely filled.
WM_CF_HIDE WM_CF_LATE_CLIP
WM_CF_MEMDEV WM_CF_MEMDEV_ON_REDRAW
Hide window after creation (default).
This flag can be used to tell the WM that the clipping should be done in the drawing routines (late clipping). The default behavior of the WM is early clipping. That means that the clipping rectangle will be calculated before a WM_PAINT message will be send to a window. In dependence of other existing windows it can be necessary to send more than one WM_PAINT message
to a window. If using WM_CF_LATE_CLIP the
WM makes sure only one message will be sent to an invalid window and the clipping will be
done by the drawing routines. The Sample
folder of emWin contains the example
WM_LateClipping.c to show the effect.
Automatically use a memory device when redrawing. This will avoid flicker and also improve the output speed in most cases, as clipping is simplified. Note that the memory device package is required (and needs to be enabled in the configuration) in order to be able to use this flag. If memory devices are not enabled, this flag is ignored.
After the window is drawn the first time the WM will automatically use a memory device for redrawing. This flag can be used as a replacement of WM_CF_MEMDEV. It typically accelerates the initial rendering of the window, but maintains the advantage of flicker free updates.
WM_CF_SHOW WM_CF_STAYONTOP
Show window after creation.
Make sure window stays on top of all siblings created without this flag.
Return value
Handle for created window.
Additional information
Several create flags can be combined by using the (OR) operator. Negative-position coordinates may be used.
Examples
Creates a window with callback: hWin2 = WM_CreateWindow(100, 10 ,180, 100, WM_CF_SHOW, &WinHandler, 0);
Creates a window without callback: hWin2 = WM_CreateWindow(100, 10 ,180, 100,WM_CF_SHOW, NULL, 0);
WM_CreateWindowAsChild()
Description
Creates a window as a child window.
Prototype
WM_HWIN WM_CreateWindowAsChild(int x0, int y0, int width, int height, WM_HWIN hWinParent, U8 Style, WM_CALLBACK * cb int NumExtraBytes);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
359
Parameter x0 y0 width height hWinParent Style cb NumExtraBytes
Description
Upper left X-position in window coordinates of the parent window. Upper left Y-position in window coordinates of the parent window. X-size of window. If 0, X-size of client area of parent window. Y-size of window. If 0, Y-size of client area of parent window. Handle of parent window.
Window create flags (see WM_CreateWindow()).
Pointer to callback routine, or NULL if no callback used.
Number of extra bytes to be allocated, normally 0.
Return value
Handle for the child window.
Additional information
If the hWinParent parameter is set to 0, the background window is used as parent. A child window is placed on top of its parent and any previous siblings by default, so that if their Z-positions are not changed, the "youngest" window will always be topmost. The Z-positions of siblings may be changed, although they will always remain on top of their parent regardless of their order.
WM_Deactivate()
Description
Deactivates the Window Manager.
Prototype
void WM_Deactivate(void);
Additional information
After calling this function, the clip area is set to the complete LCD area and the WM will not execute window callback functions.
WM_DefaultProc()
Description
Default message handler.
Prototype
void WM_DefaultProc(WM_MESSAGE * pMsg);
Parameter pMsg
Pointer to message.
Description
Additional information
Use this function to handle unprocessed messages as in the following example:
static WM_RESULT cbBackgroundWin(WM_MESSAGE * pMsg) { switch (pMsg->MsgId) { case WM_PAINT: GUI_Clear(); default: WM_DefaultProc(pMsg); }
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
360
CHAPTER
The Window Manager (WM)
WM_DeleteWindow()
Description
Deletes a specified window.
Prototype
void WM_DeleteWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
Before the window is deleted, it receives a WM_DELETE message. This message is typically used to delete any objects (widgets) it uses and to free memory dynamically allocated by the window. If the specified window has any existing child windows, these are automatically deleted before the window itself is deleted. Child windows therefore do not need to be separately deleted. Before the window will be deleted it sends a WM_NOTIFICATION_CHILD_DELETED message to its parent window.
WM_DetachWindow()
Description
Detaches a window from its parent window. Detached windows will not be redrawn by the Window Manager.
Prototype
void WM_DetachWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
WM_DisableWindow()
Description
Set the specified window to a disabled state. The WM does not pass pointer input device (PID) messages (touch, mouse, joystick, ...) to a disabled window.
Prototype
void WM_DisableWindow(WM_Handle hObj);
Parameter hObj
Handle of widget.
Description
Additional information
A widget that is disabled will typically appear gray, and will not accept input from the user. However, the actual appearance may vary (depends on widget/configuration settings, etc.). A disabled window will not receive the following messages: WM_TOUCH, WM_TOUCH_CHILD, WM_PID_STATE_CHANGED and WM_MOUSEOVER.
WM_EnableWindow()
Description
Sets the specified window to enabled state. An enabled window receives pointer input device (PID) messages (touch, mouse, joystick, ...) from the WM.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
361
Prototype
void WM_EnableWindow(WM_Handle hObj);
Parameter hObj
Handle of window.
Description
Additional information
This is the default setting for any widget.
WM_Exec()
Description
Redraws invalid windows by executing callback functions (all jobs).
Prototype
int WM_Exec(void);
Return value
0 if there were no jobs performed. 1 if a job was performed.
Additional information
This function will automatically call WM_Exec1() repeatedly until it has completed all jobs -- essentially until a 0 value is returned. It is recommended to call the function GUI_Exec() instead. Normally this function does not need to be called by the user application. It is called automatically by GUI_Delay(). If you are using a multitasking system, we recommend executing this function by a separate task as seen below: void ExecIdleTask(void) {
while(1) { WM_Exec();
} }
WM_Exec1()
Description
Redraws an invalid window by executing one callback function (one job only).
Prototype
int WM_Exec1(void);
Return value
0 if there were no jobs performed. 1 if a job was performed.
Additional information
This routine may be called repeatedly until 0 is returned, which means all jobs have been completed. It is recommended to call the function GUI_Exec1() instead. This function is called automatically by WM_Exec().
WM_ForEachDesc()
Description
Iterates over all descendants of the given window. A descendant of a window is a child window or a grand child window or a child of a grand child or ....
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
362
CHAPTER
The Window Manager (WM)
Prototype
void WM_ForEachDesc(WM_HWIN hWin, WM_tfForEach * pcb, void * pData);
Parameter hWin pcb pData
Description
Window handle.
Pointer to callback function to be called by WM_ForEachDesc.
User data to be passed to the callback function.
Additional information
This function calls the callback function given by the pointer pcb for each descendant of the given window. The parameter pData will be passed to the user function and can be used to point to user defined data.
Prototype of callback function
void CallbackFunction(WM_HWIN hWin, void * pData);
Example
The following example shows how the function can be used. It creates 3 windows, the first as a child window of the desktop, the second as a child window of the first window and the third as a child window of the second window. After creating the window it uses WM_ForEachDesc() to move each window within its parent window:
static void _cbWin(WM_MESSAGE * pMsg) { GUI_COLOR Color; switch (pMsg->MsgId) { case WM_PAINT: WM_GetUserData(pMsg->hWin, &Color, 4); GUI_SetBkColor(Color); GUI_Clear(); break; default: WM_DefaultProc(pMsg); }
}
static void _cbDoSomething(WM_HWIN hWin, void * p) { int Value = *(int *)p; WM_MoveWindow(hWin, Value, Value);
}
void MainTask(void) { WM_HWIN hWin_1, hWin_2, hWin_3; int Value = 10; GUI_COLOR aColor[] = {GUI_RED, GUI_GREEN, GUI_BLUE}; GUI_Init(); WM_SetDesktopColor(GUI_BLACK); hWin_1 = WM_CreateWindow( 10, 10, 100, 100, WM_CF_SHOW, _cbWin, 4); hWin_2 = WM_CreateWindowAsChild(10, 10, 80, 80, hWin_1, WM_CF_SHOW, _cbWin, 4); hWin_3 = WM_CreateWindowAsChild(10, 10, 60, 60, hWin_2, WM_CF_SHOW, _cbWin, 4); WM_SetUserData(hWin_1, &aColor[0], 4); WM_SetUserData(hWin_2, &aColor[1], 4); WM_SetUserData(hWin_3, &aColor[2], 4); while(1) { WM_ForEachDesc(WM_HBKWIN, _cbDoSomething, (void *)&Value); Value *= -1; GUI_Delay(500); }
}
WM_GetCallback()
Description
Returns a pointer to the callback function of the given window
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
363
Prototype
WM_CALLBACK * WM_GetCallback(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
Pointer of type WM_CALLBACK which points to the callback function of the given window. If the window has no callback function, NULL is returned.
WM_GetActiveWindow()
Description
Returns the handle of the active window used for drawing operations.
Prototype
WM_HWIN WM_GetActiveWindow(void);
Additional information
This function should be used only when the message WM_PAINT is processed in a window callback function.
Return value
The handle of the active window.
WM_GetClientRect()
Description
Returns the coordinates of the client area in the active window in window coordinates. That means x0 and y0 of the GUI_RECT structure will be 0, x1 and y1 corresponds to the size - 1.
Prototype
void WM_GetClientRect(GUI_RECT * pRect);
Parameter pRect
Description
Pointer to a GUI_RECT structure.
WM_GetClientRectEx()
Description
Returns the coordinates of the client area of a window in window coordinates. That means x0 and y0 of the GUI_RECT structure will be 0, x1 and y1 corresponds to the size - 1.
Prototype
void WM_GetClientRectEx(WM_HWIN hWin, GUI_RECT * pRect);
Parameter hWin pRect
Description
Window handle. Pointer to a GUI_RECT structure.
WM_GetDesktopWindow()
Description
Returns the handle of the desktop window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
364
CHAPTER
The Window Manager (WM)
Prototype
WM_HWIN WM_GetDesktopWindow(void);
Return value
The handle of the desktop window.
Additional information
The desktop window is always the bottommost window and any further created windows are its descendants.
WM_GetDesktopWindowEx()
Description
Returns the handle of the specified desktop window when working in a multi layer environment.
Prototype
WM_HWIN WM_GetDesktopWindowEx(unsigned int LayerIndex);
Parameter LayerIndex
Index of layer
Description
Return value
The handle of the specified desktop window.
WM_GetDialogItem()
Description
Returns the window handle of a dialog box item (widget).
Prototype
WM_HWIN WM_GetDialogItem(WM_HWIN hDialog, int Id);
Parameter hDialog Id
Handle of dialog box. Window Id of the widget.
Description
Return value
The window handle of the widget.
Additional information
This function is always used when creating dialog boxes, since the window Id of a widget used in a dialog must be converted to its handle before it can be used.
WM_GetFirstChild()
Description
Returns the handle of a specified window's first child window.
Prototype
void WM_GetFirstChild(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
Handle of the window's first child window; 0 if no child window exists.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
365
Additional information
A window's first child window is the first child created to that particular parent. If the Z-positions of the windows have not been changed, it will be the window directly on top of the specified parent.
WM_GetFocussedWindow()
Description
Returns the handle of the window with the input focus.
Prototype
WM_HWIN WM_GetFocussedWindow(void);
Return value
Handle of the window with the input focus or 0 if no window has the input focus.
WM_GetHasTrans()
Description
Returns the current value of the has transparency flag.
Prototype
U8 WM_GetHasTrans(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
0: no transparency 1: window has transparency
Additional information
When set, this flag tells the Window Manager that a window contains sections which are not redrawn and will therefore be transparent. The WM then knows that the background needs to be redrawn prior to redrawing the window in order to make sure the transparent sections are restored correctly.
WM_GetInvalidRect()
Description
Returns the invalid rectangle of a window in desktop coordinates.
Prototype
int WM_GetInvalidRect(WM_HWIN hWin, GUI_RECT * pRect);
Parameter hWin pRect
Description
Window handle. Pointer to a GUI_RECT-structure for storing the invalid rectangle.
Return value
0 if nothing is invalid, otherwise 1.
WM_GetNextSibling()
Description
Returns the handle of a specified window's next sibling.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
366
CHAPTER
The Window Manager (WM)
Prototype
void WM_GetNextSibling(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
Handle of the window's next sibling; 0 if none exists.
Additional information
A window's next sibling is the next child window that was created relative to the same parent. If the Z-positions of the windows have not been changed, it will be the window directly on top of the one specified.
WM_GetOrgX(), WM_GetOrgY()
Description
Returns the X- or Y-position (respectively) of the origin of the active window in desktop coordinates.
Prototypes
int WM_GetOrgX(void); int WM_GetOrgY(void);
Return value
X- or Y-position of the origin of the active window in desktop coordinates.
WM_GetParent()
Description
Returns the handle of a specified window's parent window.
Prototype
void WM_GetParent(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
Handle of the window's parent window; 0 if none exists.
Additional information
The only case in which no parent window exists is if the handle of the desktop window is used as parameter.
WM_GetPrevSibling()
Description
Returns the handle of a specified window's previous sibling.
Prototype
void WM_GetPrevSibling(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
367
Return value
Handle of the window's previous sibling; 0 if none exists.
Additional information
A window's previous sibling is the previous child window that was created relative to the same parent. If the Z-positions of the windows have not been changed, it will be the window directly below of the one specified.
WM_GetStayOnTop()
Description
Returns the current value of the stay on top flag.
Prototype
int WM_GetStayOnTop(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
0: stay on top flag not set 1: stay on top flag set
WM_GetUserData()
Description
Retrieves the data set with WM_SetUserData().
Prototype
int WM_GetUserData(WM_HWIN hWin, void * pDest, int SizeOfBuffer);
Parameter hWin pDest SizeOfBuffer
Window handle. Pointer to buffer. SIze of buffer.
Description
Return value
Number of bytes retrieved.
Additional information
The maximum number of bytes returned by this function is the number of ExtraBytes specified when creating the window.
WM_GetWindowOrgX(), WM_GetWindowOrgY()
Description
Returns the X- or Y-position (respectively) of the origin of the specified window in desktop coordinates.
Prototypes
int WM_GetWindowOrgX(WM_HWIN hWin); int WM_GetWindowOrgY(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
368
CHAPTER
The Window Manager (WM)
Return value
X- or Y-position of the client area in pixels.
WM_GetWindowRect()
Description
Returns the coordinates of the active window in desktop coordinates.
Prototype
void WM_GetWindowRect(GUI_RECT * pRect);
Parameter pRect
Description
Pointer to a GUI_RECT structure.
WM_GetWindowRectEx()
Description
Returns the coordinates of a window in desktop coordinates.
Prototype
void WM_GetWindowRectEx(WM_HWIN hWin, GUI_RECT * pRect);
Parameter hWin pRect
Description
Window handle. Pointer to a GUI_RECT structure.
Additional information
If the given window handle is 0 or the given pointer to the GUI_RECT structure is NULL the function returns immediately.
WM_GetWindowSizeX(), WM_GetWindowSizeY()
Description
Return the X- or Y-size (respectively) of a specified window.
Prototypes
int WM_GetWindowSizeX(WM_HWIN hWin); int WM_GetWindowSizeY(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
X- or Y-size of the window in pixels. Defined as x1-x0+1 in horizontal direction, y1-y0+1 in vertical direction, where x0, x1, y0, y1 are the leftmost/rightmost/topmost/bottommost positions of the window. If the given window handle is 0 the function returns the size of the desktop window.
WM_HasCaptured()
Description
Checks if the given window has captured PID input.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
369
Prototype
int WM_HasCaptured(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
1 if the given window has captured mouse- and touchscreen-input, 0 if not.
Additional information
If the given window handle is invalid or 0 the function returns a wrong result.
WM_HasFocus()
Description
Checks if the given window has the input focus.
Prototype
int WM_HasFocus(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
1 if the given window has the input focus, otherwise 0.
Additional information
If the given window handle is invalid or 0 the function returns a wrong result.
WM_HideWindow()
Description
Makes a specified window invisible.
Prototype
void WM_HideWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
The window will not immediately appear "invisible" after calling this function. The invalid areas of other windows (areas which appear to lie "behind" the window which should be hidden) will be redrawn when executing WM_Exec(). If you need to hide (draw over) a window immediately, you should call WM_Paint() to redraw the other windows.
WM_InvalidateArea()
Description
Invalidates a specified, rectangular area of the display.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
370
CHAPTER
The Window Manager (WM)
Prototype
void WM_InvalidateArea(GUI_RECT * pRect);
Parameter pRect
Description
Pointer to a GUI_RECT structure with desktop coordinates.
Additional information
Calling this function will tell the WM that the specified area is not updated. This function can be used to invalidate any windows or parts of windows that overlap or intersect the area. The coordinates of the GUI_RECT structure have to be in desktop coordinates.
WM_InvalidateRect()
Description
Invalidates a specfied, rectangular area of a window.
Prototype
void WM_InvalidateRect(WM_HWIN hWin, GUI_RECT * pRect);
Parameter hWin pRect
Description
Window handle. Pointer to a GUI_RECT structure with window coordinates of the parent window.
Additional information
Calling this function will tell the WM that the specified area is not updated. The next time WM_Paint() is called to redraw the window, the area will be redrawn as well. The coordinates of the GUI_RECT structure have to be in window coordinates.
WM_InvalidateWindow()
Description
Invalidates a specified window.
Prototype
void WM_InvalidateWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
Calling this function tells the WM that the specified window is not updated.
WM_IsCompletelyCovered()
Description
Checks if the given window is completely covered or not.
Prototype
char WM_IsCompletelyCovered(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
1 if the given window is completely covered, otherwise 0.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
371
Additional information
If the given window handle is invalid or 0 the function returns a wrong result.
WM_IsCompletelyVisible()
Description
Checks if the given window is completely visible or not.
Prototype
char WM_IsCompletelyVisible(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
1 if the given window is completely visible, otherwise 0.
Additional information
If the given window handle is invalid or 0 the function returns a wrong result.
WM_IsEnabled()
Description
This function returns if a window is enabled or not.
Prototype
int WM_IsEnabled(WM_HWIN hObj);
Parameter hObj
Handle of window.
Description
Return value
1 if the window is enabled, 0 if not.
Additional information
A widget that is disabled will typically appear gray, and will not accept input from the user. However, the actual appearance may vary (depends on widget/configuration settings, etc.)
WM_IsVisible()
Description
Determines whether or not a specified window is visible.
Prototype
int WM_IsVisible(WM_HWIN hWin);
Parameter hWin
Window handle.
Return value
0: Window is not visible 1: Window is visible
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
372
CHAPTER
The Window Manager (WM)
WM_IsWindow()
Description
Determines whether or not a specified handle is a valid window handle.
Prototype
void WM_IsWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
0: handle is not a valid window handle 1: handle is a valid window handle
Additional information
This function should be used only if absolutely necessary. The more windows exist the more time will be used to evaluate, if the given handle is a window.
WM_MakeModal()
Description
This function makes the window work in 'modal' mode. This means pointer device input will only be send to the 'modal' window or a child window of it if the input position is within the rectangle of the modal window.
Prototype
void WM_MakeModal(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
WM_MoveChildTo()
Description
Moves a specified window to a certain position.
Prototype
void WM_MoveChildTo(WM_HWIN hWin, int x, int y);
Parameter hWin x y
Description
Window handle. New X-position in window coordinates of the parent window. New Y-position in window coordinates of the parent window.
WM_MoveTo()
Description
Moves a specified window to a certain position.
Prototype
void WM_MoveTo(WM_HWIN hWin, int x, int y);
Parameter hWin x y
Description
Window handle. New X-position in desktop coordinates. New Y-position in desktop coordinates.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
373
WM_MoveWindow()
Description
Moves a specified window by a certain distance.
Prototype
void WM_MoveWindow(WM_HWIN hWin, int dx, int dy);
Parameter hWin dx dy
Window handle. Horizontal distance to move. Vertical distance to move.
Description
WM_NotifyParent()
Description
Sends a WM_NOTIFY_PARENT message to the given window.
Prototype
void WM_NotifyParent(WM_HWIN hWin, int Notification);
Parameter hWin Notification
Description
Window handle. Value to send to the parent window.
Additional information
The Notification-parameter will be send in the Data.v element of the message. The macro WM_NOTIFICATION_USER can be used for defining application defined messages:
#define NOTIFICATION_1 (WM_NOTIFICATION_USER + 0) #define NOTIFICATION_2 (WM_NOTIFICATION_USER + 1)
WM_Paint()
Description
Draws or redraws a specified window immediately.
Prototype
void WM_Paint(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
The window is redrawn reflecting all updates made since the last time it was drawn.
WM_PaintWindowAndDescs()
Description
Paints the given window and all its descendants.
Prototype
void WM_PaintWindowAndDescs(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
374
CHAPTER
The Window Manager (WM)
Additional information
The function draws the complete window regions by invalidating them before drawing.
WM_ReleaseCapture()
Description
Releases capturing of mouse- and touchscreen-input.
Prototype
void WM_ReleaseCapture(void);
Additional information
Use WM_SetCapture() to send all mouse- and touchscreen-input to a specific window.
WM_ResizeWindow()
Description
Changes the size of a specified window by adding (or subtracting) the given differences.
Prototype
void WM_ResizeWindow(WM_HWIN hWin, int XSize, int YSize);
Parameter hWin dx dy
Window handle. Difference in X. Difference in Y.
Description
WM_Screen2hWin()
Description
Returns the window which lies at the specified position.
Prototype
WM_HWIN WM_Screen2hWin(int x, int y);
Parameter x y
x-coordinate y-coordinate
Description
Return value
Handle to the found window.
WM_Screen2hWinEx()
Description
Returns the window which lies at the specified position.
Prototype
WM_HWIN WM_Screen2hWinEx(WM_HWIN hStop, int x, int y);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
375
Parameter hStop x y
Description
Handle of a descendant (low-level window) to stop at. x-coordinate y-coordinate
Return value
Handle to the found window. If hStop was found the handle to it's parent window is returned.
WM_SelectWindow()
Description
Sets the active window to be used for drawing operations.
Prototype
WM_HWIN WM_SelectWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
The selected window.
Additional information
This function should not be called within a paint function called by the Window Manager. If the Window Manager sends a WM_PAINT message the target window already has been selected. When working with a multi layer configuration the function switches also to the layer of the top level parent window of the given window. If the given window handle is 0 the function selects the first created window, normally the first desktop window.
Example
Sets a window with handle hWin2 to the active window, sets the background color, and then clears the window:
WM_SelectWindow(hWin2); GUI_SetBkColor(0xFF00); GUI_Clear();
WM_SendMessage()
Description
Sends a message to a specified window.
Prototype
void WM_SendMessage(WM_HWIN hWin, WM_MESSAGE * pMsg)
Parameter hWin pMsg
Description
Window handle. Pointer to a WM_MESSAGE structure. See "Elements of WM_MESSAGE" on page 340.
Additional information
This function can be also used to send custom messages as described in the section "Application-defined messages" on page 350.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
376
CHAPTER
The Window Manager (WM)
WM_SendMessageNoPara()
Description
Sends a message without parameters to a specified window.
Prototype
void WM_SendMessageNoPara(WM_HWIN hWin, int MsgId)
Parameter hWin MsgId
Window handle. Id of message to be send.
Description
Additional information
If only a message Id should be send to a window this should be done with this function, because it does not need a pointer to a WM_MESSAGE structure. Note that the receiving window gets no further information except the message Id. This function can be used to send application-defined messages. For details, please refer to page 350.
WM_SendToParent()
Description
Sends the given message to the parent window of the given window.
Prototype
void WM_SendToParent(WM_HWIN hWin, WM_MESSAGE * pMsg);
Parameter hWin pMsg
Description
Window handle. Pointer to WM_MESSAGE-structure.
WM_SetCallback()
Description
Sets a callback routine to be executed by the Window Manager.
Prototype
WM_CALLBACK * WM_SetCallback(WM_HWIN hWin, WM_CALLBACK * cb)
Parameter hWin cb
Window handle. Pointer to callback routine.
Description
Return value
Pointer to the previous callback routine.
Additional information
The given window will be invalidated. This makes sure the window will be redrawn.
WM_SetCapture()
Description
Routes all PID-messages to the given window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
377
Prototype
void WM_SetCapture(WM_HWIN hObj, int AutoRelease);
Parameter hWin AutoRelease
Description
Window handle. 1 if capturing should end when the user releases the touch.
WM_SetCaptureMove()
Description
Moves a window according to the given PID state. This function is intended to be used in a window callback function. It should react to the message WM_TOUCH if the PID is in pressed state.
Prototype
void WM_SetCaptureMove(WM_HWIN hWin,
GUI_PID_STATE * pState,
int MinVisibility, int LimitTop);
Parameter
Description
hWin
Handle of the window which should be moved.
pState
Pointer to the PID state.
Defines the minimum visibility of the parent window in pixels. The window will not be
MinVisibility moved farther than the parent window reduced by the minimum visibility.
LimitTop
Defines a number of top pixel lines which can not be moved outside the parent rectangle. The bottom pixel lines which are excluded are allowed to be moved outside the parent rectangle.
Example
The following example application shows a callback function of a window which is moved using WM_SetCaptureMove():
static void _cbWin(WM_MESSAGE * pMsg) { const GUI_PID_STATE * pState; WM_HWIN hWin;
hWin = pMsg->hWin; switch (pMsg->MsgId) { case WM_TOUCH:
pState = (const GUI_PID_STATE *)pMsg->Data.p; if (pState) {
if (pState->Pressed) { WM_SetCaptureMove(hWin, pState, 0, 0);
} } break; case WM_PAINT: GUI_SetBkColor(GUI_DARKBLUE); GUI_Clear(); break; default: WM_DefaultProc(pMsg); } }
void MainTask(void) { WM_HWIN hWin;
GUI_Init(); WM_SetDesktopColor(GUI_DARKGREEN); hWin = WM_CreateWindow(10, 10, 200, 100, WM_CF_SHOW, _cbWin, 0); while (1) {
GUI_Delay(1); } }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
378
CHAPTER
The Window Manager (WM)
WM_SetCreateFlags()
Description
Sets the flags to be used as default when creating a new window.
Prototype
U8 WM_SetCreateFlags(U8 Flags);
Parameter Flags
Description Window create flags (see WM_CreateWindow()).
Return value
Former value of this parameter.
Additional information
The flags specified here are binary ORed with the flags specified in the WM_CreateWindow() and WM_CreateWindowAsChild() routines. The flag WM_CF_MEMDEV is frequently used to enable memory devices on all windows. Please note that it is permitted to set create flags before GUI_Init() is called. This causes the background window to be also affected by the create flags.
Example
WM_SetCreateFlags(WM_CF_MEMDEV); /* Auto. use memory devices on all windows */
WM_SetDesktopColor()
Description
Sets the color for the desktop window.
Prototype
GUI_COLOR WM_SetDesktopColor(GUI_COLOR Color);
Parameter Color
Description
Color for desktop window, 24-bit RGB value.
Return value
The previously selected desktop window color.
Additional information
The default setting for the desktop window is not to repaint itself. If this function is not called, the desktop window will not be redrawn at all; therefore other windows will remain visible even after they are deleted. Once a color is specified with this function, the desktop window will repaint itself. In order to restore the default, call this function and specify GUI_INVALID_COLOR.
WM_SetDesktopColorEx()
Description
Sets the color for the desktop window in a multi layer environment.
Prototype
GUI_COLOR WM_SetDesktopColorEx(GUI_COLOR Color, unsigned int LayerIndex);
Parameter Color LayerIndex
Description
Color for desktop window, 24-bit RGB value. Index of the layer.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
379
Return value
The previously selected desktop window color.
Additional information
(see WM_SetDesktopColor).
WM_SetFocus()
Description
Sets the input focus to a specified window.
Prototype
void WM_SetFocus(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Return value
0 if window accepted focus; value other than 0 if it could not.
Additional information
The window receives a WM_SET_FOCUS message which gives it the input focus. If for some reason the window could not accept the focus, nothing happens.
WM_SetHasTrans()
Description
Enables transparency for the given window.
Prototype
void WM_SetHasTrans(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
Using this function causes the Window Manager to redraw the background of the given window in order to have the transparent parts updated before the actual window is drawn.
WM_SetId()
Description
This function sends a WM_SET_ID message to the given window.
Prototype
void WM_SetId(WM_HWIN hObj, int Id);
Parameter hObj Id
Window handle. Id to be send to the window.
Description
Additional information
This function can be used to change the Id of a widget. It works with every widget. When using this function with a application defined window, the callback function of the window should handle the message. Otherwise it will be ignored.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
380
CHAPTER
The Window Manager (WM)
WM_SetpfPollPID()
Description
Sets a function which will be called by the Window Manager in order to poll the pointer input device (touch-screen or mouse).
Prototype
WM_tfPollPID * WM_SetpfPollPID(WM_tfPollPID * pf);
Parameter pf
Description Pointer to a function of type WM_tfPollPID.
Additional information
The function type is defined as follows: typedef void WM_tfPollPID(void);
Example
Example of a touch-screen handled as a device: void ReadTouch(void) {
// ...read touchscreen }
WM_SetpfPollPID(ReadTouch);
WM_SetSize()
Description
Sets the new size of a window.
Prototype
void WM_SetSize(WM_HWIN hWin, int XSize, int YSize);
Parameter hWin XSize YSize
Window handle. New size in X. New size in Y.
Description
WM_SetWindowPos()
Description
Sets the size and the position of a window.
Prototype
void WM_SetWindowPos(WM_HWIN hWin,
int
xPos, int yPos,
int
xSize, int ySize);
Parameter hWin xPos yPos xSize ySize
Description
Window handle. New position in X in desktop coordinates. New position in Y in desktop coordinates. New size in X. New size in Y.
WM_SetXSize()
Description
Sets the new X-size of a window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
381
Prototype
void WM_SetXSize(WM_HWIN hWin, int XSize);
Parameter hWin XSize
Window handle. New size in X.
Description
WM_SetYSize()
Description
Sets the new Y-size of a window.
Prototype
void WM_SetYSize(WM_HWIN hWin, int YSize);
Parameter hWin YSize
Window handle. New size in Y.
Description
WM_SetStayOnTop()
Description
Sets the stay on top flag.
Prototype
void WM_SetStayOnTop(WM_HWIN hWin, int OnOff);
Parameter hWin OnOff
Window handle. See table below.
Description
Permitted values for parameter OnOff
0
Stay on top flag would be cleared.
1
Stay on top flag would be set.
WM_SetTransState()
Description
This function sets or clears the flags WM_CF_HASTRANS and WM_CF_CONST_OUTLINE of the given window.
Prototype
void WM_SetTransState(WM_HWIN hWin, unsigned State);
Parameter hWin State
Description
Window handle.
Combination of the flags WM_CF_HASTRANS and WM_CF_CONST_OUTLINE.
Additional information
For details about the flag WM_CF_CONST_OUTLINE, refer to "WM_CreateWindow()" on page 357.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
382
CHAPTER
The Window Manager (WM)
WM_SetUserClipRect()
Description
Temporarily reduces the clip area of the current window to a specified rectangle.
Prototype
const GUI_RECT * WM_SetUserClipRect(const GUI_RECT * pRect);
Parameter pRect
Description
Pointer to a GUI_RECT structure defining the clipping region in desktop coordinates.
Return value
Pointer to the previous clip rectangle.
Additional information
A NULL pointer can be passed in order to restore the default settings. The clip rectangle will automatically be reset by the WM when callbacks are used. The specified rectangle must be relative to the current window. You cannot enlarge the clip rectangle beyond the current window rectangle. Your application must ensure that the specified rectangle retains its value until it is no longer needed; that is, until a different clip rectangle is specified or until a NULL pointer is passed. This means that the rectangle structure passed as parameter should not be an auto variable (usually located on the stack) if the clip rectangle remains active until after the return. In this case, a static variable should be used.
Example
This example is taken from the drawing routine of a progress indicator. The progress indicator must write text on top of the progress bar, where the text color has to be different on the left and right parts of the bar. This means that half of a digit could be in one color, while the other half could be in a different color. The best way to do this is to temporarily reduce the clip area when drawing each part of the bar as shown below: /* Draw left part of the bar */
r.x0=0; r.x1=x1-1; r.y0=0; r.y1 = GUI_YMAX; WM_SetUserClipRect(&r); GUI_SetBkColor(pThis->ColorBar[0]); GUI_SetColor(pThis->ColorText[0]); GUI_Clear(); GUI_GotoXY(xText,yText); GUI_DispDecMin(pThis->v); GUI_DispChar('%'); /* Draw right part of the bar */ r.x0=r.x1; r.x1=GUI_XMAX; WM_SetUserClipRect(&r); GUI_SetBkColor(pThis->ColorBar[1]); GUI_SetColor(pThis->ColorText[1]); GUI_Clear(); GUI_GotoXY(xText,yText); GUI_DispDecMin(pThis->v); GUI_DispChar('%');
Screen shot of progress bar
WM_SetUserData()
Description
Sets the extra data of a window. Memory for extra data is reserved with the parameter NumExtraBytes when creating a window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
383
Prototype
int WM_SetUserData(WM_HWIN hWin, void * pSrc, int NumBytes);
Parameter hWin pSrc NumBytes
Window handle. Pointer to buffer. Size of buffer.
Description
Return value
Number of bytes written.
Additional information
The maximum number of bytes used to store user data is the number of ExtraBytes specified when creating a window.
WM_ShowWindow()
Description
Makes a specified window visible.
Prototype
void WM_ShowWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
The window will not immediately be visible after calling this function. It will be redrawn when executing WM_Exec(). If you need to show (draw) the window immediately, you should call WM_Paint().
WM_Update()
Description
Draws the invalid part of the specified window immediately.
Prototype
void WM_Update(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
After updating a window its complete region is marked as valid.
WM_UpdateWindowAndDescs()
Description
Paints the invalid part of the given window and the invalid part of all its descendants.
Prototype
void WM_UpdateWindowAndDescs(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
384
CHAPTER
The Window Manager (WM)
Additional information
The function only draws the invalid window regions.
WM_ValidateRect()
Description
Validates a specfied, rectangular area of a window.
Prototype
void WM_ValidateRect(WM_HWIN hWin, GUI_RECT * pRect);
Parameter hWin pRect
Description
Window handle. Pointer to a GUI_RECT structure with window coordinates of the parent window.
Additional information
Calling this function will tell the WM that the specified area is updated. Normally this function is called internally and does not need to be called by the user application. The coordinates of the GUI_RECT structure have to be in desktop coordinates.
WM_ValidateWindow()
Description
Validates a specified window.
Prototype
void WM_ValidateWindow(WM_HWIN hWin);
Parameter hWin
Window handle.
Description
Additional information
Calling this function will tell the WM that the specified window is updated. Normally this function is called internally and does not need to be called by the user application.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
385
15.9 WM API: Motion support
WM_MOTION_Enable()
Description
Enables motion support for the WM. Needs to be called once at the beginning of the program.
Prototype
void WM_MOTION_Enable(int OnOff);
Parameter OnOff
Description
1 for enabling motion support, 0 for disabling it.
WM_MOTION_SetDeceleration()
Description
Can be used to set the deceleration of the current moving operation.
Prototype
void WM_MOTION_SetDeceleration(WM_HWIN hWin, int Axis, I32 Deceleration);
Parameter
hWin Axis Deceleration
Window handle. See table below. Deceleration in pixel / (s * s)
Description
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Axis
X axis should be used. Y axis should be used.
Additional information
Makes only sense if the given window is already moving.
WM_MOTION_SetDefaultPeriod()
Description
Sets the default value to be used for the duration of the deceleration phase after the PID has been released. If the window is already moving the window decelerates its motion until it stops. If the window is not moving but snapping is used the window moves within that period to the next raster position. If the window is already moving and snapping is used the window decelerates its motion until it stops to the nearest raster position given by the current speed.
Prototype
unsigned WM_MOTION_SetDefaultPeriod(unsigned Period);
Parameter Period
Period to be used.
Return value
Previous default value of the period.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
386
CHAPTER
The Window Manager (WM)
WM_MOTION_SetMotion()
Description
Starts a moving operation with the given speed and deceleration.
Prototype
void WM_MOTION_SetMotion(WM_HWIN hWin, int Axis, I32 Speed, I32 Deceleration);
Parameter
hWin Axis Speed Deceleration
Window handle. See table below. Speed to be used. Deceleration to be used.
Description
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Axis
X axis should be used. Y axis should be used.
Additional information
The moving operation then can be affected by further motion functions.
WM_MOTION_SetMoveable()
Description
Enables moveability of the given window.
Prototype
void WM_MOTION_SetMoveable(WM_HWIN hWin, U32 Flags, int OnOff);
Parameter hWin Flags OnOff
Window handle. See table below. 1 for enabling, 0 for disabling.
Description
Permitted values for parameter Flags WM_CF_MOTION_X Enables / disables moveability for the X axis. WM_CF_MOTION_Y Enables / disables moveability for the Y axis.
Additional information
Motion support of a window can also be set with creation flags when creating the window or within the callback routine of the window. For details please also refer to "Motion support" on page 337.
WM_MOTION_SetMovement()
Description
Starts a moving operation with the given speed for the given distance.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
387
Prototype
void WM_MOTION_SetMovement(WM_HWIN hWin, int Axis, I32 Speed, I32 Dist);
Parameter hWin Axis Speed Dist
Description
Window handle. See table below. Speed in pixels / s to be used. Positive and negative values are supported. Distance to be used. Needs to be a positive value.
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Axis
X axis should be used. Y axis should be used.
Additional information
The moving operation stops automatically if the given distance is reached.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
388
CHAPTER
The Window Manager (WM)
WM_MOTION_SetSpeed()
Description
Starts moving the given window with the given speed.
Prototype
void WM_MOTION_SetSpeed(WM_HWIN hWin, int Axis, I32 Speed);
Parameter hWin Axis Speed
Window handle. See table below. Speed in pixel / s to be used.
Description
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Axis
X axis should be used. Y axis should be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
389
15.10 WM API: ToolTip related functions
In addition to the introduction at the beginning of the chapter the following contains the detailed descriptions of the ToolTip related functions.
WM_TOOLTIP_AddTool()
Description
Adds a tool to an existing ToolTip object.
Prototype
int WM_TOOLTIP_AddTool(WM_TOOLTIP_HANDLE hToolTip, WM_HWIN hTool, const char * pText);
Parameter hToolTip hTool pText
Handle of ToolTip object. Handle of tool window. Pointer to a string.
Description
Return value
0 on success, !=0 on error.
Additional information
This function can be used for adding tools by passing the window Id and a string pointer. The given string is copied into the dynamic memory of emWin and does not need to remain valid.
WM_TOOLTIP_Create()
Description
Creates a ToolTip object for the given dialog.
Prototype
WM_TOOLTIP_HANDLE WM_TOOLTIP_Create(WM_HWIN hDlg, const TOOLTIP_INFO * pInfo, unsigned NumItems);
Parameter hDlg pInfo NumItems
Description
Handle of the dialog containing the tools as child- or grand child windows.
Pointer to an array of TOOLTIP_INFO structures. Can be NULL.
Number if tools to be added.
Return value
Handle to the ToolTip object on success, 0 on failure.
Additional information
If one of the parameters pInfo or NumItems is 0 the function only creates the ToolTip object. Please note that it is the responsibility of the application to delete the object if it is no longer used.
WM_TOOLTIP_Delete()
Description
Deletes the given ToolTip object.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
390
CHAPTER
The Window Manager (WM)
Prototype
void WM_TOOLTIP_Delete(WM_TOOLTIP_HANDLE hToolTip);
Parameter hToolTip
Description
Handle of ToolTip object to be deleted.
WM_TOOLTIP_SetDefaultColor()
Description
Sets the default colors to be used for drawing ToolTips.
Prototype
GUI_COLOR WM_TOOLTIP_SetDefaultColor(unsigned Index, GUI_COLOR Color);
Parameter Index Color
See table below. Default color to be used.
Description
Permitted values for parameter Index
WM_TOOLTIP_CI_BK
Color to be used for the background.
WM_TOOLTIP_CI_FRAME Color to be used for the thin frame.
WM_TOOLTIP_CI_TEXT Color to be used for the text.
Return value
Previous used color.
WM_TOOLTIP_SetDefaultFont()
Description
Sets the font to be used for displaying the text of ToolTips.
Prototype
const GUI_FONT * WM_TOOLTIP_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Font to be used.
Return value
Previous default font used for ToolTips.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
391
WM_TOOLTIP_SetDefaultPeriod()
Description
Sets the default periods to be used for showing ToolTips.
Prototype
unsigned WM_TOOLTIP_SetDefaultPeriod(unsigned Index, unsigned Period);
Parameter Index Period
See table below. Period to be used.
Description
Permitted values for parameter Index
WM_TOOLTIP_PI_FIRST WM_TOOLTIP_PI_SHOW WM_TOOLTIP_PI_NEXT
Period to be used the first time the PID is hovered over a tool. The ToolTip appears after the PID has not moved for at least this period. Default is 1000 ms.
Period to be used for showing the ToolTip. The ToolTip disappears after the PID remains for at least this period without moving. Default is 5000 ms.
Period to be used if the PID hovers over a tool of the same parent as before. The ToolTip appears after the PID is not moved for at least this period. Default is 50 ms.
Return value
Previous used value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
392
CHAPTER
The Window Manager (WM)
15.11 WM API: Memory device support (optional)
When a memory device is used for redrawing a window, all drawing operations are automatically routed to a memory device context and are executed in memory. Only after all drawing operations have been carried out is the window redrawn on the LCD, reflecting all updates at once. The advantage of using memory devices is that any flickering effects (which normally occur when the screen is continuously updated as drawing operations are executed) are eliminated. For more information on how memory devices operate, see the chapter "Memory Devices" on page 287.
WM_DisableMemdev()
Description
Disables the use of memory devices for redrawing a window.
Prototype
void WM_DisableMemdev (WM_HWIN hWin)
Parameter hWin
Window handle.
Description
WM_EnableMemdev()
Description
Enables the use of memory devices for redrawing a window.
Prototype
void WM_EnableMemdev (WM_HWIN hWin)
Parameter hWin
Window handle.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
393
15.12 WM API: Timer related functions
WM_CreateTimer()
Description
Creates a timer which sends a message to the given window after the given time period has expired. The timer is associated to the given window.
Prototype
WM_HTIMER WM_CreateTimer(WM_HWIN hWin, int UserId, int Period, int Mode);
Parameter hWin UserId Period Mode
Description
Handle of window to be informed. User defined Id. Can be set to 0 if not using multiple timers for the same window. Time period after which the given window should receive a message. (reserved for future use, should be 0)
Return value
Handle of the timer.
Additional information
The function creates a 'one shot timer' which sends a WM_TIMER message to the given window. After the timer period has expired the timer object remains valid and can be restarted using the function WM_RestartTimer() or deleted with WM_DeleteTimer(). Please note that the Window Manager automatically deletes each associated timer of a window when deleting the window.
Example
static void _cbWin(WM_MESSAGE * pMsg) { switch (pMsg->MsgId) { case WM_TIMER: /* ... do something ... */ WM_RestartTimer(pMsg->Data.v, 1000); break; default: WM_DefaultProc(pMsg); }
}
static void _DemoTimer(void) { WM_HWIN hWin; WM_HTIMER hTimer; hWin = WM_CreateWindow(10, 10, 100, 100, WM_CF_SHOW, _cbWin, 0); hTimer = WM_CreateTimer(hWin, 0, 1000, 0); while (1) { GUI_Exec(); }
}
WM_DeleteTimer()
Description
Deletes the given timer.
Prototype
void WM_DeleteTimer(WM_HTIMER hTimer);
Parameter hTimer
Description
Handle of the timer to be deleted.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
394
CHAPTER
The Window Manager (WM)
Additional information
After a timer has expired the timer object remains valid and will not be deleted automatically. If it is not used anymore it should be deleted using this function. Please note that the Window Manager automatically deletes the timer when deleting the window.
WM_GetTimerId()
Description
Gets the Id of the given timer.
Prototype
int WM_GetTimerId(WM_HTIMER hTimer);
Parameter hTimer
Description
Handle of the timer to be deleted.
Return value
The Id of the timer which was previously set within the function WM_CreateTimer().
WM_RestartTimer()
Description
Restarts the given timer with the given period.
Prototype
void WM_RestartTimer(WM_HTIMER hTimer, int Period);
Parameter hTimer Period
Description
Handle of the timer to be restarted. New period to be used.
Additional information
After the period has expired a WM_TIMER message will be send to the window assigned to the timer. For details, refer to "WM_CreateTimer()" on page 393.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
395
15.13 WM API: Widget related functions
WM_GetClientWindow()
Description
Returns the handle of the client window. The function sends a message to the active window to retrieve the handle of the client window. If the window does not handle the message the handle of the current window will be returned.
Prototype
WM_HWIN WM_GetClientWindow(WM_HWIN hObj);
Parameter hWin
Handle of widget.
Description
Return value
Handle of the client window.
Additional information
Use this function to retrieve the client window handle of a FRAMEWIN widget.
WM_GetId()
Description
Returns the ID of a specified widget window.
Prototype
int WM_GetId(WM_HWIN hObj);
Parameter hObj
Handle of widget.
Description
Return value
The ID of the widget specified at creation. 0 will be returned if the specified window is not a widget.
WM_GetInsideRect()
Description
Returns the coordinates of the client area of the active widget less the border size. The function sends a message to the active window to retrieve the inside rectangle. If the widget does not handle the message (that means the widget has no border) WM_GetClientRect will be used to calculate the rectangle. The result is given in window coordinates. That means x0 and y0 of the GUI_RECT structure corresponds to the border size in x and y, x1 and y1 corresponds to the size of the window less the border size - 1.
Prototype
void WM_GetInsideRect(GUI_RECT * pRect);
Parameter pRect
Description
Pointer to a GUI_RECT structure.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
396
CHAPTER
The Window Manager (WM)
WM_GetInsideRectEx()
Description
Returns the coordinates of a window less the border size. For details, refer to "WM_GetInsideRect()" on page 395.
Prototype
void WM_GetInsideRectEx(WM_HWIN hObj, GUI_RECT * pRect);
Parameter hObj pRect
Description
Handle of widget. Pointer to a GUI_RECT structure.
WM_GetScrollPosH()
Description
Returns the horizontal scrolling position of a window.
Prototype
int WM_GetScrollPosH(WM_HWIN hWin);
Parameter hWin
Description
Handle of a window which has a horizontal SCROLLBAR attached.
Return value
Position of the horizontal SCROLLBAR widget (0 < n) 0, if no horizontal SCROLLBAR widget is attached.
Additional information
Additional information can be found in "SCROLLBAR: Scroll bar widget" on page 678.
WM_GetScrollPosV()
Description
Returns the vertical scrolling position of a window.
Prototype
int WM_GetScrollPosV(WM_HWIN hWin);
Parameter hWin
Description
Handle of a window which has a vertical SCROLLBAR attached.
Return value
Position of the horizontal SCROLLBAR widget (0 < n) 0, if no horizontal SCROLLBAR widget is attached.
Additional information
Additional information can be found in "SCROLLBAR: Scroll bar widget" on page 678.
WM_GetScrollState()
Description
Fills a data structure with information of the current state of a specified SCROLLBAR widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
397
Prototype
void WM_GetScrollState(WM_HWIN hObj, WM_SCROLL_STATE * pScrollState);
Parameter
Description
hObj
Handle of scroll bar widget.
pScrollState Pointer to a data structure of type WM_SCROLL_STATE.
Additional information
This function does not return since the state of a scroll bar is defined by more than one value. It has no effect on other types of widgets or windows. Additional information can be found in "SCROLLBAR: Scroll bar widget" on page 678.
Elements of WM_SCROLL_STATE
Data type int int int
Element NumItems v PageSize
Description
Number of items. Current value. Number of items visible on one page.
WM_SetScrollPosH()
Description
Sets the horizontal scrolling position of a window.
Prototype
void WM_SetScrollPosH(WM_HWIN hWin, unsigned ScrollPos);
Parameter hWin ScrollPos
Description
Handle of a window which has a horizontal SCROLLBAR attached. New scroll position of the scroll bar.
Additional information
Additional information can be found in "SCROLLBAR: Scroll bar widget" on page 678.
WM_SetScrollPosV()
Description
Sets the vertical scrolling position of a window.
Prototype
void WM_SetScrollPosV(WM_HWIN hWin, unsigned ScrollPos);
Parameter hWin ScrollPos
Description
Handle of a window which has a vertical SCROLLBAR attached. New scroll position of the scroll bar.
Additional information
Additional information can be found in "SCROLLBAR: Scroll bar widget" on page 678.
WM_SetScrollState()
Description
Sets the state of a specified SCROLLBAR widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
398
CHAPTER
The Window Manager (WM)
Prototype
void WM_SetScrollState(WM_HWIN hObj, const WM_SCROLL_STATE * pState);
Parameter hObj
Handle of scroll bar widget.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
399
15.14 Example
The following example illustrates the difference between using a callback routine for redrawing the background and not having one. It also shows how to set your own callback function. The example is available as WM_Redraw.c in the examples shipped with emWin:
/*********************************************************************
*
SEGGER MICROCONTROLLER SYSTEME GmbH
*
*
Solutions for real time microcontroller applications
*
*
*
*
emWin example code
*
*
*
**********************************************************************
----------------------------------------------------------------------
File
: WM_Redraw.c
Purpose
: Demonstrates the redrawing mechanism of the Window Manager
----------------------------------------------------------------------
*/
#include "GUI.H"
/*******************************************************************
*
*
Callback routine for background window
*
********************************************************************
*/
static void cbBackgroundWin(WM_MESSAGE * pMsg) { switch (pMsg->MsgId) { case WM_PAINT: GUI_Clear(); default: WM_DefaultProc(pMsg); }
}
/*******************************************************************
*
*
Callback routine for foreground window
*
********************************************************************
*/
static void cbForegroundWin(WM_MESSAGE * pMsg) { switch (pMsg->MsgId) { case WM_PAINT: GUI_SetBkColor(GUI_GREEN); GUI_Clear(); GUI_DispString("Foreground window"); break; default: WM_DefaultProc(pMsg); }
}
/*******************************************************************
*
*
Demonstrates the redraw mechanism of emWin
*
********************************************************************
*/
static void DemoRedraw(void) { GUI_HWIN hWnd; while(1) { /* Create foreground window */ hWnd = WM_CreateWindow(10, 10, 100, 100, WM_CF_SHOW, cbForegroundWin, 0); /* Show foreground window */ GUI_Delay(1000); /* Delete foreground window */ WM_DeleteWindow(hWnd); GUI_DispStringAt("Background of window has not been redrawn", 10, 10); /* Wait a while, background will not be redrawn */ GUI_Delay(1000); GUI_Clear(); /* Set callback for Background window */
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
400
CHAPTER
The Window Manager (WM)
WM_SetCallback(WM_HBKWIN, cbBackgroundWin); /* Create foreground window */ hWnd = WM_CreateWindow(10, 10, 100, 100,WM_CF_SHOW, cbForegroundWin, 0); /* Show foreground window */ GUI_Delay(1000); /* Delete foreground window */ WM_DeleteWindow(hWnd); /* Wait a while, background will be redrawn */ GUI_Delay(1000); /* Delete callback for Background window */ WM_SetCallback(WM_HBKWIN, 0); }}
/*******************************************************************
*
*
main
*
********************************************************************
*/
void main(void) { GUI_Init(); DemoRedraw();
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
401
Chapter 16
Window Objects (Widgets)
Widgets are windows with object-type properties. They are called controls in the Windows environments and make up the elements of the user interface. They can react automatically to certain events. For example, a button can appear in a different state if it is pressed. Widgets have properties which may be changed at any time during their existence. They are typically deleted as soon as they are not used any longer. Similar to windows, widgets are referenced by handles which are returned by the respective create function. Widgets require the Window Manager. Once a widget is created, it is treated just like any other window. The WM ensures that it is properly displayed (and redrawn) whenever necessary. The use of widgets is not mandatory for applications or user interfaces, but they decrease development time.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
402
CHAPTER
Window Objects (Widgets)
16.1 Some basics
16.1.1 Available widgets
The following table shows the appearance of the currently available widgets. Some of the widgets support skinning. This method of changing the appearance is explained in detail in chapter 'Skinning'. The second screenshot shows the appearance when skinning is enabled for the widget:
Name
BUTTON CHECKBOX
Screenshot (classic)
Screenshot (skinned)
Description
Button which can be pressed. Text or bitmaps may be displayed on a button. Check box which may be checked or unchecked.
DROPDOWN
Dropdown listbox, opens a listbox when pressed.
EDIT FRAMEWIN
Single-line edit field which prompts the user to type a number or text.
Frame window. Creates the typical GUI look.
GRAPH HEADER
Graph widget, used to show curves or measured values.
Header control, used to manage columns.
ICONVIEW
Icon view widget. Useful for icon based platforms as found in common hand held devices.
IMAGE LISTBOX LISTVIEW LISTWHEEL MENU
Image widget. Displays several image formats automatically.
Listbox which highlights items as they are selected by the user.
Listview widgets are used to creates tables.
Listwheel widget. The data can be moved and accelerated via pointer input device.
Menu widgets are used to create horizontal and vertical menus.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Name
MULTIEDIT
403
Screenshot (classic)
Screenshot (skinned)
Description
Multiedit widgets are used to edit multiple lines of text.
MULTIPAGE
PROGBAR RADIO SCROLLBAR SLIDER SPINBOX TEXT
TREEVIEW
Multipage widgets are used to create dialogs with multiple pages.
Progress bar used for visualization. Radio button which may be selected. Only one button may be selected at a time. Scrollbar which may be horizontal or vertical. Slider bar used for changing values. Spinning box to display and adjust a specific value. Static text controls typically used in dialogs.
Treeview widget for managing hierarchical lists.
16.1.2 Understanding the redrawing mechanism
A widget draws itself according to its properties. This is done when WM_Exec(), GUI_Exec() or GUI_Delay() is called. In a multitasking environment, a background task is normally used to call WM_Exec() and update the widgets (and all other windows with callback functions). When a property of a widget is changed, the window of the widget (or part of it) is marked as invalid, but it is not immediately redrawn. Therefore, the section of code executes very fast. The redrawing is done by the WM at a later time or it can be forced by calling WM_Paint() for the widget (or WM_Exec() until all windows are redrawn).
16.1.3 How to use widgets
Suppose we would like to display a progress bar. All that is needed is the following code: PROGBAR_Handle hProgBar; GUI_DispStringAt("Progress bar", 100, 20); hProgBar = PROGBAR_Create(100, 40, 100, 20, WM_CF_SHOW);
The first line reserves memory for the handle of the widget. The last line actually creates the widget. The widget will then automatically be drawn by the Window Manager once WM_Exec() is called the next time, what may happen in a separate task. Member functions are available for each type of widget which allow modifications to their appearance. Once the widget has been created, its properties can be changed by calling its member functions. These functions take the handle of the widget as their first argument. In order to make the progress bar created above show 45% and to change the bar colors from their defaults (dark gray/light gray) to green/red, the following section of code may be used:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
404
CHAPTER
PROGBAR_SetBarColor(hProgBar, 0, GUI_GREEN); PROGBAR_SetBarColor(hProgBar, 1, GUI_RED); PROGBAR_SetValue(hProgBar, 45);
Window Objects (Widgets)
Default configuration
All widgets also have one or more configuration macros which define various default settings such as fonts and colors used. The available configuration options are listed for each widget in their respective sections later in the chapter.
How widgets communicate
Widgets are often created as child windows. The parent window may be any type of window, even another widget. A parent window usually needs to be informed whenever something occurs with one of its children in order to ensure synchronization. Child window widgets communicate with their parent window by sending a WM_NOTIFY_PARENT message whenever an event occurs. The notification code sent as part of the message depends on the event. Most widgets have one or more notification codes defining different types of events. The available notification codes for each widget (if any) are listed under their respective sections.
Skinning
The appearance of a widget can be modified by using the member functions of the respective widget. Some of the widgets support skinning. If skinning is used for a widget the 'skin' determines the appearance of the widget and some of the member functions have no effect. For details please refer to the chapter 'Skinning'.
Dynamic memory usage for widgets
In embedded applications it is usually not very desirable to use dynamic memory at all because of fragmentation effects. There are a number of different strategies that can be used to avoid this, but they all work in a limited way whenever memory areas are referenced by a pointer in the application program. For this reason, emWin uses a different approach: all objects (and all data stored at run-time) are stored in memory areas referenced by a handle. This makes it possible to relocate the allocated memory areas at run-time, thus avoiding the long-term allocation problems which occur when using pointers. All widgets are thus referenced by handles.
Determine the type of a widget
The type of a widget can be determined by comparing the callback function of a specific widget with the public callback functions of the widget API. The following shows a short example how to determine the type of a widget. In case of overwritten callback functions the method should be adapted:
WM_CALLBACK * pCb;
pCb = WM_GetCallback(hWidget);
if
(pCb == BUTTON_Callback) {
// Widget is a button
} else if (pCb == DROPDOWN_Callback) {
// Widget is a dropdown
} else if (pCb == LISTBOX_Callback) {
// Widget is a listbox
} else if (...) {
...
}
Please note that this code needs to be adapted, if callback functions have been overwritten.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
405
16.2 Configuration options
Type
Macro
B WIDGET_USE_PARENT_EFFECT
B WIDGET_USE_SCHEME_LARGE
B WIDGET_USE_SCHEME_MEDIUM
B WIDGET_USE_SCHEME_SMALL B WIDGET_USE_FLEX_SKIN
Default
0 0 0 1 0
Description
If set to 1, each 'child widget' of a widget, has the same effect as the parent widget. If for example a listbox needs to create a scrollbar, the new scrollbar has the same effect as the listbox.
If set to 1, the default appearance of the widgets is large sized. That means that all widgets which show text are configured to use large sized default fonts.
If set to 1, the default appearance of the widgets is medium sized. That means that all widgets which show text are configured to use medium sized default fonts.
If set to 1, the default appearance of the widgets is small sized. That means that all widgets which show text are configured to use small sized default fonts.
If set to 1, widgets are drawn using the Flex Skin by default. For more information about Skinning, please refer to the chapter 'Skinning'.
WIDGET_USE_SCHEME...
The table below shows the default appearance of the widget schemes:
WIDGET_USE_SCHEME_LARGE
WIDGET_USE_SCHEME_MEDIUM
WIDGET_USE_SCHEME_SMALL
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
406
CHAPTER
Window Objects (Widgets)
16.3 Widget IDs
In order to be able to separate all widgets from each other IDs can be assigned. This is usually done by using the according parameter of the <WIDGET>_Create...()-functions. To make sure that every widget has its unique Id, predefined symbols may be used. The predefined symbols are listed in the subsections of the according widgets. If the predefined symbols do not match ones requirements, custom unique IDs may be defined as follows:
#define MY_WIDGET_ID_0 (GUI_ID_USER + 0) #define MY_WIDGET_ID_1 (GUI_ID_USER + 1) #define MY_WIDGET_ID_2 (GUI_ID_USER + 2) #define MY_WIDGET_ID_3 (GUI_ID_USER + 3)
. . .
16.4 General widget API
16.4.1 WM routines used for widgets
Since widgets are essentially windows, they are compatible with any of the Window Manager API routines. The handle of the widget is used as the hWin parameter and the widget is treated like any other window. The WM functions most commonly used with widgets are listed as follows:
Routine WM_DeleteWindow() WM_DisableMemdev() WM_EnableMemdev() WM_InvalidateWindow() WM_Paint()
Description
Deletes a window. Disables usage of memory devices for redrawing. Enables usage of memory devices for redrawing. Invalidates a window. Draws or redraws a window immediately.
For a complete list of WM-related functions, refer to the chapter "The Window Manager (WM)" on page 331.
16.4.2 Common routines
The table below lists available widget-related routines in alphabetical order. These functions are common to all widgets, and are listed here in order to avoid repetition. Detailed descriptions of the routines follow. The additional member functions available for each widget may be found in later sections.
Routine <WIDGET>_Callback() <WIDGET>_CreateIndirect() <WIDGET>_CreateUser() <WIDGET>_GetUserData() <WIDGET>_SetUserData() WIDGET_GetDefaultEffect() WIDGET_SetDefaultEffect() WIDGET_SetEffect()
Description
Default callback function. Used for automatic creation in dialog boxes. Creates a widget using extra bytes as user data. Retrieves the data set with <WIDGET>_SetUserData. Sets the extra data of a widget. Returns the default effect used for widgets. Sets the default effect used for widgets. Sets the effect used for a given widget.
<WIDGET>_Callback()
Description
Default callback function of the widgets to be used from within overwritten callback function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
407
Prototype
void <WIDGET>_Callback(WM_MESSAGE * pMsg);
Parameter pMsg
Description
Pointer to a data structure of type WM_MESSAGE.
Additional information
A default callback function of a widget should not be called directly. It is only to be used from within an overwritten callback function. For details about the WM_MESSAGE data structure, refer to "Messages" on page 340.
<WIDGET>_CreateIndirect()
Description
Creates a widget to be used in dialog boxes.
Prototype
<WIDGET>_Handle <WIDGET>_CreateIndirect(
const GUI_WIDGET_CREATE_INFO * pCreateInfo,
WM_HWIN
hParent,
int
x0,
int
y0,
WM_CALLBACK
* cb
);
Parameter pCreateInfo hParent x0 y0 cb
Description Pointer to a GUI_WIDGET_CREATE_INFO structure (see below).
Handle of parent window. Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Pointer to a callback function.
Additional information
Any widget may be created indirectly by using the appropriate prefix. For example: BUTTON_CreateIndirect() to indirectly create a button widget, CHECKBOX_CreateIndirect() to indirectly create a check box widget, and so on.
A widget only needs to be created indirectly if it is to be included in a dialog box. Otherwise, it may be created directly by using the <WIDGET>_Create() functions. See the chapter "Dialogs" on page 737 for more information about dialog boxes.
Resource table
The GUI_WIDGET_CREATE_INFO data structure is defined in the dialog resource table as follows:
typedef struct {
GUI_WIDGET_CREATE_FUNC * pfCreateIndirect; // Create function
const char * pName;
// Text (not used for all widgets)
I16 Id;
// Window ID of the widget
I16 x0, y0, xSize, ySize;
// Size and position of the widget
I16 Flags;
// Widget-specific flags (or 0)
I32 Para;
// Widget-specific parameter (or 0)
U32 NumExtraBytes;
// Number of extra bytes usable
// with <WIDGET>_SetUserData &
//
<WIDGET>_GetUserData
} GUI_WIDGET_CREATE_INFO;
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
408
CHAPTER
Window Objects (Widgets)
Widget flags and parameters are optional, and vary depending on the type of widget. The available flags and parameters for each widget (if any) will be listed under the appropriate section later in this chapter.
<WIDGET>_CreateUser()
Description
Creates a widget using extra bytes as user data. This function is similar to the <WIDGET>_CreateEx()-function of the appropriate widget in every case except the additional parameter NumExtraBytes.
Prototype
<WIDGET>_Handle <WIDGET>_CreateUser(int x0, int y0, ..., int Id, int NumExtraBytes);
Parameter NumBytes
Description
Number of extra bytes to be allocated
Return value
Handle of the created widget; 0 if the function fails.
Additional information
For more information about the other parameters the appropriate <WIDGET>_CreateEx()-functions can be referred to.
<WIDGET>_GetUserData()
Description
Retrieves the data set with <WIDGET>_SetUserData.
Prototype
int <WIDGET>_GetUserData(<WIDGET>_Handle hObj,
void
* pDest,
int
NumBytes)
Parameter hObj pDest NumBytes
Handle of the widget Pointer to buffer Number of bytes to read
Description
Return value
Number of bytes read
Additional information
The maximum number of bytes returned by this function is the number of extra bytes specified when creating the widget using <WIDGET>_CreateUser() or <WIDGET>_CreateIndirect().
<WIDGET>_SetUserData()
Description
Sets the extra data of a widget.
Prototype
int <WIDGET>_GetUser(<WIDGET>_Handle hObj,
void
* pDest,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
409
int
NumBytes)
Parameter hObj pDest NumBytes
Handle of the widget Pointer to buffer Number of bytes to write
Description
Return value
Number of bytes written
Additional information
The maximum number of bytes used to store user data is the number of extra bytes specified when creating the widget using <WIDGET>_CreateUser() or <WIDGET>_CreateIndirect().
WIDGET_GetDefaultEffect()
Description
Returns the default effect used for widgets.
Prototype
const WIDGET_EFFECT * WIDGET_GetDefaultEffect(void);
Return value
The result of the function is a pointer to a WIDGET_EFFECT structure.
Additional information
For more information, refer to "WIDGET_SetDefaultEffect()" on page 409.
WIDGET_SetDefaultEffect()
Description
Sets the default effect used for widgets.
Prototype
const WIDGET_EFFECT * WIDGET_SetDefaultEffect(const WIDGET_EFFECT* pEffect);
Parameter pEffect
Description
Pointer to a WIDGET_EFFECT structure. See table below.
Permitted values for element pEffect
&WIDGET_Effect_3D &WIDGET_Effect_None &WIDGET_Effect_Simple
Sets the default effect to '3D'. Sets the default effect to 'None'. Sets the default effect to 'Simple'.
Return value
Previous used default effect.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
410
CHAPTER
Window Objects (Widgets)
Additional information
The following table shows the appearance of some widgets in dependence of the used effect:
'3D'
'None'
'Simple'
WIDGET_SetEffect()
Description
Sets the effect for the given widget.
Prototype
void WIDGET_SetEffect(WM_HWIN hObj, const WIDGET_EFFECT* pEffect);
Parameter hObj pEffect
Description
Handle of widget. Pointer to a WIDGET_EFFECT structure. For details, refer to "WIDGET_SetDefaultEffect()" on page 409.
16.4.3 User drawn widgets
Some widgets supports owner drawing, for example the LISTBOX widget. If the user draw mode of a widget has been activated a application-defined function of type WIDGET_DRAW_ITEM_FUNC will be called to draw the widget (item). The prototype of an application-defined owner draw function should be defined as follows:
Prototype
int WIDGET_DRAW_ITEM_FUNC(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo)
Parameter pDrawItemInfo
Description
Pointer to a WIDGET_ITEM_DRAW_INFO structure.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
411
Elements of WIDGET_ITEM_DRAW_INFO
Data type Element
WM_HWIN int int int int
hWin Cmd ItemIndex x0 y0
Description
Handle to the widget. See table below. Zero based index of item to be drawn. X position in window coordinates to be used to draw the item. Y position in window coordinates to be used to draw the item.
Permitted values for element Cmd
WIDGET_ITEM_GET_XSIZE WIDGET_ITEM_GET_YSIZE WIDGET_ITEM_DRAW
The function returns the x-size (width) in pixels of the given item.
The function returns the y-size (height) in pixels of the given item.
The function draws the given item at the given position.
WIDGET_DRAW_BACKGROUND WIDGET_DRAW_OVERLAY
The background of the widget should be drawn.
This command is send after all other drawing operations have been finished and enables the possibility to draw some overlaying items above the widget.
Return value
Depends on the given command.
Reaction to commands
The function has to react to the command given in the WIDGET_ITEM_DRAW_INFO structure. This can be done in one of 2 ways: · By calling the appropriate default function supplied by the particular widget (for
example, LISTBOX_OwnerDraw()) · By supplying code that reacts accordingly.
Commands
The commands listed below are supported and should be reacted to by the function. As explained above, the default owner draw function should be called for all not handled functions. This can save code size (for example if the height is the same as the default height) and makes sure that your code stays compatible if additional commands are introduced in future versions of the software.
WIDGET_ITEM_GET_XSIZE
The X-size in pixels of the given item has to be returned.
WIDGET_ITEM_GET_YSIZE
The Y-size (height) in pixels of the given item has to be returned.
WIDGET_ITEM_DRAW
The given item has to be drawn. x0 and y0 of the WIDGET_ITEM_DRAW_INFO structure specify the position of the item in window coordinates. The item has to fill its entire rectangle; the rectangle is defined by the starting position x0, y0 supplied to the function and the sizes returned by the function as reaction to the commands WIDGET_ITEM_GET_YSIZE, WIDGET_ITEM_GET_XSIZE. It may NOT leave a part of this rectangular area unpainted. It can not paint outside of this rectangular area because the clip rectangle has been set before the function call.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
412
CHAPTER
Window Objects (Widgets)
16.5 BUTTON: Button widget
Button widgets are commonly used as the primary user interface element for touchscreens. If the button has the input focus, it also reacts on the keys GUI_KEY_SPACE and GUI_KEY_ENTER. Buttons may be displayed with text, as shown below, or with a bitmap.
All BUTTON-related routines are located in the file(s) BUTTON*.c, BUTTON.h. All identifiers are prefixed BUTTON.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.5.1 Configuration options
Type
Macro
Default
Description
N BUTTON_3D_MOVE_X
1
Number of pixels that text/bitmap moves in horizontal direction in pressed state.
N BUTTON_3D_MOVE_Y
1
Number of pixels that text/bitmap moves in vertical direction in pressed state.
N BUTTON_ALIGN_DEFAULT
GUI_TA_HCENTER
|
Alignment used to display the button text.
GUI_TA_VCENTER
N
BUTTON_BKCOLOR0_DEFAULT 0xAAAAAA
Background color, unpressed state.
N
BUTTON_BKCOLOR1_DEFAULT GUI_WHITE
Background color, pressed state.
N
BUTTON_FOCUSCOLOR_DEFAULT GUI_BLACK
Default color for rendering the focus rectangle.
S BUTTON_FONT_DEFAULT
&GUI_Font13_1 Font used for button text.
B BUTTON_REACT_ON_LEVEL
0
See description below.
N
BUTTON_TEXTCOLOR0_DEFAULT GUI_BLACK
Text color, unpressed state.
N
BUTTON_TEXTCOLOR1_DEFAULT GUI_BLACK
Text color, pressed state.
BUTTON_REACT_ON_LEVEL
A button per default reacts on each touch message. For example if touching a dialog with a pointer input device (PID) not exactly on the button and then move the PID in pressed state over the button, the button changes from unpressed to pressed state. This behavior can be useful if using a touch panel. If a button should only react on level changes, BUTTON_REACT_ON_LEVEL should be set to 1. Then a button changes the state only if the PID is pressed and released on the button. If then moving a PID in pressed state over the button it does not react. This behavior can be useful if dialogs should react on WM_NOTIFICATION_CLICKED. Example (BUTTON_REACT_ON_LEVEL = 0): One dialog (dialog 2) is shown over an other dialog (dialog 1). The close button of dialog 2 is on the same position as a button of dialog 1. Now the close button of dialog 2 is pressed, which removes dialog 2. The PID now is in pressed state. If now moving the button before releasing it the button of dialog 1 would change from unpressed to pressed state. This unwanted behavior can be avoided by setting BUTTON_REACT_ON_LEVEL to 1. Alternatively to this configuration option the function BUTTON_SetReactOnLevel() can be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
413
BUTTON_BKCOLOR0_DEFAULT, BUTTON_BKCOLOR1_DEFAULT
The default for the button is to use a white background in the pressed state. This has been done purposely because it makes it very obvious that the button is pressed, on any kind of display. If you want the background color of the button to be the same in both its pressed and unpressed states, change BUTTON_BKCOLOR1_DEFAULT to BUTTON_BKCOLOR0_DEFAULT.
16.5.2 Predefined IDs
The following symbols define IDs which may be used to make BUTTON widgets distinguishable from creation: GUI_ID_BUTTON0 - GUI_ID_BUTTON9
16.5.3 Notification codes
The following events are sent from a button widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED
WM_NOTIFICATION_MOVED_OUT
Description
Button has been clicked. Button has been released. Button has been clicked and pointer has been moved out of the button without releasing.
16.5.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_ENTER GUI_KEY_SPACE
Reaction
If the keys is pressed, the button reacts as it has been pressed and immediately released. If the keys is pressed, the button state changes to pressed. If the keys is released, the button state changes to unpressed.
16.5.5 BUTTON API
The table below lists the available emWin BUTTON-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine BUTTON_Create() BUTTON_CreateAsChild() BUTTON_CreateEx() BUTTON_CreateIndirect() BUTTON_CreateUser() BUTTON_GetBitmap() BUTTON_GetBkColor() BUTTON_GetDefaultBkColor() BUTTON_GetDefaultFont() BUTTON_GetDefaultTextAlign() BUTTON_GetDefaultTextColor() BUTTON_GetFont() BUTTON_GetText() BUTTON_GetTextAlign() BUTTON_GetTextColor() BUTTON_GetUserData() BUTTON_IsPressed() BUTTON_SetBitmap()
Description
Creates a BUTTON widget. (Obsolete) Creates a BUTTON widget as a child window. (Obsolete) Creates a BUTTON widget. Creates a BUTTON widget from a resource table entry. Creates a BUTTON widget using extra bytes as user data. Returns the pointer to the BUTTON bitmap. Returns the background color of the BUTTON Returns the default background color for BUTTON widgets. Returns the default font for BUTTON widgets. Returns the default text alignment for BUTTON widgets. Returns the default text color for BUTTON widgets. Returns the pointer to the font of the BUTTON widget. Retrieves the text of a specified BUTTON. Returns the alignment of the BUTTON text. Returns the text color of the specified BUTTON. Retrieves the data set with BUTTON_SetUserData(). Returns if a button is pressed or not. Sets the bitmap used when displaying the BUTTON.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
414
CHAPTER
Window Objects (Widgets)
Routine BUTTON_SetBitmapEx() BUTTON_SetBkColor() BUTTON_SetBMP() BUTTON_SetBMPEx() BUTTON_SetDefaultBkColor() BUTTON_SetDefaultFont() BUTTON_SetDefaultTextAlign() BUTTON_SetDefaultTextColor() BUTTON_SetFocussable() BUTTON_SetFont() BUTTON_SetPressed() BUTTON_SetReactOnLevel() BUTTON_SetStreamedBitmap() BUTTON_SetStreamedBitmapEx() BUTTON_SetText() BUTTON_SetTextAlign() BUTTON_SetTextColor()
BUTTON_SetTextOffset()
BUTTON_SetUserData()
Description
Sets the bitmap used when displaying the BUTTON. Sets the background color of the button. Sets the bitmap used when displaying the BUTTON. Sets the bitmap used when displaying the BUTTON. Sets the default background color for BUTTON widgets. Sets the default font for BUTTON widgets. Sets the default text alignment for BUTTON widgets. Sets the default text color for BUTTON widgets. Sets the ability to receive the input focus. Selects the font for the text. Sets the state of the button to pressed or unpressed. Sets all BUTTON widgets to react on level. Sets the bitmap used when displaying the BUTTON widget. Sets the bitmap used when displaying the BUTTON widget. Sets the text. Sets the alignment of the BUTTON text. Set the color(s) for the text. Adjusts the position of the button text considering the current text alignment setting. Sets the extra data of a BUTTON widget.
BUTTON_Create()
(Obsolete, BUTTON_CreateEx() should be used instead)
Description
Creates a BUTTON widget of a specified size at a specified location.
Prototype
BUTTON_Handle BUTTON_Create(int x0, int y0, int xsize, int ysize, int Id, int Flags);
Parameter x0 y0 xsize ysize Id
Flags
Description
Leftmost pixel of the button (in parent coordinates). Topmost pixel of the button (in parent coordinates). Horizontal size of the button (in pixels). Vertical size of the button (in pixels). ID to be returned when button is pressed.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
Return value
Handle of the created BUTTON widget; 0 if the function fails.
BUTTON_CreateAsChild()
(Obsolete, BUTTON_CreateEx should be used instead)
Description
Creates a BUTTON widget as a child window.
Prototype
BUTTON_Handle BUTTON_CreateAsChild(int int
x0, xsize,
int y0, int ysize,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
415
WM_HWIN hParent, int Id,
int
Flags);
Parameter x0 y0 xsize ysize
hParent
Id Flags
Description
X-position of the button relative to the parent window. Y-position of the button relative to the parent window. Horizontal size of the button (in pixels). Vertical size of the button (in pixels). Handle of parent window. If 0, the BUTTON widget will be a child of the desktop (toplevel window). ID to be returned when button is pressed.
Window create flags (see BUTTON_Create()).
Return value
Handle of the created BUTTON widget; 0 if the function fails.
BUTTON_CreateEx()
Description
Creates a BUTTON widget of a specified size at a specified location.
Prototype
BUTTON_Handle BUTTON_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the BUTTON widget will be a child of the desktop (toplevel window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Not used yet, reserved for future use. Window ID of the widget.
Return value
Handle of the created BUTTON widget; 0 if the function fails.
Additional information
If the possibility of storing user data is a matter the function BUTTON_CreateUser() should be used instead.
BUTTON_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
416
CHAPTER
Window Objects (Widgets)
BUTTON_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function BUTTON_CreateEx() can be referred to.
BUTTON_GetBitmap()
Description
Returns a pointer to the optional BUTTON bitmap.
Prototype
const GUI_BITMAP * BUTTON_GetBitmap(BUTTON_Handle hObj, unsigned int Index);
Parameter hObj Index
Description
Handle of widget. Index of desired bitmap. See table below.
Permitted values for parameter Index BUTTON_BI_DISABLED Bitmap for disabled state. BUTTON_BI_PRESSED Bitmap for pressed state. BUTTON_BI_UNPRESSED Bitmap for unpressed state.
Return value
Pointer to the bitmap, 0 if no bitmap exist.
Additional information
For details about how to set a button bitmap, refer to "BUTTON_SetBitmap()" on page 419 and "BUTTON_SetBitmapEx()" on page 419.
BUTTON_GetBkColor()
Description
Returns the background color of the given BUTTON widget.
Prototype
GUI_COLOR BUTTON_GetBkColor(BUTTON_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of widget. Color index. See table below.
Description
Permitted values for parameter Index BUTTON_CI_DISABLED Color for disabled state. BUTTON_CI_PRESSED Color for pressed state. BUTTON_CI_UNPRESSED Color for unpressed state.
Return value
Background color of the given BUTTON widget
BUTTON_GetDefaultBkColor()
Description
Returns the default background color for BUTTON widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
417
Prototype
GUI_COLOR BUTTON_GetDefaultBkColor(unsigned Index);
Parameter Index
Description
Index for color. See table below.
Permitted values for parameter Index BUTTON_CI_DISABLED Color for disabled state. BUTTON_CI_PRESSED Color for pressed state. BUTTON_CI_UNPRESSED Color for unpressed state.
Return value
Default background color for BUTTON widgets
BUTTON_GetDefaultFont()
Description
Returns the pointer to the font used to display the text of BUTTON widgets.
Prototype
const GUI_FONT * BUTTON_GetDefaultFont(void);
Return value
Pointer to the font used to display the text of BUTTON widgets.
BUTTON_GetDefaultTextAlign()
Description
Returns the default text alignment used to display the text of BUTTON widgets.
Prototype
int BUTTON_GetDefaultTextAlign(void);
Return value
Default text alignment used to display the text of BUTTON widgets.
BUTTON_GetDefaultTextColor()
Description
Returns the default text color used to display the text of BUTTON widgets.
Prototype
GUI_COLOR BUTTON_GetDefaultTextColor(unsigned Index);
Parameter Index
Description
Index for color. See table below.
Permitted values for parameter Index BUTTON_CI_DISABLED Color for disabled state. BUTTON_CI_PRESSED Color for pressed state. BUTTON_CI_UNPRESSED Color for unpressed state.
Return value
Default text color used to display the text of BUTTON widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
418
CHAPTER
Window Objects (Widgets)
BUTTON_GetFont()
Description
Returns a pointer to the font used to display the text of the given BUTTON widget
Prototype
const GUI_FONT * BUTTON_GetFont(BUTTON_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Pointer to the font used to display the text of the given BUTTON widget.
BUTTON_GetText()
Description
Retrieves the text of the specified BUTTON widget.
Prototype
void BUTTON_GetText(BUTTON_Handle hObj, char * pBuffer, int MaxLen);
Parameter hObj pBuffer MaxLen
Handle of widget. Pointer to buffer. Size of buffer.
Description
BUTTON_GetTextAlign()
Description
Returns the alignment of the BUTTON text.
Prototype
int BUTTON_GetTextAlign(BUTTON_Handle hObj);
Parameter hObj
Handle of the BUTTON widget.
Description
Return value
Alignment of the BUTTON text.
BUTTON_GetTextColor()
Description
Returns the text color of the given BUTTON widget.
Prototype
GUI_COLOR BUTTON_GetTextColor(BUTTON_Handle hObj, unsigned int Index);
Parameter hObj Index
Description
Handle of widget. Index for color. See table below..
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
419
Permitted values for parameter Index BUTTON_CI_DISABLED Color for disabled state. BUTTON_CI_PRESSED Color for pressed state. BUTTON_CI_UNPRESSED Color for unpressed state.
Return value
Text color of the given BUTTON widget.
BUTTON_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
BUTTON_IsPressed()
Description
Returns if the BUTTON is pressed or not.
Prototype
unsigned BUTTON_IsPressed(BUTTON_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
1 if the button is pressed, 0 if not.
BUTTON_SetBitmap()
Description
Sets the bitmap(s) to be used when displaying a specified button.
Prototype
void BUTTON_SetBitmap(BUTTON_Handle
hObj,
unsigned int
Index,
const GUI_BITMAP * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of button. Index for bitmap. See table below. Pointer to the bitmap structure.
Permitted values for parameter Index BUTTON_BI_DISABLED Bitmap for disabled state. BUTTON_BI_PRESSED Bitmap for pressed state. BUTTON_BI_UNPRESSED Bitmap for unpressed state.
Additional information
If only a bitmap for the unpressed state is set the button will show it also when it is pressed or disabled. To deactivate a previously set bitmap, NULL has to be passed as pBitmap.
BUTTON_SetBitmapEx()
Description
Sets the bitmap(s) to be used when displaying a specified button.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
420
CHAPTER
Window Objects (Widgets)
Prototype
void BUTTON_SetBitmapEx(BUTTON_Handle
hObj,
unsigned int
Index,
const GUI_BITMAP * pBitmap,
int
x,
int
y);
Parameter hObj Index pBitmap x y
Description
Handle of button.
Index for bitmap (see BUTTON_SetBitmap()).
Pointer to the bitmap structure. X-position for the bitmap relative to the button. Y-position for the bitmap relative to the button.
Additional information
If only a bitmap for the unpressed state is set the button will show it also when it is pressed or disabled.
BUTTON_SetBkColor()
Description
Sets the button background color.
Prototype
void BUTTON_SetBkColor(BUTTON_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of button. Index for color. See table below. Background color to be set.
Description
Permitted values for parameter Index BUTTON_CI_DISABLED Sets the color to be used when button is disabled. BUTTON_CI_PRESSED Sets the color to be used when button is pressed. BUTTON_CI_UNPRESSED Sets the color to be used when button is unpressed.
BUTTON_SetBMP()
Description
Sets the bitmap to be displayed on the specified button.
Prototype
void BUTTON_SetBMP(BUTTON_Handle hObj, unsigned int Index, const void * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of widget. Index for bitmap. See table below. Pointer to bitmap file data
Permitted values for parameter Index BUTTON_BI_DISABLED Sets the bitmap to be used when button is disabled. BUTTON_BI_PRESSED Sets the bitmap to be used when button is pressed. BUTTON_BI_UNPRESSED Sets the bitmap to be used when button is unpressed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
421
Additional information
If only a bitmap for the unpressed state is set the button will show it also when it is pressed or disabled. For additional information's regarding bitmap files, refer to "BMP file support" on page 148.
BUTTON_SetBMPEx()
Description
Sets the bitmap to be displayed at the specified position on the given button.
Prototype
void BUTTON_SetBMPEx(BUTTON_Handle hObj, unsigned int Index,
const void * pBitmap, int
x,
int
y);
Parameter hObj Index pBitmap x y
Description
Handle of widget.
Index for bitmap (see BUTTON_SetBitmap()).
Pointer to bitmap file data X-position for the bitmap relative to the button. Y-position for the bitmap relative to the button.
Additional information
If only a bitmap for the unpressed state is set the button will show it also when it is pressed or disabled. For additional informations regarding bitmap files, refer to "BMP file support" on page 148.
BUTTON_SetDefaultBkColor()
Description
Sets the default background color used for BUTTON widgets.
Prototype
void BUTTON_SetDefaultBkColor(GUI_COLOR Color, unsigned Index);
Parameter Color Index
Color to be used. Index for color. See table below.
Description
Permitted values for parameter Index BUTTON_CI_DISABLED Color for disabled state. BUTTON_CI_PRESSED Color for pressed state. BUTTON_CI_UNPRESSED Color for unpressed state.
BUTTON_SetDefaultFocusColor()
Description
Sets the default focus rectangle color for BUTTON widgets.
Prototype
GUI_COLOR BUTTON_SetDefaultFocusColor(GUI_COLOR Color);
Parameter Color
Description
Default color to be used for BUTTON widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
422
CHAPTER
Window Objects (Widgets)
Return value
Previous default focus rectangle color.
Additional information
For more information, refer to "BUTTON_SetFocusColor()" on page 422.
BUTTON_SetDefaultFont()
Description
Sets a pointer to a GUI_FONT structure used to display the text of BUTTON widgets.
Prototype
void BUTTON_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to GUI_FONT structure to be used.
BUTTON_SetDefaultTextAlign()
Description
Sets the default text alignment used to display the text of BUTTON widgets.
Prototype
void BUTTON_SetDefaultTextAlign(int Align);
Parameter Align
Description
Text alignment to be used. For details, refer to "GUI_SetTextAlign()" on page 88.
BUTTON_SetDefaultTextColor()
Description
Sets the default text color used to display the text of BUTTON widgets.
Prototype
void BUTTON_SetDefaultTextColor(GUI_COLOR Color, unsigned Index);
Parameter Color Index
Default text color to be used. Index for color. See table below.
Description
Permitted values for parameter Index BUTTON_CI_DISABLED Color for disabled state. BUTTON_CI_PRESSED Color for pressed state. BUTTON_CI_UNPRESSED Color for unpressed state.
BUTTON_SetFocusColor()
Before
After
Description
Sets the color used to render the focus rectangle of the BUTTON widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
423
Prototype
GUI_COLOR BUTTON_SetFocusColor(BUTTON_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Description
Handle of widget. Color to be used for the focus rectangle.
Return value
Previous color of the focus rectangle.
Additional information
The focus rectangle is only visible if the widget has the input focus.
BUTTON_SetFocussable()
Description
Sets the ability to receive the input focus.
Prototype
void BUTTON_SetFocussable(BUTTON_Handle hObj, int State);
Parameter hWin State
Window handle. see table below
Description
Permitted values for parameter State
1
Button can receive the input focus
0
Button can't receive the input focus
BUTTON_SetFont()
Description
Sets the button font.
Prototype
void BUTTON_SetFont(BUTTON_Handle hObj, const GUI_FONT* pFont);
Parameter hObj pFont
Handle of button. Pointer to the font.
Description
Additional information
If no font is selected, BUTTON_FONT_DEF will be used.
BUTTON_SetPressed()
Description
Sets the state of the button to pressed or unpressed.
Prototype
void BUTTON_SetPressed(BUTTON_Handle hObj, int State);
Parameter hObj State
Description
Handle of button. State, 1 for pressed, 0 for unpressed
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
424
CHAPTER
Window Objects (Widgets)
BUTTON_SetReactOnLevel()
Description
Sets all BUTTON widgets to react on level changes of the PID.
Prototype
void BUTTON_SetReactOnLevel(void);
Additional Information
Alternatively to this function the configuration option BUTTON_REACT_ON_LEVEL can be used.
BUTTON_SetReactOnTouch()
Description
Sets all BUTTON widgets to react on touch events.
Prototype
void BUTTON_SetReactOnTouch(void);
Additional Information
The default behavior of BUTTON widgets is reacting on touch events.
BUTTON_SetStreamedBitmap()
Description
Sets the streamed bitmap(s) to be used when displaying a specified button object.
Prototype
void BUTTON_SetStreamedBitmap(BUTTON_Handle
hObj,
unsigned int
Index,
const GUI_BITMAP_STREAM * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of button.
Index for bitmap (see BUTTON_SetBitmap()).
Pointer to a bitmap stream.
Additional information
For details about streamed bitmaps, refer to "GUI_DrawStreamedBitmap()" on page 124.
Example
BUTTON_SetStreamedBitmap(hButton, BUTTON_CI_UNPRESSED, (const GUI_BITMAP_STREAM *)acImage);
BUTTON_SetStreamedBitmapEx()
Description
Sets the streamed bitmap(s) to be used when displaying a specified button object.
Prototype
void BUTTON_SetStreamedBitmapEx(BUTTON_Handle
hObj,
unsigned int
Index,
const GUI_BITMAP_STREAM * pBitmap,
int
x,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
425
int
y);
Parameter hObj Index pBitmap x y
Description
Handle of button.
Index for bitmap (see BUTTON_SetBitmap()).
Pointer to a bitmap stream. X-position for the bitmap relative to the button. Y-position for the bitmap relative to the button.
Additional information
For details about streamed bitmaps, refer to "GUI_DrawStreamedBitmap()" on page 124().
BUTTON_SetText()
Description
Sets the text to be displayed on the button.
Prototype
int BUTTON_SetText(BUTTON_Handle hObj, const char * s);
Parameter hObj s
Handle of the button widget. Text to display.
Description
Return value
0 on success, 1 on error.
BUTTON_SetTextAlign()
Description
Sets the alignment of the button text.
Prototype
void BUTTON_SetTextAlign(BUTTON_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of the button widget. Text alignment to be set (see "GUI_SetTextAlign()" on page 88)
Additional information
The default value of the text alignment is GUI_TA_HCENTER | GUI_TA_VCENTER.
BUTTON_SetTextColor()
Description
Sets the button text color.
Prototype
void BUTTON_SetTextColor(BUTTON_Handle hObj, unsigned int Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
426
CHAPTER
Window Objects (Widgets)
GUI_COLOR Color);
Parameter hObj Index Color
Handle of the button widget. Color index. See table below. Text color to be set.
Description
Permitted values for parameter Index BUTTON_CI_DISABLED Sets the color to be used when button is disabled. BUTTON_CI_PRESSED Sets the color to be used when button is pressed. BUTTON_CI_UNPRESSED Sets the color to be used when button is unpressed.
BUTTON_SetTextOffset()
Description
Adjusts the position of the button text considering the current text alignment setting.
Prototype
void BUTTON_SetTextOffset(BUTTON_Handle hObj, int xPos, int yPos);
Parameter hObj xPos yPos
Description
Handle of the button widget. Offset to be used for the x-axis. Default is 0. Offset to be used for the y-axis. Default is 0.
BUTTON_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.5.6 Examples
The Sample folder contains the following examples which show how the widget can be used: · WIDGET_ButtonSimple.c · WIDGET_ButtonPhone.c · WIDGET_ButtonRound.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
427
Screenshot of WIDGET_ButtonSimple.c:
Screenshot of WIDGET_ButtonPhone.c:
Screenshot of WIDGET_ButtonRound.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
428
CHAPTER
Window Objects (Widgets)
16.6 CHECKBOX: Checkbox widget
One of the most familiar widgets for selecting various choices is the check box. A check box may be checked or unchecked by the user, and any number of boxes may be checked at one time. If using a keyboard interface the state of a focused check box can be toggled by the <SPACE> key. A box will appear gray if it is disabled, as seen in the table below where each of the possible check box appearances are illustrated:
Unchecked
Checked
Third state
Enabled
Disabled
All CHECKBOX-related routines are located in the file(s) CHECKBOX*.c, CHECKBOX.h. All identifiers are prefixed CHECKBOX.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.6.1 Configuration options
Type
Macro
Default
Description
N
CHECKBOX_BKCOLOR_DEFAULT
0xC0C0C0
Default background color.
N
CHECKBOX_BKCOLOR0_DEFAULT 0x808080
Background color of the default image, disabled state.
N
CHECKBOX_BKCOLOR1_DEFAULT GUI_WHITE
Background color of the default image, enabled state.
N
CHECKBOX_FGCOLOR0_DEFAULT 0x101010
Foreground color of the default image, disabled state.
N
CHECKBOX_FGCOLOR1_DEFAULT GUI_BLACK
Foreground color of the default image, enabled state.
N
CHECKBOX_FOCUSCOLOR_DEFAULT GUI_BLACK
Color used to render the focus rectangle.
S CHECKBOX_FONT_DEFAULT
&GUI_Font13_1
Default font used to display the optional checkbox text.
S CHECKBOX_IMAGE0_DEFAULT
(see table above)
Pointer to bitmap used to draw the widget if checked, disabled state.
S CHECKBOX_IMAGE1_DEFAULT
(see table above)
Pointer to bitmap used to draw the widget if checked, enabled state.
N CHECKBOX_SPACING_DEFAULT 4
Spacing used to display the optional checkbox text beside the box.
N
GUI_TA_LEFT |
Default alignment of the optional
CHECKBOX_TEXTALIGN_DEFAULT GUI_TA_VCENTER checkbox text.
N
CHECKBOX_TEXTCOLOR_DEFAULT GUI_BLACK
Default color used to display the optional checkbox text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
429
16.6.2 Predefined IDs
The following symbols define IDs which may be used to make CHECKBOX widgets distinguishable from creation: GUI_ID_CHECK0 - GUI_ID_CHECK9
16.6.3 Notification codes
The following events are sent from a check box widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_VALUE_CHANGED
Description
Check box has been clicked. Check box has been released. Check box has been clicked and pointer has been moved out of the box without releasing. Status of check box has been changed.
16.6.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_SPACE
Reaction
Toggles the checked state of the widget.
16.6.5 CHECKBOX API
The table below lists the available emWin CHECKBOX-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine CHECKBOX_Check() CHECKBOX_Create() CHECKBOX_CreateEx() CHECKBOX_CreateIndirect() CHECKBOX_CreateUser()
CHECKBOX_GetDefaultBkColor()
CHECKBOX_GetDefaultFont()
CHECKBOX_GetDefaultSpacing()
CHECKBOX_GetDefaultTextAlign()
CHECKBOX_GetDefaultTextColor() CHECKBOX_GetState() CHECKBOX_GetText() CHECKBOX_GetUserData() CHECKBOX_IsChecked() CHECKBOX_SetBkColor() CHECKBOX_SetBoxBkColor() CHECKBOX_SetDefaultBkColor() CHECKBOX_SetDefaultFocusColor()
CHECKBOX_SetDefaultFont()
CHECKBOX_SetDefaultImage()
Description
Set the check box state to checked. (Obsolete)
Creates a CHECKBOX widget. (Obsolete)
Creates a CHECKBOX widget.
Creates a CHECKBOX widget from resource table entry. Creates a CHECKBOX widget using extra bytes as user data. Returns the default background color for CHECKBOX widgets. Returns the default font used to display the text of CHECKBOX widgets. Returns the default spacing between the box and the text of CHECKBOX widgets. Returns the default alignment used to display the text of CHECKBOX widgets. Returns the default text color used to display the text of CHECKBOX widgets. Returns the current state of the check box.
Returns the text of the check box.
Retrieves the data set with CHECKBOX_SetUserData(). Return the current state (checked or not checked) of the check box. Sets the background color of the given CHECKBOX widget.
Sets the background color of the box area.
Sets the default background color for CHECKBOX widget. Sets the default focus rectangle color for CHECKBOX widgets. Sets the default font used to display the text of CHECKBOX widgets. Sets the default image to be shown when a box has been checked.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
430
CHAPTER
Window Objects (Widgets)
Routine CHECKBOX_SetDefaultSpacing()
CHECKBOX_SetDefaultTextAlign()
CHECKBOX_SetDefaultTextColor() CHECKBOX_SetFocusColor() CHECKBOX_SetFont() CHECKBOX_SetImage() CHECKBOX_SetNumStates() CHECKBOX_SetSpacing() CHECKBOX_SetState() CHECKBOX_SetText() CHECKBOX_SetTextAlign()
CHECKBOX_SetTextColor() CHECKBOX_SetUserData() CHECKBOX_Uncheck()
Description
Sets the default spacing between the box and the text of CHECKBOX widgets. Sets the default alignment used to display the check box text. Sets the default text color used to display the text of CHECKBOX widgets. Sets the color of the focus rectangle.
Sets the checkbox font.
Sets the image to be shown when box has been checked. Sets the number of possible states of the check box (2 or 3). Sets the spacing between the box and the check box text.
Sets the state of the CHECKBOX widget.
Sets the text of the CHECKBOX widget. Sets the alignment used to display the text of the CHECKBOX widget. Sets the color used to display the text of the CHECKBOX widget. Sets the extra data of a CHECKBOX widget.
Set the check box state to unchecked. (Obsolete)
CHECKBOX_Check()
(Obsolete, CHECKBOX_SetState() should be used instead)
Before
After
Description
Sets a specified check box to a checked state.
Prototype
void CHECKBOX_Check(CHECKBOX_Handle hObj);
Parameter hObj
Handle of check box.
Description
CHECKBOX_Create()
(Obsolete, CHECKBOX_CreateEx should be used instead)
Description
Creates a CHECKBOX widget of a specified size at a specified location.
Prototype
CHECKBOX_Handle CHECKBOX_Create(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int Id,
int
Flags);
Parameter x0 y0 xsize
Description
Leftmost pixel of the check box (in parent coordinates). Topmost pixel of the check box (in parent coordinates). Horizontal size of the check box (in pixels).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
431
Parameter
Description
ysize
Vertical size of the check box (in pixels).
hParent
Handle of parent window.
Id
ID to be returned.
Flags
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
Return value
Handle of the created CHECKBOX widget; 0 if the function fails.
Additional information
If the parameters xsize or ysize are 0 the size of the bitmap will be used as default size of the check box.
CHECKBOX_CreateEx()
Description
Creates a CHECKBOX widget of a specified size at a specified location.
Prototype
CHECKBOX_Handle CHECKBOX_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new CHECKBOX widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Not used yet, reserved for future use. Window ID of the widget.
Return value
Handle of the created CHECKBOX widget; 0 if the function fails.
Additional information
If the parameters xsize or ysize are 0 the size of the default check mark bitmap (11 x 11 pixels) plus the effect size will be used as default size of the check box. If the desired size of the check box is different to the default size it can be useful to set a user defined check mark image using the function CHECKBOX_SetImage(). If check box text should be shown with the widget the size should be large enough to show the box + text + spacing between box and text.
CHECKBOX_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
432
CHAPTER
Window Objects (Widgets)
CHECKBOX_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function CHECKBOX_CreateEx() can be referred to.
CHECKBOX_GetDefaultBkColor()
Description
Returns the default background color of new check box widgets.
Prototype
GUI_COLOR CHECKBOX_GetDefaultBkColor(void);
Return value
Default background color of new check box widgets.
Additional information
The background color returned by this function is not the background color shown in the box, but the background color of the rest of the widget. For more information, refer to "CHECKBOX_SetBoxBkColor()" on page 435.
CHECKBOX_GetDefaultFont()
Description
Returns a pointer to a GUI_FONT structure used to display the check box text of new check box widgets.
Prototype
const GUI_FONT * CHECKBOX_GetDefaultFont(void);
Return value
Pointer to a GUI_FONT structure used to display the check box text of new check box widgets.
Additional information
For more information, refer to "CHECKBOX_SetFont()" on page 438.
CHECKBOX_GetDefaultSpacing()
Description
Returns the default spacing between box and text used to display the check box text of new check box widgets.
Prototype
int CHECKBOX_GetDefaultSpacing(void);
Return value
Default spacing between box and text used to display the check box text of new check box widgets.
Additional information
For more information, refer to "CHECKBOX_SetSpacing()" on page 439.
CHECKBOX_GetDefaultTextAlign()
Description
Returns the default alignment used to display the check box text of new check box widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
433
Prototype
int CHECKBOX_GetDefaultAlign(void);
Return value
Default alignment used to display the check box text.
Additional information
For more information, refer to "CHECKBOX_SetTextAlign()" on page 441.
CHECKBOX_GetDefaultTextColor()
Description
Returns the default text color used to display the check box text of new check box widgets.
Prototype
GUI_COLOR CHECKBOX_GetDefaultTextColor(void);
Return value
Default text color used to display the check box text of new check box widgets.
Additional information
For more information, refer to "CHECKBOX_SetTextColor()" on page 441.
CHECKBOX_GetState()
Description
Returns the current state of the given check box.
Prototype
int CHECKBOX_GetState(CHECKBOX_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Current state of the given check box.
Additional information
Per default a check box can have 2 states, checked (1) and unchecked (0). With the function CHECKBOX_SetNumStates() the number of possible states can be increased to 3. If the check box is in the third state the function returns 2. For more information, refer to "CHECKBOX_SetNumStates()" on page 439.
CHECKBOX_GetText()
Description
Returns the optional text of the given check box.
Prototype
int CHECKBOX_GetText(CHECKBOX_Handle hObj, char * pBuffer, int MaxLen);
Parameter hObj pBuffer MaxLen
Description
Handle of widget. Pointer to buffer to which the text will be copied. Buffer size in bytes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
434
CHAPTER
Window Objects (Widgets)
Return value
Length of the text copied into the buffer.
Additional information
If the check box contains no text the function returns 0 and the buffer remains unchanged.
CHECKBOX_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
CHECKBOX_IsChecked()
Description
Returns the current state (checked or not checked) of a specified CHECKBOX widget.
Prototype
int CHECKBOX_IsChecked(CHECKBOX_Handle hObj);
Parameter hObj
Handle of check box.
Return value
0: not checked 1: checked
CHECKBOX_SetBkColor()
Description
Before
After
Description
Sets the background color used to display the background of the check box.
Prototype
void CHECKBOX_SetBkColor(CHECKBOX_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Description
Handle of widget.
Color to be used to draw the background or GUI_INVALID_COLOR to work in
transparent mode.
Additional information
If the check box should work in transparent mode GUI_INVALID_COLOR should be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
CHECKBOX_SetBoxBkColor()
Before
435 After
Description
Sets the background color of the box area.
Prototype
GUI_COLOR CHECKBOX_SetBoxBkColor(CHECKBOX_Handle hObj,
GUI_COLOR
Color,
int
Index);
Parameter hObj Color Index
Handle of widget. Color to be used. See table below.
Description
Permitted values for parameter Index
CHECKBOX_CI_DISABLED CHECKBOX_CI_ENABLED
Background color used for disabled state. Background color used for enabled state.
Return value
Previous background color.
Additional information
The color set by this function will only be visible, if the images used by the widget are transparent or no image is used. The default images of this widget are transparent.
CHECKBOX_SetDefaultBkColor()
Description
Sets the default background color used for new check box widgets.
Prototype
void CHECKBOX_SetDefaultBkColor(GUI_COLOR Color);
Parameter Color
Description Color to be used, GUI_INVALID_COLOR for transparency.
Additional information
For more information, refer to "CHECKBOX_SetBkColor()" on page 434.
CHECKBOX_SetDefaultFocusColor()
Description
Sets the color used to render the focus rectangle of new check box widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
436
CHAPTER
Window Objects (Widgets)
Prototype
GUI_COLOR CHECKBOX_SetDefaultFocusColor(GUI_COLOR Color);
Parameter Color
Color to be used.
Description
Return value
Previous color used to render the focus rectangle.
Additional information
For mode information, refer to "CHECKBOX_SetFocusColor()" on page 438.
CHECKBOX_SetDefaultFont()
Description
Sets a pointer to a GUI_FONT structure used to display the check box text of new check box widgets.
Prototype
void CHECKBOX_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to GUI_FONT structure to be used.
Additional information
For more information, refer to "CHECKBOX_SetFont()" on page 438.
CHECKBOX_SetDefaultImage()
Description
Sets the images used for new check boxes to be shown if they has been checked.
Prototype
void CHECKBOX_SetDefaultImage(const GUI_BITMAP * pBitmap,
unsigned int
Index);
Parameter pBitmap Index
Pointer to bitmap. See table below.
Description
Permitted values for parameter Index
CHECKBOX_BI_INACTIV_UNCHECKED CHECKBOX_BI_ACTIV_UNCHECKED CHECKBOX_BI_INACTIV_CHECKED CHECKBOX_BI_ACTIV_CHECKED CHECKBOX_BI_INACTIV_3STATE
CHECKBOX_BI_ACTIV_3STATE
Sets the bitmap displayed when the check box is unchecked and disabled.
Sets the bitmap displayed when the check box is unchecked and enabled.
Sets the bitmap displayed when the check box is checked and disabled.
Sets the bitmap displayed when the check box is checked and enabled.
Sets the bitmap displayed when the check box is in the third state and disabled.
Sets the bitmap displayed when the check box is in the third state and enabled.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
437
Additional information
The image has to fill the complete inner area of the check box.
CHECKBOX_SetDefaultSpacing()
Description
Sets the default spacing between box and text used to display the check box text of new check box widgets.
Prototype
void CHECKBOX_SetDefaultSpacing(int Spacing);
Parameter Spacing
Description
Number of pixels between box and text used for new check box widgets.
Additional information
For more information, refer to "CHECKBOX_SetSpacing()" on page 439.
CHECKBOX_SetDefaultTextAlign()
Description
Sets the default alignment used to display the check box text of new check box widgets.
Prototype
void CHECKBOX_SetDefaultTextAlign(int Align);
Parameter Align
Description
Text alignment used to display the text of new check box widgets.
Additional information
For more information, refer to "CHECKBOX_SetTextAlign()" on page 441.
CHECKBOX_SetDefaultTextColor()
Description
Sets the default text color used to display the check box text of new check box widgets.
Prototype
void CHECKBOX_SetDefaultTextColor(GUI_COLOR Color);
Parameter Color
Color to be used.
Description
Additional information
For more information, refer to "CHECKBOX_SetTextColor()" on page 441.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
438
CHECKBOX_SetFocusColor()
CHAPTER
Before
Window Objects (Widgets) After
Description
Sets the color used to render the focus rectangle.
Prototype
GUI_COLOR CHECKBOX_SetFocusColor(CHECKBOX_Handle hObj, GUI_COLOR Color);
Parameter hObj
Handle of widget.
Description
Return value
Previous color of the focus rectangle.
Additional information
The focus rectangle is only visible if the widget has the input focus.
CHECKBOX_SetFont()
Description
Sets the checkbox font.
Prototype
void CHECKBOX_SetFont(CHECKBOX_Handle
hObj,
const GUI_FONT GUI_UNI_PTR * pFont);
Parameter hObj pFont
Handle of checkbox. Pointer to the font.
CHECKBOX_SetImage()
Description
Before
After
Description
Sets the images to be shown if the check box has been checked.
Prototype
void CHECKBOX_SetImage(CHECKBOX_Handle hObj, const GUI_BITMAP * pBitmap,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
439
unsigned int
Index);
Parameter hObj pBitmap Index
Description
Handle of check box. Pointer to bitmap.
(see table shown under CHECKBOX_SetDefaultImage)
Additional information
The image has to fill the complete inner area of the check box. If using this function make sure, the size of the check box used to create the widget is large enough to show the bitmap and (optional) the text.
CHECKBOX_SetNumStates()
Description
This function sets the number of possible states of the given check box.
Prototype
void CHECKBOX_SetNumStates(CHECKBOX_Handle hObj, unsigned NumStates);
Parameter hObj NumStates
Description
Handle of widget. Number of possible states of the given check box. Currently supported are 2 or 3 states.
Additional information
Per default a check box supports 2 states: checked (1) and unchecked (0). If the check box should support a third state the number of possible states can be increased to 3.
CHECKBOX_SetSpacing()
Before
After
Description
Sets the number of pixels between box and text of a given check box widget.
Prototype
void CHECKBOX_SetSpacing(CHECKBOX_Handle hObj, unsigned Spacing);
Parameter hObj Spacing
Description
Handle of widget. Number of pixels between box and text to be used.
Additional information
The default spacing is 4 pixels. The function CHECKBOX_SetDefaultSpacing() or the configuration macro CHECKBOX_SPACING_DEFAULT can be used to set the default value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
440
CHECKBOX_SetState()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the new state of the given check box widget.
Prototype
void CHECKBOX_SetState(CHECKBOX_Handle hObj, unsigned State);
Parameter hObj State
Description
Handle of widget. Zero based number of new state.
Permitted values for parameter State
0
Unchecked
1
Checked
2
Third state
Additional information
The passed state should not be greater than the number of possible states set with CHECKBOX_SetNumStates() minus 1.
CHECKBOX_SetText()
Before
After
Description
Sets the optional text shown beside the box.
Prototype
void CHECKBOX_SetText(CHECKBOX_Handle hObj, const char * pText);
Parameter hObj pText
Description
Handle of widget. Pointer to text to be shown beside the box.
Additional information
Clicking on the text beside the box has the same effect as clicking into the box.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
CHECKBOX_SetTextAlign()
Before
441 After
Description
Sets the alignment used to display the check box text beside the box.
Prototype
void CHECKBOX_SetTextAlign(CHECKBOX_Handle hObj, int Align);
Parameter hObj Align
Handle of widget. Desired text alignment.
Description
Additional information
Per default the text alignment is GUI_TA_LEFT | GUI_TA_VCENTER. The function
CHECKBOX_SetDefaultTextAlign()
and
the
configuration
macro
CHECKBOX_TEXTALIGN_DEFAULT can be used to set a user defined default value.
CHECKBOX_SetTextColor()
Before
After
Description
Sets the color used to display the check box text.
Prototype
void CHECKBOX_SetTextColor(CHECKBOX_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of widget. Desired color of check box text.
Description
Additional information
Per default the text color of a check box text is GUI_BLACK. The function
CHECKBOX_SetDefaultTextColor()
and
the
configuration
macro
CHECKBOX_TEXTCOLOR_DEFAULT can be used to set a user defined default color.
CHECKBOX_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
442
CHAPTER
Window Objects (Widgets)
CHECKBOX_Uncheck()
(Obsolete, CHECKBOX_SetState() should be used instead)
Before
After
Description
Sets the state of a specified check box unchecked.
Prototype
void CHECKBOX_Uncheck(CHECKBOX_Handle hObj);
Parameter hObj
Handle of check box.
Description
Additional information
This is the default setting for check boxes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
443
16.6.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_Checkbox.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_Checkbox.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
444
CHAPTER
Window Objects (Widgets)
16.7 DROPDOWN: Dropdown widget
DROPDOWN widgets are used to select one element of a list with several columns. It shows the currently selected item in non open state. If the user opens a DROPDOWN widget a LISTBOX appears to select a new item.
DROPDOWN closed
DROPDOWN opened
If mouse support is enabled, the open list reacts on moving the mouse over it.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.7.1 Configuration options
Type
Macro
Default
Description
N DROPDOWN_ALIGN_DEFAULT S DROPDOWN_FONT_DEFAULT
GUI_TA_LEFT &GUI_Font13_1
Text alignment used to display the dropdown text in closed state.
Default font
N
DROPDOWN_BKCOLOR0_DEFAULT GUI_WHITE
Background color, unselected state.
N
DROPDOWN_BKCOLOR1_DEFAULT GUI_GRAY
Background color, selected state without focus.
N
DROPDOWN_BKCOLOR2_DEFAULT GUI_BLUE
Background color, selected state with focus.
N DROPDOWN_KEY_EXPAND
GUI_KEY_SPACE
Key which can be used to expand the dropdown list.
N DROPDOWN_KEY_SELECT
GUI_KEY_ENTER
Key which can be used to select an item from the open dropdown list.
N
DROPDOWN_TEXTCOLOR0_DEFAULT GUI_BLACK
Text color, unselected state.
N
DROPDOWN_TEXTCOLOR1_DEFAULT GUI_BLACK
Text color, selected state without focus.
N
DROPDOWN_TEXTCOLOR2_DEFAULT GUI_WHITE
Enable 3D support.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
445
16.7.2 Predefined IDs
The following symbols define IDs which may be used to make DROPDOWN widgets distinguishable from creation: GUI_ID_DROPDOWN0 - GUI_ID_DROPDOWN3
16.7.3 Notification codes
The following events are sent from the widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT
WM_NOTIFICATION_SCROLL_CHANGED WM_NOTIFICATION_SEL_CHANGED
Description
Widget has been clicked.
Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing. The scroll position of the optional scrollbar of the opened dropdown widget has been changed. The selection of the dropdown list has been changed.
16.7.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_ENTER GUI_KEY_SPACE
Reaction
Selects an item from the open dropdown list and closes the list. Opens the dropdown list.
16.7.5 DROPDOWN API
The table below lists the available emWin DROPDOWN-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine DROPDOWN_AddString() DROPDOWN_Collapse() DROPDOWN_Create() DROPDOWN_CreateEx() DROPDOWN_CreateIndirect()
DROPDOWN_CreateUser() DROPDOWN_DecSel() DROPDOWN_DecSelExp() DROPROWN_DeleteItem() DROPDOWN_Expand() DROPDOWN_GetDefaultFont() DROPDOWN_GetItemDisabled() DROPDOWN_GetItemText() DROPDOWN_GetListbox() DROPDOWN_GetNumItems() DROPDOWN_GetSel()
DROPDOWN_GetSelExp()
DROPDOWN_GetUserData() DROPDOWN_IncSel()
Description
Adds an element to the DROPDOWN list.
Closes the dropdown list.
Creates a DROPDOWN widget. (Obsolete)
Creates a DROPDOWN widget. Creates a DROPDOWN widget from a resource table entry. Creates a DROPDOWN widget using extra bytes as user data. Decrements selection.
Decrements selection in expanded state.
Deletes an item of the DROPDOWN list.
Opens the dropdown list. Returns the default font used to create DROPDOWN widgets. Returns the state of the given item.
Returns the text of a specific DROPDOWN item. Returns the handle of the attached LISTBOX in expanded state. Returns the number of items in the dropdown list. Returns the number of the currently selected element. Returns the number of the currently selected element in expanded state. Retrieves the data set with DROPDOWN_SetUserData(). Increments selection.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
446
CHAPTER
Window Objects (Widgets)
Routine DROPDOWN_IncSelExp() DROPDOWN_InsertString() DROPDOWN_SetAutoScroll() DROPDOWN_SetBkColor() DROPDOWN_SetColor()
DROPDOWN_SetDefaultColor() DROPDOWN_SetDefaultFont() DROPDOWN_SetDefaultScrollbarColor() DROPDOWN_SetFont() DROPDOWN_SetItemDisabled() DROPDOWN_SetItemSpacing() DROPDOWN_SetScrollbarColor() DROPDOWN_SetSel() DROPDOWN_SetSelExp() DROPDOWN_SetTextAlign() DROPDOWN_SetTextColor() DROPDOWN_SetTextHeight() DROPDOWN_SetUpMode() DROPDOWN_SetUserData()
Description
Increments selection in expanded state.
Inserts a string to the dropdown list. Enables the automatic use of a scrollbar in the dropdown list. Sets the background color. Sets the color of the arrow and the button of the DROPDOWN widget. Sets the default color for arrow and button of DROPDOWN widgets. Sets the default font for DROPDOWN widgets. Sets the default colors of the optional scrollbar in the dropdown list. Sets the font of the given DROPDOWN widget
Sets the state of the given item. Sets the spacing between the items of the dropdown list. Sets the colors of the scrollbar in the dropdown list.
Sets the current selection.
Sets the current selection in expanded state. Sets the text alignment used to display the dropdown text in closed state. Sets the text color of the given DROPDOWN widget. Sets the height of the rectangle used to display the dropdown text in closed state. Enables the up mode for the given widget.
Sets the extra data of a DROPDOWN widget.
DROPDOWN_AddString()
Description
Adds a new element to the dropdown list.
Prototype
void DROPDOWN_AddString(DROPDOWN_Handle hObj, const char * s);
Parameter hObj s
Handle of widget Pointer to string to be added
Description
DROPDOWN_Collapse()
Description
Closes the dropdown list of the DROPDOWN widget.
Prototype
void DROPDOWN_Collapse(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
DROPDOWN_Create()
(Obsolete, DROPDOWN_CreateEx() should be used instead)
Description
Creates a DROPDOWN widget of a specified size at a specified location.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
447
Prototype
DROPDOWN_Handle DROPDOWN_Create(WM_HWIN hWinParent,
int
x0,
int y0,
int
xsize,
int ysize,
int
Flags);
Parameter hWinParent x0 y0 xsize ysize
Flags
Description
Handle of parent window Leftmost pixel of the DROPDOWN widget (in parent coordinates). Topmost pixel of the DROPDOWN widget (in parent coordinates). Horizontal size of the DROPDOWN widget (in pixels). Vertical size of the DROPDOWN widget in open state (in pixels).
Window create flags. Typically, WM_CF_SHOW to make the widget visible immediately
(refer to "WM_CreateWindow()" on page 357 for a list of available parameter values).
Return value
Handle of the created DROPDOWN widget; 0 if the function fails.
Additional information
The ysize of the widget in closed state depends on the font used to create the widget. You can not set the ysize of a closed DROPDOWN widget.
DROPDOWN_CreateEx()
Description
Creates a DROPDOWN widget of a specified size at a specified location.
Prototype
DROPDOWN_Handle DROPDOWN_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget in open state (in pixels). Handle of parent window. If 0, the new DROPDOWN widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). See table below. Window ID of the widget.
Permitted values for parameter ExFlags
0 DROPDOWN_CF_AUTOSCROLLBAR
DROPDOWN_CF_UP
No function.
Enable automatic use of a scrollbar. For details, refer to "DROPDOWN_SetAutoScroll()" on page 451.
Creates a DROPDOWN widget which opens the dropdown list above the widget. This flag is useful if the space below the widget is not sufficient for the dropdown list.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
448
CHAPTER
Window Objects (Widgets)
Return value
Handle of the created DROPDOWN widget; 0 if the function fails.
DROPDOWN_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
DROPDOWN_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function DROPDOWN_CreateEx() can be referred to.
DROPDOWN_DecSel()
Description
Decrement the selection, moves the selection of a specified DROPDOWN widget up by one item.
Prototype
void DROPDOWN_DecSel(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
DROPDOWN_DecSelExp()
Description
Decrements the selection of the attached LISTBOX in expanded state.
Prototype
void DROPDOWN_DecSelExp(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
DROPDOWN_DeleteItem()
Description
Deletes the given item of the dropdown list.
Prototype
void DROPDOWN_DeleteItem(DROPDOWN_Handle hObj, unsigned int Index);
Parameter hObj Index
Description
Handle of widget. Zero based index of the item to be deleted.
Additional information
If the index is greater than the number of items < 1 the function returns immediately.
DROPDOWN_Expand()
Description
Opens the dropdown list of the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
449
Prototype
void DROPDOWN_Expand(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget.
Description
Additional information
The dropdown list remains open until an element has been selected or the focus has been lost.
DROPDOWN_GetItemDisabled()
Description
Returns the state of the given item.
Prototype
unsigned DROPDOWN_GetItemDisabled(DROPDOWN_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of widget Zero-based index of the item.
Description
Return value
1 if the given item is disabled, 0 if not.
DROPDOWN_GetItemText()
Description
Returns the state of the given item.
Prototype
int DROPDOWN_GetItemText(DROPDOWN_Handle hObj, unsigned Index,
char
* pBuffer, int
MaxSize);
Parameter hObj Index pBuffer MaxSize
Description
Handle of the DROPDOWN widget. Zero-based index of the item. Pointer to a char buffer which is filled with the text. Maximum number of chars which can be stored by pBuffer.
Return value
0 on success, 1 on error.
DROPDOWN_GetListbox()
Description
Returns the handle of the attached LISTBOX widget in expanded state.
Prototype
LISTBOX_Handle DROPDOWN_GetListbox(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
450
CHAPTER
Window Objects (Widgets)
Return value
Handle of the attached LISTBOX widget in expanded state, 0 if DROPDOWN is in collapsed state.
DROPDOWN_GetNumItems()
Description
Returns the number of items in the given DROPDOWN widget.
Prototype
int DROPDOWN_GetNumItems(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of items in the given DROPDOWN widget.
DROPDOWN_GetSel()
Description
Returns the number of the currently selected item in a specified DROPDOWN widget.
Prototype
int DROPDOWN_GetSel(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of the currently selected item.
DROPDOWN_GetSelExp()
Description
Returns the number of the currently selected item of the attached LISTBOX in expanded state.
Prototype
int DROPDOWN_GetSelExp(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of the currently selected item.
DROPDOWN_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
DROPDOWN_IncSel()
Description
Increment the selection, moves the selection of a specified DROPDOWN widget down by one item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
451
Prototype
void DROPDOWN_IncSel(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
DROPDOWN_IncSelExp()
Description
Increments the selection of the attached LISTBOX in expanded state.
Prototype
void DROPDOWN_IncSelExp(DROPDOWN_Handle hObj);
Parameter hObj
Handle of widget
Description
DROPDOWN_InsertString()
Description
Inserts a string to the dropdown list at the given position.
Prototype
void DROPDOWN_InsertString(DROPDOWN_Handle hObj,
const char
* s,
unsigned int
Index);
Parameter hObj s Index
Description
Handle of widget. Pointer to the string to be inserted. Zero based index of the position.
Additional information
If the given index is greater than the number of items the string will be appended to the end of the dropdown list.
DROPDOWN_SetAutoScroll()
Description
Enables the automatic use of a vertical scrollbar in the dropdown list.
Prototype
void DROPDOWN_SetAutoScroll(DROPDOWN_Handle hObj, int OnOff);
Parameter hObj OnOff
Handle of widget. See table below.
Description
Permitted values for parameter OnOff
0
Disable automatic use of a scrollbar.
1
Enable automatic use of a scrollbar.
Additional information
If enabled the dropdown list checks if all elements fits into the listbox. If not a vertical scrollbar will be added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
452
DROPDOWN_SetBkColor()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the background color of the given DROPDOWN widget.
Prototype
void DROPDOWN_SetBkColor(DROPDOWN_Handle hObj,
unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index for background color. See table below. Color to be set.
Permitted values for parameter Index
DROPDOWN_CI_UNSEL DROPDOWN_CI_SEL DROPDOWN_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
DROPDOWN_SetColor()
Before
After
Description
Sets the color of the button or the arrow of the given DROPDOWN widget.
Prototype
void DROPDOWN_SetColor(DROPDOWN_Handle hObj,
unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index of desired item. See table below. Color to be used.
Permitted values for parameter Index
DROPDOWN_CI_ARROW
Color of small arrow within the button.
DROPDOWN_CI_BUTTON
Button color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
453
DROPDOWN_SetDefaultColor()
Description
Sets the default colors for the arrow and the button of new DROPDOWN widgets.
Prototype
GUI_COLOR DROPDOWN_SetDefaultColor(int Index, GUI_COLOR Color);
Parameter Index Color
Description
Refer to "DROPDOWN_SetColor()" on page 452. Color to be used.
DROPDOWN_SetDefaultFont()
Description
Sets the default font used for new DROPDOWN widgets.
Prototype
void DROPDOWN_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Pointer to GUI_FONT structure.
Description
DROPDOWN_SetDefaultScrollbarColor()
Description
Sets the default colors used for the optional scrollbar in the dropdown list.
Prototype
GUI_COLOR DROPDOWN_SetDefaultScrollbarColor(int Index, GUI_COLOR Color);
Parameter Index Color
Description
Refer to "DROPDOWN_SetScrollbarColor()" on page 454. Color to be used.
DROPDOWN_SetFont()
Description
Sets the font used to display the given DROPDOWN widget.
Prototype
void DROPDOWN_SetFont(DROPDOWN_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle of widget Pointer to the font.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
454
CHAPTER
DROPDOWN_SetItemDisabled()
Before
Window Objects (Widgets) After
Description
Sets the enabled state of the given item.
Prototype
void DROPDOWN_SetItemDisabled(DROPDOWN_Handle hObj,
unsigned
Index,
int
OnOff);
Parameter hObj Index OnOff
Handle of widget Zero-based index of the item. 1 for enabled, 0 for disabled.
DROPDOWN_SetScrollbarColor()
Description
Before
After
Description
Sets the colors of the optional scrollbar in the dropdown list.
Prototype
void DROPDOWN_SetScrollbarColor(DROPDOWN_Handle hObj,
unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index of desired item. See table below. Color to be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
455
Permitted values for parameter Index
SCROLLBAR_CI_THUMB SCROLLBAR_CI_SHAFT SCROLLBAR_CI_ARROW
Color of thumb area. Color of shaft. Color of arrows.
DROPDOWN_SetScrollbarWidth()
Description
Sets the width of the scrollbars used by the dropdown list of the given DROPDOWN widget.
Prototype
void DROPDOWN_SetScrollbarWidth(DROPDOWN_Handle hObj, unsigned Width);
Parameter hObj Width
Description
Handle of widget. Width of the scrollbar(s) used by the dropdown list of the given DROPDOWN widget.
DROPDOWN_SetSel()
Description
Sets the selected item of a specified DROPDOWN widget.
Prototype
void DROPDOWN_SetSel(DROPDOWN_Handle hObj, int Sel);
Parameter hObj Sel
Handle of widget Element to be selected.
Description
DROPDOWN_SetSelExp()
Description
Sets the selected item of the attached LISTBOX in expanded state.
Prototype
void DROPDOWN_SetSelExp(DROPDOWN_Handle hObj, int Sel);
Parameter hObj Sel
Handle of widget Element to be selected.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
456
CHAPTER
DROPDOWN_SetItemSpacing()
Before
Window Objects (Widgets) After
Description
Sets an additional spacing below the items of the dropdown list.
Prototype
void DROPDOWN_SetItemSpacing(DROPDOWN_Handle hObj, unsigned Value);
Parameter hObj Value
Description
Handle of widget Number of pixels used as additional space between the items of the dropdown list.
DROPDOWN_SetTextAlign()
Before
After
Description
Sets the alignment used to display the dropdown text in closed state.
Prototype
void DROPDOWN_SetTextAlign(DROPDOWN_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of widget Alignment used to display the dropdown text in closed state.
DROPDOWN_SetTextColor()
Description
Sets the background color of the given DROPDOWN widget.
Prototype
void DROPDOWN_SetTextColor(DROPDOWN_Handle hObj, unsigned int Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
457
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index for background color. See table below. Color to be set.
Permitted values for parameter Index
DROPDOWN_CI_UNSEL DROPDOWN_CI_SEL DROPDOWN_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
DROPDOWN_SetTextHeight()
Before
After
Description
Sets the height of the rectangle used to display the DROPDOWN text in closed state.
Prototype
void DROPDOWN_SetTextHeight(DROPDOWN_Handle hObj, unsigned TextHeight);
Parameter hObj TextHeight
Description
Handle of widget Height of the rectangle used to display the text in closed state.
Additional information
Per default the height of the DROPDOWN widget depends on the used font. Using this function with TextHeight > 0 means the given value should be used. Text Height = 0 means the default behavior should be used.
DROPDOWN_SetUpMode()
Before
After
Description
Enables opening of the box to the upper side of the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
458
CHAPTER
Window Objects (Widgets)
Prototype
int DROPDOWN_SetUpMode(DROPDOWN_Handle hObj, int OnOff);
Parameter hObj OnOff
Description
Handle of widget 1 for enabling, 0 for disabling 'up mode'.
DROPDOWN_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.7.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_Dropdown.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_Dropdown.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
459
16.8 EDIT: Edit widget
Edit fields are commonly used as the primary user interface for text input:
Blank edit field
Edit field with user input
You can also use edit fields for entering values in binary, decimal, or hexadecimal modes. A decimal-mode edit field might appear similar to those in the following table. The background color of EDIT widgets by default turns gray if disabled:
Edit field with user input (decimal)
Disabled edit field
All EDIT-related routines are located in the file(s) EDIT*.c, EDIT.h. All identifiers are prefixed EDIT.
16.8.1 Configuration options
Type
Macro
S EDIT_ALIGN_DEFAULT
N EDIT_BKCOLOR0_DEFAULT N EDIT_BKCOLOR1_DEFAULT N EDIT_BORDER_DEFAULT S EDIT_FONT_DEFAULT N EDIT_TEXTCOLOR0_DEFAULT N EDIT_TEXTCOLOR1_DEFAULT
N EDIT_XOFF
Default
Description
GUI_TA_RIGHT | GUI_TA_VCENTER
Alignment
for
edit
field
text.
0xc0c0c0
Background color, disabled state.
GUI_WHITE
Background color, enabled state.
1
Width of border, in pixels.
&GUI_Font13_1 Font used for edit field text.
GUI_BLACK
Text color, disabled state.
GUI_BLACK 2
Text color, enabled state.
Distance in X to offset text from left border of edit field.
Available alignment flags are: GUI_TA_LEFT, GUI_TA_RIGHT, GUI_TA_HCENTER for horizontal alignment. GUI_TA_TOP, GUI_TA_BOTTOM, GUI_TA_VCENTER for vertical alignment.
16.8.2 Predefined IDs
The following symbols define IDs which may be used to make EDIT widgets distinguishable from creation: GUI_ID_EDIT0 - GUI_ID_EDIT9
16.8.3 Notification codes
The following events are sent from an edit widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_VALUE_CHANGED
Description
Widget has been clicked. Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing. Value (content) of the edit widget has changed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
460
CHAPTER
Window Objects (Widgets)
16.8.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_UP GUI_KEY_DOWN GUI_KEY_RIGHT GUI_KEY_LEFT GUI_KEY_BACKSPACE GUI_KEY_DELETE
GUI_KEY_INSERT
Reaction
Increases the current character. If for example the current character (the character below the cursor) is a 'A' it changes to 'B'. Decreases the current character. If for example the current character is a 'B' it changes to 'A'. Moves the cursor one character to the right.
Moves the cursor one character to the left. If the widget works in text mode, the character before the cursor is deleted. If the widget works in text mode, the current is deleted. If the widget works in text mode, this key toggles the edit mode
between GUI_EDIT_MODE_OVERWRITE and GUI_EDIT_MODE_INSERT. For details, refer to
"EDIT_SetInsertMode()" on page 471.
16.8.5 EDIT API
The table below lists the available emWin EDIT-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine EDIT_AddKey() EDIT_Create() EDIT_CreateAsChild() EDIT_CreateEx() EDIT_CreateIndirect() EDIT_CreateUser() EDIT_EnableBlink() EDIT_GetBkColor() EDIT_GetCursorCharPos() EDIT_GetCursorPixelPos() EDIT_GetDefaultBkColor() EDIT_GetDefaultFont() EDIT_GetDefaultTextAlign() EDIT_GetDefaultTextColor() EDIT_GetFloatValue() EDIT_GetFont() EDIT_GetNumChars() EDIT_GetText() EDIT_GetTextColor() EDIT_GetUserData() EDIT_GetValue() EDIT_SetBinMode() EDIT_SetBkColor() EDIT_SetCursorAtChar() EDIT_SetCursorAtPixel() EDIT_SetDecMode() EDIT_SetDefaultBkColor() EDIT_SetDefaultFont() EDIT_SetDefaultTextAlign() EDIT_SetDefaultTextColor() EDIT_SetFloatMode()
Description
Key input routine. Creates an EDIT widget. (Obsolete) Creates an EDIT widget as a child window. (Obsolete) Creates an EDIT widget. Creates an EDIT widget from resource table entry. Creates an EDIT widget using extra bytes as user data. Enables/disables a blinking cursor Returns the background color of the EDIT widget. Returns the number of the character at the cursor position. Returns the pixel position of the cursor. Returns the default background color. Returns the default font. Returns the default text alignment. Returns the default text color. Returns the current value as floating point value. Returns a pointer to the used font. Returns the number of characters of the given edit widget. Returns the user input. Returns the text color. Retrieves the data set with EDIT_SetUserData(). Returns the current value. Enables the binary edit mode. Sets the background color of the EDIT widget. Sets the edit widget cursor to a specified character position. Sets the edit widget cursor to a specified pixel position. Enables the decimal edit mode. Sets the default background color. Sets the default font used for EDIT widgets. Sets the default text alignment for EDIT widgets. Sets the default text color for EDIT widgets. Enables the floating point edit mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
461
Routine EDIT_SetFloatValue() EDIT_SetFocussable() EDIT_SetFont() EDIT_SetHexMode() EDIT_SetInsertMode() EDIT_SetMaxLen() EDIT_SetpfAddKeyEx() EDIT_SetpfUpdateBuffer() EDIT_SetSel() EDIT_SetText() EDIT_SetTextAlign() EDIT_SetTextColor() EDIT_SetTextMode() EDIT_SetValue() EDIT_SetUlongMode() EDIT_SetUserData() GUI_EditBin() GUI_EditDec() GUI_EditFloat() GUI_EditHex() GUI_EditString()
Description
Sets the floating point value if using the floating point edit mode. Sets focussability of the EDIT widget. Selects the font to be used. Enables the hexadecimal edit mode. Enables or disables the insert mode. Sets the maximum number of characters of the edit field. Sets a function which is called to add a character. Sets a function which is called to add a character. Sets the current selection. Sets the text. Sets the text alignment for the EDIT widget. Sets the color(s) for the text. Sets the edit mode of the widget back to text mode. Sets the current value. Enables the unsigned long decimal edit mode. Sets the extra data of an EDIT widget. Edits a binary value at the current cursor position. Edits a decimal value at the current cursor position. Edits a floating point value at the current cursor position. Edits a hexadecimal value at the current cursor position. Edits a string at the current cursor position.
EDIT_AddKey()
Description
Adds user input to a specified edit field.
Prototype
void EDIT_AddKey(EDIT_Handle hObj, int Key);
Parameter hObj Key
Handle of the EDIT widget. Character to be added.
Description
Additional information
The specified character is added to the user input of the EDIT widget. If the last character should be erased, the key GUI_KEY_BACKSPACE can be used. If the maximum count of characters has been reached, another character will not be added.
EDIT_Create()
(Obsolete, EDIT_CreateEx() should be used instead)
Description
Creates an EDIT widget of a specified size at a specified location.
Prototype
EDIT_Handle EDIT_Create(int x0, int y0,
int xsize, int ysize,
int Id, int MaxLen, int Flags);
Parameter x0 y0 xsize
Description
Leftmost pixel of the edit field (in parent coordinates). Topmost pixel of the edit field (in parent coordinates). Horizontal size of the edit field (in pixels).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
462
CHAPTER
Window Objects (Widgets)
Parameter
Description
ysize Id MaxLen
Flags
Vertical size of the edit field (in pixels. ID to be returned. Maximum count of characters.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
Return value
Handle of the created EDIT widget; 0 if the function fails.
EDIT_CreateAsChild()
(Obsolete, EDIT_CreateEx should be used instead)
Description
Creates an EDIT widget as a child window.
Prototype
EDIT_Handle EDIT_CreateAsChild(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int Id,
int
Flags, int MaxLen);
Parameter x0 y0 xsize ysize hParent Id Flags MaxLen
Description
X-position of the edit field relative to the parent window. Y-position of the edit field relative to the parent window. Horizontal size of the edit field (in pixels). Vertical size of the edit field (in pixels). Handle of parent window. ID to be assigned to the EDIT widget.
Window create flags (see EDIT_Create()).
Maximum count of characters.
Return value
Handle of the created EDIT widget; 0 if the function fails.
EDIT_CreateEx()
Description
Creates an EDIT widget of a specified size at a specified location.
Prototype
EDIT_Handle EDIT_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id,
int
MaxLen);
Parameter x0 y0 xsize ysize
hParent
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new EDIT widget will be a child of the desktop (top-level window).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
463
Parameter
Description
WinFlags
ExFlags Id MaxLen
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Not used, reserved for future use. Window ID of the widget. Maximum count of characters.
Return value
Handle of the created EDIT widget; 0 if the function fails.
EDIT_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The following flags may be used as the Flags element of the resource passed as parameter:
Permitted indirect creation flags ("OR" combinable)
EDIT_CF_LEFT
Horizontal alignment: left
EDIT_CF_RIGHT EDIT_CF_HCENTER EDIT_CF_TOP
Horizontal alignment: right Horizontal alignment: center Vertical alignment: top
EDIT_CF_BOTTOM EDIT_CF_VCENTER
Vertical alignment: bottom Vertical alignment: center
The Para element is used as maximum length of a string to display / max. no. of digits if used in decimal, bin or hex mode.
EDIT_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function EDIT_CreateEx() can be referred to.
EDIT_EnableBlink()
Description
Enables/disables a blinking cursor.
Prototype
void EDIT_EnableBlink(EDIT_Handle hObj, int Period, int OnOff);
Parameter hObj Period OnOff
Description
Handle of the EDIT widget. Blinking period 1 enables blinking, 0 disables blinking
Additional information
This function calls GUI_X_GetTime().
EDIT_GetBkColor()
Description
Returns the background color of the EDIT widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
464
CHAPTER
Window Objects (Widgets)
Prototype
GUI_COLOR EDIT_GetBkColor(EDIT_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of the EDIT widget. Color index. See table below.
Description
Permitted values for parameter Index EDIT_CI_DISABLED Color index for the disabled state. EDIT_CI_ENABLED Color index for the enabled state.
Return value
Background color of the EDIT widget
EDIT_GetCursorCharPos()
Description
Returns the number of the character at the cursor position.
Prototype
int EDIT_GetCursorCharPos(EDIT_Handle hObj);
Parameter hObj
Handle of the EDIT widget.
Description
Return value
Number of the character at the cursor position.
Additional information
The widget returns the character position if it has the focus or not. This means the cursor position is also returned, if the cursor is currently not visible in the widget.
EDIT_GetCursorPixelPos()
Description
Returns the pixel position of the cursor in window coordinates.
Prototype
void EDIT_GetCursorPixelPos(EDIT_Handle hObj, int * pxPos, int * pyPos);
Parameter hObj pxPos pyPos
Description
Handle of the EDIT widget. Pointer to integer variable for the X-position in window coordinates. Pointer to integer variable for the Y-position in window coordinates.
Additional information
The widget returns the pixel position if it has the focus or not. This means the cursor position is also returned, if the cursor is currently not visible in the widget.
EDIT_GetDefaultBkColor()
Description
Returns the default background color used for EDIT widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
465
Prototype
GUI_COLOR EDIT_GetDefaultBkColor(unsigned int Index);
Parameter Index
Color index. See table below.
Description
Permitted values for parameter Index EDIT_CI_DISABLED Color index for the disabled state. EDIT_CI_ENABLED Color index for the enabled state.
Return value
Default background color used for EDIT widgets.
EDIT_GetDefaultFont()
Description
Returns the default font used for EDIT widgets.
Prototype
const GUI_FONT * EDIT_GetDefaultFont(void);
Return value
Default font used for EDIT widgets.
EDIT_GetDefaultTextAlign()
Description
Returns the default text alignment used for EDIT widgets.
Prototype
int EDIT_GetDefaultTextAlign(void);
Return value
Default text alignment used for EDIT widgets.
EDIT_GetDefaultTextColor()
Description
Returns the default text color used for EDIT widgets.
Prototype
GUI_COLOR EDIT_GetDefaultTextColor(unsigned int Index);
Parameter Index
Description
Has to be 0, reserved for future use.
Return value
Default text color used for EDIT widgets.
EDIT_GetFloatValue()
Description
Returns the current value of the edit field as floating point value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
466
CHAPTER
Window Objects (Widgets)
Prototype
float EDIT_GetFloatValue(EDIT_Handle hObj);
Parameter hObj
Handle of the EDIT widget.
Description
Return value
The current value.
Additional information
The use of this function makes only sense if the edit field is in floating point edit mode.
EDIT_GetFont()
Description
Returns a pointer to the used font.
Prototype
const GUI_FONT GUI_UNI_PTR * EDIT_GetFont(EDIT_Handle hObj);
Parameter hObj
Handle of the EDIT widget.
Description
Return value
Pointer to the used font.
EDIT_GetNumChars
Description
Returns the number of characters of the specified edit field.
Prototype
int EDIT_GetNumChars(EDIT_Handle hObj);
Parameter hObj
Handle of the EDIT widget.
Description
Return value
Number of characters of the specified edit field.
EDIT_GetText()
Description
Retrieves the user input of a specified edit field.
Prototype
void EDIT_GetText(EDIT_Handle hObj, char * sDest, int MaxLen);
Parameter hObj sDest MaxLen
Handle of the EDIT widget. Pointer to buffer. Size of buffer.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
467
EDIT_GetTextColor()
Description
Returns the text color.
Prototype
GUI_COLOR EDIT_GetTextColor(EDIT_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of the EDIT widget. Color index. See table below.
Description
Permitted values for parameter Index EDIT_CI_DISABLED Color index for the disabled state. EDIT_CI_ENABLED Color index for the enabled state.
EDIT_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
EDIT_GetValue()
Description
Returns the current value of the edit field. The current value is only useful if the edit field is in binary, decimal or hexadecimal mode.
Prototype
I32 EDIT_GetValue(EDIT_Handle hObj);
Parameter hObj
Handle of the EDIT widget.
Description
Return value
The current value.
EDIT_SetBinMode()
Description
Enables the binary edit mode of the edit field. The given value can be modified in the given range.
Prototype
void EDIT_SetBinMode(EDIT_Handle hObj, U32 Value, U32 Min, U32 Max);
Parameter hObj Value Min Max
Handle of the EDIT widget. Value to be modified. Minimum value. Maximum value.
EDIT_SetBkColor()
Description
Sets the edit fields background color.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
468
CHAPTER
Window Objects (Widgets)
Prototype
void EDIT_SetBkColor(EDIT_Handle hObj, unsigned int Index, GUI_COLOR Color);
Parameter hObj Index Color
Handle of the EDIT widget. Color index. See table below. Color to be set.
Description
Permitted values for parameter Index EDIT_CI_DISABLED Color index for the disabled state. EDIT_CI_ENABLED Color index for the enabled state.
EDIT_SetCursorAtChar()
Description
Sets the edit widget cursor to a specified character position.
Prototype
void EDIT_SetCursorAtChar(EDIT_Handle hObj, int xPos);
Parameter hObj xPos
Description
Handle of the EDIT widget. Character position to set cursor to.
Additional information
The character position works as follows: 0: left of the first (leftmost) character, 1: between the first and second characters, 2: between the second and third characters, and so on.
EDIT_SetCursorAtPixel()
Description
Sets the edit widget cursor to a specified pixel position.
Prototype
void EDIT_SetCursorAtPixel(EDIT_Handle hObj, int Pos);
Parameter hObj Pos
Handle of the EDIT widget. Pixel position to set cursor to.
Description
EDIT_SetDecMode()
Description
Enables the decimal edit mode of the edit field. The given value can be modified in the given range.
Prototype
void EDIT_SetDecMode(EDIT_Handle hEdit, I32 Value, I32 Min,
I32
Max, int Shift, U8 Flags);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
469
Parameter hObj Value Min Max Shift Flags
Description
Handle of the EDIT widget. Value to be set. Minimum value. Maximum value. If > 0 it specifies the position of the decimal point. See table below.
Permitted values for parameter Flags ("OR" combinable)
Edit in normal mode. A sign is displayed only if the value is
GUI_EDIT_NORMAL negative. GUI_EDIT_SIGNED "+" and "-" sign is displayed.
EDIT_SetDefaultBkColor()
Description
Sets the default background color used for edit widgets.
Prototype
void EDIT_SetDefaultBkColor(unsigned int Index, GUI_COLOR Color);
Parameter Index Color
Color index. See table below. Color to be used.
Description
Permitted values for parameter Index EDIT_CI_DISABLED Color index for the disabled state. EDIT_CI_ENABLED Color index for the enabled state.
EDIT_SetDefaultFont()
Description
Sets the default font used for edit fields.
Prototype
void EDIT_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to the font to be set as default.
EDIT_SetDefaultTextAlign()
Description
Sets the default text alignment for edit fields.
Prototype
void EDIT_SetDefaultTextAlign(int Align);
Parameter Align
Description
Default text alignment. For details, refer to "EDIT_SetTextAlign()" on page 473.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
470
CHAPTER
Window Objects (Widgets)
EDIT_SetDefaultTextColor()
Description
Sets the default text color used for edit widgets.
Prototype
void EDIT_SetDefaultTextColor(unsigned int Index, GUI_COLOR Color);
Parameter Index Color
Description
Has to be 0, reserved for future use. Color to be used.
EDIT_SetFloatMode()
Description
Enables the floating point edit mode of the edit field. The given value can be modified in the given range.
Prototype
void EDIT_SetFloatMode(EDIT_Handle hObj, float Value, float Min,
float
Max, int Shift, U8 Flags);
Parameter hObj Value Min Max Shift Flags
Description
Handle of the EDIT widget. Value to be modified. Minimum value. Maximum value. Number of post decimal positions. See table below.
Permitted values for parameter Flags ("OR" combinable)
GUI_EDIT_NORMAL
Edit in normal mode. A sign is displayed only if the value is negative.
GUI_EDIT_SIGNED
"+" and "-" sign is displayed.
GUI_EDIT_SUPPRESS_LEADING_ZEROES Does not show leading zeroes.
EDIT_SetFloatValue()
Description
The function can be used to set the floating point value of the edit field if working in floating point mode.
Prototype
void EDIT_SetFloatValue(EDIT_Handle hObj, float Value);
Parameter hObj Value
Description
Handle of the EDIT widget. New floating point value of the edit field.
Additional information
The use of this function makes only sense if the edit field works in floating point mode. If working in text mode the function has no effect. If working in binary, decimal or hexadecimal mode the behavior of the edit field is undefined.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
471
EDIT_SetFocussable()
Description
Sets the focussability of the EDIT widget.
Prototype
void EDIT_SetFocussable(EDIT_Handle hObj, int State);
Parameter hObj State
Description
Handle of the EDIT widget. If State is set to 0, the EDIT widget is set not to be focusable. Otherwise it is set to be focusable.
EDIT_SetFont()
Description
Sets the used font.
Prototype
void EDIT_SetFont(EDIT_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle of EDIT widget. Pointer to the font.
Description
EDIT_SetHexMode()
Description
Enables the hexadecimal edit mode of the edit field. The given value can be modified in the given range.
Prototype
void EDIT_SetHexMode(EDIT_Handle hObj, U32 Value, U32 Min, U32 Max);
Parameter hObj Value Min Max
Handle of the EDIT widget. Value to be modified. Minimum value. Maximum value.
Description
EDIT_SetInsertMode()
Description
Enables or disables the insert mode of the edit widget.
Prototype
int EDIT_SetInsertMode(EDIT_Handle hObj, int OnOff);
Parameter hObj OnOff
Handle of the EDIT widget. See table below.
Description
Permitted values for parameter OnOff
0
Disable insert mode.
1
Enable insert mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
472
CHAPTER
Window Objects (Widgets)
Return value
Returns the previous insert mode state.
Additional information
The use of this function makes only sense if the edit widget operates in text mode or in any user defined mode. If working in hexadecimal, binary, floating point or decimal mode the use of this function has no effect except that it changes the appearance of the cursor.
EDIT_SetMaxLen()
Description
Sets the maximum number of characters to be edited by the given edit field.
Prototype
void EDIT_SetMaxLen(EDIT_Handle hObj, int MaxLen);
Parameter hObj MaxLen
Handle of the EDIT widget. Number of characters.
Description
EDIT_SetpfAddKeyEx()
Description
Sets the function pointer which is used by the EDIT widget to call the function which is responsible for adding characters.
Prototype
void EDIT_SetpfAddKeyEx(EDIT_Handle hObj, tEDIT_AddKeyEx * pfAddKeyEx);
Parameter hObj pfAddKeyEx
Description
Handle of the EDIT widget. Function pointer to the function to be used to add a character.
Additional information
If working in text mode (default) or one of the modes for editing values, the edit widget uses its own routines to add a character. The use of this function only makes sense if the default behavior of the edit widget needs to be changed. If a function pointer has been set with this function the application program is responsible for the content of the text buffer.
EDIT_SetSel()
Before
After
Description
Used to set the current selection of the edit field.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
473
Prototype
void EDIT_SetSel(EDIT_Handle hObj, int FirstChar, int LastChar);
Parameter hObj FirstChar
LastChar
Description
Handle of the EDIT widget. Zero based index of the first character to be selected. -1 if no character should be selected. Zero based index of the last character to be selected. -1 if all characters from the first character until the last character should be selected.
Additional information
Selected characters are usually displayed in reverse. Setting the cursor position deselects all characters.
Example
EDIT_SetSel(0, -1); /* Selects all characters of the widget */ EDIT_SetSel(-1, 0); /* Deselects all characters */ EDIT_SetSel(0, 2); /* Selects the first 3 characters */
EDIT_SetText()
Description
Sets the text to be displayed in the edit field.
Prototype
void EDIT_SetText(EDIT_Handle hObj, const char* s)
Parameter hObj s
Handle of the EDIT widget. Text to display.
Description
EDIT_SetTextAlign()
Description
Sets the text alignment of the EDIT widget.
Prototype
void EDIT_SetTextAlign(EDIT_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of the EDIT widget. Or-combination of text alignment flags. See table below.
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT
Align X-position left (default).
GUI_TA_HCENTER GUI_TA_RIGHT
Center X-position. Align X-position right.
Vertical alignment
GUI_TA_TOP
Align Y-position with top of characters (default).
GUI_TA_VCENTER Center Y-position.
GUI_TA_BOTTOM Align Y-position with bottom pixel line of font.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
474
CHAPTER
Window Objects (Widgets)
EDIT_SetTextColor()
Description
Sets the edit fields text color.
Prototype
void EDIT_SetTextColor(EDIT_Handle hObj, unsigned int Index, GUI_COLOR Color);
Parameter hObj Index Color
Description
Handle of the EDIT widget. Index for text color. See table below. Color to be set.
Permitted values for parameter OnOff EDIT_CI_DISABLED Sets the text color for disabled state. EDIT_CI_ENABLED Sets the text color for enabled state.
EDIT_SetTextMode()
Description
Sets the edit mode of the widget back to text mode.
Prototype
void EDIT_SetTextMode(EDIT_Handle hEdit);
Parameter hObj
Handle of widget.
Description
Additional information
If one of the functions EDIT_SetBinMode(), EDIT_SetDecMode(), EDIT_SetFloatMode() or EDIT_SetHexMode() has been used to set the edit field to one of the numeric edit modes, this function sets the edit mode back to text mode. It also clears the content of the widget.
EDIT_SetUlongMode()
Description
Enables the unsigned long decimal edit mode of the edit field. The given value can be modified in the given range.
Prototype
void EDIT_SetUlongMode(EDIT_Handle hEdit, U32 Value, U32 Min, U32 Max);
Parameter hObj Value Min Max
Handle of the EDIT widget. Value to be modified. Minimum value. Maximum value.
Description
EDIT_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
475
EDIT_SetValue()
Description
Sets the current value of the edit field. Only useful if binary, decimal or hexadecimal edit mode is set.
Prototype
void EDIT_SetValue(EDIT_Handle hObj, I32 Value);
Parameter hObj Value
Handle of the EDIT widget. New value.
Description
GUI_EditBin()
Description
Edits a binary value at the current cursor position.
Prototype
U32 GUI_EditBin(U32 Value, U32 Min, U32 Max, int Len, int xsize);
Parameter Value Min Max Len xsize
Value to be modified. Minimum value. Maximum value. Number of digits to edit. Pixel-size in X of the edit field.
Description
Return value
The new value will be returned if <ENTER> is pressed. If <ESC> is pressed, the old value is returned.
Additional information
The routine returns after pressing <ENTER> or <ESC>. The content of the given text will be modified only if <ENTER> is pressed.
GUI_EditDec()
Description
Edits a decimal value at the current cursor position.
Prototype
U32 GUI_EditDec(I32 Value, I32 Min, I32 Max, int Len, int xsize, int Shift, U8 Flags);
Parameter Value Min Max Len xsize Shift Flags
Description
Value to be modified. Minimum value. Maximum value. Number of digits to edit. Pixel-size in X of edit field. If > 0 it specifies the position of the decimal point.
See EDIT_SetDecMode().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
476
CHAPTER
Window Objects (Widgets)
Return value
The new value will be returned if <ENTER> is pressed. If <ESC> is pressed, the old value is returned.
Additional information
The routine returns after pressing <ENTER> or <ESC>. The content of the given text will be modified only if <ENTER> is pressed.
GUI_EditFloat()
Description
Edits a floating point value at the current cursor position.
Prototype
float GUI_EditFloat(float Value, float Min, float Max, int Len, int xsize, int Shift, U8 Flags);
Parameter Value Min Max Len xsize Shift Flags
Description
Value to be modified. Minimum value. Maximum value. Number of digits to edit. Pixel-size in X of the EDIT widget. Specifies the position of the decimal point, if > 0.
See EDIT_SetFloatMode().
Return value
The new value will be returned if <ENTER> is pressed. If <ESC> is pressed, the old value is returned.
Additional information
The routine returns after pressing <ENTER> or <ESC>. The content of the given text will be modified only if <ENTER> is pressed.
GUI_EditHex()
Description
Edits a hexadecimal value at the current cursor position.
Prototype
U32 GUI_EditHex(U32 Value, U32 Min, U32 Max, int Len, int xsize);
Parameter Value Min Max Len xsize
Value to be modified. Minimum value. Maximum value. Number of digits to edit. Pixel-size in X of the edit field.
Description
Return value
The new value will be returned if <ENTER> is pressed. If <ESC> is pressed, the old value is returned.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
477
Additional information
The routine returns after pressing <ENTER> or <ESC>. The content of the given text will be modified only if <ENTER> is pressed.
GUI_EditString()
Description
Edits a string at the current cursor position.
Prototype
void GUI_EditString(char * pString, int Len, int xsize);
Parameter pString Len xsize
Description
Pointer to the string to be edited. Maximum number of characters. Pixel-size in X of the edit field.
Additional information
The routine returns after pressing <ENTER> or <ESC>. The content of the given text will be modified only if <ENTER> is pressed.
16.8.6 Examples
The Sample folder contains the following examples which show how the widget can be used: · WIDGET_Edit.c · WIDGET_EditWinmode.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screen shot of WIDGET_Edit.c:
Screen shot of WIDGET_EditWinmode.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
478
CHAPTER
Window Objects (Widgets)
16.9 FRAMEWIN: Frame window widget
Frame windows give your application a PC application-window appearance. They consist of a surrounding frame, a title bar and a user area. The color of the title bar changes to show whether the window is active or inactive, as seen below:
Active frame window
Inactive frame window
You can attach predefined buttons to the title bar as seen below or you can attach your own buttons to a title bar:
Description
Frame window
Frame window with minimize-, maximize- and close button.
Frame window with minimize-, maximize- and close button in maximized state.
Frame window with minimize-, maximize- and close button in minimized state
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
y-size of client window D H B
479
16.9.1 Structure of the frame window
The following diagram shows the detailed structure and looks of a frame window:
x-size of frame window
B
x-size of client window
B
Title bar
Client window
y-size of frame window
B
The frame window actually consists of 2 windows; the main window and a child window. The child window is called Client window. It is important to be aware of this when dealing with callback functions: There are 2 windows with 2 different callback functions. When creating child windows, these child windows are typically created as children of the client window; their parent is therefor the client window.
Detail B H D Title bar
Client window
Description
Border size of the frame window. The default size of the border is 3 pixels. Height of the title bar. Depends on the size of the used font for the title. Spacing between title bar and client window. (1 pixel) The title bar is part of the frame window and not a separate window. The client window is a separate window created as a child window of the frame window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
480
CHAPTER
Window Objects (Widgets)
16.9.2 Configuration options
Type
Macro
Default
Description
B FRAMEWIN_ALLOW_DRAG_ON_FRAME
1
Allows dragging the widget on the surrounding frame.
N
FRAMEWIN_BARCOLOR_ACTIVE_DEFAULT 0xff0000
Title bar color, active state.
N
FRAMEWIN_BARCOLOR_INACTIVE_DEFAULT 0x404040
Title bar color, inactive state.
N FRAMEWIN_BORDER_DEFAULT
3
Outer border width, in pixels.
N FRAMEWIN_CLIENTCOLOR_DEFAULT
0xc0c0c0
Color of client window area.
S FRAMEWIN_DEFAULT_FONT
&GUI_Font8_1 Font used for title bar text.
N FRAMEWIN_FRAMECOLOR_DEFAULT
0xaaaaaa
Frame color.
N FRAMEWIN_IBORDER_DEFAULT
1
Inner border width, in pixels.
N FRAMEWIN_TITLEHEIGHT_DEFAULT
0
Default height of title bar.
16.9.3 Keyboard reaction
The widget can not gain the input focus and does not react on keyboard input.
16.9.4 FRAMEWIN API
The table below lists the available emWin FRAMEWIN-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine
Description
FRAMEWIN_AddButton() FRAMEWIN_AddCloseButton()
Adds a button in the title bar. Adds a close button in the title bar.
FRAMEWIN_AddMaxButton() FRAMEWIN_AddMenu()
Adds a maximize button in the title bar. Adds a menu widget to the frame window.
FRAMEWIN_AddMinButton()
Adds a minimize button in the title bar.
FRAMEWIN_Create() FRAMEWIN_CreateAsChild()
Creates a FRAMEWIN widget. (Obsolete) Creates a FRAMEWIN widget as a child window. (Obsolete)
FRAMEWIN_CreateEx()
Creates a FRAMEWIN widget.
FRAMEWIN_CreateIndirect() FRAMEWIN_CreateUser() FRAMEWIN_GetActive() FRAMEWIN_GetBarColor()
Creates a BUTTON widget from a resource table entry. Creates a FRAMEWIN widget using extra bytes as user data. Returns if the frame window is in active state.
Returns the color of the title bar.
FRAMEWIN_GetBorderSize()
Returns the size of the border.
FRAMEWIN_GetDefaultBarColor()
Returns the default color of the title bar.
FRAMEWIN_GetDefaultBorderSize() Returns the default border size
FRAMEWIN_GetDefaultClientColor() Returns the default color of the client area.
FRAMEWIN_GetDefaultFont() FRAMEWIN_GetDefaultTextColor()
Returns the default font used for the title bar Returns the default text color of the title.
FRAMEWIN_GetDefaultTitleHeight() Returns the default size of the title bar
FRAMEWIN_GetFont() FRAMEWIN_GetText()
Returns the font used for the title text. Returns the title text.
FRAMEWIN_GetTextAlign()
Returns the alignment of the title text.
FRAMEWIN_GetTitleHeight() FRAMEWIN_GetUserData()
Returns the height of the title bar. Retrieves the data set with FRAMEWIN_SetUserData().
FRAMEWIN_IsMinimized()
Returns if the frame window is minimized or not.
FRAMEWIN_IsMaximized() FRAMEWIN_Maximize()
Returns if the frame window is maximized or not. Enlarges the frame window to the size of its parent.
FRAMEWIN_Minimize()
Hides the client area of the frame window.
FRAMEWIN_OwnerDraw()
Default function for drawing the title bar.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
481
Routine
Description
FRAMEWIN_Restore()
Restores a minimized or maximized frame window.
FRAMEWIN_SetActive()
Sets the state of the frame window. (Obsolete)
FRAMEWIN_SetBarColor()
Sets the color of the title bar.
FRAMEWIN_SetBorderSize()
Sets the border size of the frame window.
FRAMEWIN_SetClientColor()
Sets the color of the client area
FRAMEWIN_SetDefaultBarColor()
Sets the default color of the title bar
FRAMEWIN_SetDefaultBorderSize() Sets the default border size
FRAMEWIN_SetDefaultClientColor() Sets the default color of the client area.
FRAMEWIN_SetDefaultFont()
Sets the default font used for the title bar.
FRAMEWIN_SetDefaultTextColor() Sets the default text color of the title.
FRAMEWIN_SetDefaultTitleHeight() Sets the default height of the title bar
FRAMEWIN_SetFont()
Selects the font used for the title text.
FRAMEWIN_SetMoveable()
Sets the frame window to a moveable/non-moveable state.
FRAMEWIN_SetOwnerDraw()
Enables the frame window to be owner drawn.
FRAMEWIN_SetResizeable()
Sets the frame window to resizable state.
FRAMEWIN_SetText()
Sets the title text.
FRAMEWIN_SetTextAlign()
Sets the alignment of the title text.
FRAMEWIN_SetTextColor()
Sets the color(s) for the title text.
FRAMEWIN_SetTextColorEx()
Sets the color(s) for the title text.
FRAMEWIN_SetTitleHeight()
Sets the height of the title bar.
FRAMEWIN_SetTitleVis()
Sets the visibility flag of the title bar
FRAMEWIN_SetUserData()
Sets the extra data of a FRAMEWIN widget.
FRAMEWIN_AddButton()
Before
After
Description
Adds a button to the title bar of the frame window.
Prototype
WM_HWIN FRAMEWIN_AddButton(FRAMEWIN_Handle hObj, int Flags,
int
Off, int Id);
Parameter hObj Flags Off Id
Description
Handle of frame window. See table below. X-offset used to create the BUTTON widget ID of the BUTTON widget
Permitted values for parameter Flags FRAMEWIN_BUTTON_LEFT The BUTTON will be created at the left side. FRAMEWIN_BUTTON_RIGHT The BUTTON will be created at the right side.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
482
CHAPTER
Window Objects (Widgets)
Return value
Handle of the BUTTON widget.
Additional information
The button will be created as a child window from the frame window. So the Window Manager keeps sure it will be deleted when the frame window will be deleted. The button can be created at the left side or at the right side of the title bar depending on the parameter Flags. The parameter Offset specifies the space between the button and the border of the frame window or the space between the previous created button.
FRAMEWIN_AddCloseButton()
Before
After
Description
Adds a close button to the title bar of the frame window.
Prototype
WM_HWIN FRAMEWIN_AddCloseButton(FRAMEWIN_Handle hObj, int Flags, int Off);
Parameter hObj Flags Off
Description
Handle of frame window. See table below. X-offset used to create the BUTTON widget
Permitted values for parameter Index FRAMEWIN_BUTTON_LEFT The BUTTON will be created at the left side. FRAMEWIN_BUTTON_RIGHT The BUTTON will be created at the right side.
Return value
Handle of the close button.
Additional information
When the user presses the close button the frame window and all its children will be deleted.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
FRAMEWIN_AddMaxButton()
Before
After
483 Maximized
Description
Adds a maximize button to the title bar of the frame window.
Prototype
WM_HWIN FRAMEWIN_AddMaxButton(FRAMEWIN_Handle hObj, int Flags, int Off);
Parameter hObj Flags Off
Description
Handle of frame window. See table below. X-offset used to create the BUTTON widget
Permitted values for parameter Index FRAMEWIN_BUTTON_LEFT The BUTTON will be created at the left side. FRAMEWIN_BUTTON_RIGHT The BUTTON will be created at the right side.
Return value
Handle of the maximize button.
Additional information
When the user presses the maximize button the first time the frame window will be enlarged to the size of its parent window. The second use of the button will reduce the frame window to its old size and restores the old position.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
484
FRAMEWIN_AddMenu()
Before
CHAPTER
Window Objects (Widgets) After
Description
Adds the given menu to a frame window. The menu is shown below the title bar.
Prototype
void FRAMEWIN_AddMenu(FRAMEWIN_Handle hObj, WM_HWIN hMenu);
Parameter hObj hMenu
Description
Handle of frame window. Handle of menu widget to be added.
Additional information
The added menu is attached as a child of the frame window. If the frame window has been created with a callback routine, the function makes sure, that the WM_MENU messages are passed to the client window of the frame window.
FRAMEWIN_AddMinButton()
Before
After
Minimized window
Description
Adds a minimize button to the title bar of the frame window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
485
Prototype
WM_HWIN FRAMEWIN_AddMinButton(FRAMEWIN_Handle hObj, int Flags, int Off);
Parameter hObj Flags Off
Description
Handle of frame window. See table below. X-offset used to create the BUTTON widget
Permitted values for parameter Index FRAMEWIN_BUTTON_LEFT The BUTTON will be created at the left side. FRAMEWIN_BUTTON_RIGHT The BUTTON will be created at the right side.
Return value
Handle of the minimize button.
Additional information
When the user presses the minimize button the first time the client area of the frame window will be hidden and only the title bar remains visible. The second use of the button will restore the frame window to its old size.
FRAMEWIN_Create()
(Obsolete, FRAMEWIN_CreateEx() should be used instead)
Description
Creates a FRAMEWIN widget of a specified size at a specified location.
Prototype
FRAMEWIN_Handle FRAMEWIN_Create(const char * pTitle, WM_CALLBACK * cb,
int
Flags,
int
x0,
int
y0,
int
xsize, int
ysize);
Parameter pTitle cb
Flags
x0 y0 xsize ysize
Description
Title displayed in the title bar. Pointer to callback routine of client area.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Leftmost pixel of the frame window (in parent coordinates). Topmost pixel of the frame window (in parent coordinates). Horizontal size of the frame window (in pixels). Vertical size of the frame window (in pixels).
Return value
Handle of the created FRAMEWIN widget; 0 if the function fails.
FRAMEWIN_CreateAsChild()
(Obsolete, FRAMEWIN_CreateEx should be used instead)
Description
Creates a FRAMEWIN widget as a child window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
486
CHAPTER
Window Objects (Widgets)
Prototype
FRAMEWIN_Handle FRAMEWIN_CreateAsChild(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN
hParent,
const char * pText,
WM_CALLBACK * cb,
int Flags);
Parameter x0 y0 xsize ysize hParent pText cb Flags
Description
X-position of the frame window relative to the parent window. Y-position of the frame window relative to the parent window. Horizontal size of the frame window (in pixels). Vertical size of the frame window (in pixels). Handle of parent window. Text to be displayed in the title bar. Optional pointer to a custom callback function for the client window.
Window create flags (see FRAMEWIN_Create()).
Return value
Handle of the created FRAMEWIN widget; 0 if the function fails.
FRAMEWIN_CreateEx()
Description
Creates a FRAMEWIN widget of a specified size at a specified location.
Prototype
FRAMEWIN_Handle FRAMEWIN_CreateEx(int int WM_HWIN int const char
x0,
int y0,
xsize, int ysize,
hParent, int WinFlags,
ExFlags, int Id,
* pTitle,
WM_CALLBACK * cb);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id pTitle cb
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new FRAMEWIN widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). See table below. Window ID of the widget. Title displayed in the title bar. Optional pointer to a custom callback function for the client window.
Permitted values for parameter ExFlags
0 FRAMEWIN_CF_MOVEABLE
No function.
Sets the new frame window to a moveable state. For details, refer to "FRAMEWIN_SetMoveable()" on page 496.
Return value
Handle of the created FRAMEWIN widget; 0 if the function fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
487
Additional information
The user callback routine is typically used for 2 purposes: · to paint the client window (if filling with a color is not desired) · to react to messages of child windows, typically dialog elements The normal behaviour of the client window is to paint itself, filling the entire window with the client color. If the user callback also fills the client window (or a part of it), it can be desirable to set the client color to GUI_INVALID_COLOR, causing the window callback to not fill the client window. The user callback of the client window does not receive all messages sent to the client window; some system messages are completely handled by the window callback routine and are not passed to the user callback. All notification messages as well as WM_PAINT and all user messages are sent to the user callback routine. The handle received by the user callback is the handle of the frame window (the parent window of the client window), except for the WM_PAINT message, which receives the handle of the client window.
FRAMEWIN_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
FRAMEWIN_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function FRAMEWIN_CreateEx() can be referred to.
FRAMEWIN_GetActive()
Description
Returns if the given frame window is in active state or not.
Prototype
GUI_COLOR FRAMEWIN_GetBarColor(FRAMEWIN_Handle hObj, unsigned Index);
Parameter hObj
Handle of frame window.
Description
Return value
1 if frame window is in active state, 0 if not.
FRAMEWIN_GetBarColor()
Description
Returns the color of the title bar of the given frame window.
Prototype
GUI_COLOR FRAMEWIN_GetBarColor(FRAMEWIN_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of frame window. See table below.
Description
Permitted values for parameter Index
0
Returns the bar color used when frame window is inactive.
1
Returns the bar color used when frame window is active.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
488
CHAPTER
Window Objects (Widgets)
Return value
Color of the title bar as RGB value.
FRAMEWIN_GetBorderSize()
Description
Returns the border size of the given frame window.
Prototype
int FRAMEWIN_GetBorderSize(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Return value
The border size of the given frame window.
FRAMEWIN_GetDefaultBarColor()
Description
Returns the default color for title bars in frame windows.
Prototype
const GUI_COLOR* FRAMEWIN_GetDefaultBarColor(unsigned int Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
0
Returns the bar color used when frame window is inactive.
1
Returns the bar color used when frame window is active.
Return value
Pointer to the default title bar color used for frame windows in the specified state.
FRAMEWIN_GetDefaultBorderSize()
Description
Returns the default size of a frame window border.
Prototype
int FRAMEWIN_GetDefaultBorderSize(void);
Return value
Default size of a frame window border.
FRAMEWIN_GetDefaultClientColor()
Description
Returns the default color of client areas in frame windows.
Prototype
const GUI_COLOR* FRAMEWIN_GetDefaultClientColor(void);
Return value
Pointer to the default client area color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
489
FRAMEWIN_GetDefaultFont()
Description
Returns the default font used for frame window captions.
Prototype
const GUI_FONT* FRAMEWIN_GetDefaultFont(void);
Return value
Pointer to the default font used for frame window captions.
FRAMEWIN_GetDefaultTextColor()
Description
Returns the default text color of the title.
Prototype
GUI_COLOR FRAMEWIN_GetDefaultTextColor(unsigned Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
0
Color to be used when frame window is inactive.
1
Color to be used when frame window is active.
Return value
Default text color of the title.
FRAMEWIN_GetFont()
Description
Returns a pointer to the font used to draw the title text.
Prototype
const GUI_FONT GUI_UNI_PTR * FRAMEWIN_GetFont(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Return value
Pointer to the font used to draw the title text.
FRAMEWIN_GetText()
Description
Returns the title text.
Prototype
void FRAMEWIN_GetText(FRAMEWIN_Handle hObj, char * pBuffer, int MaxLen);
Parameter hObj pBuffer MaxLen
Description
Handle of frame window. Pointer to buffer to be filled with the title text. Buffer size in bytes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
490
CHAPTER
Window Objects (Widgets)
Additional information
If the buffer size is smaller than the title text the function copies MaxLen.
FRAMEWIN_GetTextAlign()
Description
Returns the text alignment of the title text.
Prototype
int FRAMEWIN_GetTextAlign(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Return value
The currently used text alignment. For details about text alignment, refer to"GUI_SetTextAlign()" on page 88.
FRAMEWIN_GetDefaultTitleHeight()
Description
Returns the default height of title bars in frame windows.
Prototype
int FRAMEWIN_GetDefaultCaptionSize(void);
Return value
Default title bar height. For more informations about the title height, refer to "FRAMEWIN_SetDefaultTitleHeight()" on page 496.
FRAMEWIN_GetTitleHeight()
Description
Returns the height of title bar of the given frame window.
Prototype
int FRAMEWIN_GetTitleHeight(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Return value
The height of title bar of the given frame window. For more informations about the title height, refer to "FRAMEWIN_SetDefaultTitleHeight()" on page 496.
FRAMEWIN_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
FRAMEWIN_IsMaximized()
Description
Returns if the frame window is maximized or not.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
491
Prototype
int FRAMEWIN_IsMaximized(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Return value
1 if the frame window is maximized, 0 if not.
FRAMEWIN_IsMinimized()
Description
Returns if the frame window is minimized or not.
Prototype
int FRAMEWIN_IsMinimized(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Return value
1 if the frame window is minimized, 0 if not.
FRAMEWIN_Maximize()
Before
After
Description
Enlarges a frame window to the size of its parent window.
Prototype
void FRAMEWIN_Maximize(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Additional information
When calling this function the frame window will show the same behavior as when the user presses the maximize button. The frame window will be enlarged to the size of its parent window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
492
FRAMEWIN_Minimize()
Before
CHAPTER
Window Objects (Widgets) After
Description
Hides the client area of the given frame window.
Prototype
void FRAMEWIN_Minimize(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Additional information
When calling this function the frame window will show the same behavior as when the user presses the minimize button. The client area of the frame window will be hidden and only the title bar remains visible.
FRAMEWIN_OwnerDraw()
Description
Default function for drawing the title bar of a frame window.
Prototypes
int FRAMEWIN_OwnerDraw(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
Parameter pDrawItemInfo
Description
Pointer to a WIDGET_ITEM_DRAW_INFO structure.
Additional information
This function is useful if FRAMEWIN_SetOwnerDraw() is used. It should be called for all unhandled commands passed to the owner draw function. For more information, refer to the section explaining user drawn widgets and FRAMEWIN_SetOwnerDraw().
FRAMEWIN_Restore()
Before
After
Description
Restores a minimized or maximized frame window to its old size and position.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
493
Prototype
void FRAMEWIN_Restore(FRAMEWIN_Handle hObj);
Parameter hObj
Handle of frame window.
Description
Additional information
If the given frame window is neither maximized nor minimized the function takes no effect.
FRAMEWIN_SetActive()
Before
After
Description
Sets the state of a specified frame window. Depending on the state, the color of the title bar will change.
Prototype
void FRAMEWIN_SetActive(FRAMEWIN_Handle hObj, int State);
Parameter hObj State
Description
Handle of frame window. State of frame window. See table below.
Permitted values for parameter State
0
Frame window is inactive.
1
Frame window is active.
Additional information
This function is obsolete. If pointing with a input device to a child of a frame window the frame window will become active automatically. It is not recommended to use this function. If using this function to set a frame window to active state, it is not warranted that the state becomes inactive if an other frame window becomes active.
FRAMEWIN_SetBarColor()
Before
After
Description
Sets the color of the title bar of a specified frame window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
494
CHAPTER
Window Objects (Widgets)
Prototype
void FRAMEWIN_SetBarColor(FRAMEWIN_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of frame window. Index for state of frame window. See table below. Color to be set.
Permitted values for parameter Index
0
Sets the color to be used when frame window is inactive.
1
Sets the color to be used when frame window is active.
FRAMEWIN_SetBorderSize()
Before
After
Description
Sets the border size of a specified frame window.
Prototype
void FRAMEWIN_SetBorderSize(FRAMEWIN_Handle hObj, unsigned Size);
Parameter hObj Size
Description
Handle of frame window. New border size of the frame window.
FRAMEWIN_SetClientColor()
Before
After
Description
Sets the color of the client window area of a specified frame window.
Prototype
void FRAMEWIN_SetClientColor(FRAMEWIN_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of frame window. Color to be set.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
495
FRAMEWIN_SetDefaultBarColor()
Description
Sets the default color for title bars in frame windows.
Prototype
void FRAMEWIN_SetDefaultBarColor(unsigned int Index, GUI_COLOR Color);
Parameter Index Color
Description
Index for state of frame window. See table below. Color to be set.
Permitted values for parameter Index
0
Sets the color to be used when frame window is inactive.
1
Sets the color to be used when frame window is active.
FRAMEWIN_SetDefaultBorderSize()
Description
Sets the default border size of frame windows.
Prototype
void FRAMEWIN_SetDefaultBorderSize(int BorderSize);
Parameter BorderSize
Size to be set.
Description
FRAMEWIN_SetDefaultClientColor()
Description
Sets the default color for client areas in frame windows.
Prototype
void FRAMEWIN_SetDefaultClientColor(GUI_COLOR Color);
Parameter Color
Color to be set.
Description
FRAMEWIN_SetDefaultFont()
Description
Sets the default font used to display the title in frame windows.
Prototype
void FRAMEWIN_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to font to be used as default
FRAMEWIN_SetDefaultTextColor()
Description
Sets the default text color of the title.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
496
CHAPTER
Window Objects (Widgets)
Prototype
void FRAMEWIN_SetDefaultTextColor(unsigned Index, GUI_COLOR Color);
Parameter Index Color
See table below. Color to be used.
Description
Permitted values for parameter Index
0
Color to be used when frame window is inactive.
1
Color to be used when frame window is active.
FRAMEWIN_SetDefaultTitleHeight()
Description
Sets the size in Y for the title bar.
Prototype
void FRAMEWIN_SetDefaultTitleHeight(int Height);
Parameter Height
Size to be set
Description
Additional information
The default value of the title height is 0. That means the height of the title depends on the font used to display the title text. If the default value is set to a value > 0 each new frame window will use this height for the title height and not the height of the font of the title.
FRAMEWIN_SetFont()
Before
After
Description
Sets the title font.
Prototype
void FRAMEWIN_SetFont(FRAMEWIN_Handle hObj, const GUI_FONT * pfont);
Parameter hObj pFont
Handle of frame window. Pointer to the font.
Description
FRAMEWIN_SetMoveable()
Description
Sets a frame window to a moveable or fixed state.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
497
Prototype
void FRAMEWIN_SetMoveable(FRAMEWIN_Handle hObj, int State);
Parameter hObj State
Description
Handle of frame window. State of frame window. See table below.
Permitted values for parameter State
0
Frame window is fixed (non-moveable).
1
Frame window is moveable.
Additional information
The default state of a frame window after creation is fixed. Moveable state means, the frame window can be dragged with a pointer input device (PID). To move the frame window, it first needs to be touched with a PID in pressed state in the title area. Moving the pressed PID now moves also the widget. If the config macro FRAMEWIN_ALLOW_DRAG_ON_FRAME is 1 (default), the frame window can also be dragged on the surrounding frame. This works only if the frame window is not in resizable state.
FRAMEWIN_SetOwnerDraw()
Description
Enables the frame window to be owner drawn.
Prototype
void FRAMEWIN_SetOwnerDraw(FRAMEWIN_Handle
hObj,
WIDGET_DRAW_ITEM_FUNC * pfDrawItem);
Parameter hObj pfDrawItem
Handle of frame window. Pointer to owner draw function.
Description
Additional information
This function sets a function pointer to a function which will be called by the widget if a frame window has to be drawn. It gives you the possibility to draw a complete customized title bar, not just plain text. pfDrawItem is a pointer to an applicationdefined function of type WIDGET_DRAW_ITEM_FUNC which is explained at the beginning of the chapter.
Example
The following shows a typical owner draw function:
int _OwnerDraw(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) { GUI_RECT Rect; char acBuffer[20]; switch (pDrawItemInfo->Cmd) { case WIDGET_ITEM_DRAW: Rect.x0 = pDrawItemInfo->x0 + 1; Rect.x1 = pDrawItemInfo->x1 - 1; Rect.y0 = pDrawItemInfo->y0 + 1; Rect.y1 = pDrawItemInfo->y1; FRAMEWIN_GetText(pDrawItemInfo->hWin, acBuffer, sizeof(acBuffer)); GUI_DrawGradientH(pDrawItemInfo->x0, pDrawItemInfo->y0, pDrawItemInfo->x1, pDrawItemInfo->y1, GUI_RED, GUI_GREEN); GUI_SetFont(FRAMEWIN_GetFont(pDrawItemInfo->hWin)); GUI_SetTextMode(GUI_TM_TRANS); GUI_SetColor(GUI_YELLOW); GUI_DispStringInRect(acBuffer, &Rect, FRAMEWIN_GetTextAlign(pDrawItemInfo->hWin)); return 0; }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
498
CHAPTER
return FRAMEWIN_OwnerDraw(pDrawItemInfo); }
void CreateFrameWindow(void) { ... FRAMEWIN_SetOwnerDraw(hWin, _OwnerDraw); ...
}
Screenshot of above example
FRAMEWIN_SetResizeable()
Before
Window Objects (Widgets) After
Description
Sets the resizable state of the given frame window.
Prototype
void FRAMEWIN_SetResizeable(FRAMEWIN_Handle hObj, int State);
Parameter hObj State
Description
Handle of frame window. 1 if the frame window should be resizable, 0 if not.
Additional information
If the frame window is in resizable state its size can be changed by dragging the borders. If a pointer input device points over the border, the cursor will change to a resize cursor (if cursor is on and if optional mouse support is enabled). If pointing to the edge of the border, the X and Y size of the window can be changed simultaneously.
FRAMEWIN_SetText()
Before
After
Description
Sets the title text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
499
Prototype
void FRAMEWIN_SetText(FRAMEWIN_Handle hObj, const char * s);
Parameter hObj s
Handle of frame window. Text to display as the title.
FRAMEWIN_SetTextAlign()
Description
Before
After
Description
Sets the text alignment of the title bar.
Prototype
void FRAMEWIN_SetTextAlign(FRAMEWIN_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of frame window. Alignment attribute for the title. See table below.
Permitted values for parameter Align
GUI_TA_HCENTER Centers the title (default).
GUI_TA_LEFT
Displays the title to the left.
GUI_TA_RIGHT Displays the title to the right.
Additional information
If this function is not called, the default behavior is to display the text centered.
FRAMEWIN_SetTextColor()
Before
After
Description
Sets the color of the title text for both states, active and inactive.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
500
CHAPTER
Window Objects (Widgets)
Prototype
void FRAMEWIN_SetTextColor(FRAMEWIN_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of frame window. Color to be set.
FRAMEWIN_SetTextColorEx()
Description
Before
After
Description
Sets the text color for the given state.
Prototype
void FRAMEWIN_SetTextColorEx(FRAMEWIN_Handle hObj, unsigned Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of frame window. See table below. Color to be used.
Description
Permitted values for parameter Index
0
Color to be used when frame window is inactive.
1
Color to be used when frame window is active.
FRAMEWIN_SetTitleHeight()
Before
After
Description
Sets the height of the title bar.
Prototype
int FRAMEWIN_SetTitleHeight(FRAMEWIN_Handle hObj, int Height);
Parameter hObj Height
Handle of frame window. Height of the title bar.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
501
Additional information
Per default the height of the title bar depends on the size on the font used to display the title text. When using FRAMEWIN_SetTitleHeight the height will be fixed to the given value. Changes of the font takes no effect concerning the height of the title bar. A value of 0 will restore the default behavior.
FRAMEWIN_SetTitleVis()
Before
After
Description
Sets the visibility flag of the title bar.
Prototype
void FRAMEWIN_SetTitleVis(FRAMEWIN_Handle hObj, int Show);
Parameter hObj Show
Description
Handle of frame window. 1 for visible (default), 0 for hidden
FRAMEWIN_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.9.5 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_FrameWin.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screen shot of WIDGET_FrameWin.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
502
CHAPTER
Window Objects (Widgets)
16.10 GRAPH: Graph widget
Graph widgets can be used to visualize data. Typical applications for graph widgets are showing measurement values or the curve of a function graph. Multiple curves can be shown simultaneously. Horizontal and vertical scales can be used to label the curves. A grid with different horizontal and vertical spacing can be shown on the background. If the data array does not fit into the visible area of the graph, the widget can automatically show scrollbars which allow scrolling through large data arrays.
16.10.1 Structure of the graph widget
A graph widget consists of different kinds objects:
· The graph widget itself to which data objects and scale objects can be attached. · Optionally one or more data objects. · Optionally one or more scale objects.
The following diagram shows the detailed structure of a graph widget:
Border
Frame Grid
Data objects
Application defined graphics
Y-Size
X-Size
Data area
Scrollbar(s)
Scale objects
The following table explains the details of the diagram above:
Detail
Description
Border
The optional border is part of the graph widget.
Frame Grid
A thin line around the data area, part of the graph widget. Shown in the background of the data area, part of the graph widget.
Data area
Area, in which grid and data objects are shown.
Data object(s) For each curve one data object should be added to the graph widget.
Application defined graphic Scrollbar(s) Scale object(s)
An application defined callback function can be used to draw any application defined text and/or graphics.
If the range of the data object is bigger than the data area of the graph widget, the graph widget can automatically show a horizontal and/or a vertical scrollbar.
Horizontal and vertical scales can be attached to the graph widget.
X-Size
X-Size of the data area.
Y-Size
Y-Size of the data area.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
503
16.10.2 Creating and deleting a graph widget
The process of creating a graph widget should be the following:
· Create the graph widget and set the desired attributes. · Create the data object(s). · Attach the data object(s) to the graph widget. · Create the optional scale object(s). · Attach the scale object(s) to the graph widget.
Once attached to the graph widget the data and scale objects need not to be deleted by the application. This is done by the graph widget.
Example
The following shows a small example how to create and delete a graph widget:
GRAPH_DATA_Handle hData; GRAPH_SCALE_Handle hScale; WM_HWIN hGraph; hGraph = GRAPH_CreateEx(10, 10, 216, 106, WM_HBKWIN, WM_CF_SHOW, 0, GUI_ID_GRAPH0); hData = GRAPH_DATA_YT_Create(GUI_DARKGREEN, NumDataItems, aData0, MaxNumDataItems); GRAPH_AttachData(hGraph, hData); hScale = GRAPH_SCALE_Create(28, GUI_TA_RIGHT, GRAPH_SCALE_CF_VERTICAL, 20); GRAPH_AttachScale(hGraph, hScale); /*
Do something with the widget... */ WM_DeleteWindow(hGraph);
16.10.3 Drawing process
As explained above a graph widget consists of different parts and 'sub' objects. The following will explain, in which sequence the widget is drawn: 1. Filling the background with the background color. 2. Calling an optional callback routine. This makes it possible to draw for example a
user defined grid. 3. Drawing the grid (if enabled). 4. Drawing the data objects and the border area. 5. Drawing the scale objects. 6. Calling an optional callback routine. This makes it possible to draw for example a
user defined scale or some additional text and/or graphics.
16.10.4 Supported types of curves
The requirements for showing a curve with continuously updated measurement values can be different to the requirements when showing a function graph with X/Y coordinates. For that reason the widget currently supports 2 kinds of data objects, which are shown in the table below:
G R A P H _ DATA _ X Y
G R A P H _ DATA _ Y T
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
504
CHAPTER
Window Objects (Widgets)
16.10.4.1GRAPH_DATA_XY
This data object is used to show curves which consist of an array of points. The object data is drawn as a polyline. A typical application for using this data object is drawing a function graph.
16.10.4.2GRAPH_DATA_YT
This data object is used to show curves with one Y-value for each X-position on the graph. A typical application for using this data object is showing a curve with continuously updated measurement values.
16.10.5 Configuration options
16.10.5.1Graph widget
Type
Macro
N GRAPH_BKCOLOR_DEFAULT
N GRAPH_BORDERCOLOR_DEFAULT
N GRAPH_FRAMECOLOR_DEFAULT N GRAPH_GRIDCOLOR_DEFAULT N GRAPH_GRIDSPACING_X_DEFAULT N GRAPH_GRIDSPACING_Y_DEFAULT N GRAPH_BORDER_L_DEFAULT N GRAPH_BORDER_T_DEFAULT N GRAPH_BORDER_R_DEFAULT N GRAPH_BORDER_B_DEFAULT
Default
Description
GUI_BLACK 0xC0C0C0
Default background color of the data area.
Default background color of the border.
GUI_WHITE
Default color of the thin frame line.
GUI_DARKGRAY Default color used to draw the grid.
50
Default horizontal spacing of the grid.
50
Default vertical spacing of the grid.
0
Default size of the left border.
0
Default size of the top border.
0
Default size of the right border.
0
Default size of the bottom border.
16.10.5.2Scale object
Type
Macro
Default
N
GRAPH_SCALE_TEXTCOLOR_DEFAULT GUI_WHITE
S GRAPH_SCALE_FONT_DEFAULT
&GUI_Font6x8
Description
Default text color. Default font used to draw the values.
16.10.6 Predefined IDs
The following symbols define IDs which may be used to make GRAPH widgets distinguishable from creation: GUI_ID_GRAPH0 - GUI_ID_GRAPH3
16.10.7 Keyboard reaction
The widget can not gain the input focus and does not react on keyboard input.
16.10.8 GRAPH API
The table below lists the available emWin GRAPH-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine
GRAPH_AttachData() GRAPH_AttachScale() GRAPH_CreateEx() GRAPH_CreateIndirect() GRAPH_CreateUser()
Description Common routines
Attaches a data object to a GRAPH widget. Attaches a scale object to a GRAPH widget. Creates a GRAPH widget. Creates a GRAPH widget from a resource table entry Creates a GRAPH widget using extra bytes as user data.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
505
Routine
Description
GRAPH_DetachData()
Detaches a data object from a GRAPH widget.
GRAPH_DetachScale()
Detaches a scale object from a GRAPH widget.
GRAPH_GetUserData()
Retrieves the data set with GRAPH_SetUserData().
GRAPH_SetBorder()
Sets the size (right, left, top and bottom) of the border.
GRAPH_SetColor()
Sets the color of the GRAPH widget.
GRAPH_SetGridDistX()
Sets the horizontal grid spacing.
GRAPH_SetGridDistY()
Sets the vertical grid spacing.
GRAPH_SetGridFixedX()
Fixes the grid in X-axis.
GRAPH_SetGridVis()
Enables the drawing of a grid.
GRAPH_SetLineStyleH()
Sets the line style for the horizontal grid lines.
GRAPH_SetLineStyleV()
Sets the line style for the vertical grid lines.
GRAPH_SetUserData()
Sets the extra data of a GRAPH widget.
GRAPH_SetUserDraw()
Sets the user callback function.
GRAPH_SetVSizeX()
Sets the horizontal range of the GRAPH widget.
GRAPH_SetVSizeY()
Sets the vertical range of the GRAPH widget.
GRAPH_DATA_YT related routines
GRAPH_DATA_YT_AddValue()
Adds one data item to the GRAPH_DATA_YT object.
GRAPH_DATA_YT_Clear()
Clears all data items of the GRAPH_DATA_YT object.
GRAPH_DATA_YT_Create()
Creates a GRAPH_DATA_YT object.
GRAPH_DATA_YT_Delete()
Deletes a GRAPH_DATA_YT object.
GRAPH_DATA_YT_MirrorX()
Mirrors the x-axis.
GRAPH_DATA_YT_SetAlign()
Sets the alignment of the given GRAPH_DATA_YT object.
GRAPH_DATA_YT_SetOffY()
Sets a vertical offset for drawing the data.
GRAPH_DATA_XY related routines
GRAPH_DATA_XY_AddPoint()
Adds one point to the GRAPH_DATA_XY object.
GRAPH_DATA_XY_Create()
Creates a GRAPH_DATA_XY object.
GRAPH_DATA_XY_Delete()
Deletes a GRAPH_DATA_XY object.
GRAPH_DATA_XY_SetLineStyle() Sets the line style used to draw the data.
GRAPH_DATA_XY_SetOffX()
Sets a horizontal offset for drawing the data.
GRAPH_DATA_XY_SetOffY()
Sets a vertical offset for drawing the data.
GRAPH_DATA_XY_SetOwnerDraw() Sets the owner callback function.
GRAPH_DATA_XY_SetPenSize()
Sets the pen size used to draw the data.
Scale related routines
GRAPH_SCALE_Create() GRAPH_SCALE_Delete()
GRAPH_SCALE_SetFactor()
GRAPH_SCALE_SetFont() GRAPH_SCALE_SetNumDecs() GRAPH_SCALE_SetOff() GRAPH_SCALE_SetPos() GRAPH_SCALE_SetTextColor() GRAPH_SCALE_SetTickDist()
Creates a GRAPH_SCALE object. Deletes a GRAPH_SCALE object. Sets a calculation factor used to calculate from pixels to the desired unit. Sets the font used to draw the numbers. Sets the number of digits of the fractional portion. Sets an optional offset which is added to the numbers. Sets the horizontal or vertical position of the scale. Sets the text color of the scale. Sets the distance in pixels between the tick marks.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
506
16.10.8.1Common routines GRAPH_AttachData()
Before
CHAPTER
Window Objects (Widgets) After
Description
Attaches a data object to an existing graph widget.
Prototype
void GRAPH_AddGraph(GRAPH_Handle hObj, GRAPH_DATA_Handle hData);
Parameter hObj hData
Description
Handle of widget Handle of the data object to be added to the widget. The data object should be cre-
ated with GRAPH_DATA_YT_Create() or GRAPH_DATA_XY_Create()
Additional information
Once attached to a graph widget the application needs not to destroy the data object. The graph widget deletes all attached data objects when it is deleted. For details about how to create data objects, refer to "GRAPH_DATA_YT_Create()" on page 515 and "GRAPH_DATA_XY_Create()" on page 518.
GRAPH_AttachScale()
Before
After
Description
Attaches a scale object to an existing graph widget.
Prototype
void GRAPH_AttachScale(GRAPH_Handle hObj, GRAPH_SCALE_Handle hScale);
Parameter hObj hScale
Handle of widget Handle of the scale to be added.
Description
Additional information
Once attached to a graph widget the application needs not to destroy the scale object. The graph widget deletes all attached scale objects when it is deleted.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
507
For details about how to create scale objects, refer to "GRAPH_SCALE_Create()" on page 522.
GRAPH_CreateEx()
Description
Creates a new GRAPH widget of a specified size at a specified location.
Prototype
GRAPH_Handle GRAPH_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates).
Topmost pixel of the widget (in parent coordinates).
Horizontal size of the widget (in pixels).
Vertical size of the widget (in pixels). Handle of parent window. If 0, the new button window will be a child of the desktop (top-level window). Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to "WM_CreateWindow()" on page 357 for a list of available parameter values). See table below.
Window Id of the widget.
Permitted values for parameter ExFlags
This flag 'fixes' the grid in X-axis. That means if hor-
GRAPH_CF_GRID_FIXED_X izontal scrolling is used, the grid remains on its
position.
Return value
Handle of the created GRAPH widget; 0 if the function fails.
GRAPH_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
GRAPH_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function GRAPH_CreateEx() can be referred to.
GRAPH_DetachData()
Description
Detaches a data object from a graph widget.
Prototype
void GRAPH_DetachData(GRAPH_Handle hObj, GRAPH_DATA_Handle hData);
Parameter hObj hData
Description
Handle of widget Handle of the data object to be detached from the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
508
CHAPTER
Window Objects (Widgets)
Additional information
Once detached from a graph widget the application needs to destroy the data object. Detaching a data object does not delete it. For more details about deleting data objects, refer to "GRAPH_DATA_YT_Delete()" on page 516 and "GRAPH_DATA_XY_Delete()" on page 519.
GRAPH_DetachScale()
Description
Detaches a scale object from a graph widget.
Prototype
void GRAPH_DetachScale(GRAPH_Handle hObj, GRAPH_SCALE_Handle hScale);
Parameter hObj hScale
Description
Handle of widget Handle of the scale object to be detached from the widget.
Additional information
Once detached from a graph widget the application needs to destroy the scale object. Detaching a scale object does not delete it. For more details about deleting scale objects, refer to "GRAPH_SCALE_Delete()" on page 523.
GRAPH_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
GRAPH_SetBorder()
Before
After
Description
Sets the left, top, right and bottom border of the given graph widget.
Prototype
void GRAPH_SetBorder(GRAPH_Handle hObj,
unsigned
BorderL, unsigned BorderT,
unsigned
BorderR, unsigned BorderB);
Parameter hObj BorderL BorderT BorderR BorderB
Description
Handle of widget. Size in pixels from the left border. Size in pixels from the top border. Size in pixels from the right border. Size in pixels from the bottom border.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
509
Additional information
The border size is the number of pixels between the widget effect frame and the data area of the graph widget. The frame, the thin line around the data area, is only visible if the border size is at least one pixel. For details about how to set the color of the border and the thin frame, refer to "GRAPH_SetColor()" on page 509.
GRAPH_SetColor()
Before
After
Description
Sets the desired color of the given graph widget.
Prototype
GUI_COLOR GRAPH_SetColor(GRAPH_Handle hObj, GUI_COLOR Color,
unsigned
Index);
Parameter hObj Color Index
Description
Handle of widget. Color to be used for the desired item. See table below.
Permitted values for parameter Index
GRAPH_CI_BK GRAPH_CI_BORDER GRAPH_CI_FRAME GRAPH_CI_GRID
Sets the background color. Sets the color of the border area. Sets the color of the thin frame line. Sets the color of the grid.
Return value
Previous color used for the desired item.
GRAPH_SetGridDistX(), GRAPH_SetGridDistY()
Before
After
Description
These functions set the distance from one grid line to the next.
Prototypes
unsigned GRAPH_SetGridDistX(GRAPH_Handle hObj, unsigned Value);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
510
CHAPTER
Window Objects (Widgets)
unsigned GRAPH_SetGridDistY(GRAPH_Handle hObj, unsigned Value)
Parameter hObj Value
Description
Handle of widget Distance in pixels from one grid line to the next, default is 50 pixel.
Return value
Previous grid line distance.
Additional information
The first vertical grid line is drawn at the leftmost position of the data area and the first horizontal grid line is drawn at the bottom position of the data area, except an offset is used.
GRAPH_SetGridFixedX()
Description
Fixes the grid in X-axis.
Prototype
unsigned GRAPH_SetGridFixedX(GRAPH_Handle hObj, unsigned OnOff);
Parameter hObj OnOff
Description
Handle of widget. 1 if grid should be fixed in X-axis, 0 if not (default).
Return value
Previous value used
Additional information
In some situations it can be useful to fix the grid in X-axis. A typical application would be a YT-graph, to which continuously new values are added and horizontal scrolling is possible. In this case it could be desirable to fix the grid in the background. For details about how to activate scrolling for a graph widget, refer to "GRAPH_SetVSizeX(), GRAPH_SetVSizeY()" on page 513.
GRAPH_SetGridOffY()
Before
After
Description
Adds an offset used to show the horizontal grid lines.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
511
Prototype
unsigned GRAPH_SetGridOffY(GRAPH_Handle hObj, unsigned Value);
Parameter hObj Value
Handle of widget. Offset to be used.
Description
Return value
Previous offset used to draw the horizontal grid lines.
Additional information
When rendering the grid the widget starts drawing the horizontal grid lines from the bottom of the data area and uses the current spacing. In case of a zero point in the middle of the Y-axis it could happen, that there is no grid line in the middle. In this case the grid can be shifted in Y-axis by adding an offset with this function. A positive value shifts the grid down and negative values shifts it up. For details about how to set the grid spacing, refer to the functions "GRAPH_SetGridDistX(), GRAPH_SetGridDistY()" on page 509.
GRAPH_SetGridVis()
Before
After
Description
Sets the visibility of the grid lines.
Prototype
unsigned GRAPH_SetGridVis(GRAPH_Handle hObj, unsigned OnOff);
Parameter hObj OnOff
Description
Handle of widget. 1 if the grid should be visible, 0 if not (default).
Return value
Previous value of the grid visibility.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
512
CHAPTER
GRAPH_SetLineStyleH(), GRAPH_SetLineStyleV()
Window Objects (Widgets)
Before
After
Description
These functions are used to set the line style used to draw the horizontal and vertical grid lines.
Prototypes
U8 GRAPH_SetLineStyleH(GRAPH_Handle hObj, U8 LineStyle); U8 GRAPH_SetLineStyleV(GRAPH_Handle hObj, U8 LineStyle);
Parameter hObj LineStyle
Description
Handle of widget. Line style to be used. For details about the supported line styles, refer to
"GUI_SetLineStyle()" on page 131. Default is GUI_LS_SOLID.
Return value
Previous line style used to draw the horizontal/vertical grid lines.
Additional information
Note that using other styles than GUI_LS_SOLID will need more time to show the grid.
GRAPH_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
GRAPH_SetUserDraw()
Before
After
Description
Sets the user draw function. This function is called by the widget during the drawing process to give the application the possibility to draw user defined data.
Prototype
void GRAPH_SetUserDraw(GRAPH_Handle hObj, void (* pUserDraw)(WM_HWIN hObj, int Stage));
Parameter hObj pUserDraw
Description
Handle of widget Pointer to application function to be called by the widget during the drawing process.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
513
Permitted values for parameter Stage
GRAPH_DRAW_FIRST GRAPH_DRAW_LAST
Function call after filling the background of the data area. Gives the application for example the possibility to draw a user defined grid.
Function call after drawing all graph items. Gives the application for example the possibility to label the data with a user defined scale.
Additional information
The user draw function is called at the beginning after filling the background of the data area and after drawing all graph items like described at the beginning of the chapter. On the first call the clipping region is limited to the data area. On the last call it is limited to the complete graph widget area except the effect frame.
Example
The following small example shows the use of a user draw function:
static void _UserDraw(WM_HWIN hWin, int Stage) { switch (Stage) { case GRAPH_DRAW_FIRST: /* Draw for example a user defined grid... */ break; case GRAPH_DRAW_LAST: /* Draw for example a user defined scale or additional text... */ break; }
}
static void _CreateGraph(void) { WM_HWIN hGraph; hGraph = GRAPH_CreateEx(10, 10, 216, 106, WM_HBKWIN, WM_CF_SHOW, 0, GUI_ID_GRAPH0); GRAPH_SetUserDraw(hGraph, _UserDraw); /* Enable user draw */ ...
}
GRAPH_SetVSizeX(), GRAPH_SetVSizeY()
Before
After
Description
The functions set the virtual size in X and Y-axis.
Prototypes
unsigned GRAPH_SetVSizeX(GRAPH_Handle hObj, unsigned Value);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
514
CHAPTER
Window Objects (Widgets)
unsigned GRAPH_SetVSizeY(GRAPH_Handle hObj, unsigned Value);
Parameter hObj Value
Description
Handle of widget. Virtual size in pixels in X or Y axis.
Return value
Previous virtual size of the widgets data area in X or Y-axis.
Additional information
If the widgets virtual size is bigger than the visible size of the data area, the widget automatically shows a scrollbar. If for example a data object, created by the function GRAPH_DATA_YT_Create(), contains more data than can be shown in the data area, the function GRAPH_SetVSizeX() can be used to enable scrolling. A function call like GRAPH_SetVSizeX(NumDataItems) enables the horizontal scrollbar, provided that the number of data items is bigger than the X-size of the visible data area.
16.10.8.2GRAPH_DATA_YT related routines
GRAPH_DATA_YT_AddValue()
Before
After
Description
Adds a new data item to a GRAPH_DATA_YT object.
Prototype
void GRAPH_DATA_YT_AddValue(GRAPH_DATA_Handle hDataObj, I16 Value);
Parameter hDataObj Value
Description
Handle of data object. Value to be added to the data object.
Additional information
The given data value is added to the data object. If the data object is 'full', that means it contains as many data items as specified in parameter MaxNumItems during the creation, it first shifts the data items by one before adding the new value. So the first data item is shifted out when adding a data item to a 'full' object.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
515
The value 0x7FFF can be used to handle invalid data values. These values are excluded when drawing the graph. The following screenshot shows a graph with 2 gaps of invalid data:
GRAPH_DATA_YT_Clear()
Before
After
Description
Clears all data items of the data object.
Prototype
void GRAPH_DATA_YT_Clear(GRAPH_DATA_Handle hDataObj);
Parameter hDataObj
Handle of data object.
Description
GRAPH_DATA_YT_Create()
Description
Creates a GRAPH_DATA_YT object. This kind of object requires for each point on the xaxis a value on the y-axis. Typically used for time related graphs.
Prototype
GRAPH_DATA_Handle GRAPH_DATA_YT_Create(GUI_COLOR Color,
unsigned MaxNumItems,
I16
* pData,
unsigned NumItems);
Parameter Color MaxNumItems pData NumItems
Description
Color to be used to draw the data. Maximum number of data items.
Pointer to data to be added to the object. The pointer should point to an array of I16
values. Number of data items to be added.
Return value
Handle of data object if creation was successful, otherwise 0.
Additional information
The last data item is shown at the rightmost column of the data area. If a data object contains more data as can be shown in the data area of the graph widget, the function GRAPH_SetVSizeX() can be used to show a scrollbar which makes it possible to scroll through large data objects.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
516
CHAPTER
Window Objects (Widgets)
Once attached to a graph widget a data object needs not to be deleted by the application. This is automatically done during the deletion of the graph widget.
GRAPH_DATA_YT_Delete()
Description
Deletes the given data object.
Prototype
void GRAPH_DATA_YT_Delete(GRAPH_DATA_Handle hDataObj);
Parameter hDataObj
Data object to be deleted.
Description
Additional information
When a graph widget is deleted it deletes all currently attached data objects. So the application needs only to delete unattached data objects.
GRAPH_DATA_YT_MirrorX()
Before
After
Description
Mirrors the x-axis of the widget.
Prototype
void GRAPH_DATA_YT_MirrorX(GRAPH_DATA_Handle hDataObj, int Value);
Parameter hDataObj OnOff
Description
Handle of data object. 1 for mirroring the x-axis, 0 for default view.
Additional information
Per default the data is drawn from the right to the left. After calling this function the data is drawn from the left to the right.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
GRAPH_DATA_YT_SetAlign()
Before
517 After
Description
Sets the alignment of the data.
Prototype
void GRAPH_DATA_YT_SetAlign(GRAPH_DATA_Handle hDataObj, int Align);
Parameter hDataObj Align
Handle of data object. See table below.
Description
Permitted values for parameter Align GRAPH_ALIGN_RIGHT The data is aligned at the right edge (default). GRAPH_ALIGN_LEFT The data is aligned at the left edge.
GRAPH_DATA_YT_SetOffY()
Before
After
Description
Sets a vertical offset used to draw the object data.
Prototype
void GRAPH_DATA_YT_SetOffY(GRAPH_DATA_Handle hDataObj, int Off);
Parameter hDataObj Off
Description
Handle of data object. Vertical offset which should be used to draw the data.
Additional information
The vertical range of data, which is shown by the data object, is the range (0) - (Ysize of data area - 1). In case of using a scroll bar the current scroll position is added to the range.
Example
If for example the visible data range should be -200 to -100 the data needs to be shifted in positive direction by 200 pixels:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
518
CHAPTER
GRAPH_DATA_YT_SetOffY(hDataObj, 200);
16.10.8.3GRAPH_DATA_XY related routines
Window Objects (Widgets)
GRAPH_DATA_XY_AddPoint()
Before
After
Description
Adds a new data item to a GRAPH_DATA_XY object.
Prototype
void GRAPH_DATA_XY_AddPoint(GRAPH_DATA_Handle hDataObj, GUI_POINT * pPoint);
Parameter hDataObj pPoint
Description
Handle of data object. Pointer to a GUI_POINT structure to be added to the data object.
Additional information
The given point is added to the data object. If the data object is 'full', that means it contains as many points as specified in parameter MaxNumItems during the creation, it first shifts the data items by one before adding the new point. So the first point is shifted out when adding a new point to a 'full' object.
GRAPH_DATA_XY_Create()
Description
Creates a GRAPH_DATA_XY object. This kind of object is able to store any pairs of values which will be connected by adding order.
Prototype
GRAPH_DATA_Handle GRAPH_DATA_XY_Create(GUI_COLOR Color, unsigned MaxNumItems, GUI_POINT * pData, unsigned NumItems);
Parameter Color MaxNumItems pData NumItems
Description
Color to be used to draw the data. Maximum number of points.
Pointer to data to be added to the object. The pointer should point to a GUI_POINT
array. Number of points to be added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
519
Return value
Handle of data object if creation was successful, otherwise 0.
Additional information
Once attached to a graph widget a data object needs not to be deleted by the application. This is automatically done during the deletion of the graph widget.
GRAPH_DATA_XY_Delete()
Description
Deletes the given data object.
Prototype
void GRAPH_DATA_XY_Delete(GRAPH_DATA_Handle hDataObj);
Parameter hDataObj
Data object to be deleted.
Description
Additional information
When a graph widget is deleted it deletes all currently attached data objects. So the application needs only to delete unattached data objects.
GRAPH_DATA_XY_SetOffX(), GRAPH_DATA_XY_SetOffY()
Before
After
Description
Sets a vertical or horizontal offset used to draw the polyline.
Prototype
void GRAPH_DATA_XY_SetOffX(GRAPH_DATA_Handle hDataObj, int Off); void GRAPH_DATA_XY_SetOffY(GRAPH_DATA_Handle hDataObj, int Off);
Parameter hDataObj Off
Description
Handle of data object. Horizontal/vertical offset which should be used to draw the polyline.
Additional information
The range of data shown by the data object is (0, 0) - (X-size of data area - 1, Y-size of data area - 1). In case of using scroll bars the current scroll position is added to the respective range. To make other ranges of data visible this functions should be used to set an offset, so that the data is in the visible area.
Example
If for example the visible data range should be (100, -1200) - (200, -1100) the following offsets need to be used:
GRAPH_DATA_XY_SetOffX(hDataObj, -100); GRAPH_DATA_XY_SetOffY(hDataObj, 1200);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
520
CHAPTER
Window Objects (Widgets)
GRAPH_DATA_XY_SetOwnerDraw()
Description
Sets the owner callback function. This function is called by the widget during the drawing process to give the application the possibility to draw additional items on top of the widget.
Prototype
void GRAPH_DATA_XY_SetOwnerDraw(GRAPH_DATA_Handle hDataObj, void (* pOwnerDraw)(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo));
Parameter hDataObj pOwnerDraw
Description
Data object to be deleted. Pointer to application function to be called by the widget during the drawing process.
Additional information
The owner draw function is called after background, scales and grid lines are drawn.
Example
The following code snippet shows an example of an user draw function:
static int _cbData(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) { switch (pDrawItemInfo->Cmd) { case WIDGET_ITEM_DRAW: GUI_DrawRect(pDrawItemInfo->x0 - 3, pDrawItemInfo->y0 - 3, pDrawItemInfo->x0 + 3, pDrawItemInfo->y0 + 3); break; } return 0;
}
void MainTask(void) {
WM_HWIN
hGraph;
GRAPH_DATA_Handle hData;
GUI_Init();
hGraph = GRAPH_CreateEx (140, 100, 171, 131, 0, WM_CF_SHOW, 0, GUI_ID_GRAPH0);
hData = GRAPH_DATA_XY_Create(USER_DEFINED_COLOR, 126, 0, 0);
GRAPH_DATA_XY_SetOwnerDraw(hData, _cbData);
}
GRAPH_DATA_XY_SetLineStyle()
Before
After
Description
Sets the line style used to draw the polyline.
Prototype
void GRAPH_DATA_XY_SetLineStyle(GRAPH_DATA_Handle hDataObj, U8 LineStyle);
Parameter hDataObj LineStyle
Description
Handle of data object. New line style to be used. For details about the supported line styles, refer to "GUI_SetLineStyle()" on page 131.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
521
Limitations
Note that only curves with line style GUI_LS_SOLID (default) can be drawn with a pen size >1.
GRAPH_DATA_XY_SetPenSize()
Before
After
Description
Sets the pen size used to draw the polyline.
Prototype
void GRAPH_DATA_XY_SetPenSize(GRAPH_DATA_Handle hDataObj, U8 PenSize);
Parameter hDataObj PenSize
Description
Handle of data object. Pen size which should be used to draw the polyline.
Limitations
Note that only curves with line style GUI_LS_SOLID (default) can be drawn with a pen size >1.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
522
CHAPTER
Window Objects (Widgets)
16.10.8.4Scale related routines
The graph widget supports horizontal and vertical scales for labeling purpose. The following describes the available functions for using scales.
GRAPH_SCALE_Create()
Description
Creates a GRAPH_SCALE object.
Prototype
GRAPH_SCALE_Handle GRAPH_SCALE_Create(int
Pos, int
TextAlign,
unsigned Flags, unsigned TickDist);
Parameter Pos TextAlign Flags TickDist
Description
Position relative to the left/top edge of the graph widget. Text alignment used to draw the numbers. See table below. See table below. Distance from one tick mark to the next.
Permitted values for parameter TextAlign (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT GUI_TA_HCENTER GUI_TA_RIGHT
Align X-position left (default). Center X-position. Align X-position right.
Vertical alignment
GUI_TA_TOP GUI_TA_VCENTER GUI_TA_BOTTOM
Align Y-position with top of characters (default). Center Y-position. Align Y-position with bottom pixel line of font.
Permitted values for parameter Flags
GRAPH_SCALE_CF_HORIZONTAL Creates a horizontal scale object.
GRAPH_SCALE_CF_VERTICAL
Creates a vertical scale object.
Return value
Handle of the scale object if creation was successful, otherwise 0.
Additional information
A horizontal scale object starts labeling from the bottom edge of the data area to the top and a vertical scale object from the left edge (horizontal scale) to the right, where the first position is the zero point. The parameter TickDist specifies the distance between the numbers. The parameter Pos specifies in case of a horizontal scale the vertical distance in pixels from the top edge of the graph widget to the scale text. In case of a vertical scale the parameter specifies the horizontal distance from the left edge of the graph widget to the horizontal text position. Note that the actual text position also depends on the text alignment specified with parameter TextAlign. The scale object draws a number for each position which is within the data area. In case of a horizontal scale there is one exception: If the first position is 0 no number is drawn at this position. Once attached to a graph widget a scale object needs not to be deleted by the application. This is automatically done during the deletion of the graph widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
523
GRAPH_SCALE_Delete()
Description
Deletes the given scale object.
Prototype
void GRAPH_SCALE_Delete(GRAPH_SCALE_Handle hScaleObj);
Parameter hScaleObj
Scale object to be deleted.
Description
Additional information
When a graph widget is deleted it deletes all currently attached scale objects. So the application needs only to delete unattached scale objects.
GRAPH_SCALE_SetFactor()
Before
After
Description
Sets a factor used to calculate the numbers to be drawn.
Prototype
float GRAPH_SCALE_SetFactor(GRAPH_SCALE_Handle hScaleObj, float Factor);
Parameter hScaleObj Factor
Description
Handle of scale object. Factor to be used to calculate the number.
Return value
Old factor used to calculate the numbers.
Additional information
Without using a factor the unit of the scale object is 'pixel'. So the given factor should convert the pixel value to the desired unit.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
524
GRAPH_SCALE_SetFont()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the font used to draw the scale numbers.
Prototype
const GUI_FONT * GRAPH_SCALE_SetFont(GRAPH_SCALE_Handle hScaleObj,
const GUI_FONT
* pFont);
Parameter hScaleObj pFont
Handle of scale object. Font to be used.
Description
Return value
Previous used font used to draw the numbers.
GRAPH_SCALE_SetNumDecs()
Before
After
Description
Sets the number of post decimal positions to be shown.
Prototype
int GRAPH_SCALE_SetNumDecs(GRAPH_SCALE_Handle hScaleObj, int NumDecs);
Parameter hScaleObj NumDecs
Description
Handle of scale object. Number of post decimal positions.
Return value
Previous number of post decimal positions.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
GRAPH_SCALE_SetOff()
Before
525 After
Description
Sets an offset used to 'shift' the scale object in positive or negative direction.
Prototype
int GRAPH_SCALE_SetOff(GRAPH_SCALE_Handle hScaleObj, int Off);
Parameter hScaleObj Off
Description
Handle of scale object. Offset used for drawing the scale.
Return value
Previous used offset.
Additional information
As described under the function GRAPH_SCALE_Create() a horizontal scale object starts labeling from the bottom edge of the data area to the top and a vertical scale object from the left edge (horizontal scale) to the right, where the first position is the zero point. In many situations it is not desirable, that the first position is the zero point. If the scale should be 'shifted' in positive direction, a positive offset should be added, for negative direction a negative value.
GRAPH_SCALE_SetPos()
Before
After
Description
Sets the position for showing the scale object within the graph widget.
Prototype
int GRAPH_SCALE_SetPos(GRAPH_SCALE_Handle hScaleObj, int Pos);
Parameter hScaleObj Pos
Description
Handle of scale object. Position, at which the scale should be shown.
Return value
Previous position of the scale object.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
526
CHAPTER
Window Objects (Widgets)
Additional information
The parameter Pos specifies in case of a horizontal scale the vertical distance in pixels from the top edge of the graph widget to the scale text. In case of a vertical scale the parameter specifies the horizontal distance from the left edge of the graph widget to the horizontal text position. Note that the actual text position also depends on the text alignment of the scale object.
GRAPH_SCALE_SetTextColor()
Before
After
Description
Sets the text color used to draw the numbers.
Prototype
GUI_COLOR GRAPH_SCALE_SetTextColor(GRAPH_SCALE_Handle hScaleObj,
GUI_COLOR
Color);
Parameter hScaleObj Color
Description
Handle of scale object. Color to be used to show the numbers.
Return value
Previous color used to show the numbers.
GRAPH_SCALE_SetTickDist()
Before
After
Description
Sets the distance from one number to the next.
Prototype
unsigned GRAPH_SCALE_SetTickDist(GRAPH_SCALE_Handle hScaleObj,
unsigned
Dist);
Parameter hScaleObj Dist
Description
Handle of scale object. Distance in pixels between the numbers.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
527
Return value
Previous distance between the numbers.
16.10.9 Examples
The Sample folder contains the following examples which show how the widget can be used: · WIDGET_GraphXY.c · WIDGET_GraphYT.c Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screen shot of WIDGET_GraphXY.c:
Screen shot of WIDGET_GraphYT.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
528
CHAPTER
16.11 HEADER: Header widget
HEADER widgets are used to label columns of a table:
Window Objects (Widgets)
If a pointer input device (PID) is used, the width of the header items can be managed by dragging the dividers by the PID.
Behavior with mouse
If mouse support is enabled, the cursor is on and the PID is moved nearby a divider the cursor will change to signal, that the divider can be dragged at the current position.
Behavior with touch screen
If the widget is pressed nearby a divider and the cursor is on the cursor will change to signal, that the divider can now be dragged.
Screenshot of drag-able divider
Predefined cursors
There are 2 predefined cursors as shown below:
GUI_CursorHeaderM (default)
GUI_CursorHeaderMI
You can also create and use your own cursors when using a HEADER widget as described later in this chapter.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
529
16.11.1 Configuration options
Type
Macro
Default
Description
N
HEADER_BKCOLOR_DEFAULT 0xAAAAAA
Default value of background color
S
HEADER_CURSOR_DEFAULT
&GUI_CursorHeaderM Default cursor
S HEADER_FONT_DEFAULT
&GUI_Font13_1
N HEADER_BORDER_H_DEFAULT 2
N HEADER_BORDER_V_DEFAULT 0
B HEADER_SUPPORT_DRAG
1
N
HEADER_TEXTCOLOR_DEFAULT GUI_BLACK
Default font Horizontal space between text and border Vertical space between text and border Enable/disable dragging support Default value of text color
16.11.2 Notification codes
The following events are sent from a HEADER widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED
WM_NOTIFICATION_MOVED_OUT
Description
Widget has been clicked. Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing.
16.11.3 Keyboard reaction
The widget can not gain the input focus and does not react on keyboard input.
16.11.4 HEADER API
The table below lists the available emWin HEADER-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine HEADER_AddItem() HEADER_Create() HEADER_CreateAttached() HEADER_CreateEx() HEADER_CreateIndirect() HEADER_CreateUser() HEADER_GetDefaultBkColor() HEADER_GetDefaultBorderH() HEADER_GetDefaultBorderV() HEADER_GetDefaultCursor() HEADER_GetDefaultFont() HEADER_GetDefaultTextColor() HEADER_GetHeight() HEADER_GetItemWidth() HEADER_GetNumItems() HEADER_GetUserData() HEADER_SetBitmap() HEADER_SetBitmapEx() HEADER_SetBkColor() HEADER_SetBMP() HEADER_SetBMPEx() HEADER_SetDefaultBkColor()
Description
Adds one item at the right side Creates a HEADER widget. (Obsolete) Creates a HEADER widget attached to a window Creates a HEADER widget. Creates a HEADER widget from a resource table entry Creates a HEADER widget using extra bytes as user data. Returns the default background color Returns the value of the horizontal spacing. Returns the value of the vertical spacing. Returns the a pointer to the default cursor. Returns a pointer to the default font. Returns the default text color. Returns the height of the widget. Returns the item width. Returns the number of items. Retrieves the data set with HEADER_SetUserData(). Sets the bitmap used when displaying the given item. Sets the bitmap used when displaying the given item. Sets the background color of the widget. Sets the bitmap used when displaying the given item. Sets the bitmap used when displaying the given item. Sets the default background color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
530
CHAPTER
Window Objects (Widgets)
Routine HEADER_SetDefaultBorderH() HEADER_SetDefaultBorderV() HEADER_SetDefaultCursor() HEADER_SetDefaultFont() HEADER_SetDefaultTextColor() HEADER_SetDragLimit() HEADER_SetFont() HEADER_SetHeight() HEADER_SetItemText() HEADER_SetItemWidth() HEADER_SetStreamedBitmap() HEADER_SetStreamedBitmapEx() HEADER_SetTextAlign() HEADER_SetTextColor() HEADER_SetUserData()
Description
Sets the default value for the horizontal spacing. Sets the default value for the vertical spacing. Sets the default cursor. Sets the default font. Sets the default text color. Sets the limit for dragging the items on or off. Sets the font of the widget. Sets the height of the widget. Sets the text of a given item. Sets the width of a given item. Sets the bitmap used when displaying the given item. Sets the bitmap used when displaying the given item. Sets the alignment of the given item. Sets the Text color of the widget. Sets the extra data of a HEADER widget.
HEADER_AddItem()
Description
Adds an item to an already existing HEADER widget.
Prototype
void HEADER_AddItem(HEADER_Handle hObj, int Width, const char * s, int Align);
Parameter hObj Width s
Align
Description
Handle of widget Width of the new item Text to be displayed
Text alignment mode to set. May be a combination of a horizontal and a vertical alignment flag.
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT
Align X-position left (default).
GUI_TA_HCENTER Center X-position.
GUI_TA_RIGHT
Align X-position right (default).
Vertical alignment
GUI_TA_TOP
Align Y-position with top of characters (default).
GUI_TA_VCENTER Center Y-position.
GUI_TA_BOTTOM Align Y-position with bottom pixel line of font.
Additional information
The Width-parameter can be 0. If Width = 0 the width of the new item will be calculated by the given text and by the default value of the horizontal spacing.
HEADER_Create()
(Obsolete, HEADER_CreateEx() should be used instead)
Description
Creates a HEADER widget of a specified size at a specified location.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
531
Prototype
HEADER_Handle HEADER_Create(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int Id,
int
Flags, int SpecialFlags);
Parameter
Description
x0 y0 xsize ysize hParent Id
Leftmost pixel of the HEADER widget (in parent coordinates). Topmost pixel of the HEADER widget (in parent coordinates). Horizontal size of the HEADER widget (in pixels). Vertical size of the HEADER widget (in pixels). Handle of the parent window Id of the new HEADER widget
Window create flags. Typically WM_CF_SHOW in order to make the widget visible
Flags
immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
SpecialFlags (Reserved for later use)
Return value
Handle of the created HEADER widget; 0 if the function fails.
HEADER_CreateAttached()
Description
Creates a HEADER widget which is attached to an existing window.
Prototype
HEADER_Handle HEADER_CreateAttached(WM_HWIN hParent,
int
Id,
int
SpecialFlags);
Parameter
Description
hObj
Handle of widget
Id
Id of the HEADER widget
SpecialFlags (Not used, reserved for later use)
Return value
Handle of the created HEADER widget; 0 if the function fails.
Additional information
An attached HEADER widget is essentially a child window which will position itself on the parent window and operate accordingly.
HEADER_CreateEx()
Description
Creates a HEADER widget of a specified size at a specified location.
Prototype
HEADER_Handle HEADER_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
532
CHAPTER
Window Objects (Widgets)
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new HEADER widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Not used, reserved for future use. Window ID of the widget.
Return value
Handle of the created HEADER widget; 0 if the function fails.
HEADER_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
HEADER_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function HEADER_CreateEx() can be referred to.
HEADER_GetDefaultBkColor()
Description
Returns the default background color used when creating a HEADER widget.
Prototype
GUI_COLOR HEADER_GetDefaultBkColor(void);
Return value
Default background color used when creating a HEADER widget.
HEADER_GetDefaultBorderH()
Description
Returns the value used for the horizontal spacing when creating a HEADER widget. Horizontal spacing means the horizontal distance in pixel between text and the horizontal border of the item.
Prototype
int HEADER_GetDefaultBorderH(void);
Return value
Value used for the horizontal spacing when creating a HEADER widget.
Additional information
Horizontal spacing takes effect only if the given width of a new item is 0.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
533
HEADER_GetDefaultBorderV()
Description
Returns the value used for the vertical spacing when creating a HEADER widget. Vertical spacing means the vertical distance in pixel between text and the vertical border of the HEADER widget.
Prototype
int HEADER_GetDefaultBorderV(void);
Return value
Value used for the vertical spacing when creating a HEADER widget.
HEADER_GetDefaultCursor()
Description
Returns a pointer to the cursor displayed when dragging the width of an item.
Prototype
const GUI_CURSOR * HEADER_GetDefaultCursor(void);
Return value
pointer to the cursor displayed when dragging the width of an item.
HEADER_GetDefaultFont()
Description
Returns a pointer to the default font used when creating a HEADER widget.
Prototype
const GUI_FONT * HEADER_GetDefaultFont(void);
Return value
Pointer to the default font used when creating a HEADER widget.
HEADER_GetDefaultTextColor()
Description
Returns the default text color used when creating a HEADER widget.
Prototype
GUI_COLOR HEADER_GetDefaultTextColor(void);
Return value
Default text color used when creating a HEADER widget.
HEADER_GetHeight()
Description
Returns the height of the given HEADER widget.
Prototype
int HEADER_GetHeight(HEADER_Handle hObj);
Parameter hObj
Handle of widget
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
534
CHAPTER
Window Objects (Widgets)
Return value
Height of the given HEADER widget.
HEADER_GetItemWidth()
Description
Returns the item width of the given HEADER widget.
Prototype
int HEADER_GetItemWidth(HEADER_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of widget Index of the item
Description
Return value
Width of the item.
HEADER_GetNumItems()
Description
Returns the number of items of the given HEADER widget.
Prototype
int HEADER_GetNumItems(HEADER_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of items of the given HEADER widget.
HEADER_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
HEADER_SetBitmap()
Description
Sets the bitmap used when displaying the specified item.
Prototype
void HEADER_SetBitmap(HEADER_Handle unsigned int
hObj, Index,
const GUI_BITMAP * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of widget Index of the item Pointer to a bitmap structure to be displayed
Additional information
One item of a HEADER widget can contain text and a bitmap. (look at sample under HEADER_SetBitmapEx)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
535
HEADER_SetBitmapEx()
Description
Sets the bitmap used when displaying the specified item.
Prototype
void HEADER_SetBitmapEx(HEADER_Handle
hObj, unsigned int Index,
const GUI_BITMAP * pBitmap,
int
x,
int
y);
Parameter hObj Index pBitmap x y
Description
Handle of widget Index of the item Pointer to a bitmap structure to be displayed Additional offset in x Additional offset in y
Additional information
One item of a HEADER widget can contain text and a bitmap.
Example:
... HEADER_Handle hHeader; GUI_Init(); HEADER_SetDefaultTextColor(GUI_YELLOW); HEADER_SetDefaultFont(&GUI_Font8x8); hHeader = HEADER_Create(10, 10, 100, 40, WM_HBKWIN, 1234, WM_CF_SHOW, 0); HEADER_AddItem(hHeader, 50, "Phone", GUI_TA_BOTTOM | GUI_TA_HCENTER); HEADER_AddItem(hHeader, 50, "Code" , GUI_TA_BOTTOM | GUI_TA_HCENTER); HEADER_SetBitmapEx(hHeader, 0, &bmPhone, 0, -15); HEADER_SetBitmapEx(hHeader, 1, &bmCode, 0, -15); ... Screenshot of example above:
HEADER_SetBkColor()
Description
Sets the background color of the given HEADER widget.
Prototype
void HEADER_SetBkColor(HEADER_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of widget Background color to be set
Description
HEADER_SetBMP()
Description
Sets the bitmap used when displaying the specified item.
Prototype
void HEADER_SetBMP(HEADER_Handle hObj,
unsigned int Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
536
CHAPTER
Window Objects (Widgets)
const void * pBitmap);
Parameter hObj Index pBitmap
Handle of widget Index of HEADER item Pointer to bitmap file data
Description
Additional information
For additional informations regarding bitmap files, refer to chapter "Displaying bitmap files" on page 147.
HEADER_SetBMPEx()
Description
Sets the bitmap used when displaying the specified item.
Prototype
void HEADER_SetBMPEx(HEADER_Handle hObj, unsigned int Index,
const void * pBitmap,
int
x,
int
y);
Parameter hObj Index pBitmap x y
Handle of widget Index of the item Pointer to bitmap file data Additional offset in x Additional offset in y
Description
Additional information
For additional informations regarding bitmap files, refer to chapter "Displaying bitmap files" on page 147.
HEADER_SetDefaultBkColor()
Description
Sets the default background color used when creating a HEADER widget.
Prototype
GUI_COLOR HEADER_SetDefaultBkColor(GUI_COLOR Color);
Parameter Color
Background color to be used
Description
Return value
Previous default background color.
HEADER_SetDefaultBorderH()
Description
Sets the value used for the horizontal spacing when creating a HEADER widget. Horizontal spacing means the horizontal distance in pixel between text and the horizontal border of the item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
537
Prototype
int HEADER_SetDefaultBorderH(int Spacing);
Parameter Spacing
Value to be used
Description
Return value
Previous default value.
Additional information
Horizontal spacing takes effect only if the given width of a new item is 0.
HEADER_SetDefaultBorderV()
Description
Sets the value used for the vertical spacing when creating a HEADER widget. Vertical spacing means the vertical distance in pixel between text and the vertical border of the HEADER widget.
Prototype
int HEADER_SetDefaultBorderV(int Spacing);
Parameter Spacing
Value to be used
Description
Return value
Previous default value.
HEADER_SetDefaultCursor()
Description
Sets the cursor which will be displayed when dragging the width of an HEADER item.
Prototype
const GUI_CURSOR * HEADER_SetDefaultCursor(const GUI_CURSOR * pCursor);
Parameter pCursor
Description
Pointer to the cursor to be shown when dragging the width of an HEADER item
Return value
Pointer to the previous default cursor.
Additional information
There are 2 predefined cursors shown at the beginning of this chapter.
HEADER_SetDefaultFont()
Description
Sets the default font used when creating a HEADER widget.
Prototype
const GUI_FONT * HEADER_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Pointer to font to be used
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
538
CHAPTER
Window Objects (Widgets)
Return value
Pointer to previous default font.
HEADER_SetDefaultTextColor()
Description
Returns the default text color used when creating a HEADER widget.
Prototype
GUI_COLOR HEADER_SetDefaultTextColor(GUI_COLOR Color);
Parameter Color
Color to be used
Description
Return value
Previous default value.
HEADER_SetDragLimit()
Description
Sets the limit for dragging the dividers on or off. If the limit is on, a divider can only be dragged within the widget area. If the limit is off, it can be dragged outside the widget.
Prototype
void HEADER_SetDragLimit(HEADER_Handle hObj, unsigned OnOff);
Parameter hObj OnOff
Description
Handle of widget 1 for setting the drag limit on, 0 for off.
HEADER_SetFont()
Description
Sets the font used when displaying the given HEADER widget
Prototype
void HEADER_SetFont(HEADER_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle of widget Pointer to font to be used
Description
HEADER_SetHeight()
Description
Sets the height of the given HEADER widget.
Prototype
void HEADER_SetHeight(HEADER_Handle hObj, int Height);
Parameter hObj Height
Handle of widget New height
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
539
HEADER_SetItemText()
Description
Sets the text used when displaying the specified item.
Prototype
void HEADER_SetItemText(HEADER_Handle hObj, unsigned int Index, const char * s);
Parameter hObj Index s
Handle of widget Index of HEADER item Pointer to string to be displayed
Description
Additional information
One HEADER item can contain a string and a bitmap.
HEADER_SetItemWidth()
Description
Sets the width of the specified HEADER item.
Prototype
void HEADER_SetItemWidth(HEADER_Handle hObj, unsigned int Index, int Width);
Parameter hObj Index Width
Handle of widget Index of HEADER item New width
Description
HEADER_SetStreamedBitmap()
Description
Sets the bitmap used when displaying the specified item.
Prototype
void HEADER_SetStreamedBitmap(HEADER_Handle
hObj,
unsigned int
Index,
const GUI_BITMAP_STREAM * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of widget Index of the item Pointer to streamed bitmap data to be displayed
Additional information
For additional informations regarding streamed bitmap files, refer to the chapter "2D Graphic Library" on page 103.
HEADER_SetStreamedBitmapEx()
Description
Sets the bitmap used when displaying the specified item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
540
CHAPTER
Window Objects (Widgets)
Prototype
void HEADER_SetStreamedBitmapEx(HEADER_Handle
hObj,
unsigned int
Index,
const GUI_BITMAP_STREAM * pBitmap,
int
x,
int
y);
Parameter hObj Index pBitmap x y
Description
Handle of widget Index of the item Pointer to streamed bitmap data to be displayed Additional offset in x Additional offset in y
Additional information
For additional informations regarding streamed bitmap files, refer to the chapter "2D Graphic Library" on page 103.
HEADER_SetTextAlign()
Description
Sets the text alignment of the specified HEADER item.
Prototype
void HEADER_SetTextAlign(HEADER_Handle hObj, unsigned int Index, int Align);
Parameter hObj Index
Align
Description
Handle of widget Index of header item
Text alignment mode to set. May be a combination of a horizontal and a vertical alignment flag.
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT
Align X-position left (default).
GUI_TA_HCENTER Center X-position.
GUI_TA_RIGHT
Align X-position right (default).
Vertical alignment
GUI_TA_TOP
Align Y-position with top of characters (default).
GUI_TA_VCENTER Center Y-position.
GUI_TA_BOTTOM Align Y-position with bottom pixel line of font.
HEADER_SetTextColor()
Description
Sets the text color used when displaying the widget.
Prototype
void HEADER_SetTextColor(HEADER_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of widget Color to be used
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
541
HEADER_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.11.5 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_Header.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screen shot of WIDGET_Header.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
542
CHAPTER
Window Objects (Widgets)
16.12 ICONVIEW: Icon view widget
The icon view widget can be used for icon based menus often required in hand held devices like mobile telephones or pocket organizers. It shows a list of icons where each icon can be labeled with optional text. Icon view widgets support transparency and alpha blending. So any content can be shown in the background. The currently selected icon can be highlighted by a solid color or with an alpha blending effect, which lets the background shine through. If required a scrollbar can be shown.
ICONVIEW with transparency
ICONVIEW without transparency
All ICONVIEW-related routines are in the file(s) ICONVIEW*.c, ICONVIEW*.h. All identifiers are prefixed ICONVIEW.
16.12.1 Configuration options
Type
Macro
Default
Description
N
ICONVIEW_BKCOLOR0_DEFAULT GUI_WHITE
Background color, unselected state.
N
ICONVIEW_BKCOLOR1_DEFAULT GUI_BLUE
Background color, selected state.
N
ICONVIEW_TEXTCOLOR0_DEFAULT GUI_WHITE
Text color, unselected state.
N
ICONVIEW_TEXTCOLOR1_DEFAULT GUI_WHITE
Text color, selected state.
S ICONVIEW_FONT_DEFAULT
GUI_Font13_1
Font to be used for drawing the labels.
N ICONVIEW_FRAMEX_DEFAULT
5
Free space between the icons and the left and right border of the widget.
N ICONVIEW_FRAMEY_DEFAULT
5
Free space between the icons and the top and bottom border of the widget.
N ICONVIEW_SPACEX_DEFAULT
5
Free horizontal space between the icons.
N ICONVIEW_SPACEY_DEFAULT
5
Free vertical space between the icons.
N ICONVIEW_ALIGN_DEFAULT
GUI_TA_HCENTER Default alignment to be used for draw| GUI_TA_BOTTOM ing the labels.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
543
16.12.2 Predefined IDs
The following symbols define IDs which may be used to make ICONVIEW widgets distinguishable from creation: GUI_ID_ICONVIEW0 - GUI_ID_ICONVIEW3
16.12.3 Notification codes
The following events are sent from an ICONVIEW widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT
WM_NOTIFICATION_SCROLL_CHANGED WM_NOTIFICATION_SEL_CHANGED
Description
Widget has been clicked.
Widget has been released. Widget has been clicked and pointer has been moved out of the widget area without releasing. The scroll position of the optional scrollbar has been changed. The selection of the widget has been changed.
16.12.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_RIGHT GUI_KEY_LEFT GUI_KEY_DOWN GUI_KEY_UP GUI_KEY_HOME GUI_KEY_END
Reaction
Moves the selection to the next icon. Moves the selection to the previous icon. Moves the selection down. Moves the selection up. Moves the selection to the first icon. Moves the selection to the last icon.
16.12.5 ICONVIEW API
The table below lists the available emWin ICONVIEW-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine ICONVIEW_AddBitmapItem() ICONVIEW_AddStreamedBitmapItem() ICONVIEW_CreateEx() ICONVIEW_CreateIndirect()
ICONVIEW_CreateUser() ICONVIEW_DeleteItem() ICONVIEW_EnableStreamAuto() ICONVIEW_GetItemText() ICONVIEW_GetItemUserData() ICONVIEW_GetNumItems() ICONVIEW_GetSel() ICONVIEW_GetUserData()
ICONVIEW_InsertBitmapItem()
ICONVIEW_InsertStreamedBitmapItem() ICONVIEW_SetBitmapItem()
Description
Adds a new icon to the ICONVIEW widget. Adds a new icon to the ICONVIEW widget using a streamed bitmap. Creates an ICONVIEW widget. Creates an ICONVIEW widget from a resource table entry. Creates an ICONVIEW widget using extra bytes as user data. Deletes an existing item.
Enables full support for streamed bitmaps.
Retrieves the text of a specified icon view item. Retrieves the previously stored user data from a specific item. Returns the number of items in the given icon view.
Returns the index of the currently selected icon. Retrieves the data set with ICONVIEW_SetUserData(). Inserts a new icon to the icon view widget at the given position. Inserts a new icon to the icon view widget at the given position using a streamed bitmap. Sets a bitmap to be used by a specific item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
544
CHAPTER
Window Objects (Widgets)
Routine ICONVIEW_SetBkColor() ICONVIEW_SetFont() ICONVIEW_SetFrame() ICONVIEW_SetItemText() ICONVIEW_SetItemUserData() ICONVIEW_SetSel() ICONVIEW_SetSpace() ICONVIEW_SetStreamedBitmapItem() ICONVIEW_SetTextAlign() ICONVIEW_SetTextColor() ICONVIEW_SetUserData() ICONVIEW_SetWrapMode()
ICONVIEW_AddBitmapItem()
Before
Description
Sets the background color. Sets the font to be used for drawing the labels. Sets the size of the frame between the border of the widget and the icons. Sets the text of a specific item. Stores user data in a specific item. Sets the current selection. Sets the space between icons in x- or y-direction. Sets a streamed bitmap to be used by a specific item. Sets the alignment of the text. Sets the color to be used to draw the labels. Sets the extra data of an ICONVIEW widget. Sets the wrapping mode of the given ICONVIEW widget.
After
Description
Adds a new bitmap icon to the widget.
Prototype
int ICONVIEW_AddBitmapItem(ICONVIEW_Handle hObj,
const GUI_BITMAP * pBitmap,
const char
* pText);
Parameter hObj pBitmap pText
Description
Handle of the widget. Pointer to a bitmap structure used to draw the icon. Text to be used to label the icon.
Return value
0 on success, !=0 on error.
Additional information
Note that the bitmap pointer needs to remain valid.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
ICONVIEW_AddStreamedBitmapItem()
Before
545 After
Description
Adds a new streamed bitmap icon to the widget.
Prototype
int ICONVIEW_AddStreamedBitmapItem(ICONVIEW_Handle hObj,
const void
* pStreamedBitmap,
const char
* pText);
Parameter hObj pStreamedBitmap pText
Description
Handle of the widget. Pointer to a bitmap stream used to draw the icon. Text to be used to label the icon.
Return value
0 on success, !=0 on error.
Additional information
The pointer to the bitmap stream needs to remain valid.
ICONVIEW_CreateEx()
Description
Creates an ICONVIEW widget of a specified size at a specified location.
Prototype
ICONVIEW_Handle ICONVIEW_CreateEx(int
x0,
int y0,
int
xSize,
int ySize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id,
int
xSizeItem, int ySizeItem);
Parameter x0 y0 xSize ySize hParent
WinFlags
ExFlags
Description
Leftmost pixel of the widget in parent coordinates.
Topmost pixel of the widget in parent coordinates.
Horizontal size of the widget in pixels.
Vertical size of the widget in pixels. Handle of parent window. If 0, the new widget will be a child window of the desktop (top-level window). Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to "WM_CreateWindow()" on page 357 for a list of available parameter values). See table below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
546
CHAPTER
Window Objects (Widgets)
Parameter Id xSizeItem ySizeItem
Window ID of the widget. Horizontal icon size in pixels. Vertical icon size in pixels.
Description
Permitted values for parameter ExFlags
0 ICONVIEW_CF_AUTOSCROLLBAR_V
(default)
A vertical scrollbar will be added if the widget area is too small to show all icons.
Return value
Handle of the new widget, 0 if the function fails.
Additional information
If the widget should be transparent, the parameter WinFlags should be or-combined with WM_CF_HASTRANS.
ICONVIEW_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
ICONVIEW_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function ICONVIEW_CreateEx() can be referred to.
ICONVIEW_DeleteItem()
Description
Deletes an existing item of the ICONVIEW widget.
Prototype
void ICONVIEW_DeleteItem(ICONVIEW_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of the widget. Index of the item to be deleted.
Description
ICONVIEW_EnableStreamAuto()
Description
Enables full support for streamed bitmaps.
Prototype
void ICONVIEW_EnableStreamAuto(void);
Additional information
Please note that per default only index based streamed bitmaps are supported. Calling this function enables support for all kinds of streamed bitmaps. A side effect of using this function will be that all drawing functions for streamed bitmaps will be referenced by the linker.
ICONVIEW_GetItemText()
Description
Retrieves the text of a specified icon view item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
547
Prototype
int ICONVIEW_GetItemText(ICONVIEW_Handle hObj, int Index,
char *
pBuffer, int MaxSize);
Parameter hObj Index pBuffer MaxSize
Description
Handle of the widget. Index of the item to be deleted. Buffer to retrieve the text. Maximum length of text to copy to the buffer.
Return value
The length of the actually copied text is returned.
ICONVIEW_GetItemUserData()
Description
Retrieves the previously stored user data from a specific item.
Prototype
U32 ICONVIEW_GetItemUserData(ICONVIEW_Handle hObj, int Index);
Parameter hObj Index
Handle of the widget. Index of the item.
Description
Return value
User data stored in the item as U32.
ICONVIEW_GetNumItems()
Description
Returns the number of items in the given icon view.
Prototype
int ICONVIEW_GetNumItems(ICONVIEW_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Number of items.
ICONVIEW_GetSel()
Description
Returns the zero based index of the currently selected icon.
Prototype
int ICONVIEW_GetSel(ICONVIEW_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Zero based index of the currently selected icon.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
548
CHAPTER
Window Objects (Widgets)
ICONVIEW_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
ICONVIEW_InsertBitmapItem()
Description
Inserts a new bitmap icon to the widget. See "ICONVIEW_AddBitmapItem()" on page 544 for screenshots.
Prototype
int ICONVIEW_InsertBitmapItem(ICONVIEW_Handle hObj,
const GUI_BITMAP * pBitmap,
const char
* pText
int
Index);
Parameter hObj pBitmap pText Index
Description
Handle of the widget. Pointer to a bitmap structure used to draw the icon. Text to be used to label the icon. Index position to insert the item at.
Return value
0 on success, !=0 on error.
Additional information
Note that the bitmap pointer needs to remain valid.
ICONVIEW_InsertStreamedBitmapItem()
Description
Inserts a new streamed bitmap icon to the widget. See "ICONVIEW_AddBitmapItem()" on page 544 for screenshots.
Prototype
int ICONVIEW_InsertStreamedBitmapItem(ICONVIEW_Handle hObj,
const void
* pStreamedBitmap,
const char
* pText,
int
Index);
Parameter hObj pStreamedBitmap pText Index
Description
Handle of the widget. Pointer to a bitmap stream used to draw the icon. Text to be used to label the icon. Index position to insert the item at.
Return value
0 on success, !=0 on error.
Additional information
The pointer to the bitmap stream needs to remain valid.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
ICONVIEW_SetBitmapItem()
Before
549 After
Description
Sets a bitmap to be used by a specific item.
Prototype
void ICONVIEW_SetBitmapItem(ICONVIEW_Handle hObj,
int
Index,
const GUI_BITMAP * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of widget. Index of the item. Pointer to the bitmap to be used.
Additional information
The pointer to the bitmap structure needs to remain valid.
ICONVIEW_SetBkColor()
Before
After
Description
Sets the background color of the widget.
Prototype
void ICONVIEW_SetBkColor(ICONVIEW_Handle hObj, int Index, GUI_COLOR Color);
Parameter hObj Index Color
Description
Handle of widget. See table below. Color to be used for drawing the background.
Permitted values for parameter Index
ICONVIEW_CI_BK ICONVIEW_CI_SEL
Color used to draw the widget background. Color used to highlight the currently selected item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
550
CHAPTER
Window Objects (Widgets)
Additional information
The upper 8 bits of the 32 bit color value can be used for an alpha blending effect. For more details about alpha blending, refer to "GUI_SetAlpha()" on page 117.
ICONVIEW_SetFont()
Before
After
Description
Sets the font to be used for drawing the icon labels.
Prototype
void ICONVIEW_SetFont(ICONVIEW_Handle
hObj,
const GUI_FONT GUI_UNI_PTR * pFont);
Parameter hObj pFont
Description
Handle of widget. Pointer to a GUI_FONT structure to be used to draw the icon labels.
ICONVIEW_SetFrame()
Before
After
Description
Sets the size of the frame between the border of the widget and the icons.
Prototype
void ICONVIEW_SetFrame(ICONVIEW_Handle hObj,
int
Coord,
int
Value);
Parameter hObj Coord Value
Description
Handle of the widget. See permitted values for this parameter below. Distance to be set.
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Coord
X-direction. Y-direction.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
ICONVIEW_SetItemText()
Before
551 After
Description
Sets the text of a specific item.
Prototype
void ICONVIEW_SetItemText(ICONVIEW_Handle hObj,
int
Index,
const char
* pText);
Parameter hObj Index pText
Handle of the widget. Index of the item. Pointer to the text to be used.
Description
ICONVIEW_SetItemUserData()
Description
Stores user data in a specific item.
Prototype
void ICONVIEW_SetItemUserData(ICONVIEW_Handle hObj,
int
Index,
U32
UserData);
Parameter hObj Index UserData
Handle of widget. Index of the item. 32 bit user data to be stored.
ICONVIEW_SetSel()
Description
Before
After
Description
Sets the current selection.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
552
CHAPTER
Prototype
void ICONVIEW_SetSel(ICONVIEW_Handle hObj, int Sel);
Parameter hObj Sel
Handle of widget. New selection.
ICONVIEW_SetSpace()
Description
Window Objects (Widgets)
Before
After
Description
Sets the space between icons in x- or y-direction.
Prototype
void ICONVIEW_SetSpace(ICONVIEW_Handle hObj, int Coord, int Value);
Parameter hObj Coord Value
Description
Handle of the widget. See permitted values for this parameter below. Distance to be set.
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Coord
X-direction. Y-direction.
ICONVIEW_SetStreamedBitmapItem()
Before
After
Description
Sets a streamed bitmap to be used by a specific item.
Prototype
void ICONVIEW_SetStreamedBitmapItem(ICONVIEW_Handle int
hObj, Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
553
const void
* pStreamedBitmap);
Parameter hObj Index pStreamedBitmap
Description
Handle of widget. Index of the item. Pointer to the bitmap stream to be used.
Additional information
The pointer to the bitmap stream needs to remain valid.
ICONVIEW_SetTextAlign()
Before
After
Description
Sets the color to be used to draw the labels.
Prototype
void ICONVIEW_SetTextAlign(ICONVIEW_Handle hObj, int TextAlign);
Parameter hObj TextAlign
Handle of widget. See table below.
Description
Permitted values for parameter TextAlign (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT GUI_TA_HCENTER GUI_TA_RIGHT
Align X-position left (default). Center X-position. Align X-position right (default).
Vertical alignment
GUI_TA_TOP GUI_TA_VCENTER GUI_TA_BOTTOM
Align Y-position with top of characters (default). Center Y-position. Align Y-position with bottom pixel line of font.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
554
ICONVIEW_SetTextColor()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the color to be used to draw the labels.
Prototype
void ICONVIEW_SetTextColor(ICONVIEW_Handle hObj, int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of widget. See table below. Color to be used
Description
Permitted values for parameter Index
ICONVIEW_CI_UNSEL ICONVIEW_CI_SEL
Color used to draw the labels in unselected state. Color used to draw the labels in selected state.
ICONVIEW_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
ICONVIEW_SetWrapMode()
Before
After
Description
Sets the wrapping mode to be used for the given ICONVIEW widget.
Prototype
void ICONVIEW_SetTextColor(ICONVIEW_Handle hObj, GUI_WRAPMODE WrapMode);
Parameter hObj WrapMode
Handle of the ICONVIEW widget. See table below.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
555
Permitted values for parameter WrapMode
GUI_WRAPMODE_NONE GUI_WRAPMODE_WORD GUI_WRAPMODE_CHAR
No wrapping will be performed. Text is wrapped word wise. Text is wrapped char wise.
16.12.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_IconView
Screenshot of WIDGET_Iconview.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
556
CHAPTER
Window Objects (Widgets)
16.13 IMAGE: Image widget
Image widgets are used to display images of different formats from internal as well as from external memory.
All IMAGE-related routines are located in the file(s) IMAGE*.c, IMAGE.h. All identifiers are prefixed IMAGE.
16.13.1 Configuration options
The IMAGE widget can be configured using an or-combination of the following symbols as 'ExFlags'-parameter at creation. See IMAGE_CreateEx() below.
Configuration flag
IMAGE_CF_MEMDEV
IMAGE_CF_TILE IMAGE_CF_ALPHA IMAGE_CF_ATTACHED IMAGE_CF_AUTOSIZE
Default
not set
not set not set not set not set
Description
Use an internal memory device to display compressed images (GIF, JPEG, PNG). Use tiling to fill the whole widget area. Support PNG images using alpha blending. Fix the widget size to the borders of the parent window. Set the widget size to the size of the image.
16.13.2 Predefined IDs
The following symbols define IDs which may be used to make IMAGE widgets distinguishable from creation: GUI_ID_IMAGE0 - GUI_ID_IMAGE9
16.13.3 IMAGE API
The table below lists the available IMAGE-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine IMAGE_CreateEx() IMAGE_CreateIndirect() IMAGE_CreateUser() IMAGE_SetBitmap() IMAGE_SetBMP() IMAGE_SetBMPEx() IMAGE_SetDTA() IMAGE_SetDTAEx() IMAGE_SetGIF() IMAGE_SetGIFEx() IMAGE_SetJPEG() IMAGE_SetJPEGEx() IMAGE_SetPNG() IMAGE_SetPNGEx()
Description
Creates an IMAGE widget. Creates a IMAGE widget from a resource table entry. Creates a IMAGE widget using extra bytes as user data. Sets a bitmap to be displayed. Sets a BMP file to be displayed. Sets a BMP file to be displayed from external memory. Sets a DTA file to be displayed. Sets a DTA file to be displayed from external memory. Sets a GIF file to be displayed. Sets a GIF file to be displayed from external memory. Sets a JPEG file to be displayed. Sets a JPEG file to be displayed from external memory. Sets a PNG file to be displayed. Sets a PNG file to be displayed from external memory.
IMAGE_CreateEx()
Description
Creates an IMAGE widget of a specified size at a specified location.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
557
Prototype
IMAGE_Handle IMAGE_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the IMAGE widget will be a child of the desktop (toplevel window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). . Window ID of the widget.
Return value
Handle of the created IMAGE widget; 0 if the function fails.
Additional information
If the possibility of storing user data is a matter the function IMAGE_CreateUser() should be used instead.
IMAGE_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
IMAGE_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function BUTTON_CreateEx() can be referred to.
IMAGE_SetBitmap()
Description
Sets a bitmap to be displayed.
Prototype
void IMAGE_SetBitmap(IMAGE_Handle hWin, const GUI_BITMAP * pBitmap);
Parameter hWin pBitmap
Handle of the IMAGE widget. Pointer to the bitmap.
Description
IMAGE_SetBMP() IMAGE_SetDTA() IMAGE_SetGIF() IMAGE_SetJPEG() IMAGE_SetPNG()
Description
These functions set a file of one of the formats listed below to be displayed:
· BMP
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
558
CHAPTER
Window Objects (Widgets)
· DTA · GIF · JPEG · PNG
Prototype
void IMAGE_Set<FORMAT>(IMAGE_Handle hObj, const void * pData, U32 FileSize);
Parameter hObj pData FileSize
Handle of the IMAGE widget. Pointer to the image data. Size of the image data.
Description
Additional information
The PNG functionality requires the PNG library which can be downloaded from www.segger.com/link/emwin_png.zip. GIF files containing several images are animated automatically.
IMAGE_SetBMPEx() IMAGE_SetDTAEx() IMAGE_SetGIFEx() IMAGE_SetJPEGEx() IMAGE_SetPNGEx()
Description
These functions set a file of one of the formats listed below to be displayed from external memory:
· BMP · DTA · GIF · JPEG · PNG
Prototype
void IMAGE_SetBMPEx(IMAGE_Handle hObj, GUI_GET_DATA_FUNC * pfGetData,
void
* pVoid);
Parameter hObj pfGetData pVoid
Description
Handle of the IMAGE widget.
Pointer to the GetData-function. For details about the GetData function, refer to
"Getting data with the ...Ex() functions" on page 174. Void pointer passed to the function pointed by pfGetData.
Additional information
The PNG functionality requires the PNG library which can be downloaded from www.segger.com/link/emwin_png.zip. Animated GIF files are displayed automatically.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
559
16.14 LISTBOX: List box widget
List boxes are used to select one element of a list. A list box can be created without a surrounding frame window, as shown below, or as a child window of a FRAMEWIN widget (see the additional screen shots at the end of the section). As items in a list box are selected, they appear highlighted. Note that the background color of a selected item depends on whether the list box window has input focus.
List box with focus
List box without focus
All LISTBOX-related routines are in the file(s) LISTBOX*.c, LISTBOX.h. All identifiers are prefixed LISTBOX.
16.14.1 Configuration options
Type
Macro
N LISTBOX_BKCOLOR0_DEFAULT
N LISTBOX_BKCOLOR1_DEFAULT
Default
GUI_WHITE GUI_GRAY
N
LISTBOX_BKCOLOR2_DEFAULT GUI_BLUE
S LISTBOX_FONT_DEFAULT
&GUI_Font13_1
N
LISTBOX_TEXTCOLOR0_DEFAULT GUI_BLACK
N
LISTBOX_TEXTCOLOR1_DEFAULT GUI_WHITE
N
LISTBOX_TEXTCOLOR2_DEFAULT GUI_WHITE
Description
Background color, unselected state. Background color, selected state without focus. Background color, selected state with focus. Font used. Text color, unselected state. Text color, selected state without focus. Text color, selected state with focus.
16.14.2 Predefined IDs
The following symbols define IDs which may be used to make LISTBOX widgets distinguishable from creation: GUI_ID_LISTBOX0 - GUI_ID_LISTBOX9
16.14.3 Notification codes
The following events are sent from a list box widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT
WM_NOTIFICATION_SCROLL_CHANGED WM_NOTIFICATION_SEL_CHANGED
Description
List box has been clicked.
List box has been released. List box has been clicked and pointer has been moved out of the box without releasing. The scroll position of the optional scrollbar has been changed. The selection of the list box has changed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
560
CHAPTER
Window Objects (Widgets)
16.14.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_SPACE
GUI_KEY_RIGHT
GUI_KEY_LEFT GUI_KEY_DOWN GUI_KEY_UP
Reaction
If the widget works in multi selection mode this key toggles the state of the current selected item. If the maximum X-size of the list box items is larger than the list box itself this key scrolls the list box content to the left. If the maximum X-size of the list box items is larger than the list box itself this key scrolls the list box content to the right.
Moves the selection bar down.
Moves the selection bar up.
16.14.5 LISTBOX API
The table below lists the available emWin LISTBOX-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine
Description
LISTBOX_AddString()
Adds an item to a list box.
LISTBOX_Create()
Creates a LISTBOX widget. (Obsolete)
LISTBOX_CreateAsChild()
Creates a LISTBOX widget as a child window. (Obsolete)
LISTBOX_CreateEx()
Creates a LISTBOX widget.
LISTBOX_CreateIndirect()
Creates a LISTBOX widget from resource table entry.
LISTBOX_CreateUser()
Creates a LISTBOX widget using extra bytes as user data.
LISTBOX_DecSel()
Decrements selection.
LISTBOX_DeleteItem()
Deletes an element.
LISTBOX_GetDefaultBkColor()
Returns the default background color for LISTBOX widgets.
LISTBOX_GetDefaultFont()
Returns the default font for LISTBOX widgets.
LISTBOX_GetDefaultScrollStepH()
Returns the default number of pixels to be scrolled horizontal.
LISTBOX_GetDefaultTextAlign() Returns the default text alignment for new list boxes.
LISTBOX_GetDefaultTextColor() Returns the default text color for new list boxes.
LISTBOX_GetFont()
Returns the font of the list box.
LISTBOX_GetItemDisabled()
Returns the disabled state of the given item.
LISTBOX_GetItemSel()
Returns the selection state of a LISTBOX entry.
LISTBOX_GetItemText()
Returns the text of a list box entry.
LISTBOX_GetMulti()
Returns if the multi select mode is active.
LISTBOX_GetNumItems()
Returns the number of items in a list box.
LISTBOX_GetScrollStepH()
Returns the number of pixels to be scrolled horizontal.
LISTBOX_GetSel()
Returns the number of the selected item.
LISTBOX_GetTextAlign()
Returns the text alignment of the LISTBOX.
LISTBOX_GetUserData()
Retrieves the data set with LISTBOX_SetUserData().
LISTBOX_IncSel()
Increments selection.
LISTBOX_InsertString()
Inserts an element.
LISTBOX_InvalidateItem()
Invalidates an item of an owner drawn LISTBOX.
LISTBOX_OwnerDraw()
Default function for drawing a LISTBOX entry.
LISTBOX_SetAutoScrollH()
Activates automatic use of a horizontal scrollbar.
LISTBOX_SetAutoScrollV()
Activates automatic use of a vertical scrollbar.
LISTBOX_SetBkColor()
Sets the background color.
LISTBOX_SetDefaultBkColor()
Sets the default background color for LISTBOX widgets.
LISTBOX_SetDefaultFont()
Changes the default font for LISTBOX widgets.
LISTBOX_SetDefaultScrollStepH() Sets the default number of pixels to be scrolled horizontal.
LISTBOX_SetDefaultTextAlign() Sets the default text alignment for new LISTBOX widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
561
Routine LISTBOX_SetDefaultTextColor() LISTBOX_SetFont() LISTBOX_SetItemDisabled() LISTBOX_SetItemSel() LISTBOX_SetItemSpacing() LISTBOX_SetMulti() LISTBOX_SetOwnerDraw() LISTBOX_SetScrollbarColor() LISTBOX_SetScrollbarWidth() LISTBOX_SetScrollStepH() LISTBOX_SetSel() LISTBOX_SetString() LISTBOX_SetTextAlign() LISTBOX_SetTextColor() LISTBOX_SetUserData()
Description
Sets the default text color for LISTBOX widgets. Selects the font. Sets the disabled state of the given item. Sets the selection state of the given item. Sets a spacing between the items. Sets the multi selection mode on or off. Enables the list box to be owner drawn. Sets the colors of the optional scrollbar. Sets the width of the scrollbars used by the LISTBOX. Sets the number of pixels to be scrolled horizontal. Sets the selected item. Sets the text of an element. Sets the text alignment of the LISTBOX. Sets the foreground color. Sets the extra data of a LISTBOX widget.
LISTBOX_AddString()
Description
Adds an item to an already existing list box.
Prototype
void LISTBOX_AddString(LISTBOX_Handle hObj, const char * s);
Parameter hObj s
Handle of list box. Text to display.
Description
LISTBOX_Create()
Description
Creates a LISTBOX widget of a specified size at a specified location.
Prototype
LISTBOX_Handle LISTBOX_Create(const GUI_ConstString * ppText, int x0, int y0, int xSize, int ySize, int Flags);
Parameter ppText x0 y0 xSize ySize
Flags
Description
Pointer to an array of string pointers containing the elements to be displayed. Leftmost pixel of the list box (in parent coordinates). Topmost pixel of the list box (in parent coordinates). Horizontal size of the list box (in pixels). Vertical size of the list box (in pixels).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
Return value
Handle of the created LISTBOX widget; 0 if the function fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
562
CHAPTER
Window Objects (Widgets)
Additional information
If the parameter ySize is greater than the required space for drawing the content of the widget, the Y-size will be reduced to the required value. The same applies for the Xsize parameter.
LISTBOX_CreateAsChild()
Description
Creates a LISTBOX widget as a child window.
Prototype
LISTBOX_Handle LISTBOX_CreateAsChild(const GUI_ConstString * ppText,
WM_HWIN hParent,
int
x0,
int y0,
int
xSize, int ySize,
int
Flags);
Parameter ppText hParent x0 y0 xSize ySize Flags
Description
Pointer to an array of string pointers containing the elements to be displayed. Handle of parent window. X-position of the list box relative to the parent window. Y-position of the list box relative to the parent window. Horizontal size of the list box (in pixels). Vertical size of the list box (in pixels).
Window create flags (see LISTBOX_Create()).
Return value
Handle of the created LISTBOX widget; 0 if the function fails.
Additional information
If the parameter ySize is greater than the space required for drawing the content of the widget, the Y-size will be reduced to the required value. If ySize = 0 the Y-size of the widget will be set to the Y-size of the client area from the parent window. The same applies for the Xsize parameter.
LISTBOX_CreateEx()
Description
Creates a LISTBOX widget of a specified size at a specified location.
Prototype
LISTBOX_Handle LISTBOX_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id,
const GUI_ConstString * ppText);
Parameter x0 y0 xsize ysize hParent
WinFlags
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new HEADER widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
563
Parameter
Description
ExFlags Id ppText
Not used, reserved for future use. Window ID of the widget. Pointer to an array of string pointers containing the elements to be displayed.
Return value
Handle of the created LISTBOX widget; 0 if the function fails.
LISTBOX_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
LISTBOX_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function LISTBOX_CreateEx() can be referred to.
LISTBOX_DecSel()
Description
Decrement the list box selection (moves the selection bar of a specified list box up by one item).
Prototypes
void LISTBOX_DecSel(LISTBOX_Handle hObj);
Parameter hObj
Handle of list box.
Description
Additional information
Note that the numbering of items always starts from the top with a value of 0; therefore, decrementing the selection will actually move the selection one row up.
LISTBOX_DeleteItem()
Description
Deletes an element from a listbox.
Prototypes
void LISTBOX_DeleteItem(LISTBOX_Handle hObj, unsigned int Index);
Parameter hObj Index
Description
Handle of list box. Zero based index of element to be deleted.
LISTBOX_GetDefaultBkColor()
Description
Returns the default background color for new LISTBOX widgets.
Prototype
GUI_COLOR LISTBOX_GetDefaultBkColor(unsigned Index);
Parameter Index
Description
Zero based index for background color. See table below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
564
CHAPTER
Window Objects (Widgets)
Permitted values for parameter Index
LISTBOX_CI_UNSEL LISTBOX_CI_SEL LISTBOX_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
Return value
Default background color for new LISTBOX widgets.
LISTBOX_GetDefaultFont()
Description
Returns the default font used for creating LISTBOX widgets.
Prototype
const GUI_FONT * LISTBOX_GetDefaultFont(void);
Return value
Pointer to the default font.
LISTBOX_GetDefaultScrollStepH()
Description
Returns the default horizontal scroll step used for creating LISTBOX widgets. The horizontal scroll step defines the number of pixels to be scrolled if needed.
Prototype
int LISTBOX_GetDefaultScrollStepH(void);
Return value
Default horizontal scroll step.
LISTBOX_GetDefaultTextAlign()
Description
Returns the default text alignment for new LISTBOX widgets.
Prototype
int LISTBOX_GetDefaultTextAlign(void);
Return value
Default text alignment for new LISTBOX widgets.
Additional information
For more information, refer to "LISTBOX_SetTextAlign()" on page 575.
LISTBOX_GetDefaultTextColor()
Description
Returns the default text color for new LISTBOX widgets.
Prototype
GUI_COLOR LISTBOX_GetDefaultTextColor(unsigned Index);
Parameter Index
Description
Zero based index for text color. See table below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
565
Permitted values for parameter Index
LISTBOX_CI_UNSEL LISTBOX_CI_SEL LISTBOX_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
Return value
Default text color for new LISTBOX widgets.
LISTBOX_GetFont()
Description
Returns a pointer to the font used to display the text of the list box.
Prototype
const GUI_FONT * LISTBOX_GetFont(LISTBOX_Handle hObj);
Parameter hObj
Handle of list box.
Description
Return value
Pointer to the font used to display the text of the list box.
LISTBOX_GetItemDisabled()
Description
Returns if the given list box item has been disabled.
Prototype
int LISTBOX_GetItemDisabled(LISTBOX_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of list box. Zero based index of item.
Description
Return value
1 if item has been disabled, 0 if not.
LISTBOX_GetItemSel()
Description
Returns the selection state of the given listbox item. The selection state of a LISTBOX item can be modified in multi selection mode only.
Prototype
int LISTBOX_GetItemSel(LISTBOX_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of list box. Zero based index of item.
Return value
1 if item has been selected, 0 if not.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
566
CHAPTER
Window Objects (Widgets)
LISTBOX_GetItemText()
Description
Returns the text of the given list box item.
Prototype
void LISTBOX_GetItemText(LISTBOX_Handle hObj, unsigned Index,
char
* pBuffer, int
MaxSize);
Parameter hObj Index pBuffer MaxSize
Description
Handle of list box. Zero based item index. Pointer to buffer to store the item text. Size of the buffer.
Additional information
The function copies the text of the given list box item into the given buffer.
LISTBOX_GetMulti()
Description
Returns if the multi selection mode of the given list box is active.
Prototype
int LISTBOX_GetMulti(LISTBOX_Handle hObj);
Parameter hObj
Handle of the LISTBOX widget.
Description
Return value
1 if active, 0 if not.
LISTBOX_GetNumItems()
Description
Returns the number of items in a specified list box.
Prototypes
unsigned LISTBOX_GetNumItems(LISTBOX_Handle hObj);
Parameter hObj
Handle of list box.
Description
Return value
Number of items in the list box.
LISTBOX_GetScrollStepH()
Description
Returns the horizontal scroll step of the given list box.
Prototype
int LISTBOX_GetScrollStepH(LISTBOX_Handle hObj);
Parameter hObj
Handle of list box.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
567
Return value
Horizontal scroll step of the given list box.
LISTBOX_GetSel()
Description
Returns the zero based index of the currently selected item in a specified list box. In multi selection mode the function returns the index of the focused element.
Prototype
int LISTBOX_GetSel(LISTBOX_Handle hObj);
Parameter hObj
Handle of list box.
Description
Return value
Zero based index of the currently selected item.
Additional information
If no element has been selected the function returns -1.
LISTBOX_GetTextAlign()
Description
Returns the text alignment of the given LISTBOX widget.
Prototype
int LISTBOX_GetTextAlign(LISTBOX_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Text alignment of the given LISTBOX widget.
Additional information
For more information, refer to "LISTBOX_SetTextAlign()" on page 575.
LISTBOX_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
LISTBOX_IncSel()
Description
Increment the list box selection (moves the selection bar of a specified list box down by one item).
Prototypes void LISTBOX_IncSel(LISTBOX_Handle hObj);
Parameter hObj
Handle of list box.
Description
Additional information
Note that the numbering of items always starts from the top with a value of 0; therefore incrementing the selection will actually move the selection one row down.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
568
CHAPTER
Window Objects (Widgets)
LISTBOX_InsertString()
Description
Inserts an element into a listbox.
Prototypes
void LISTBOX_InsertString(LISTBOX_Handle hObj, const char * s, unsigned int Index);
Parameter hObj s Index
Description
Handle of list box. Pointer to string to be inserted. Zero based index of element to be inserted.
LISTBOX_InvalidateItem()
Description
Invalidates an item of a owner drawn listbox.
Prototypes
void LISTBOX_InvalidateItem(LISTBOX_Handle hObj, int Index);
Parameter hObj Index
Description
Handle of list box. Zero based index of element to be invalidated or LISTBOX_ALL_ITEMS if all items should be invalidated.
Additional information
This function only needs to be called if an item of an owner drawn listbox has been changed. If a listbox API function (like LISTBOX_SetString()) has been used to modify a listbox item LISTBOX_InvalidateItem() needs not to be called. It needs to be called if the user decides, that for example the vertical size of an item has been changed. With other words if no listbox API function has been used to modify the item this function needs to be called.
LISTBOX_ALL_ITEMS
If all items of a listbox should be invalidated use this define as Index parameter.
LISTBOX_OwnerDraw()
Description
Default function to handle a LISTBOX entry.
Prototypes
int LISTBOX_OwnerDraw(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
Parameter pDrawItemInfo
Description
Pointer to a WIDGET_ITEM_DRAW_INFO structure.
Additional information
This function is useful if LISTBOX_SetOwnerDraw() has been used. It can be used from your drawing function to retrieve the original x size of a LISTBOX entry and/or to display the text of a LISTBOX entry and should be called for all unhandled commands. For more information, refer to the section explaining user drawn widgets, LISTBOX_SetOwnerDraw() and to the provided example.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
569
LISTBOX_SetAutoScrollH()
Description
Enables/disables the automatic use of a horizontal scrollbar.
Prototypes
void LISTBOX_SetAutoScrollH(LISTBOX_Handle hObj, int OnOff);
Parameter hObj OnOff
Handle of list box. See table below.
Description
Permitted values for parameter OnOff
0
Disable automatic use of a horizontal scrollbar.
1
Enable automatic use of a horizontal scrollbar.
Additional information
If enabled the listbox checks if all elements fits into the listbox. If not a horizontal scrollbar will be attached to the window.
LISTBOX_SetAutoScrollV()
Description
Enables/disables the automatic use of a vertical scrollbar.
Prototypes
void LISTBOX_SetAutoScrollV(LISTBOX_Handle hObj, int OnOff);
Parameter hObj OnOff
Handle of list box. See table below.
Description
Permitted values for parameter OnOff
0
Disable automatic use of a vertical scrollbar.
1
Enable automatic use of a vertical scrollbar.
Additional information
If enabled the listbox checks if all elements fits into the listbox. If not a vertical scrollbar will be added.
LISTBOX_SetBkColor()
Description
Sets the list box background color.
Prototype
void LISTBOX_SetBkColor(LISTBOX_Handle hObj, unsigned int Index, GUI_COLOR Color);
Parameter hObj Index Color
Description
Handle of list box. Index for background color. See table below. Color to be set.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
570
CHAPTER
Window Objects (Widgets)
Permitted values for parameter Index
LISTBOX_CI_UNSEL LISTBOX_CI_SEL LISTBOX_CI_SELFOCUS LISTBOX_CI_DISABLED
Unselected element. Selected element, without focus. Selected element, with focus. Disabled element.
LISTBOX_SetDefaultBkColor()
Description
Sets the default background color for new LISTBOX widgets.
Prototype
void LISTBOX_SetDefaultBkColor(unsigned Index, GUI_COLOR Color);
Parameter Index Color
Description
Zero based index for background color. See table below. Desired background color.
Permitted values for parameter Index
LISTBOX_CI_UNSEL LISTBOX_CI_SEL
Unselected element. Selected element, without focus.
LISTBOX_CI_SELFOCUS LISTBOX_CI_DISABLED
Selected element, with focus. Disabled element.
LISTBOX_SetDefaultFont()
Description
Sets the default font used for creating LISTBOX widgets.
Prototype
void LISTBOX_SetDefaultFont(const GUI_FONT * pFont)
Parameter pFont
Pointer to the font.
Description
LISTBOX_SetDefaultScrollStepH()
Description
Sets the default horizontal scroll step used when creating a LISTBOX widget.
Prototype
void LISTBOX_SetDefaultScrollStepH(int Value);
Parameter Value
Number of pixels to be scrolled.
Description
LISTBOX_SetDefaultTextAlign()
Description
Sets the default text alignment for new LISTBOX widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
571
Prototype
void LISTBOX_SetDefaultTextAlign(int Align);
Parameter Align
Description
Default text alignment for new LISTBOX widgets.
Additional information
For more information, refer to "LISTBOX_SetTextAlign()" on page 575.
LISTBOX_SetDefaultTextColor()
Description
Sets the default text color for new LISTBOX widgets.
Prototype
void LISTBOX_SetDefaultTextColor(unsigned Index, GUI_COLOR Color);
Parameter Index Color
Description
Zero based index for text color. See table below. Desired text color.
Permitted values for parameter Index
LISTBOX_CI_UNSEL LISTBOX_CI_SEL
Unselected element. Selected element, without focus.
LISTBOX_CI_SELFOCUS Selected element, with focus.
LISTBOX_SetFont()
Description
Sets the list box font.
Prototype
void LISTBOX_SetFont(LISTBOX_Handle hObj, const GUI_FONT* pfont);
Parameter hObj pFont
Handle of list box. Pointer to the font.
Description
LISTBOX_SetItemDisabled()
Description
Modifies the disable state of the given list box item.
Prototype
void LISTBOX_SetItemDisabled(LISTBOX_Handle hObj, unsigned Index,
int
OnOff);
Parameter hObj Index OnOff
Description
Handle of list box. Zero based index of the listbox item. 1 for disabled, 0 for not disabled.
Additional information
When scrolling through a list box disabled items will be skipped. You can not scroll to a disabled list box item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
572
CHAPTER
Window Objects (Widgets)
LISTBOX_SetItemSel()
Description
Modifies the selection state of the given list box item.
Prototype
void LISTBOX_SetItemSel(LISTBOX_Handle hObj, unsigned Index, int OnOff);
Parameter hObj Index OnOff
Description
Handle of list box. Zero based index of the listbox item. 1 for selected, 0 for not selected.
Additional information
Setting the selection state of a list box item makes only sense when using the multi selection mode. See also LISTBOX_SetMulti().
LISTBOX_SetItemSpacing()
Before
After
Description
Sets an additional spacing below the items of a list box.
Prototype
void LISTBOX_SetItemSpacing(LISTBOX_Handle hObj, unsigned Value);
Parameter hObj Value
Description
Handle of list box. Number of pixels used as additional spacing between the items.
LISTBOX_SetMulti()
Description
Switches the multi selection mode of a LISTBOX on or off.
Prototype
void LISTBOX_SetMulti(LISTBOX_Handle hObj, int Mode);
Parameter hObj Mode
Handle of list box. 0 for off, 1 for on.
Description
Additional information
The multi selection mode enables the list box to have more than one selected element. Using the space key would toggle the selection state of a list box item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
573
LISTBOX_SetOwnerDraw()
Description
Sets the list box to be owner drawn.
Prototype
void LISTBOX_SetOwnerDraw(LISTBOX_Handle
hObj,
WIDGET_DRAW_ITEM_FUNC * pfDrawItem);
Parameter hObj pfDrawItem
Handle of list box. Pointer to owner draw function.
Description
Additional information
This function sets a function pointer to a function which will be called by the widget if a list box item has to be drawn and when the x or y size of a item is needed. It gives you the possibility to draw anything as list box item, not just plain text. pfDrawItem is a pointer to a application-defined function of type WIDGET_DRAW_ITEM_FUNC which is explained at the beginning of the chapter.
Structure of the user defined owner draw function
The following shows the structure of a typical owner draw function. It assumes that your LISTBOX entries are 30 pixels wider than and have the same height as the item drawn by the default function:
static int _OwnerDraw(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) { switch (pDrawItemInfo->Cmd) { case WIDGET_ITEM_GET_XSIZE: return LISTBOX_OwnerDraw(pDrawItemInfo) + 30; /* Returns the default xsize+10 */ case WIDGET_ITEM_DRAW:
/* Your code to be added to draw the LISTBOX item */
return 0; } return LISTBOX_OwnerDraw(pDrawItemInfo); }
Example
/* Def. function for unhandled cmds */
The source code of this example is available in the examples as WIDGET_ListBoxOwnerDraw.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
574
LISTBOX_SetScrollbarColor()
CHAPTER
Before
Window Objects (Widgets) After
Description
Sets the colors of the optional scrollbar.
Prototype
void LISTBOX_SetScrollbarColor(LISTBOX_Handle hObj,
unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index of desired item. See table below. Color to be used.
Permitted values for parameter Index
SCROLLBAR_CI_THUMB SCROLLBAR_CI_SHAFT SCROLLBAR_CI_ARROW
Color of thumb area. Color of shaft. Color of arrows.
LISTBOX_SetScrollbarWidth()
Description
Sets the width of the scrollbars used by the given list box.
Prototype
void LISTBOX_SetScrollbarWidth(LISTBOX_Handle hObj, unsigned Width);
Parameter hObj Width
Description
Handle of list box. Width of the scrollbar(s) used by the given listbox.
LISTBOX_SetScrollStepH()
Description
Sets the horizontal scroll step of the given list box. The horizontal scroll step defines the number of pixels to be scrolled if needed.
Prototype
void LISTBOX_SetScrollStepH(LISTBOX_Handle hObj, int Value);
Parameter hObj Value
Handle of list box. Number of pixels to be scrolled.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
575
LISTBOX_SetSel()
Description
Sets the selected item of a specified list box.
Prototype
void LISTBOX_SetSel(LISTBOX_Handle hObj, int Sel);
Parameter hObj Sel
Handle of list box. Element to be selected.
Description
LISTBOX_SetString()
Description
Sets the content of the given item.
Prototypes
void LISTBOX_SetString(LISTBOX_Handle hObj, const char * s, unsigned int Index);
Parameter hObj s Index
Description
Handle of list box. Pointer to string containing the new content. Zero based index of element to be changed.
LISTBOX_SetTextAlign()
Before
After
Description
The function sets the text alignment used to display each item of the list box.
Prototype
void LISTBOX_SetTextAlign(LISTBOX_Handle hObj, int Align);
Parameter hObj Align
Handle of widget. Text alignment to be used.
Description
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT GUI_TA_HCENTER GUI_TA_RIGHT
Align X-position left (default). Center X-position. Align X-position right (default).
Vertical alignment
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
576
CHAPTER
Window Objects (Widgets)
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
GUI_TA_TOP GUI_TA_VCENTER GUI_TA_BOTTOM
Align Y-position with top of characters (default). Center Y-position. Align Y-position with bottom pixel line of font.
Additional information
The default alignment of list boxes is GUI_TA_LEFT. Per default the height of each item depends on the height of the font used to render the list box items. So vertical text alignment makes only sense if the function LISTBOX_SetItemSpacing() is used to set an additional spacing below the items.
LISTBOX_SetTextColor()
Description
Sets the list box text color.
Prototype
void LISTBOX_SetTextColor(LISTBOX_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of list box.
Index for text color (see LISTBOX_SetBackColor()).
Color to be set.
LISTBOX_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.14.6 Examples
The Sample folder contains the following examples which show how the widget can be used: · WIDGET_SimpleListBox.c · WIDGET_ListBox.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_SimpleListBox.c:
Screenshot(s) of WIDGET_ListBox.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
577
16.15 LISTVIEW: Listview widget
LISTVIEW widgets are used to select one element of a list with several columns. To manage the columns a LISTVIEW widget contains a HEADER widget. A LISTVIEW can be created without a surrounding frame window or as a child window of a FRAMEWIN widget. As items in a listview are selected, they appear highlighted. Note that the background color of a selected item depends on whether the LISTVIEW window has input focus. The table below shows the appearance of the LISTVIEW widget:
Description
LISTVIEW widget
No focus No surrounding FRAMEWIN No SCROLLBAR attached Grid lines not visible
Has input focus No surrounding FRAMEWIN No SCROLLBAR attached Grid lines not visible
Has input focus With surrounding FRAMEWIN No SCROLLBAR attached Grid lines not visible
Has input focus With surrounding FRAMEWIN SCROLLBAR attached Grid lines not visible
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
578
Description
Has input focus With surrounding FRAMEWIN SCROLLBAR attached Grid lines visible
CHAPTER
Window Objects (Widgets)
LISTVIEW widget
16.15.1 Configuration options
Type
Macro
Default
Description
S LISTVIEW_FONT_DEFAULT N LISTVIEW_BKCOLOR0_DEFAULT
&GUI_Font13_1 GUI_WHITE
Default font Background color, unselected state.
N LISTVIEW_BKCOLOR1_DEFAULT
GUI_GRAY
Background color, selected state without focus.
N LISTVIEW_BKCOLOR2_DEFAULT
GUI_BLUE
N LISTVIEW_SCROLLSTEP_H_DEFAULT 10
Background color, selected state with
focus. Defines the number of pixels to be scrolled if needed.
N
LISTVIEW_TEXTCOLOR0_DEFAULT GUI_BLACK
Text color, unselected state.
N
LISTVIEW_TEXTCOLOR1_DEFAULT GUI_WHITE
Text color, selected state without focus.
N
LISTVIEW_TEXTCOLOR2_DEFAULT GUI_WHITE
Text color, selected state with focus.
N
LISTVIEW_GRIDCOLOR_DEFAULT
GUI_LIGHTGRAY Color of grid lines (if shown)
N LISTVIEW_ALIGN_DEFAULT
GUI_TA_VCENTER |GUI_TA_HCENTER
Default
text
alignment
16.15.2 Predefined IDs
The following symbols define IDs which may be used to make LISTVIEW widgets distinguishable from creation: GUI_ID_LISTVIEW0 - GUI_ID_LISTVIEW3
16.15.3 Notification codes
The following events are sent from a LISTVIEW widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT
WM_NOTIFICATION_SCROLL_CHANGED WM_NOTIFICATION_SEL_CHANGED
Description
Widget has been clicked.
Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing. The scroll position of the optional scrollbar has been changed. The selection of the list box has changed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
579
16.15.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_UP GUI_KEY_DOWN GUI_KEY_RIGHT
GUI_KEY_LEFT
Reaction
Moves the selection bar up.
Moves the selection bar down. If the total amount of the column width is > than the inside area of the listview, the content scrolls to the left. If the total amount of the column width is > than the inside area of the listview, the content scrolls to the right.
16.15.5 LISTVIEW API
The table below lists the available emWin LISTVIEW-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine LISTVIEW_AddColumn() LISTVIEW_AddRow() LISTVIEW_CompareDec() LISTVIEW_CompareText() LISTVIEW_Create() LISTVIEW_CreateAttached() LISTVIEW_CreateEx() LISTVIEW_CreateIndirect()
LISTVIEW_CreateUser()
LISTVIEW_DecSel() LISTVIEW_DeleteColumn() LISTVIEW_DeleteRow() LISTVIEW_DisableRow() LISTVIEW_DisableSort() LISTVIEW_EnableRow() LISTVIEW_EnableSort() LISTVIEW_GetBkColor() LISTVIEW_GetFont() LISTVIEW_GetHeader() LISTVIEW_GetItemText() LISTVIEW_GetNumColumns() LISTVIEW_GetNumRows() LISTVIEW_GetSel() LISTVIEW_GetSelUnsorted() LISTVIEW_GetTextColor() LISTVIEW_GetUserData() LISTVIEW_GetUserDataRow() LISTVIEW_IncSel() LISTVIEW_InsertRow() LISTVIEW_SetAutoScrollH() LISTVIEW_SetAutoScrollV() LISTVIEW_SetBkColor() LISTVIEW_SetColumnWidth() LISTVIEW_SetCompareFunc() LISTVIEW_SetDefaultBkColor() LISTVIEW_SetDefaultFont()
Description
Adds a column to a LISTVIEW. Adds a row to a LISTVIEW. Compare function for comparing 2 integer values. Compare function for comparing 2 strings. Creates a LISTVIEW widget. (Obsolete) Creates a LISTVIEW widget attached to a window. Creates a LISTVIEW widget. Creates a LISTVIEW widget from a resource table entry. Creates a LISTVIEW widget using extra bytes as user data. Decrements selection. Deletes the given column. Deletes the given row. Sets the state of the given row to disabled. Disables sorting of the LISTVIEW. Sets the state of the given row to enabled. Enables sorting of the LISTVIEW. Returns the background color of the LISTVIEW. Returns the font of the LISTVIEW. Returns the handle of the attached HEADER widget. Returns the text of the given cell. Returns the number of columns. Returns the number of rows. Returns the number of the selected item. Returns the number of the selected item in unsorted state. Returns the text color of the LISTVIEW. Retrieves the data set with LISTVIEW_SetUserData(). Returns the user data of the given row. Increments selection. Inserts a new row at the given position. Enables the automatic use of a horizontal scrollbar. Enables the automatic use of a vertical scrollbar. Sets the background color. Sets the column width. Sets the compare function for the given column. Sets the default background color for HEADER widgets. Sets the default font for HEADER widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
580
CHAPTER
Window Objects (Widgets)
Routine LISTVIEW_SetDefaultGridColor()
LISTVIEW_SetDefaultTextColor()
LISTVIEW_SetFixed() LISTVIEW_SetFont() LISTVIEW_SetGridVis() LISTVIEW_SetHeaderHeight() LISTVIEW_SetItemBitmap() LISTVIEW_SetItemBkColor() LISTVIEW_SetItemText() LISTVIEW_SetItemTextColor() LISTVIEW_SetLBorder() LISTVIEW_SetRBorder() LISTVIEW_SetRowHeight() LISTVIEW_SetSel() LISTVIEW_SetSelUnsorted() LISTVIEW_SetSort() LISTVIEW_SetTextAlign() LISTVIEW_SetTextColor() LISTVIEW_SetUserData() LISTVIEW_SetUserDataRow() LISTVIEW_SetWrapMode()
Description
Sets the default text color for HEADER widgets. Sets the default color of the grid lines for HEADER widgets. Fixes the given number of columns. Sets the font of the LISTVIEW. Sets the visibility flag of the grid lines. Sets the height of the header. Sets a bitmap as the background of a LISTVIEW cell Sets the background color of a LISTVIEW cell Sets the text of a LISTVIEW cell. Sets the text color of a LISTVIEW cell Sets the number of pixels used for the left border. Sets the number of pixels used for the right border. Sets the row height of the LISTVIEW Sets the current selection. Sets the current selection in unsorted state. Sets the column and sorting order to be sorted by. Sets the text alignment of a column. Sets the text color. Sets the extra data of a LISTVIEW widget. Sets the user data of the given row. Sets the wrapping mode for the given LISTVIEW widget.
LISTVIEW_AddColumn()
Description
Adds a new column to a LISTVIEW widget.
Prototype
void LISTVIEW_AddColumn(LISTVIEW_Handle hObj, int Width,
const char
* s, int Align);
Parameter hObj Width s
Align
Description
Handle of widget Width of the new column Text to be displayed in the HEADER widget
Text alignment mode to set. May be a combination of a horizontal and a vertical alignment flag.
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT
Align X-position left.
GUI_TA_HCENTER Center X-position.
GUI_TA_RIGHT
Align X-position right.
Vertical alignment
GUI_TA_TOP
Align Y-position with top of characters.
GUI_TA_VCENTER Center Y-position.
GUI_TA_BOTTOM Align Y-position with bottom pixel line of font.
Additional information
The Width-parameter can be 0. If Width = 0 the width of the new column will be calculated by the given text and by the default value of the horizontal spacing.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
581
You can only add columns to an 'empty' LISTVIEW widget. If it contains 1 or more rows you can not add a new column.
LISTVIEW_AddRow()
Description
Adds a new row to a LISTVIEW widget.
Prototype
void LISTVIEW_AddRow(LISTVIEW_Handle hObj, const GUI_ConstString * ppText);
Parameter hObj ppText
Description
Handle of widget Pointer to array containing the text of the LISTVIEW cells
Additional information
The ppText-array should contain one item for each column. If it contains less items the remaining cells left blank.
LISTVIEW_CompareDec()
Description
Compare function for comparing 2 integer values.
Prototype
int LISTVIEW_CompareDec(const void * p0, const void * p1);
Parameter p0 p1
Void pointer to first value: Void pointer to second value.
Description
Return value
< 0 if value of cell 0 greater than value of cell 1. 0 if value of cell 0 identical to value of cell 1. > 0 if value of cell 0 less than value of cell 1.
Additional information
The purpose of this function is to be used by the listviews sorting algorithm if the cell text represents integer values. For details about how to use this function for sorting, refer also to "LISTVIEW_SetCompareFunc()" on page 591. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_CompareText()
Description
Function for comparison of 2 strings.
Prototype
int LISTVIEW_CompareText(const void * p0, const void * p1);
Parameter p0 p1
Void pointer to first text: Void pointer to second text.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
582
CHAPTER
Window Objects (Widgets)
Return value
> 0 if text of cell 0 greater than text of cell 1. 0 if text of cell 0 identical to text of cell 1. < 0 if text of cell 0 less than text of cell 1.
Additional information
The purpose of this function is to be used by the listviews sorting algorithm. For details about how to use this function for sorting, refer also to "LISTVIEW_SetCompareFunc()" on page 591. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_Create()
(Obsolete, LISTVIEW_CreateEx() should be used instead)
Description
Creates a LISTVIEW widget of a specified size at a specified location.
Prototype
LISTVIEW_Handle LISTVIEW_Create(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int Id,
int
Flags, int SpecialFlags);
Parameter
Description
x0 y0 xsize ysize hParent Id
Leftmost pixel of the HEADER widget (in parent coordinates). Topmost pixel of the HEADER widget (in parent coordinates). Horizontal size of the HEADER widget (in pixels). Vertical size of the HEADER widget (in pixels). Handle of the parent window Id of the new HEADER widget
Window create flags. Typically WM_CF_SHOW in order to make the widget visible
Flags
immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
SpecialFlags (Reserved for later use)
Return value
Handle of the created LISTVIEW widget; 0 if the function fails.
LISTVIEW_CreateAttached()
Description
Creates a LISTVIEW widget which is attached to an existing window.
Prototype
LISTVIEW_Handle LISTVIEW_CreateAttached(WM_HWIN hParent,
int Id,
int
SpecialFlags);
Parameter
Description
hObj
Handle of widget
Id
Id of the new LISTVIEW widget
SpecialFlags (Not used, reserved for later use)
Return value
Handle of the created LISTVIEW widget; 0 if the function fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
583
Additional information
An attached LISTVIEW widget is essentially a child window which will position itself on the parent window and operate accordingly.
LISTVIEW_CreateEx()
Description
Creates a LISTVIEW widget of a specified size at a specified location.
Prototype
LISTVIEW_Handle LISTVIEW_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new LISTVIEW widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Not used, reserved for future use. Window ID of the widget.
Return value
Handle of the created LISTVIEW widget; 0 if the function fails.
LISTVIEW_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
LISTVIEW_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function LISTVIEW_CreateEx() can be referred to.
LISTVIEW_DecSel()
Description
Decrement the listview selection (moves the selection bar of a specified listview up by one item, if possible).
Prototype
void LISTVIEW_DecSel(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
Additional information
Note that the numbering of items always starts from the top with a value of 0; therefore, decrementing the selection will actually move the selection one row up.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
584
CHAPTER
Window Objects (Widgets)
LISTVIEW_DeleteColumn()
Description
Deletes the specified column of the listview.
Prototype
void LISTVIEW_DeleteColumn(LISTVIEW_Handle hObj, unsigned Index);
Parameter hObj Index
Description
Handle of widget Zero based index of column to be deleted.
Additional information
Note that the numbering of items always starts from the left with a value of 0.
LISTVIEW_DeleteRow()
Description
Deletes the specified row of the listview.
Prototype
void LISTVIEW_DeleteRow(LISTVIEW_Handle hObj, unsigned Index);
Parameter hObj Index
Description
Handle of widget Zero based index of row to be deleted.
Additional information
Note that the numbering of items always starts from the top with a value of 0.
LISTVIEW_DisableRow()
Before
After
Description
The function sets the state of the given row to disabled.
Prototype
void LISTVIEW_DisableRow(LISTVIEW_Handle hObj, unsigned Row);
Parameter hObj Row
Description
Handle of widget Zero based index of the row to be disabled.
Additional information
When scrolling through a listview disabled items will be skipped. You can not scroll to a disabled listview item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
585
LISTVIEW_DisableSort()
Description
Disables sorting of the given listview. After calling this function the content of the listview will be shown unsorted.
Prototype
void LISTVIEW_DisableSort(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
Additional information
For details about how to use sorting in listview widgets, refer to "LISTVIEW_SetCompareFunc()" on page 591 and "LISTVIEW_SetSort()" on page 599. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_EnableRow()
Before
After
Description
The function sets the state of the given row to enabled.
Prototype
void LISTVIEW_EnableRow(LISTVIEW_Handle hObj, unsigned Row);
Parameter hObj Row
Description
Handle of widget Zero based index of the row to be disabled.
Additional information
Refer to "LISTVIEW_DisableRow()" on page 584.
LISTVIEW_EnableSort()
Description
Enables sorting for the given listview. After calling this function the content of the listview can be rendered sorted after clicking on the header item of the desired column, by which the listview should sort its data. Note that this works only after a compare function for the desired column has been set.
Prototype
void LISTVIEW_EnableSort(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
586
CHAPTER
Window Objects (Widgets)
Additional information
For details about how to set a compare function, refer to "LISTVIEW_SetCompareFunc()" on page 591. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_GetBkColor()
Description
Returns the background color of the given LISTVIEW widget.
Prototype
GUI_COLOR LISTVIEW_GetBkColor(LISTVIEW_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of the LISTVIEW widget. Color index. See table below.
Description
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
Return value
Background color of the given LISTVIEW widget.
LISTVIEW_GetFont()
Description
Returns a pointer to the font used to display the text of the listview.
Prototype
const GUI_FONT * LISTVIEW_GetFont(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Pointer to the font used to display the text of the listview.
LISTVIEW_GetHeader()
Description
Returns the handle of the HEADER widget.
Prototype
HEADER_Handle LISTVIEW_GetHeader(LISTVIEW_Handle hObj);
Parameter hObj
Handle of the LISTVIEW widget.
Description
Return value
Handle of the HEADER widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
587
Additional information
Each LISTVIEW widget contains a HEADER widget to manage the columns. You can use this handle to change the properties of the LISTVIEW-HEADER, for example to change the text color of the HEADER widget. Example:
LISTVIEW_Handle hListView = LISTVIEW_Create(10, 80, 270, 89, 0, 1234, WM_CF_SHOW, 0); HEADER_Handle hHeader = LISTVIEW_GetHeader(hListView); HEADER_SetTextColor(hHeader, GUI_GREEN);
LISTVIEW_GetItemText()
Description
Returns the text of the given listview cell by copying it to the given buffer.
Prototype
void LISTVIEW_GetItemText(LISTVIEW_Handle hObj,
unsigned
Row,
unsigned Column,
char
* pBuffer,
unsigned
MaxSize);
Parameter hObj Column Row pBuffer MaxSize
Description
Handle of widget Zero based index of the cell's column. Zero based index of the cell's row Pointer to a buffer to be filled by the routine. Size in bytes of the buffer.
Additional information
If the text of the cell does not fit into the buffer, the number of bytes specified by the parameter MaxSize will be copied to the buffer.
LISTVIEW_GetNumColumns()
Description
Returns the number of columns of the given LISTVIEW widget.
Prototype
unsigned LISTVIEW_GetNumColumns(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of columns of the given LISTVIEW widget.
LISTVIEW_GetNumRows()
Description
Returns the number of rows of the given LISTVIEW widget.
Prototype
unsigned LISTVIEW_GetNumRows(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of rows of the given LISTVIEW widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
588
CHAPTER
Window Objects (Widgets)
LISTVIEW_GetSel()
Description
Returns the number of the currently selected row in a specified LISTVIEW widget.
Prototype
int LISTVIEW_GetSel(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Number of the currently selected row.
LISTVIEW_GetSelUnsorted()
Description
Returns the index of the currently selected row in unsorted state.
Prototype
int LISTVIEW_GetSelUnsorted(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
Return value
Index of the currently selected row in unsorted state.
Additional information
This function returns the actually index of the selected row, whereas the function LISTVIEW_GetSel() only returns the index of the sorted row. The actual (unsorted) row index should be used in function calls as row index. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_GetTextColor()
Description
Returns the text color of the given listview.
Prototype
GUI_COLOR LISTVIEW_GetTextColor(LISTVIEW_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of widget Index of color. See table below.
Description
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
Return value
Text color of the given listview.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
589
LISTVIEW_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
LISTVIEW_GetUserDataRow()
Description
Returns the user data of the given row.
Prototype
U32 LISTVIEW_GetUserData(LISTVIEW_Handle hObj, unsigned Row);
Parameter hObj Row
Handle of widget Zero based index of row.
Description
Return value
User data of the given row.
Additional information
For details about how to set user data of a row, please refer to "LISTVIEW_SetUserDataRow()" on page 600.
LISTVIEW_IncSel()
Description
Increment the list box selection (moves the selection bar of a specified LISTVIEW down by one item).
Prototype
void LISTVIEW_IncSel(LISTVIEW_Handle hObj);
Parameter hObj
Handle of widget
Description
LISTVIEW_InsertRow()
Description
Inserts a new row into the listview at the given position.
Prototype
int LISTVIEW_InsertRow(LISTVIEW_Handle
hObj, unsigned Index,
const GUI_ConstString * ppText);
Parameter hObj Index ppText
Description
Handle of widget Index of the new row. Pointer to a string array containing the cell data of the new row.
Return value
0 if function succeed, 1 if an error occurs.
Additional information
The ppText-array should contain one item for each column. If it contains less items the remaining cells left blank. If the given index is >= the current number of rows, the function LISTVIEW_AddRow() will be used to add the new row.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
590
CHAPTER
Window Objects (Widgets)
The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_SetAutoScrollH()
Description
Enables/disables the automatic use of a horizontal scrollbar.
Prototype
void LISTVIEW_SetAutoScrollH(LISTVIEW_Handle hObj, int OnOff);
Parameter hObj OnOff
Handle of widget See table below.
Description
Permitted values for parameter OnOff
0
Disable automatic use of a horizontal scrollbar.
1
Enable automatic use of a horizontal scrollbar.
Additional information
If enabled the listview checks if all columns fit into the widgets area. If not a horizontal scrollbar will be added.
LISTVIEW_SetAutoScrollV()
Description
Enables/disables the automatic use of a vertical scrollbar.
Prototype
void LISTVIEW_SetAutoScrollV(LISTVIEW_Handle hObj, int OnOff);
Parameter hObj OnOff
Handle of widget See table below.
Description
Permitted values for parameter OnOff
0
Disable automatic use of a vertical scrollbar.
1
Enable automatic use of a vertical scrollbar.
Additional information
If enabled the listview checks if all rows fit into the widgets area. If not a vertical scrollbar will be added.
LISTVIEW_SetBkColor()
Description
Sets the background color of the given LISTVIEW widget.
Prototype
void LISTVIEW_SetBkColor(LISTVIEW_Handle hObj, unsigned int Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
591
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index for background color. See table below. Color to be set.
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS LISTVIEW_CI_DISABLED
Unselected element. Selected element, without focus. Selected element, with focus. Disabled element.
Additional information
To set the background color for a single cell the function LISTVIEW_SetItemBkColor() should be used. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_SetColumnWidth()
Description
Sets the width of the given column.
Prototype
void LISTVIEW_SetColumnWidth(LISTVIEW_Handle hObj, unsigned int Index,
int
Width);
Parameter hObj Index Width
Handle of widget Number of column New width
Description
LISTVIEW_SetCompareFunc()
Description
Sets the compare function for the given column. A compare function needs to be set if the listview widget should be sorted by the given column.
Prototype
void LISTVIEW_SetCompareFunc(LISTVIEW_Handle hObj, unsigned Column, int (* fpCompare)(const void * p0, const void * p1));
Parameter hObj Column fpCompare
Description
Handle of widget Index of the desired column for which the compare function should be set. Function pointer to compare function.
Additional information
If the sorting feature of the listview widget is used, the widget uses a compare function to decide if the content of one cell is greater, equal or less than the content of the other cell. Per default no compare function is set for the listview columns. For each column which should be used for sorting, a compare function needs to be set.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
592
CHAPTER
Window Objects (Widgets)
The cells of the listview widget contain text. But sometimes the text represents data of other types like dates, integers or others. So different compare functions are required for sorting. emWin provides 2 compare functions:
LISTVIEW_CompareText(): Function can be used for comparing cells containing text.
LISTVIEW_CompareDec(): Function can be used for comparing cells which text, where the content represents integer values.
The compare function should return a value >0, if the content of the second cell is greater than the content of the first cell and <0, if the content of the second cell is less than the content of the first cell or 0 if equal. Also user defined compare functions can be used. The prototype of a applicationdefined function should be defined as follows:
Prototype
int APPLICATION_Compare(const void * p0, const void * p1);
Parameter p0 p1
Description
Pointer to NULL terminated string data of the first cell. Pointer to NULL terminated string data of the second cell.
Example
int APPLICATION_Compare(const void * p0, const void * p1) { return strcmp((const char *)p1, (const char *)p0);
}
void SetAppCompareFunc(WM_HWIN hListView, int Column) { LISTVIEW_SetCompareFunc(hListView, Column, APPLICATION_Compare);
}
The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_SetDefaultBkColor()
Description
Sets the default background color for new LISTVIEW widgets.
Prototype
GUI_COLOR LISTVIEW_SetDefaultBkColor(unsigned int Index, GUI_COLOR Color);
Parameter Index Color
Description
Index of default background color. See table below. Color to be set as default
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS LISTVIEW_CI_DISABLED
Unselected element. Selected element, without focus. Selected element, with focus. Disabled element.
Return value
Previous default value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
593
LISTVIEW_SetDefaultFont()
Description
Sets the default font for new LISTVIEW widgets.
Prototype
const GUI_FONT * LISTVIEW_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to font used for new LISTVIEW widgets
Return value
Previous default value.
LISTVIEW_SetDefaultGridColor()
Description
Sets the default color of the grid lines for new LISTVIEW widgets.
Prototype
GUI_COLOR LISTVIEW_SetDefaultGridColor(GUI_COLOR Color);
Parameter Color
New default value
Description
Return value
Previous default value
LISTVIEW_SetDefaultTextColor()
Description
Sets the default text color for new LISTVIEW widgets.
Prototype
GUI_COLOR LISTVIEW_SetDefaultTextColor(unsigned int Index, GUI_COLOR Color);
Parameter Index Color
Description
Index of default text color. See table below. Color to be set as default
Permitted values for parameter Index
0
Unselected element.
1
Selected element, without focus.
2
Selected element, with focus.
Return value
Previous default value.
LISTVIEW_SetFixed()
Description
Fixes the given number of columns at their horizontal positions.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
594
CHAPTER
Window Objects (Widgets)
Prototype
unsigned LISTVIEW_SetFixed(LISTVIEW_Handle hObj, unsigned Fixed);
Parameter hObj Fixed
Description
Handle of listview. Number of columns to be fixed at their horizontal positions.
Additional information
Using this function makes sense if one or more columns should remain at their horizontal positions during scrolling operations.
LISTVIEW_SetFont()
Description
Sets the listview font.
Prototype
void LISTVIEW_SetFont(LISTVIEW_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle of listview. Pointer to the font.
Description
LISTVIEW_SetGridVis()
Description
Sets the visibility flag of the grid lines. When creating a LISTVIEW the grid lines are disabled per default.
Prototype
int LISTVIEW_SetGridVis(LISTVIEW_Handle hObj, int Show);
Parameter hObj Show
Description
Handle of widget Sets the visibility of the grid lines
Permitted values for parameter Show
0
Not visible.
1
Visible
Return value
Previous value of the visibility flag.
LISTVIEW_SetHeaderHeight()
Description
Sets the height of the attached header widget.
Prototype
void LISTVIEW_SetHeaderHeight(LISTVIEW_Handle hObj, unsigned HeaderHeight);
Parameter hObj Show
Description
Handle of the LISTVIEW widget. Height of the attached HEADER widget to be set.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
595
Additional information
Setting the height to 0 causes the header widget not to be displayed.
LISTVIEW_SetItemBitmap()
Before
After
Description
Sets a bitmap as background of the given cell.
Prototype
void LISTVIEW_SetItemBitmap(LISTVIEW_Handle hObj,
unsigned
Column, unsigned Row,
int
xOff, int
yOff,
const GUI_BITMAP GUI_UNI_PTR * pBitmap);
Parameter hObj Column Row xOff yOff pBitmap
Description
Handle of a listview widget Number of column Number of row Offset for the leftmost pixel of the bitmap to be drawn Offset for the topmost pixel of the bitmap to be drawn Pointer to the bitmap
LISTVIEW_SetItemBkColor()
Before
After
Description
Sets the background color of the given cell.
Prototype
void LISTVIEW_SetItemBkColor(LISTVIEW_Handle hObj,
unsigned
Column, unsigned Row,
unsigned int Index, GUI_COLOR Color);
Parameter hObj Column Row Index Color
Description
Handle of widget Number of columns. Number of rows. Index of background color. See table below. Color to be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
596
CHAPTER
Window Objects (Widgets)
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS LISTVIEW_CI_DISABLED
Unselected element. Selected element, without focus. Selected element, with focus. Disabled element.
Additional information
This function overwrites the default background color for the given cell set by LISTVIEW_SetBkColor().
LISTVIEW_SetItemText()
Description
Sets the text of one cell of the LISTVIEW widget specified by row and column.
Prototype
void LISTVIEW_SetItemText(LISTVIEW_Handle hObj, unsigned
Column,
unsigned
Row, const char * s);
Parameter hObj Column Row s
Description
Handle of widget. Number of column. Number of row. Text to be displayed in the table cell.
LISTVIEW_SetItemTextColor()
Before
After
Description
Sets the text color of the given cell.
Prototype
void LISTVIEW_SetItemTextColor(LISTVIEW_Handle hObj,
unsigned
Column, unsigned Row,
unsigned int Index, GUI_COLOR Color);
Parameter hObj Column Row Index Color
Description
Handle of widget Number of column. Number of row. Index of text color. See table below. Color to be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
597
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
Additional information
This function overwrites the default text color for the given cell set by LISTVIEW_SetTextColor().
LISTVIEW_SetLBorder()
Before
After
Description
Sets the number of pixels used for the left border within each cell of the listview.
Prototype
void LISTVIEW_SetLBorder(LISTVIEW_Handle hObj, unsigned BorderSize);
Parameter hObj BorderSize
Handle of widget. Number of pixels to be used.
Description
Additional information
Using this function has no effect to the header widget used by the listview.
LISTVIEW_SetRBorder()
Before
After
Description
Sets the number of pixels used for the right border within each cell of the listview.
Prototype
void LISTVIEW_SetRBorder(LISTVIEW_Handle hObj, unsigned BorderSize);
Parameter hObj BorderSize
Handle of widget. Number of pixels to be used.
Description
Additional information
Using this function has no effect to the header widget used by the listview.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
598
CHAPTER
Window Objects (Widgets)
LISTVIEW_SetRowHeight()
Description
Sets the number of pixels used for the height of each row of the listview.
Prototype
unsigned LISTVIEW_SetRowHeight(LISTVIEW_Handle hObj, unsigned RowHeight);
Parameter hObj
Handle of widget.
Description
Return value
Previous value of the row height set by this function. If the return value is 0, the height of the rows depends on the height of the font used by the widget.
Additional information
Per default the height of the rows depends on the height of the used font.
LISTVIEW_SetSel()
Description
Sets the selected row of a specified LISTVIEW widget.
Prototype
void LISTVIEW_SetSel(LISTVIEW_Handle hObj, int Sel);
Parameter hObj Sel
Handle of widget Element to be selected.
Description
LISTVIEW_SetSelUnsorted()
Description
Sets the index of the currently selected row in unsorted state.
Prototype
void LISTVIEW_SetSelUnsorted(LISTVIEW_Handle hObj, int Sel);
Parameter hObj Sel
Description
Handle of widget. Zero based selection index in unsorted state.
Additional information
This function sets the actually index of the selected row, whereas the function LISTVIEW_SetSel() sets the index of the sorted row. The actual (unsorted) row index should be used in function calls as row index. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
LISTVIEW_SetSort()
Before
599 After
Description
This function sets the column to be sorted by and the sorting order.
Prototype
unsigned LISTVIEW_SetSort(LISTVIEW_Handle hObj,
unsigned Column,
unsigned
Reverse);
Parameter hObj Column Reverse
Description
Handle of widget. Column to be sorted by. 0 for normal sorting order (greatest element at the top), 1 for reverse order.
Return value
0 if function was successfully, 1 if not.
Additional information
Before calling this function a compare function needs to be set for the desired column. For details about how to set a compare function, refer to "LISTVIEW_SetCompareFunc()" on page 591. The Sample folder contains the example WIDGET_SortedListview.c which shows how to use the function.
LISTVIEW_SetTextAlign()
Description
Sets the alignment for the given column.
Prototype
void LISTVIEW_SetTextAlign(LISTVIEW_Handle hObj, unsigned int Index,
int
Align);
Parameter hObj Index
Align
Description
Handle of widget Number of column
Text alignment mode to set. May be a combination of a horizontal and a vertical alignment flag.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
600
CHAPTER
Window Objects (Widgets)
Permitted values for parameter Align (horizontal and vertical flags are OR-combinable)
Horizontal alignment
GUI_TA_LEFT
Align X-position left (default).
GUI_TA_HCENTER Center X-position.
GUI_TA_RIGHT
Align X-position right (default).
Vertical alignment
GUI_TA_TOP
Align Y-position with top of characters (default).
GUI_TA_VCENTER Center Y-position. GUI_TA_BOTTOM Align Y-position with bottom pixel line of font.
LISTVIEW_SetTextColor()
Description
Sets the text color of the given LISTVIEW widget.
Prototype
void LISTVIEW_SetTextColor(LISTVIEW_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget Index for text color. See table below. Color to be set.
Permitted values for parameter Index
LISTVIEW_CI_UNSEL LISTVIEW_CI_SEL LISTVIEW_CI_SELFOCUS
Unselected element. Selected element, without focus. Selected element, with focus.
LISTVIEW_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
LISTVIEW_SetUserDataRow()
Description
Sets the user data of the given row.
Prototype
void LISTVIEW_SetUserData(LISTVIEW_Handle hObj,
unsigned Row,
U32
UserData);
Parameter hObj Row UserData
Description
Handle of widget Row for which the user data should be set Value to be associated with the row.
Additional information
Sets the 32-bit value associated with the row. Each row has a corresponding 32-bit value intended for use by the application.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
601
LISTVIEW_SetWrapMode()
Description
Sets the wrapping mode which should be used for the cells of the given LISTVIEW widget.
Prototype
void LISTVIEW_SetWrapMode(ICONVIEW_Handle hObj, GUI_WRAPMODE WrapMode);
Parameter hObj WrapMode
Handle of the LISTVIEW widget. See table below.
Description
Permitted values for parameter WrapMode GUI_WRAPMODE_NONE No wrapping will be performed. GUI_WRAPMODE_WORD Text is wrapped word wise. GUI_WRAPMODE_CHAR Text is wrapped char wise.
16.15.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_ListView.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_ListView.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
602
CHAPTER
Window Objects (Widgets)
16.16 LISTWHEEL: Listwheel widget
This widget is similar to the LISTBOX widget described earlier in this chapter. Whereas the data of a LISTBOX is selected by moving the cursor with the keyboard or by using a SCROLLBAR the LISTWHEEL works completely different: The whole data area can be moved via pointer input device (PID). Striking over the widget from top to bottom or vice versa moves the data up or downwards. When releasing the PID during the data area is moving it slows down its motion and stops by snapping in a new item at the snap position. Further the data is shown in a loop. After the last data item it continues with the first item like in a chain. So the data can be 'rotated' like a wheel:
Description
LISTWHEEL widget
Application example showing three wheels for selecting a date. The example uses the owner draw mechanism to overlay the widget with a customized alpha mask for the shading effect.
The table above shows a screenshot of the example WIDGET_ListWheel.c located in the example folder Sample\Tutorial\ of the emWin package.
16.16.1 Configuration options
Type
Macro
S LISTWHEEL_FONT_DEFAULT N LISTWHEEL_BKCOLOR0_DEFAULT N LISTWHEEL_BKCOLOR1_DEFAULT N LISTWHEEL_TEXTCOLOR0_DEFAULT N LISTWHEEL_TEXTCOLOR1_DEFAULT N LISTWHEEL_TEXTALIGN_DEFAULT
Default
Description
GUI_Font13_1 Font used.
GUI_WHITE GUI_WHITE
Background color of normal text. Background color of selected text.
GUI_BLACK
Text color of normal text.
GUI_BLUE GUI_TA_LEFT
Text color of selected text. Default text alignment
16.16.2 Predefined IDs
The following symbols define IDs which may be used to make LISTWHEEL widgets distinguishable from creation: GUI_ID_LISTWHEEL0 - GUI_ID_LISTWHEEL3
16.16.3 Notification codes
The following events are sent from the widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_SEL_CHANGED
Description
Widget has been clicked. Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing. An item has been snapped at the snap position.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
603
16.16.4 Keyboard reaction
This widget currently does not react on keyboard input.
16.16.5 LISTWHEEL API
The table below lists the available emWin LISTWHEEL-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine LISTWHEEL_AddString() LISTWHEEL_CreateEx() LISTWHEEL_CreateIndirect() LISTWHEEL_CreateUser() LISTWHEEL_GetFont() LISTWHEEL_GetItemText() LISTWHEEL_GetLBorder() LISTWHEEL_GetLineHeight() LISTWHEEL_GetNumItems() LISTWHEEL_GetPos() LISTWHEEL_GetRBorder() LISTWHEEL_GetSel() LISTWHEEL_GetTextAlign() LISTWHEEL_GetUserData() LISTWHEEL_MoveToPos() LISTWHEEL_OwnerDraw() LISTWHEEL_SetBkColor() LISTWHEEL_SetFont() LISTWHEEL_SetItemData() LISTWHEEL_SetLBorder() LISTWHEEL_SetLineHeight() LISTWHEEL_SetOwnerDraw() LISTWHEEL_SetPos() LISTWHEEL_SetRBorder() LISTWHEEL_SetSel() LISTWHEEL_SetSnapPosition() LISTWHEEL_SetText() LISTWHEEL_SetTextAlign() LISTWHEEL_SetTextColor() LISTWHEEL_SetUserData() LISTWHEEL_SetVelocity()
Description
Adds a new string. Creates a LISTWHEEL widget. Creates a LISTWHEEL widget from a resource table entry. Creates a LISTWHEEL widget using extra bytes as user data. Returns the font used to draw the data. Returns the text of the requested item. Returns the size in pixels of the left border. Returns the height used for one item. Returns the number of data items. Returns the item index of the currently engaged item. Returns the size in pixels of the right border. Returns the currently selected item. Returns the text alignment used to draw the data items. Retrieves the data set with LISTWHEEL_SetUserData(). Moves the LISTWHEEL to the given position. Default function for drawing the widget. Sets the color used for the background. Sets the font used to draw the item text. Assigns a custom void pointer to the given data item. Sets the size in pixels of the left border. Sets the height used for drawing one data item. Sets a owner draw function for drawing the widget. Sets the LISTWHEEL to the given position. Sets the size in pixels of the right border. Sets the currently selected item. Sets the snap position in pixels from the top of the widget. Sets the content of the widget. Sets the alignment used to draw the data items. Sets the color used to draw the data items. Sets the extra data of a LISTWHEEL widget. Starts moving the wheel with the given velocity.
LISTWHEEL_AddString()
Description
Adds a new data item (typically a string) to the widget.
Prototype
void LISTWHEEL_AddString(LISTWHEEL_Handle hObj, const char * s);
Parameter hObj s
Description
Handle of the widget. Pointer to the string to be added.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
604
CHAPTER
Window Objects (Widgets)
Additional information
The width of the given text should fit into the horizontal widget area. Otherwise the text will be clipped during the drawing operation.
LISTWHEEL_CreateEx()
Description
Creates a LISTWHEEL widget of a specified size at a specified location.
Prototype
LISTWHEEL_Handle LISTWHEEL_CreateEx(int
x0,
int y0,
int
xSize, int ySize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id,
const GUI_ConstString * ppText);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id ppText
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new LISTVIEW widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible
immediately (refer to "WM_CreateWindow()" on page 357 for a list of available parameter values). Not used, reserved for future use. Window ID of the widget. Pointer to an array of string pointers containing the elements to be displayed.
Return value
Handle of the created LISTWHEEL widget; 0 if the function fails.
Additional information
If the parameter ppText is used the last element of the array needs to be a NULL element.
Example
char * apText[] = { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", NULL
};
LISTWHEEL_CreateEx(10, 10, 100, 100, WM_HBKWIN, WM_CF_SHOW, 0, GUI_ID_LISTWHEEL0, apText);
LISTWHEEL_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
LISTWHEEL_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function LISTWHEEL_CreateEx() can be referred to.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
605
LISTWHEEL_GetFont()
Description
Returns the font which is used to draw the data items of the given widget.
Prototype
const GUI_FONT GUI_UNI_PTR * LISTWHEEL_GetFont(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Pointer to a GUI_FONT structure which is used to draw the data items.
LISTWHEEL_GetItemText()
Description
Returns the text of the requested data item.
Prototype
void LISTWHEEL_GetItemText(LISTWHEEL_Handle hObj, unsigned Index,
char
* pBuffer, int
MaxSize);
Parameter hObj Index pBuffer MaxSize
Handle of the widget. Index of the requested item. Buffer for storing the text. Size in bytes of the buffer.
Description
Additional information
The function copies the text of the given item into the given buffer. If the size of the buffer is too small the text will be clipped.
LISTWHEEL_GetLBorder()
Description
Returns the size in pixels between the left border of the widget and the beginning of the text.
Prototype
int LISTWHEEL_GetLBorder(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Number of pixels between left border and text.
LISTWHEEL_GetLineHeight()
Description
Returns the height of one data item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
606
CHAPTER
Window Objects (Widgets)
Prototype
unsigned LISTWHEEL_GetLineHeight(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Height of one data item.
Additional information
This function returns the value set by the function LISTWHEEL_SetLineHeight(). A return value of zero means the height of one item depends on the size of the current font. For more details, refer to "LISTWHEEL_SetLineHeight()" on page 610,"LISTWHEEL_GetFont()" on page 605, and "GUI_GetYSizeOfFont()" on page 214.
LISTWHEEL_GetNumItems()
Description
Returns the number of data items of the given widget.
Prototype
int LISTWHEEL_GetNumItems(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Number of data items of the given widget.
LISTWHEEL_GetPos()
Description
Returns the zero based index of the item which is currently snapped in.
Prototype
int LISTWHEEL_GetPos(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Index of the item which is currently snapped in.
Additional information
The position at which the items being snapped can be set with the function
LISTWHEEL_SetSnapPosition().
For
more
details,
refer
to
"LISTWHEEL_SetSnapPosition()" on page 613.
LISTWHEEL_GetRBorder()
Description
Returns the size in pixels between the right border of the widget and the end of the text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
607
Prototype
int LISTWHEEL_GetRBorder(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Number of pixels between right border and text.
LISTWHEEL_GetSel()
Description
Returns the zero based index of the currently selected item.
Prototype
int LISTWHEEL_GetSel(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Index of the currently selected item.
Additional information
For more information, refer to "LISTWHEEL_SetSel()" on page 612.
LISTWHEEL_GetSnapPosition()
Description
Returns the position in pixels from the top of the widget at which the data items should be 'snapped in'.
Prototype
int LISTWHEEL_GetSnapPosition(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
Return value
Snap position in pixels from the top edge of the widget.
Additional information
The default value is 0.
LISTWHEEL_GetTextAlign()
Description
Returns the text alignment of the given widget.
Prototype
int LISTWHEEL_GetTextAlign(LISTWHEEL_Handle hObj);
Parameter hObj
Handle of the widget.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
608
CHAPTER
Window Objects (Widgets)
Return value
Text alignment of the given widget.
Additional information
For more information, refer to "LISTWHEEL_SetTextAlign()" on page 614.
LISTWHEEL_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
LISTWHEEL_MoveToPos()
Description
Moves the data area of the widget to the given position.
Prototype
void LISTWHEEL_MoveToPos(LISTWHEEL_Handle hObj, unsigned int Index);
Parameter hObj Index
Description
Handle of the widget. Zero based index of the item to which the 'wheel' should move.
Additional information
The widget starts moving by choosing the shortest way. If for example 7 items are available and item 2 is currently snapped and the widget should move to the last item it begins moving backwards until the seventh item has been reached. Please also refer to "LISTWHEEL_SetPos()" on page 611.
LISTWHEEL_OwnerDraw()
Description
Default function for managing drawing operations of one data item.
Prototype
int LISTWHEEL_OwnerDraw(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
Parameter hObj
Handle of the widget.
Description
Return value
Depends on the command in the Cmd element of the WIDGET_ITEM_DRAW_INFO structure pointed by pDrawItemInfo.
Additional information
This function is useful if LISTWHEEL_SetOwnerDraw() is used. It can be used to retrieve the original size of a data item and/or to draw the text of a data item and should be called for all commands which are not managed by the application defined owner draw function. The following commands are managed by the default function:
· WIDGET_ITEM_GET_XSIZE · WIDGET_ITEM_GET_YSIZE · WIDGET_ITEM_DRAW
For more information, refer to "User drawn widgets" on page 410,"LISTWHEEL_SetOwnerDraw()" on page 611, and to the provided example.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
LISTWHEEL_SetBkColor()
Before
609 After
Description
Sets the specified background color for selected and unselected items.
Prototype
void LISTWHEEL_SetBkColor(LISTWHEEL_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of the widget. See element list below. New background color.
Description
Permitted values for element Index
LISTWHEEL_CI_UNSEL LISTWHEEL_CI_SEL
Changes the background color for all unselected items. Changes the background color for the selected item.
LISTWHEEL_SetFont()
Before
After
Description
Sets the font which should be used to draw the data items.
Prototype
void LISTWHEEL_SetFont(LISTWHEEL_Handle
hObj,
const GUI_FONT GUI_UNI_PTR * pFont);
Parameter hObj pFont
Description
Handle of the widget. Pointer to a GUI_FONT structure.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
610
LISTWHEEL_SetLBorder()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the border size between the left edge of the widget and the beginning of the text.
Prototype
void LISTWHEEL_SetLBorder(LISTWHEEL_Handle hObj, unsigned BorderSize);
Parameter hObj BorderSize
Handle of the widget. Desired border size.
Additional information
The default value of the border size is 0.
LISTWHEEL_SetLineHeight()
Description
Before
After
Description
Sets the line height used to draw a data item.
Prototype
void LISTWHEEL_SetLineHeight(LISTWHEEL_Handle hObj, unsigned LineHeight);
Parameter hObj LineHeight
Description
Handle of the widget. Desired height. Default is 0 which means the font size determines the height of a line.
Additional information
Per default the height of a line depends on the used font. The value set by this function 'overwrites' this default behavior.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
LISTWHEEL_SetOwnerDraw()
Before
611 After
Description
Sets an application defined owner draw function for the widget which is responsible for drawing the widget items.
Prototype
void LISTWHEEL_SetOwnerDraw(LISTWHEEL_Handle
hObj,
WIDGET_DRAW_ITEM_FUNC * pfOwnerDraw);
Parameter hObj pfOwnerDraw
Handle of the widget. Pointer to owner draw function.
Description
Additional information
This function sets a pointer to an application defined function which will be called by the widget when a data item has to be drawn or when the x or y size of a item is needed. It gives you the possibility to draw anything as data item, not just plain text. pfDrawItem is a pointer to an application-defined function of type WIDGET_DRAW_ITEM_FUNC which is explained at the beginning of the chapter. The following commands are supported: WIDGET_ITEM_GET_YSIZE, WIDGET_ITEM_DRAW, WIDGET_DRAW_BACKGROUND and WIDGET_DRAW_OVERLAY.
Example
The following example routine draws 2 red indicator lines over the widget: static int _OwnerDraw(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) {
switch (pDrawItemInfo->Cmd) { case WIDGET_DRAW_OVERLAY:
GUI_SetColor(GUI_RED); GUI_DrawHLine(40, 0, 99); GUI_DrawHLine(59, 0, 99); break; default: return LISTWHEEL_OwnerDraw(pDrawItemInfo); } return 0; }
LISTWHEEL_SetPos()
Description
Sets the data area of the widget to the given position.
Prototype
void LISTWHEEL_SetPos(LISTWHEEL_Handle hObj, unsigned int Index);
Parameter hObj Index
Description
Handle of the widget. Zero based index of the item to which the 'wheel' should be set.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
612
CHAPTER
Additional information
Please also refer to "LISTWHEEL_MoveToPos()" on page 608.
LISTWHEEL_SetRBorder()
Window Objects (Widgets)
Before
After
Description
Sets the border size between the left edge of the widget and the beginning of the text.
Prototype
void LISTWHEEL_SetRBorder(LISTWHEEL_Handle hObj, unsigned BorderSize);
Parameter hObj BorderSize
Handle of the widget. Desired border size.
Additional information
The default value of the border size is 0.
LISTWHEEL_SetSel()
Description
Before
After
Description
The function sets the selected item.
Prototype
void LISTWHEEL_SetSel(LISTWHEEL_Handle hObj, int Sel);
Parameter hObj Sel
Description
Handle of the widget. Zero based index of item to be selected.
Additional information
Only one item can be selected. Per default the item with index 0 is selected.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
LISTWHEEL_SetSnapPosition()
Before
613 After
Description
The function sets the relative position from the top of the widget at which the items should snap in. Per default the snap position is 0 which means the items are snapped in at the top of the widget.
Prototype
void LISTWHEEL_SetSnapPosition(LISTWHEEL_Handle hObj, int SnapPosition);
Parameter
Description
hObj
Handle of the widget.
SnapPosition
Relative position in pixels from the top of the widget at which the items should be snapped in.
Additional information
The function LISTWHEEL_GetPos() can be used to get the zero based index of the current item which has been snapped in.
LISTWHEEL_SetText()
Before
After
Description
It removes any existing item and adds the given items passed by the function.
Prototype
void LISTWHEEL_SetText(LISTWHEEL_Handle
hObj,
const GUI_ConstString * ppText);
Parameter hObj ppText
Description
Handle of the widget. Pointer to an array of strings. The last item needs to be a NULL pointer.
Additional information
Note that the last element pointed to by ppText needs to be a NULL pointer.
EXample
The following should show how the function should be used:
static char * _apText[] = {
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
614
CHAPTER
"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", NULL };
static void _SetContent(void) { LISTWHEEL_SetText(hWin, _apText);
}
LISTWHEEL_SetTextAlign()
Before
Window Objects (Widgets) After
Description
Sets the text alignment used to draw the items of the widget.
Prototype
void LISTWHEEL_SetTextAlign(LISTWHEEL_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of the widget. Alignment to be used to draw the items of the widget.
Additional information
For details about text alignment, refer to "GUI_SetTextAlign()" on page 88.
LISTWHEEL_SetTextColor()
Before
After
Description
Sets the color to be used to draw the text.
Prototype
void LISTWHEEL_SetTextColor(LISTWHEEL_Handle hObj,
unsigned int
Index, GUI_COLOR Color);
Parameter hObj Index Color
Handle of the widget. See table below. Color to be used.
UM03001 User & Reference Guide for emWin V5.20
Description © 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
615
Permitted values for parameter Index
LISTWHEEL_CI_UNSEL LISTWHEEL_CI_SEL
Sets the color of the not selected text. Sets the color of the selected text.
LISTWHEEL_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
LISTWHEEL_SetVelocity()
Description
Starts moving the LISTWHEEL widget using the given velocity.
Prototype
void LISTWHEEL_SetVelocity(LISTWHEEL_Handle hObj, int Velocity);
Parameter hObj Velocity
Handle of the widget. Starting speed.
Description
Additional information
The velocity decreases automatically. The higher the given velocity the longer it takes for the movement to stop.
Example
This function is used in the sample applications MEMDEV_ListWheelEffects.c and WIDGET_ListWheel.c.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
616
CHAPTER
Window Objects (Widgets)
16.17 MENU: Menu widget
The MENU widget can be used to create several kinds of menus. Each menu item represents an application command or a submenu. MENUs can be shown horizontally and/or vertically. Menu items can be grouped using separators. Separators are supported for horizontal and vertical menus. Selecting a menu item sends a WM_MENU message to the owner of the menu or opens a submenu. If mouse support is enabled the MENU widget reacts on moving the mouse over the items of a menu. The shipment of emWin contains a application example which shows how to use the MENU widget. It can be found under Sample\Application\Reversi.c. The table below shows the appearance of a horizontal MENU widget with a vertical submenu:
Description
Menu using WIDGET_Effect_3D1L
Menu using WIDGET_Effect_Simple
Color display (8666 mode)
Monochrome display (16 gray scales)
Black/white display
The table above shows the appearance of the menu widget using its default effect WIDGET_Effect_3D1L and using WIDGET_Effect_Simple. It also works with all other effects.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
617
16.17.1 Menu messages
To inform its owner about selecting an item or opening a submenu the menu widget sends a message of type WM_MENU to its owner.
WM_MENU
Description
This message is sent to inform the owner of a menu about selecting an item or opening a submenu. Disabled menu items will not send this message.
Data
The Data.p pointer of the message points to a MENU_MSG_DATA structure.
Elements of MENU_MSG_DATA
Data type U16 U16
Element MsgType ItemId
See table below. Id of menu item.
Description
Permitted values for element MsgType
MENU_ON_INITMENU MENU_ON_ITEMACTIVATE MENU_ON_ITEMPRESSED MENU_ON_ITEMSELECT
This message is send to the owner of menu immediately before the menu opens. This gives the application the chance to modify the menu before it is shown.
The owner window of a menu will receive this message after a menu item has been highlighted. The message is not send after highlighting a sub menu.
After pressing a menu item this message will be send to the owner window of the widget. It will be send also for disabled menu items.
This message is send to the owner of a menu immediately after a menu item is selected. The
ItemId element contains the Id of the pressed
menu item.
Example
The following example shows how to react on a WM_MENU message:
void Callback(WM_MESSAGE * pMsg) { MENU_MSG_DATA * pData; WM_HWIN hWin = pMsg->hWin; switch (pMsg->MsgId) { case WM_MENU: pData = (MENU_MSG_DATA *)pMsg->Data.p; switch (pData->MsgType) { case MENU_ON_ITEMACTIVATE: _UpdateStatusbar(pData->ItemId); break; case MENU_ON_INITMENU: _OnInitMenu(); break; case MENU_ON_ITEMSELECT: switch (pData->ItemId) { case ID_MENU_ITEM0: ... /* React on selection of menu item 0 */ break; case ID_MENU_ITEM1: ... /* React on selection of menu item 1 */ break; case ... ... } break; } break; default: MENU_Callback(pMsg); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
618
CHAPTER
Window Objects (Widgets)
}
16.17.2 Data structures
The following shows the menu widget related data structures.
MENU_ITEM_DATA
This structure serves as a container to set or retrieve information about menu items.
Elements of MENU_ITEM_DATA
Data type const char * U16 U16
Element pText Id Flags
MENU_Handle hSubmenu
Description
Menu item text. Id of the menu item. See table below. If the item represents a submenu this element contains the handle of the submenu.
Permitted values for element Flags
MENU_IF_DISABLED MENU_IF_SEPARATOR
Item is disabled. Item is a separator.
16.17.3 Configuration options
Type
Macro
Default
Description
N MENU_BKCOLOR0_DEFAULT
GUI_LIGHTGRAY
N MENU_BKCOLOR1_DEFAULT
0x980000
N MENU_BKCOLOR2_DEFAULT
GUI_LIGHTGRAY
N MENU_BKCOLOR3_DEFAULT
0x980000
N MENU_BKCOLOR4_DEFAULT
0x7C7C7C
N MENU_BORDER_BOTTOM_DEFAULT 2
N MENU_BORDER_LEFT_DEFAULT 4
N MENU_BORDER_RIGHT_DEFAULT 4
N
MENU_BORDER_TOP_DEFAULT
2
Background color for enabled and unselected items.
Background color for enabled and selected items.
Background color for disabled items.
Background color for disabled and selected items.
Background color for active submenu items.
Border between item text and item bottom.
Border between item text and left edge of item.
Border between item text and right edge of item.
Border between item text and item top.
S MENU_EFFECT_DEFAULT
WIDGET_Effect_3D1L Default effect.
S MENU_FONT_DEFAULT
GUI_Font13_1
Font used.
N
MENU_TEXTCOLOR0_DEFAULT
GUI_BLACK
N
MENU_TEXTCOLOR1_DEFAULT
GUI_WHITE
Text color for enabled and unselected items.
Text color for enabled and selected items.
N
MENU_TEXTCOLOR2_DEFAULT
0x7C7C7C
Text color for disabled items.
N
MENU_TEXTCOLOR3_DEFAULT
GUI_LIGHTGRAY
Text color for disabled and selected items.
N
MENU_TEXTCOLOR4_DEFAULT
GUI_WHITE
Text color for active submenu items.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
619
16.17.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_RIGHT
GUI_KEY_LEFT GUI_KEY_DOWN GUI_KEY_UP GUI_KEY_ESCAPE GUI_KEY_ENTER
Reaction
- If the menu is horizontal, the selection moves one item to the right. - If the menu is vertical and the current item is a submenu, the submenu opens and the input focus moves to the submenu. - If the menu is vertical and the current item is not a submenu and the top level menu is horizontal, the next item of the top level menu opens and the input focus moves to it.
- If the menu is horizontal the selection moves one item to the left. - If the menu is vertical and the menu is not the top level menu, the current menu closes and the focus moves to the previous menu. If the previous menu is horizontal the previous submenu of it opens and the focus moves to the previous submenu.
- If the menu is horizontal and the current menu item is a submenu this submenu opens. - If the menu is vertical, the selection moves to the next item.
- If the menu is vertical, the selection moves to the previous item.
- If the menu is not the top level menu the current menu will be closed and the focus moves to the previous menu. - If the menu is the top level menu, the current menu item becomes unselected.
- If the current menu item is a submenu, the submenu opens and the focus moves to the submenu. - If the current menu item is not a submenu, all submenus of the top level menu closes and a MENU_ON_ITEMSELECT message will be send to the owner of the menu.
16.17.5 MENU API
The table below lists the available emWin MENU-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine MENU_AddItem()
MENU_Attach()
MENU_CreateEx() MENU_CreateIndirect() MENU_CreateUser() MENU_DeleteItem() MENU_DisableItem() MENU_EnableItem() MENU_GetDefaultBkColor() MENU_GetDefaultBorderSize() MENU_GetDefaultEffect()
MENU_GetDefaultFont()
MENU_GetDefaultTextColor() MENU_GetItem() MENU_GetItemText() MENU_GetNumItems() MENU_GetOwner() MENU_GetUserData() MENU_InsertItem() MENU_Popup() MENU_SetBkColor() MENU_SetBorderSize()
Description
Adds an item to an existing menu. Attaches a menu with the given size at the given position to a specified window. Creates a MENU widget. Creates a MENU widget from a resource table entry. Creates a MENU widget using extra bytes as user data. Deletes the specified menu item. Disables the specified menu item. Enables the specified menu item. Returns the default background color for new menus. Returns the default border size for new menus. Returns the default effect for new menus. Returns a pointer to the default font used to display the menu item text of new menus. Returns the default text color for new menus. Retrieves information about the given menu item. Returns the text of the given menu item. Returns the number of items of the given menu. Returns the owner window of the given menu. Retrieves the data set with MENU_SetUserData(). Inserts a menu item. Opens a popup menu at the given position. Sets the background color of the given menu. Sets the border size of the given menu.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
620
CHAPTER
Window Objects (Widgets)
Routine MENU_SetDefaultBkColor() MENU_SetDefaultBorderSize() MENU_SetDefaultEffect() MENU_SetDefaultFont() MENU_SetDefaultTextColor() MENU_SetFont() MENU_SetItem() MENU_SetOwner() MENU_SetTextColor() MENU_SetUserData()
MENU_AddItem()
Description
Sets the default background color for new menus. Sets the default border size for new menus. Sets the default effect for new menus. Sets a pointer to the default font used to display the menu item text of new menus. Sets the default text color for new menus. Sets the font used to display the menu item text of the given menu. Changes the information about the given menu item. Sets the window to be informed by the menu. Sets the text color of the given menu. Sets the extra data of a MENU widget.
Before
After
Description
This function adds a new item to the end of the given menu.
Prototype
void MENU_AddItem(MENU_Handle hObj, const MENU_ITEM_DATA * pItemData);
Parameter hObj pItemData
Description
Handle of widget. Pointer to a MENU_ITEM_DATA structure containing the information of the new item.
Additional information
If using a menu with several submenus the Id of the menu items should be unique. Different submenus should not contain menu items with the same IDs. When adding items to a menu and no fixed sizes are used the size of the menu will be adapted. Refer to "MENU_ITEM_DATA" on page 618.
MENU_Attach()
Description
Attaches the given menu at the given position with the given size to a specified window.
Prototype
void MENU_Attach(MENU_Handle hObj, WM_HWIN hDestWin,
int
x,
int
y,
int
xSize, int
ySize,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
621
int
Flags);
Parameter hObj hDestWin x y xSize ySize Flags
Description
Handle of widget. Handle to the window to which the menu should be attached. X position in window coordinates of the menu. Y position in window coordinates of the menu. Fixed X size of the menu. For details, refer to "MENU_CreateEx()" on page 621. Fixed Y size of the menu. For details, refer to "MENU_CreateEx()" on page 621. Reserved for future use
Additional information
After creating a menu widget this function can be used to attach the menu to an existing window.
MENU_CreateEx()
Description
Creates a MENU widget of a specified size at a specified location.
Prototype
MENU_Handle MENU_CreateEx(int
x0,
int y0,
int
xSize, int ySize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xSize ySize
hParent
WinFlags ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates).
Topmost pixel of the widget (in parent coordinates).
Fixed horizontal size of the widget (in pixels). 0 if menu should handle the xSize.
Fixed vertical size of the widget (in pixels). 0 if menu should handle the ySize. Handle of parent window. If 0, the new widget will be a child of the desktop (toplevel window). In some cases it can be useful to create the menu widget in 'unattached' state and attach it later to an existing window. For this case WM_UNATTACHED can be used as parameter.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible
immediately (refer to "WM_CreateWindow()" on page 357 for a list of available parameter values). See table below.
Window ID of the widget.
Permitted values for parameter ExFlags
MENU_CF_HORIZONTAL MENU_CF_VERTICAL
Creates a horizontal menu. Creates a vertical menu.
Return value
Handle of the created MENU widget; 0 if the function fails.
Additional information
The parameters xSize and/or ySize specifies if a fixed width and/or height should be used for the menu. If these parameters are > 0, fixed sizes should be used. If for example the menu should be attached as a horizontal menu to the top of a window it can be necessary to use a fixed X size which covers the whole top of the window. In this case the parameter xSize can be used to set a fixed X size of the menu. When attaching or deleting items of a menu with a fixed size the size of the widget does not change.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
622
CHAPTER
Window Objects (Widgets)
If the values are 0, the menu handles its size itself. That means the size of the menu depends on the size of the current menu items of a menu. If items are added or removed the size of the widget will be adapted.
MENU_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
MENU_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function MENU_CreateEx() can be referred to.
MENU_DeleteItem()
Before
After
Description
Deletes a given menu entry from a menu.
Prototype
void MENU_DeleteItem(MENU_Handle hObj, U16 ItemId);
Parameter hObj ItemId
Description
Handle of widget. Id of the menu item to be deleted.
Additional information
If the item does not exist the function returns immediately. When deleting items from a menu and no fixed sizes are used the window size will be adapted.
MENU_DisableItem()
Before
After
Description
Disables the given menu item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
623
Prototype
void MENU_DisableItem(MENU_Handle hObj, U16 ItemId);
Parameter hObj ItemId
Description
Handle of widget. Id of the menu item to be disabled.
Additional information
If a disabled menu item is selected, the menu widget sends no WM_MENU message to the owner. A disabled submenu item can not be opened.
MENU_EnableItem()
Before
After
Description
Enables the given menu item.
Prototype
void MENU_EnableItem(MENU_Handle hObj, U16 ItemId);
Parameter hObj ItemId
Description
Handle of widget. Id of the menu item to be enabled.
Additional information
For details, refer to "MENU_DisableItem()" on page 622.
MENU_GetDefaultBkColor()
Description
Returns the default background color used to draw new menu items.
Prototype
GUI_COLOR MENU_GetDefaultBkColor(unsigned ColorIndex);
Parameter ColorIndex
Description
Index of color to be returned. See table below.
Permitted values for parameter ColorIndex
MENU_CI_ACTIVE_SUBMENU MENU_CI_DISABLED MENU_CI_DISABLED_SEL
MENU_CI_ENABLED
MENU_CI_SELECTED
Background color of active submenu items.
Background color of disabled menu items.
Background color of disabled and selected menu items. Background color of enabled and not selected menu items. Background color of enabled and selected menu items.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
624
CHAPTER
Window Objects (Widgets)
Return value
Default background color used to draw new menu items.
Additional information
For details, refer to "MENU_SetBkColor()" on page 627.
MENU_GetDefaultBorderSize()
Description
Returns the default border size used for new menu widgets.
Prototype
U8 MENU_GetDefaultBorderSize(unsigned BorderIndex);
Parameter BorderIndex See table below.
Description
Permitted values for parameter BorderIndex
MENU_BI_BOTTOM MENU_BI_LEFT
Border between item text and item bottom. Border between item text and left edge of item.
MENU_BI_RIGHT MENU_BI_TOP
Border between item text and right edge of item Border between item text and item top.
Return value
Default border size used for new menu widgets.
Additional information
For details, refer to "MENU_SetBorderSize()" on page 628.
MENU_GetDefaultEffect()
Description
Returns the default effect for new menus.
Prototype
const WIDGET_EFFECT * MENU_GetDefaultEffect(void);
Return value
The result of the function is a pointer to a WIDGET_EFFECT structure.
Additional information
For more information, refer to "WIDGET_SetDefaultEffect()" on page 409.
MENU_GetDefaultFont()
Description
Returns a pointer to the default font used to display the menu item text of new menus.
Prototype
const GUI_FONT * MENU_GetDefaultFont(void);
Return value
Pointer to the default font used to display the menu item text of new menus.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
625
MENU_GetDefaultTextColor()
Description
Returns the default text color for new menus.
Prototype
GUI_COLOR MENU_GetDefaultTextColor(unsigned ColorIndex);
Parameter ColorIndex
Description
Index of color to be returned. See table below.
Permitted values for parameter ColorIndex
MENU_CI_ACTIVE_SUBMENU Text color of active submenu items.
MENU_CI_DISABLED MENU_CI_DISABLED_SEL MENU_CI_ENABLED MENU_CI_SELECTED
Text color of disabled menu items.
Text color of disabled and selected menu items. Text color of enabled and not selected menu items. Text color of enabled and selected menu items.
Return value
Default text color for new menus.
Additional information
For details, refer to "MENU_SetDefaultTextColor()" on page 630.
MENU_GetItem()
Description
Retrieves information about the given menu item.
Prototype
void MENU_GetItem(MENU_Handle hObj, U16 ItemId, MENU_ITEM_DATA * pItemData);
Parameter hObj ItemId pItemData
Description
Handle of widget. Id of the requested menu item. Pointer to a MENU_ITEM_DATA structure to be filled by the function.
Additional information
If using a menu with several submenus the handle of the widget needs to be the handle of the menu/submenu containing the requested item or the handle of a higher menu/submenu. The function sets the element pText of the MENU_ITEM_INFO data structure to 0. To retrieve the menu item text the function MENU_GetItemText() should be used. Refer to the beginning of the menu chapter for details about the MENU_ITEM_INFO data structure.
MENU_GetItemText()
Description
Returns the text of the given menu item.
Prototype
void MENU_GetItemText(MENU_Handle hObj, U16
ItemId,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
626
CHAPTER
Window Objects (Widgets)
char
* pBuffer, unsigned BufferSize);
Parameter hObj ItemId pBuffer BufferSize
Description
Handle of widget. Id of the requested menu item. Buffer to be filled by the function. Maximum number of bytes to be retrieved.
MENU_GetNumItems()
Description
Returns the number of items of the given menu.
Prototype
unsigned MENU_GetNumItems(MENU_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Number of items of the given menu.
MENU_GetOwner()
Description
Returns the owner window of the given menu.
Prototype
WM_HWIN MENU_GetOwner(MENU_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Owner window of the given menu.
MENU_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
MENU_InsertItem()
Before
After
Description
Inserts a menu item at the given position.
Prototype
void MENU_InsertItem(MENU_Handle hObj, U16 ItemId,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
627
const MENU_ITEM_DATA * pItemData);
Parameter hObj ItemId pItemData
Description
Handle of widget. Id of the menu item the new item should be inserted before. Pointer to a MENU_ITEM_DATA structure containing the information of the new item.
Additional information
Refer to the beginning of the menu chapter for details about the MENU_ITEM_INFO data structure.
MENU_Popup()
Description
Opens the given menu at the given position. After selecting a menu item or after touching the display outside the menu the popup menu will be closed.
Prototype
void MENU_Popup(MENU_Handle hObj, WM_HWIN hDestWin,
int
x,
int
y,
int
xSize, int
ySize,
int
Flags);
Parameter hObj hDestWin x y xSize ySize Flags
Description
Handle of widget. Handle to the window to which the menu should be attached. X position in window coordinates of the menu. Y position in window coordinates of the menu. Fixed X size of the menu. For details, refer to "MENU_CreateEx()" on page 621. Fixed Y size of the menu. For details, refer to "MENU_CreateEx()" on page 621. Reserved for future use
Additional information
After selecting a menu item or after touching the display outside the popup menu the menu will be closed. Note that the menu will not be deleted automatically. The Sample folder contains the example WIDGET_PopupMenu.c which shows how to use the function.
MENU_SetBkColor()
Before
After
Description
Sets the background color of the given menu.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
628
CHAPTER
Window Objects (Widgets)
Prototype
void MENU_SetBkColor(MENU_Handle hObj, unsigned ColorIndex, GUI_COLOR Color);
Parameter hObj ColorIndex Color
Handle of widget. Index of color. See table below. Color to be used.
Description
Permitted values for parameter ColorIndex
MENU_CI_ACTIVE_SUBMENU MENU_CI_DISABLED MENU_CI_DISABLED_SEL
MENU_CI_ENABLED
MENU_CI_SELECTED
Background color of active submenu items.
Background color of disabled menu items.
Background color of disabled and selected menu items. Background color of enabled and not selected menu items. Background color of enabled and selected menu items.
MENU_SetBorderSize()
Before
After
The following code is executed between the screenshots above: MENU_SetBorderSize(hMenuGame, MENU_BI_LEFT, 20);
Before
After
The following code is executed between the screenshots above: MENU_SetBorderSize(hMenu, MENU_BI_LEFT, 10); MENU_SetBorderSize(hMenu, MENU_BI_RIGHT, 10);
Description
Sets the border size of the given menu.
Prototype
void MENU_SetBorderSize(MENU_Handle hObj,
unsigned BorderIndex,
U8
BorderSize);
Parameter hObj BorderIndex BorderSize
Handle of widget. See table below. Size to be used.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
629
Permitted values for parameter BorderIndex
MENU_BI_BOTTOM MENU_BI_LEFT MENU_BI_RIGHT MENU_BI_TOP
Border between item text and item bottom. Border between item text and left edge of item. Border between item text and right edge of item Border between item text and item top.
MENU_SetDefaultBkColor()
Description
Sets the default background color used to draw new menu items.
Prototype
void MENU_SetDefaultBkColor(unsigned ColorIndex, GUI_COLOR Color);
Parameter ColorIndex Color
Description
Index of color to be returned. See table below. Color to be used.
Permitted values for parameter ColorIndex
MENU_CI_ACTIVE_SUBMENU MENU_CI_DISABLED MENU_CI_DISABLED_SEL
MENU_CI_ENABLED
MENU_CI_SELECTED
Background color of active submenu items.
Background color of disabled menu items.
Background color of disabled and selected menu items. Background color of enabled and not selected menu items. Background color of enabled and selected menu items.
Additional information
For details, refer to "MENU_SetBkColor()" on page 627.
MENU_SetDefaultBorderSize()
Description
Sets the default border size used for new menu widgets.
Prototype
void MENU_SetDefaultBorderSize(unsigned BorderIndex, U8 BorderSize);
Parameter BorderIndex BorderSize
See table below. Border size to be used.
Description
Permitted values for parameter BorderIndex
MENU_BI_BOTTOM MENU_BI_LEFT MENU_BI_RIGHT MENU_BI_TOP
Border between item text and item bottom. Border between item text and left edge of item. Border between item text and right edge of item Border between item text and item top.
Additional information
For details, refer to "MENU_SetBorderSize()" on page 628.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
630
CHAPTER
Window Objects (Widgets)
MENU_SetDefaultEffect()
Description
Sets the default effect for new menus.
Prototype
void MENU_SetDefaultEffect(const WIDGET_EFFECT * pEffect);
Parameter pEffect
Description
Pointer to a WIDGET_EFFECT structure.
Additional information
For more information, refer to "WIDGET_SetDefaultEffect()" on page 409.
MENU_SetDefaultFont()
Description
Sets the pointer to the default font used to display the menu item text of new menus.
Prototype
void MENU_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description Pointer to the GUI_FONT structure to be used.
Additional information
For details, refer to "MENU_SetFont()" on page 631.
MENU_SetDefaultTextColor()
Description
Sets the default text color for new menus.
Prototype
void MENU_SetDefaultTextColor(unsigned ColorIndex, GUI_COLOR Color);
Parameter ColorIndex Color
Description
Index of color to be used. See table below. Color to be used
Permitted values for parameter ColorIndex
MENU_CI_ACTIVE_SUBMENU MENU_CI_DISABLED MENU_CI_DISABLED_SEL MENU_CI_ENABLED MENU_CI_SELECTED
Text color of active submenu items. Text color of disabled menu items. Text color of disabled and selected menu items. Text color of enabled and not selected menu items. Text color of enabled and selected menu items.
Additional information
For details, refer to "MENU_SetTextColor()" on page 632.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
MENU_SetFont()
Before
631 After
Description
Sets the pointer to the default font used to display the menu item text of new menus.
Prototype
void MENU_SetFont(MENU_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Description
Handle of widget.
Pointer to the GUI_FONT structure to be used.
MENU_SetItem()
Before
After
Description
Sets the item information for the given menu item.
Prototype
void MENU_SetItem(MENU_Handle
hObj,
U16 ItemId,
const MENU_ITEM_DATA * pItemData);
Parameter hObj ItemId pItemData
Description
Handle of widget. Id of the menu item to be changed. Pointer to a MENU_ITEM_DATA structure containing the new information.
MENU_SetOwner()
Description
Sets the owner of the menu to be informed by the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
632
CHAPTER
Window Objects (Widgets)
Prototype
void MENU_SetOwner(MENU_Handle hObj, WM_HWIN hOwner);
Parameter hObj hOwner
Description
Handle of widget. Handle of the owner window which should receive the WM_MENU messages of the menu.
Additional information
If no owner is set the parent window of the menu will receive WM_MENU messages. In some cases it makes sense to send the messages not to the parent window of the menu. In this case this function can be used to set the recipient for the WM_MENU messages.
MENU_SetSel()
Before
After
Description
Sets the selected item of the given menu.
Prototype
void MENU_SetSel(MENU_Handle hObj, int Sel);
Parameter hObj Sel
Description
Handle of widget. Zero based index of menu item to be selected.
Return value
The function returns the zero based index of the previous selected menu item.
Additional information
A value <0 for parameter Sel deselects the menu items.
MENU_SetTextColor()
Before
After
Description
Sets the text color of the given menu.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
633
Prototype
void MENU_SetTextColor(MENU_Handle hObj, unsigned ColorIndex, GUI_COLOR Color);
Parameter hObj ColorIndex Color
Description
Handle of widget. Index of color to be used. See table below. Color to be used.
Permitted values for parameter ColorIndex
MENU_CI_ACTIVE_SUBMENU MENU_CI_DISABLED MENU_CI_DISABLED_SEL MENU_CI_ENABLED MENU_CI_SELECTED
Text color of active submenu items. Text color of disabled menu items. Text color of disabled and selected menu items. Text color of enabled and not selected menu items. Text color of enabled and selected menu items.
MENU_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.17.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_Menu.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_Menu.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
634
CHAPTER
Window Objects (Widgets)
16.18 MULTIEDIT: Multi line text widget
The MULTIEDIT widget enables you to edit text with multiple lines. You can use it as a simple text editor or to display static text. The widget supports scrolling with and without scrollbars. All MULTIEDIT-related routines are in the file(s) MULTIEDIT*.c, MULTIEDIT.h. All identifiers are prefixed MULTIEDIT. The table below shows the appearance of the MULTIEDIT widget:
Description
Frame window
edit mode, automatic horizontal scrollbar, non wrapping mode, insert mode,
edit mode, automatic vertical scrollbar, word wrapping mode, overwrite mode,
read only mode, word wrapping mode
16.18.1 Configuration options
Type
Macro
S MULTIEDIT_FONT_DEFAULT N MULTIEDIT_BKCOLOR0_DEFAULT N MULTIEDIT_BKCOLOR2_DEFAULT N MULTIEDIT_TEXTCOLOR0_DEFAULT N MULTIEDIT_TEXTCOLOR2_DEFAULT
Default
Description
GUI_Font13_1 Font used.
GUI_WHITE 0xC0C0C0
Background color. Background color read only mode.
GUI_BLACK
Text color.
GUI_BLACK
Text color read only mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
635
16.18.2 Predefined IDs
The following symbols define IDs which may be used to make MULTIEDIT widgets distinguishable from creation: GUI_ID_MULTIEDIT0 - GUI_ID_MULTIEDIT3
16.18.3 Notification codes
The following events are sent from the widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT
WM_NOTIFICATION_SCROLL_CHANGED WM_NOTIFICATION_VALUE_CHANGED
Description
Widget has been clicked.
Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing. The scroll position of the optional scrollbar has been changed. The text of the widget has been changed.
16.18.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_UP GUI_KEY_DOWN GUI_KEY_RIGHT GUI_KEY_LEFT GUI_KEY_END GUI_KEY_HOME GUI_KEY_BACKSPACE
GUI_KEY_DELETE GUI_KEY_INSERT
GUI_KEY_ENTER
Reaction
Moves the cursor one line up.
Moves the cursor one line down.
Moves the cursor one character to the right.
Moves the cursor one character to the left.
Moves the cursor to the end of the current row.
Moves the cursor to the begin of the current row. If the widget works in read/write mode this key deletes the character before the cursor. If the widget works in read/write mode this key deletes the character below the cursor. Toggles between insert and overwrite mode. If the widget works in read/write mode this key inserts a new line ('\n') at the current position. If the widget works in read only mode the cursor will be moved to the beginning of the next line.
16.18.5 MULTIEDIT API
The table below lists the available emWin MULTIEDIT-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine MULTIEDIT_AddKey() MULTIEDIT_AddText() MULTIEDIT_Create() MULTIEDIT_CreateEx() MULTIEDIT_CreateIndirect()
MULTIEDIT_CreateUser()
MULTIEDIT_EnableBlink()
MULTIEDIT_GetCursorCharPos()
MULTIEDIT_GetCursorPixelPos() MULTIEDIT_GetPrompt() MULTIEDIT_GetText()
Description
Key input routine. Adds additional text at the current cursor position. Creates a MULTIEDIT widget. (Obsolete) Creates a MULTIEDIT widget. Creates a MULTIEDIT widget from a resource table entry. Creates a MULTIEDIT widget using extra bytes as user data. Enables/disables a blinking cursor. Returns the number of the character at the cursor position. Returns the pixel position of the cursor. Returns the text of the prompt. Returns the text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
636
CHAPTER
Window Objects (Widgets)
Routine MULTIEDIT_GetTextSize() MULTIEDIT_GetUserData() MULTIEDIT_SetAutoScrollH() MULTIEDIT_SetAutoScrollV() MULTIEDIT_SetBkColor() MULTIEDIT_SetBufferSize() MULTIEDIT_SetCursorOffset() MULTIEDIT_SetFont() MULTIEDIT_SetInsertMode()
MULTIEDIT_SetMaxNumChars()
MULTIEDIT_SetPasswordMode() MULTIEDIT_SetPrompt() MULTIEDIT_SetReadOnly() MULTIEDIT_SetText() MULTIEDIT_SetTextAlign() MULTIEDIT_SetTextColor() MULTIEDIT_SetUserData() MULTIEDIT_SetWrapWord() MULTIEDIT_SetWrapNone()
Description
Returns the buffer size used by the current text. Retrieves the data set with MULTIEDIT_SetUserData(). Activates automatic use of a horizontal scrollbar. Activates automatic use of a vertical scrollbar. Sets the background color. Sets the buffer size used for text and prompt. Sets the cursor to the given character. Sets the font. Enables/disables the insert mode. Sets the maximum number of characters including the prompt. Enables/disables password mode. Sets the prompt text. Enables/disables the read only mode. Sets the text. Sets the text alignment. Sets the text color, Sets the extra data of a MULTIEDIT widget. Enables/disables word wrapping. Enables/disables the non wrapping mode.
MULTIEDIT_AddKey()
Description
Adds user input to a specified multiedit widget.
Prototype
void MULTIEDIT_AddKey(MULTIEDIT_HANDLE hObj, int Key);
Parameter hObj Key
Description
Handle of the MULTIEDIT widget. Character to be added.
Additional information
The specified character is added to the user input of the multiedit widget. If the maximum count of characters has been reached, another character will not be added.
MULTIEDIT_AddText()
Description
Adds the given text at the current cursor position.
Prototype
int MULTIEDIT_AddText(MULTIEDIT_HANDLE hObj, const char * s);
Parameter hObj s
Description
Handle of the MULTIEDIT widget. Pointer to a NULL terminated text to be added.
Additional information
If the number of characters exceeds the limit set with the function MULTIEDIT_SetMaxNumChars() the function will add only the characters of the text which fit into the widget respecting the limit.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
637
MULTIEDIT_Create()
(Obsolete, MULTIEDIT_CreateEx() should be used instead)
Description
Creates a MULTIEDIT widget of a specified size at a specified location.
Prototype
MULTIEDIT_HANDLE MULTIEDIT_Create(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN
hParent, int Id,
int
Flags, int ExFlags,
const char * pText, int MaxLen);
Parameter x0 y0 xsize ysize hParent Id
Flags
ExFlags pText MaxLen
Description
Leftmost pixel of the multiedit widget (in parent coordinates). Topmost pixel of the multiedit widget (in parent coordinates). Horizontal size of the multiedit widget (in pixels). Vertical size of the multiedit widget (in pixels). Parent window of the multiedit widget. ID of the multiedit widget.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). See table below. Text to be used. Maximum number of bytes for text and prompt.
Permitted values for parameter ExFlags
MULTIEDIT_CF_AUTOSCROLLBAR_H Automatic use of a horizontal scrollbar.
MULTIEDIT_CF_AUTOSCROLLBAR_V Automatic use of a vertical scrollbar.
MULTIEDIT_CF_INSERT
Enables insert mode.
MULTIEDIT_CF_READONLY
Enables read only mode.
Return value
Handle of the created MULTIEDIT widget; 0 if the function fails.
MULTIEDIT_CreateEx()
Description
Creates a MULTIEDIT widget of a specified size at a specified location.
Prototype
MULTIEDIT_HANDLE MULTIEDIT_CreateEx(int
x0,
int y0,
int
xsize,
int ysize,
WM_HWIN
hParent, int WinFlags,
int
ExFlags, int Id,
int
BufferSize,
const char * pText);
Parameter x0 y0 xsize ysize
hParent
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new MULTIEDIT widget will be a child of the desktop (top-level window).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
638
CHAPTER
Window Objects (Widgets)
Parameter
WinFlags
ExFlags Id BufferSize pText
Description
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). See table below. Window ID of the widget.
Initial text buffer size of the widget. Use MULTIEDIT_SetMaxNumChars to set
the maximum number of characters. Text to be used.
Permitted values for parameter ExFlags
MULTIEDIT_CF_AUTOSCROLLBAR_H Automatic use of a horizontal scrollbar.
MULTIEDIT_CF_AUTOSCROLLBAR_V Automatic use of a vertical scrollbar.
MULTIEDIT_CF_INSERT
Enables insert mode.
MULTIEDIT_CF_READONLY
Enables read only mode.
Return value
Handle of the created MULTIEDIT widget; 0 if the function fails.
MULTIEDIT_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
MULTIEDIT_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function MULTIEDIT_CreateEx() can be referred to.
MULTIEDIT_EnableBlink()
Description
Enables/disables a blinking cursor.
Prototype
void MULTIEDIT_EnableBlink(MULTIEDIT_Handle hObj, int Period, int OnOff);
Parameter hObj Period OnOff
Description
Handle of the MULTIEDIT widget. Blinking period 1 enables blinking, 0 disables blinking
Additional information
This function calls GUI_X_GetTime().
MULTIEDIT_GetCursorCharPos()
Description
Returns the number of the character at the cursor position.
Prototype
int MULTIEDIT_GetCursorCharPos(MULTIEDIT_Handle hObj);
Parameter hObj
Description
Handle of the MULTIEDIT widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
639
Return value
Number of the character at the cursor position.
Additional information
The widget returns the character position if it has the focus or not. This means the cursor position is also returned, if the cursor is currently not visible in the widget.
MULTIEDIT_GetCursorPixelPos()
Description
Returns the pixel position of the cursor in window coordinates.
Prototype
void MULTIEDIT_GetCursorPixelPos(MULTIEDIT_Handle hObj,
int
* pxPos, int * pyPos);
Parameter hObj pxPos pyPos
Description
Handle of the MULTIEDIT widget. Pointer to integer variable for the X-position in window coordinates. Pointer to integer variable for the Y-position in window coordinates.
Additional information
The widget returns the pixel position if it has the focus or not. This means the cursor position is also returned, if the cursor is currently not visible in the widget.
MULTIEDIT_GetPrompt()
Description
Returns the current prompt text.
Prototype
void MULTIEDIT_GetPrompt(MULTIEDIT_HANDLE hObj, char * sDest, int MaxLen);
Parameter hObj sDest MaxLen
Description
Handle of the MULTIEDIT widget. Buffer for the prompt text to be returned. Maximum number of bytes to be copied to sDest.
Additional information
The function copies the current prompt text to the buffer given by sDest. The maximum number of bytes copied to the buffer is given by MaxLen.
MULTIEDIT_GetText()
Description
Returns the current text.
Prototype
void MULTIEDIT_GetText(MULTIEDIT_HANDLE hObj, char * sDest, int MaxLen);
Parameter hObj sDest MaxLen
Description
Handle of the MULTIEDIT widget. Buffer for the text to be returned. Maximum number of bytes to be copied to sDest.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
640
CHAPTER
Window Objects (Widgets)
Additional information
The function copies the current text to the buffer given by sDest. The maximum number of bytes copied to the buffer is given by MaxLen.
MULTIEDIT_GetTextSize()
Description
Returns the buffer size used to store the current text (and prompt).
Prototype
int MULTIEDIT_GetTextSize(MULTIEDIT_HANDLE hObj);
Parameter hObj
Description
Handle of the MULTIEDIT widget.
Return value
Buffer size used to store the current text (and prompt).
MULTIEDIT_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
MULTIEDIT_SetAutoScrollH()
Description
Enables/disables the automatic use of a horizontal scrollbar.
Prototype
void MULTIEDIT_SetAutoScrollH(MULTIEDIT_HANDLE hObj, int OnOff);
Parameter hObj OnOff
Description
Handle of the MULTIEDIT widget. See table below.
Permitted values for parameter OnOff
0
Disables automatic use of a horizontal scrollbar.
1
Enables automatic use of a horizontal scrollbar.
Additional information
Enabling the use of a automatic horizontal scrollbar makes only sense with the non wrapping mode explained later in this chapter. If enabled the multiedit widget checks if the width of the non wrapped text fits into the client area. If not a horizontal scrollbar will be attached to the window.
MULTIEDIT_SetAutoScrollV()
Description
Enables/disables the automatic use of a vertical scrollbar.
Prototype
void MULTIEDIT_SetAutoScrollV(MULTIEDIT_HANDLE hObj, int OnOff);
Parameter hObj OnOff
Description
Handle of the MULTIEDIT widget. See table below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
641
Permitted values for parameter OnOff
0
Disables automatic use of a vertical scrollbar.
1
Enables automatic use of a vertical scrollbar.
Additional information
If enabled the multiedit widget checks if the height of the text fits into the client area. If not a vertical scrollbar will be attached to the window.
MULTIEDIT_SetBkColor()
Description
Sets the background color of the given multiedit widget.
Prototype
void MULTIEDIT_SetBkColor(MULTIEDIT_HANDLE hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of the MULTIEDIT widget. See table below. Background color to be used.
Description
Permitted values for parameter Index
MULTIEDIT_CI_EDIT MULTIEDIT_CI_READONLY
Edit mode. Read only mode.
MULTIEDIT_SetBufferSize()
Description
Sets the maximum number of bytes used by text and prompt.
Prototype
void MULTIEDIT_SetBufferSize(MULTIEDIT_HANDLE hObj, int BufferSize);
Parameter hObj BufferSize
Handle of the MULTIEDIT widget. Maximum number of bytes.
Description
Additional information
The function clears the current content of the multiedit widget and allocates the given number of bytes for the text and for the prompt.
MULTIEDIT_SetCursorOffset()
Description
Sets the cursor position to the given character.
Prototype
void MULTIEDIT_SetCursorOffset(MULTIEDIT_HANDLE hObj, int Offset);
Parameter hObj Offset
Handle of the MULTIEDIT widget. New cursor position.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
642
CHAPTER
Window Objects (Widgets)
Additional information
The number of characters used for the prompt has to be added to the parameter Offset. If a prompt is used the value for parameter Offset should not be smaller than the number of characters used for the prompt.
MULTIEDIT_SetFont()
Description
Sets the font used to display the text and the prompt.
Prototype
void MULTIEDIT_SetFont(MULTIEDIT_HANDLE hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Description
Handle of the MULTIEDIT widget. Pointer to font to be used.
MULTIEDIT_SetInsertMode()
Description
Enables/disables the insert mode. The default behaviour is overwrite mode.
Prototype
void MULTIEDIT_SetInsertMode(MULTIEDIT_HANDLE hObj, int OnOff);
Parameter hObj OnOff
Description
Handle of the MULTIEDIT widget. See table below.
Permitted values for parameter OnOff
0
Disables insert mode.
1
Enables insert mode.
MULTIEDIT_SetMaxNumChars()
Description
Sets the maximum number of characters used by text and prompt.
Prototype
void MULTIEDIT_SetMaxNumChars(MULTIEDIT_HANDLE hObj, unsigned MaxNumChars);
Parameter hObj MaxNumChars
Description
Handle of the MULTIEDIT widget. Maximum number of characters.
MULTIEDIT_SetPasswordMode()
Description
Enables/disables the password mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
643
Prototype
void MULTIEDIT_SetPasswordMode(MULTIEDIT_HANDLE hObj, int OnOff);
Parameter hObj OnOff
Handle of the MULTIEDIT widget. See table below.
Description
Permitted values for parameter OnOff
0
Disables password mode.
1
Enables password mode.
Additional information
The password mode enables you to conceal the user input.
MULTIEDIT_SetPrompt()
Description
Sets the prompt text.
Prototype
void MULTIEDIT_SetPrompt(MULTIEDIT_HANDLE hObj, const char * sPrompt);
Parameter hObj sPrompt
Handle of the MULTIEDIT widget. Pointer to the new prompt text.
Description
Additional information
The prompt text is displayed first. The cursor can not be moved into the prompt.
MULTIEDIT_SetReadOnly()
Description
Enables/disables the read only mode.
Prototype
void MULTIEDIT_SetReadOnly(MULTIEDIT_HANDLE hObj, int OnOff);
Parameter hObj OnOff
Handle of the MULTIEDIT widget. See table below.
Description
Permitted values for parameter OnOff
0
Disables read only mode.
1
Enables read only mode.
Additional information
If the read only mode has been set the widget does not change the text. Only the cursor will be moved.
MULTIEDIT_SetText()
Description
Sets the text to be handled by the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
644
CHAPTER
Window Objects (Widgets)
Prototype
void MULTIEDIT_SetText(MULTIEDIT_HANDLE hObj, const char * s);
Parameter hObj s
Description
Handle of the MULTIEDIT widget. Pointer to the text to be handled by the multiedit widget.
Additional information
The function copies the given text to the buffer allocated when creating the widget or by MULTIEDIT_SetMaxSize(). The current text can be retrieved by MULTIEDIT_GetText().
MULTIEDIT_SetTextAlign()
Description
Sets the text alignment for the given MULTIEDIT widget.
Prototype
void MULTIEDIT_SetTextAlign(MULTIEDIT_HANDLE hObj, int Align);
Parameter hObj Align
Description
Handle of the MULTIEDIT widget. See table below.
Permitted values for parameter Align
GUI_TA_LEFT GUI_TA_RIGHT
Left text align. Right text align.
MULTIEDIT_SetTextColor()
Description
Sets the text color.
Prototype
void MULTIEDIT_SetTextColor(MULTIEDIT_HANDLE hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of the MULTIEDIT widget. See table below. Text color to be used.
Permitted values for parameter Index
MULTIEDIT_CI_EDIT MULTIEDIT_CI_READONLY
Edit mode. Read only mode.
MULTIEDIT_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
MULTIEDIT_SetWrapWord()
Description
Enables the word wrapping mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
645
Prototype
void MULTIEDIT_SetWrapWord(MULTIEDIT_HANDLE hObj);
Parameter hObj
Description
Handle of the MULTIEDIT widget.
Additional information
If the word wrapping mode has been set the text at the end of a line will be wrapped at the beginning of the last word (if possible).
MULTIEDIT_SetWrapNone()
Description
Enables the non wrapping mode.
Prototype
void MULTIEDIT_SetWrapNone(MULTIEDIT_HANDLE hObj);
Parameter hObj
Description
Handle of the MULTIEDIT widget.
Additional information
'Non wrapping' means line wrapping would be done only at new lines. If the horizontal size of the text exceeds the size of the client area the text will be scrolled.
16.18.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_MultiEdit.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with it.
Screenshot of WIDGET_Multiedit.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
646
CHAPTER
Window Objects (Widgets)
16.19 MULTIPAGE: Multiple page widget
A MULTIPAGE widget is analogous to the dividers in a notebook or the labels in a file cabinet. By using a MULTIPAGE widget, an application can define multiple pages for the same area of a window or dialog box. Each page consists of a certain type of information or a group of widgets that the application displays when the user selects the corresponding page. To select a page the tab of the page has to be clicked. If not all tabs can be displayed, the MULTIPAGE widget automatically shows a small scrollbar at the edge to scroll the pages. The Sample folder contains the file WIDGET_Multipage.c which shows how to create and use the MULTIPAGE widget. The table below shows the appearance of the MULTIPAGE widget:
Description
MULTIPAGE widget
MULTIPAGE widget with 3 pages, alignment top/left.
MULTIPAGE widget with 6 pages, alignment bottom/right.
Structure of MULTIPAGE widget
A MULTIPAGE widget with n pages consists of n+2 windows: · 1 MULTIPAGE window · 1 Client window · n Page windows The page windows will be added to the client window of the widget. The diagram at the right side shows the structure of the widget.
MULTIPAGE window
Client window
Page window 1 ...
Page window n
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
647
16.19.1 Configuration options
Type
Macro
N MULTIPAGE_ALIGN_DEFAULT
N MULTIPAGE_BKCOLOR0_DEFAULT
N MULTIPAGE_BKCOLOR1_DEFAULT
S MULTIPAGE_FONT_DEFAULT
N MULTIPAGE_TEXTCOLOR0_DEFAULT
N MULTIPAGE_TEXTCOLOR1_DEFAULT
Default
Description
MULTIPAGE_ALIGN_LEFT | MULTIPAGE_ALIGN_TOP
Default
alignment.
0xD0D0D0
Default background color of pages in disabled state.
0xC0C0C0
Default background color of pages in enabled state.
&GUI_Font13_1
Default font used by the widget.
0x808080
Default text color of pages in disabled state.
0x000000
Default text color of pages in enabled state.
16.19.2 Predefined IDs
The following symbols define IDs which may be used to make MULTIPAGE widgets distinguishable from creation: GUI_ID_MULTIPAGE0 - GUI_ID_MULTIPAGE3
16.19.3 Notification codes
The following events are sent from the widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_VALUE_CHANGED
Description
Widget has been clicked. Widget has been released. Widget has been clicked and pointer has been moved out of the widget without releasing. The text of the widget has been changed.
16.19.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_PGUP GUI_KEY_PGDOWN
Reaction
Switches to the next page. Switches to the previous page.
16.19.5 MULTIPAGE API
The table below lists the available emWin MULTIPAGE-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine MULTIPAGE_AddPage() MULTIPAGE_CreateEx() MULTIPAGE_CreateIndirect()
MULTIPAGE_CreateUser() MULTIPAGE_DeletePage() MULTIPAGE_DisablePage() MULTIPAGE_EnablePage() MULTIPAGE_GetDefaultAlign() MULTIPAGE_GetDefaultBkColor()
Description
Adds a page to a MULTIPAGE widget.
Creates a MULTIPAGE widget. Creates a MULTIPAGE widget from a resource table entry. Creates a MULTIPAGE widget using extra bytes as user data. Deletes a page from a MULTIPAGE widget.
Disables a page from a MULTIPAGE widget.
Enables a page from a MULTIPAGE widget.
Returns the default alignment for MULTIPAGE widgets. Returns the default background color for MULTIPAGE widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
648
CHAPTER
Window Objects (Widgets)
Routine MULTIPAGE_GetDefaultFont() MULTIPAGE_GetDefaultTextColor() MULTIPAGE_GetSelection() MULTIPAGE_GetUserData() MULTIPAGE_GetWindow() MULTIPAGE_IsPageEnabled() MULTIPAGE_SelectPage() MULTIPAGE_SetAlign() MULTIPAGE_SetBkColor() MULTIPAGE_SetDefaultAlign()
MULTIPAGE_SetDefaultBkColor() MULTIPAGE_SetDefaultFont() MULTIPAGE_SetDefaultTextColor() MULTIPAGE_SetFont() MULTIPAGE_SetRotation() MULTIPAGE_SetText() MULTIPAGE_SetTextColor() MULTIPAGE_SetUserData()
MULTIPAGE_AddPage()
Before
Description
Returns the default font used for MULTIPAGE widgets. Returns the default text color used for MULTIPAGE widgets. Returns the current selection. Retrieves the data set with MULTIPAGE_SetUserData(). Returns the window handle of a given page. Returns if a given page is enabled or not. Selects the given page. Sets the alignment for the tabs. Sets the background color. Sets the default alignment for new MULTIPAGE widgets. Sets the default background color for new MULTIPAGE widgets. Sets the default font used by new MULTIPAGE widgets. Sets the default text color used by new MULTIPAGE widgets. Selects the font for the widget. Sets the rotation mode for the widget. Sets the text displayed in a tab of a MULTIPAGE widget. Sets the text color. Sets the extra data of a MULTIPAGE widget.
After
Description
Adds a new page to a given MULTIPAGE widget.
Prototype
void MULTIPAGE_AddPage(MULTIPAGE_Handle hObj, WM_HWIN hWin ,
const char
* pText);
Parameter hObj hWin pText
Description
Handle of MULTIPAGE widget. Handle of window to be shown in the given page. Pointer to text to be displayed in the tab of the page.
Additional information
It is recommended, that all windows added to a MULTIPAGE widget handle the complete client area of the MULTIPAGE widget when processing the WM_PAINT message.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
649
MULTIPAGE_CreateEx()
Description
Creates a MULTIPAGE widget of a specified size at a specified position.
Prototype
MULTIPAGE_Handle MULTIPAGE_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
X-position of the widget (in parent coordinates). Y-position of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible
immediately (refer to "WM_CreateWindow()" on page 357 for a list of available parameter values). Not used yet, reserved for future use. Window ID of the widget.
Return value
Handle of the new widget.
Additional information
The size of the tabs depends on the size of the font used for the MULTIPAGE widget.
MULTIPAGE_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect().
MULTIPAGE_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function MULTIPAGE_CreateEx() can be referred to.
MULTIPAGE_DeletePage()
Before
After
Description
Removes a page from a MULTIPAGE widget and optional deletes the window.
Prototype
void MULTIPAGE_DeletePage(MULTIPAGE_Handle hObj, unsigned Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
650
CHAPTER
Window Objects (Widgets)
int
Delete);
Parameter hObj Index Delete
Description
Handle of MULTIPAGE widget. Zero based index of the page to be removed from the MULTIPAGE widget. If >0 the window attached to the page will be deleted.
MULTIPAGE_DisablePage()
Before
After
Description
Disables a page from a MULTIPAGE widget.
Prototype
void MULTIPAGE_DisablePage(MULTIPAGE_Handle hObj, unsigned Index);
Parameter hObj Index
Description
Handle of MULTIPAGE widget. Zero based index of the page to be disabled.
Additional information
A disabled page of a window can not be selected by clicking the tab of the page. The default state of MULTIEDIT pages is 'enabled'.
MULTIPAGE_EnablePage()
Before
After
Description
Enables a page of a MULTIPAGE widget.
Prototype
void MULTIPAGE_EnablePage(MULTIPAGE_Handle hObj, unsigned Index);
Parameter hObj
Handle of MULTIPAGE widget.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
651
Additional information
The default state of MULTIEDIT pages is 'enabled'.
MULTIPAGE_GetDefaultAlign()
Description
Returns the default tab alignment for new MULTIPAGE widgets.
Prototype
unsigned MULTIPAGE_GetDefaultAlign(void);
Return value
Default tab alignment for new MULTIPAGE widgets.
Additional information
The following table shows the alignment values returned by this function:
Alignment
Appearance of MULTIPAGE widget
MULTIPAGE_ALIGN_LEFT | MULTIPAGE_ALIGN_TOP
MULTIPAGE_ALIGN_RIGHT | MULTIPAGE_ALIGN_TOP
MULTIPAGE_ALIGN_LEFT | MULTIPAGE_ALIGN_BOTTOM
MULTIPAGE_ALIGN_RIGHT | MULTIPAGE_ALIGN_BOTTOM
MULTIPAGE_GetDefaultBkColor()
Description
Returns the default background color for new MULTIPAGE widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
652
CHAPTER
Window Objects (Widgets)
Prototype
GUI_COLOR MULTIPAGE_GetDefaultBkColor(unsigned Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
0
Returns the default background color for pages in disabled state.
1
Returns the default background color for pages in enabled state.
Return value
Default background color for new MULTIPAGE widgets.
MULTIPAGE_GetDefaultFont()
Description
Returns a pointer to the font used to display the text in the tabs of new MULTIPAGE widgets.
Prototype
const GUI_FONT * MULTIPAGE_GetDefaultFont(void);
Return value
Pointer to the font used to display the text in the tabs of new MULTIPAGE widgets.
MULTIPAGE_GetDefaultTextColor()
Description
Returns the default text color used to display the text in the tabs of new MULTIPAGE widgets.
Prototype
GUI_COLOR MULTIPAGE_GetDefaultTextColor(unsigned Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
0
Returns the default text color for pages in disabled state.
1
Returns the default text color for pages in enabled state.
Return value
Default text color used to display the text in the tabs of new MULTIPAGE widgets.
MULTIPAGE_GetSelection()
Description
Returns the zero based index of the currently selected page of a MULTIPAGE widget.
Prototype
int MULTIPAGE_GetSelection(MULTIPAGE_Handle hObj);
Parameter hObj
Handle of MULTIPAGE widget.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
653
Return value
Zero based index of the currently selected page of a MULTIPAGE widget.
MULTIPAGE_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
MULTIPAGE_GetWindow()
Description
Returns the handle of the window displayed in the given page.
Prototype
WM_HWIN MULTIPAGE_GetWindow(MULTIPAGE_Handle hObj, unsigned Index);
Parameter hObj Index
Handle of MULTIPAGE widget. Zero based index of page.
Description
Return value
Handle of the window displayed in the given page.
MULTIPAGE_IsPageEnabled()
Description
Returns if the given page of a MULTIEDIT widget is enabled or not.
Prototype
int MULTIPAGE_IsPageEnabled (MULTIPAGE_Handle hObj, unsigned Index);
Parameter hObj Index
Description
Handle of MULTIPAGE widget. Zero based index of requested page.
Return value
1 if the given page is enabled, otherwise 0.
MULTIPAGE_SelectPage()
Before
After
Description
Sets the currently selected page of a MULTIPAGE widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
654
CHAPTER
Window Objects (Widgets)
Prototype
void MULTIPAGE_SelectPage(MULTIPAGE_Handle hObj, unsigned Index);
Parameter hObj Index
Description
Handle of MULTIPAGE widget. Zero based index of page to be selected.
MULTIPAGE_SetAlign()
Before
After
Description
Sets the tab alignment for the given MULTIPAGE widget.
Prototype
void MULTIPAGE_SetAlign(MULTIPAGE_Handle hObj, unsigned Align);
Parameter hObj Align
Handle of MULTIPAGE widget. See table below.
Description
Permitted values for parameter Index (horizontal and vertical flags are OR-combinable)
MULTIPAGE_ALIGN_BOTTOM MULTIPAGE_ALIGN_LEFT MULTIPAGE_ALIGN_RIGHT MULTIPAGE_ALIGN_TOP
Aligns the tabs at the right side. Aligns the tabs at the left side. Aligns the tabs at the top of the widget. Aligns the tabs at the bottom of the widget.
Additional information
For more information, refer to "MULTIPAGE_GetDefaultAlign()" on page 651.
MULTIPAGE_SetBkColor()
Before
After
Description
Sets the background color of the given MULTIPAGE widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
655
Prototype
void MULTIPAGE_SetBkColor(MULTIPAGE_Handle hObj, GUI_COLOR Color,
unsigned
Index);
Parameter hObj Color Index
Handle of MULTIPAGE widget. Color to be used. See table below.
Description
Permitted values for parameter Index MULTIPAGE_CI_DISABLED Sets the default text color for disabled pages. MULTIPAGE_CI_ENABLED Sets the default text color for enabled pages.
Additional information
The function only sets the background color for the MULTIPAGE widget. The child windows added to the widget are not affected. That means if the complete client area is drawn by windows added to the widget, only the background color of the tabs changes.
MULTIPAGE_SetDefaultAlign()
Description
Sets the default tab alignment for new MULTIPAGE widgets.
Prototype
void MULTIPAGE_SetDefaultAlign(unsigned Align);
Parameter Align
Description
Tab alignment used for new MULTIPAGE widgets.
Additional information
For more informations about the tab alignment, refer to "MULTIPAGE_GetDefaultAlign()" on page 651 and "MULTIPAGE_SetAlign()" on page 654.
MULTIPAGE_SetDefaultBkColor()
Description
Sets the default background color used for new MULTIPAGE widgets.
Prototype
void MULTIPAGE_SetDefaultBkColor(GUI_COLOR Color, unsigned Index);
Parameter Color Index
Color to be used. See table below.
Description
Permitted values for parameter Index
0
Sets the default background color for pages in disabled state.
1
Sets the default background color for pages in enabled state.
MULTIPAGE_SetDefaultFont()
Description
Sets the default font used to display the text in the tabs of new MULTIPAGE widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
656
CHAPTER
Window Objects (Widgets)
Prototype
void MULTIPAGE_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to GUI_FONT structure to be used.
Additional information
The horizontal and vertical size of the tabs depends on the size of the used font.
MULTIPAGE_SetDefaultTextColor()
Description
Sets the default text color used to display the text in the tabs of new MULTIPAGE widgets.
Prototype
void MULTIPAGE_SetDefaultTextColor(GUI_COLOR Color, unsigned Index);
Parameter Color Index
Color to be used. See table below.
MULTIPAGE_SetFont()
Description
Before
After
Description
Sets the font used to display the text in the tabs of a given MULTIPAGE widget.
Prototype
void MULTIPAGE_SetFont(MULTIPAGE_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Description
Handle of MULTIPAGE widget. Pointer to GUI_FONT structure used to display the text in the tabs.
Additional information
The vertical and horizontal size of the tabs depend on the size of the used font and the text shown in the tabs.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
MULTIPAGE_SetRotation()
Before
657 After
Description
Sets the rotation mode of the given widget.
Prototype
void MULTIPAGE_SetRotation(MULTIPAGE_Handle hObj, unsigned Rotation);
Parameter hObj Rotation
Handle of MULTIPAGE widget. Rotation mode. See table below.
Description
Permitted values for parameter Index
MULTIPAGE_CF_ROTATE_CW
Arranges the tabs at the vertical side and rotates the tab text by 90 degrees clockwise.
0
Default horizontal mode.
MULTIPAGE_SetText()
Before
After
Description
Sets the text displayed in the tab of a given page.
Prototype
void MULTIPAGE_SetText(MULTIPAGE_Handle hObj, const char * pText,
unsigned
Index);
Parameter hObj pText Index
Description
Handle of MULTIPAGE widget. Pointer to the text to be displayed. Zero based index of the page.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
658
MULTIPAGE_SetTextColor()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the color used to display the text in the tabs of a MULTIPAGE widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
659
Prototype
void MULTIPAGE_SetTextColor(MULTIPAGE_Handle hObj, GUI_COLOR Color,
unsigned
Index);
Parameter hObj Color Index
Handle of MULTIPAGE widget. Color to be used. See table below.
Description
Permitted values for parameter Index
0
Sets the text color for pages in disabled state.
1
Sets the text color for pages in enabled state.
MULTIPAGE_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.19.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_Multipage.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_Multipage.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
660
CHAPTER
Window Objects (Widgets)
16.20 PROGBAR: Progress bar widget
Progress bars are commonly used in applications for visualization; for example, a tank fill-level indicator or an oil-pressure indicator. Example screenshots can be found at the beginning of the chapter and at end of this section. All PROGBAR-related routines are in the file(s) PROGBAR*.c, PROGBAR.h. All identifiers are prefixed PROGBAR.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.20.1 Configuration options
Type
Macro
Default
Description
S PROGBAR_DEFAULT_FONT
GUI_DEFAULT_FONT Font used.
N
PROGBAR_DEFAULT_BARCOLOR0 0x555555 (dark gray) Left bar color.
N
PROGBAR_DEFAULT_BARCOLOR1 0xAAAAAA (light gray) Right bar color.
N
PROGBAR_DEFAULT_TEXTCOLOR0 0xFFFFFF
Text color, left bar.
N
PROGBAR_DEFAULT_TEXTCOLOR1 0x000000
Text color, right bar.
16.20.2 Predefined IDs
The following symbols define IDs which may be used to make PROGBAR widgets distinguishable from creation: GUI_ID_PROGBAR0 - GUI_ID_PROGBAR3
16.20.3 Keyboard reaction
The widget can not gain the input focus and does not react on keyboard input.
16.20.4 PROGBAR API
The table below lists the available emWin PROGBAR-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine PROGBAR_Create() PROGBAR_CreateAsChild() PROGBAR_CreateEx() PROGBAR_CreateIndirect() PROGBAR_CreateUser() PROGBAR_GetUserData() PROGBAR_SetBarColor() PROGBAR_SetFont() PROGBAR_SetMinMax() PROGBAR_SetText() PROGBAR_SetTextAlign() PROGBAR_SetTextColor() PROGBAR_SetTextPos() PROGBAR_SetUserData()
PROGBAR_SetValue()
Description
Creates a PROGBAR widget. (Obsolete) Creates a PROGBAR widget as a child window. (Obsolete) Creates a PROGBAR widget. Creates a PROGBAR widget from resource table entry. Creates a PROGBAR widget using extra bytes as user data. Retrieves the data set with PROGBAR_SetUserData(). Sets the color(s) for the bar. Select the font for the text. Set the minimum and maximum values used for the bar. Set the (optional) text for the bar graph. Set text alignment (default is centered). Set the color(s) for the text. Set the text position (default 0,0). Sets the extra data of a PROGBAR widget. Set the value for the bar graph (and percentage if no text has been assigned).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
661
PROGBAR_Create()
(Obsolete, PROGBAR_CreateEx() should be used instead)
Description
Creates a PROGBAR widget of a specified size at a specified location.
Prototype
PROGBAR_Handle PROGBAR_Create(int x0, int y0, int xsize, int ysize, int Flags);
Parameter x0 y0 xsize ysize
Flags
Description
Leftmost pixel of the progress bar (in parent coordinates). Topmost pixel of the progress bar (in parent coordinates). Horizontal size of the progress bar (in pixels). Vertical size of the progress bar (in pixels).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values).
Return value
Handle of the created PROGBAR widget; 0 if the function fails.
PROGBAR_CreateAsChild()
(Obsolete, PROGBAR_CreateEx should be used instead)
Description
Creates a PROGBAR widget as a child window.
Prototype
PROGBAR_Handle PROGBAR_CreateAsChild(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int Id,
int
Flags);
Parameter x0 y0 xsize ysize hParent Id Flags
Description
X-position of the progress bar relative to the parent window. Y-position of the progress bar relative to the parent window. Horizontal size of the progress bar (in pixels). Vertical size of the progress bar (in pixels). Handle of parent window. ID to be returned.
Window create flags (see PROGBAR_Create()).
Return value
Handle of the created PROGBAR widget; 0 if the function fails.
PROGBAR_CreateEx()
Description
Creates a PROGBAR widget of a specified size at a specified location.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
662
CHAPTER
Window Objects (Widgets)
Prototype
PROGBAR_Handle PROGBAR_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new PROGBAR widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). See table below. Window ID of the widget.
Permitted values for parameter ExFlags PROGBAR_CF_VERTICAL A vertical progress bar will be created. PROGBAR_CF_HORIZONTAL A horizontal progress bar will be created.
Return value
Handle of the created PROGBAR widget; 0 if the function fails.
PROGBAR_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
PROGBAR_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function PROGBAR_CreateEx() can be referred to.
PROGBAR_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
PROGBAR_SetBarColor()
Description
Sets the color(s) of the progress bar.
Prototype
void PROGBAR_SetBarColor(PROGBAR_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of progress bar. See table below. Other values are not permitted. Color to set (24-bit RGB value).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
663
Permitted values for parameter Index
0
Left portion of the progress bar.
1
Right portion of the progress bar.
PROGBAR_SetFont()
Description
Selects the font for the text display inside the progress bar.
Prototype
void PROGBAR_SetFont(PROGBAR_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle of progress bar. Pointer to the font.
Description
Additional information
If this function is not called, the default font for progress bars (the GUI default font) will be used. However, the progress bar default font may be changed in the GUIConf.h file. Simply #define the default font as follows (example): #define PROGBAR_DEFAULT_FONT &GUI_Font13_ASCII
PROGBAR_SetMinMax()
Description
Sets the minimum and maximum values used for the progress bar.
Prototype
void PROGBAR_SetMinMax(PROGBAR_Handle hObj, int Min, int Max);
Parameter hObj Min Max
Description
Handle of progress bar. Minimum value (Range: -16383 < Min <= 16383). Maximum value (Range: -16383 < Max <= 16383)
Additional information
If this function is not called, the default values of Min = 0, Max = 100 will be used.
PROGBAR_SetText()
Description
Sets the text displayed inside the progress bar.
Prototype
void PROGBAR_SetText(PROGBAR_Handle hObj, const char * s);
Parameter hObj s
Description
Handle of progress bar. Text to display. A NULL pointer is permitted; in this case a percentage value will be displayed.
Additional information
If this function is not called, a percentage value will be displayed as the default. If you do not want to display any text at all, you should set an empty string.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
664
CHAPTER
Window Objects (Widgets)
PROGBAR_SetTextAlign()
Description
Sets the text alignment.
Prototype
void PROGBAR_SetTextAlign(PROGBAR_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of progress bar. Horizontal alignment attribute for the text. See table below.
Permitted values for parameter Align
GUI_TA_HCENTER Centers the title (default).
GUI_TA_LEFT GUI_TA_RIGHT
Displays the title to the left. Displays the title to the right.
Additional information
If this function is not called, the default behavior is to display the text centered.
PROGBAR_SetTextColor()
Description
Sets the text color of the progress bar.
Prototype
void PROGBAR_SetTextColor(PROGBAR_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of progress bar. See table below. Other values are not permitted. Color to set (24-bit RGB value).
Permitted values for parameter Index
0
Left portion of the text.
1
Right portion of the text.
PROGBAR_SetTextPos()
Description
Sets the text position in pixels.
Prototype
void PROGBAR_SetTextPos(PROGBAR_Handle hObj, int XOff, int YOff);
Parameter hObj XOff
YOff
Description
Handle of progress bar. Number of pixels to move text in horizontal direction. Positive number will move text to the right. Number of pixels to move text in vertical direction. Positive number will move text down.
Additional information
The values move the text the specified number of pixels within the widget. Normally, the default of (0,0) should be sufficient.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
665
PROGBAR_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
PROGBAR_SetValue()
Description
Sets the value of the progress bar.
Prototype
void PROGBAR_SetValue(PROGBAR_Handle hObj, int v);
Parameter hObj v
Handle of progress bar. Value to set.
Description
Additional information
The bar indicator will be calculated with regard to the max/min values. If a percentage is automatically displayed, the percentage will also be calculated using the given min/max values as follows: p = 100% * (v-Min)/(Max-Min) The default value after creation of the widget is 0.
16.20.5 Examples
The Sample folder contains the following examples which show how the widget can be used: · WIDGET_SimpleProgbar.c · WIDGET_Progbar.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of WIDGET_SimpleProgbar.c:
Screenshot of WIDGET_Progbar.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
666
CHAPTER
Window Objects (Widgets)
16.21 RADIO: Radio button widget
Radio buttons, like check boxes, are used for selecting choices. A dot appears when a radio button is turned on or selected. The difference from check boxes is that the user can only select one radio button at a time. When a button is selected, the other buttons in the widget are turned off, as shown to the right. One radio button widget may contain any number of buttons, which are always arranged vertically. All RADIO-related routines are located in the file(s) RADIO*.c, RADIO.h. All identifiers are prefixed RADIO. The table below shows the default appearances of a RADIO button:
Selected
Unselected
Enabled
Disabled
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.21.1 Configuration options
Type
Macro
Default
Description
S RADIO_IMAGE0_DEFAULT
(see
table
above)
Default outer image abled radio button.
used
to
show
a
dis-
S RADIO_IMAGE1_DEFAULT
(see
table
above)
Default outer image used enabled radio button.
to
show
a
S
RADIO_IMAGE_CHECK_DEFAULT
(see
table
above)
Default inner image selected item.
used
to
mark
the
N RADIO_FONT_DEFAULT
&GUI_Font13_1
Default font used to render the radio button text.
N
RADIO_DEFAULT_TEXT_COLOR GUI_BLACK
N RADIO_DEFAULT_BKCOLOR
0xC0C0C0
N
RADIO_FOCUSCOLOR_DEFAULT GUI_BLACK
Default text color of radio button text.
Default background color of radio buttons if no transparency is used. Default color for rendering the focus rectangle.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
667
16.21.2 Predefined IDs
The following symbols define IDs which may be used to make RADIO widgets distinguishable from creation: GUI_ID_RADIO0 - GUI_ID_RADIO7
16.21.3 Notification codes
The following events are sent from a radio button widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_VALUE_CHANGED
Description
Radio button has been clicked. Radio button has been released. Radio button has been clicked and pointer has been moved out of the button without releasing. Value (selection) of the radio button widget has changed.
16.21.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_RIGHT GUI_KEY_DOWN GUI_KEY_LEFT GUI_KEY_UP
Reaction
Increments the selection by 1. Increments the selection by 1. Decrements the selection by 1. Decrements the selection by 1.
16.21.5 RADIO API
The table below lists the available emWin RADIO-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine RADIO_Create() RADIO_CreateEx() RADIO_CreateIndirect() RADIO_CreateUser() RADIO_Dec()
RADIO_GetDefaultFont()
RADIO_GetDefaultTextColor()
RADIO_GetText() RADIO_GetUserData() RADIO_GetValue() RADIO_Inc() RADIO_SetBkColor() RADIO_SetDefaultFocusColor()
RADIO_SetDefaultFont()
RADIO_SetDefaultImage()
RADIO_SetDefaultTextColor()
RADIO_SetFocusColor() RADIO_SetFont() RADIO_SetGroupId() RADIO_SetImage()
Description
Creates a RADIO widget. (Obsolete) Creates a RADIO widget. Creates a RADIO widget from resource table entry. Creates a RADIO widget using extra bytes as user data. Decrement the button selection by a value of 1. Returns the default font used to show the text of new radio buttons. Returns the default text color used to show the text of new radio buttons. Returns the text of a radio button item. Retrieves the data set with RADIO_SetUserData(). Return the current button selection. Increment the button selection by a value of 1. Sets the background color of the radio button. Sets the default focus rectangle color for new radio buttons. Sets the default font used to show the text of new radio buttons. Sets the images to be used for new radio buttons. Sets the default text color used to show the text of new radio buttons. Sets the color of the focus rectangle. Sets the font used to show the text of the radio button. Sets the group Id of the given radio widget. Sets the images used to display the radio button.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
668
CHAPTER
Window Objects (Widgets)
Routine RADIO_SetText() RADIO_SetTextColor() RADIO_SetUserData() RADIO_SetValue()
Description
Sets the text Sets the text color used to show the text of radio button. Sets the extra data of a RADIO widget. Set the button selection.
RADIO_Create()
(Obsolete, RADIO_CreateEx() should be used instead)
Description
Creates a RADIO widget of a specified size at a specified location.
Prototype
RADIO_Handle RADIO_Create(int
x0,
int
y0,
int
xsize, int
ysize,
WM_HWIN hParent, int
Id,
int
Flags, unsigned Para);
Parameter x0 y0 xsize ysize hParent Id
Flags
Para
Description
Leftmost pixel of the radio button widget (in parent coordinates). Topmost pixel of the radio button widget (in parent coordinates). Horizontal size of the radio button widget (in pixels). Vertical size of the radio button widget (in pixels). Handle of parent window. ID to be returned.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Number of buttons in the group.
Return value
Handle of the created RADIO widget; 0 if the function fails.
RADIO_CreateEx()
Description
Creates a RADIO widget of a specified size at a specified location.
Prototype
RADIO_Handle RADIO_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id,
int
NumItems, int Spacing);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new RADIO widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Not used, reserved for future use.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
669
Parameter
Description
Id
Window ID of the widget.
NumItems
Number of items contained by the radio widget. (default is 2)
Spacing
Number of vertical pixels used for each item of the radio widget.
Return value
Handle of the created RADIO widget; 0 if the function fails.
Additional information
If creating a radio widget make sure, that the given ysize is enough to show all items. The value should be at least NumItems * Spacing. If the given value of NumItems is <= 0 a default value of 2 is used.
RADIO_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The element Flags of the resource passed as parameter is not used. The following table shows the use of the resource element Para:
Bits 0- 7 8 - 15 16 - 23 24 - 31
Description
Number of items of the radio widget. If 0, a default value of 2 items is used. Number of vertical pixels used for each item. If 0 the height of the default image is used. Not used, reserved for future use. Not used, reserved for future use.
RADIO_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function RADIO_CreateEx() can be referred to.
RADIO_Dec()
Before
After
Description
Decrements the selection by a value of 1.
Prototype
void RADIO_Dec(RADIO_Handle hObj);
Parameter hObj
Handle of radio button widget.
Description
Additional information
Note that the numbering of the buttons always starts from the top with a value of 0; therefore, decrementing the selection will actually move the selection one button up.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
670
CHAPTER
Window Objects (Widgets)
RADIO_GetDefaultFont()
Description
Returns the default font used to display the optional text next to new radio buttons.
Prototype
const GUI_FONT * RADIO_GetDefaultFont(void);
Return value
Default font used to display the optional text next to the radio buttons.
Additional information
For information about how to add text to a radio widget, refer to "RADIO_SetText()" on page 676.
RADIO_GetDefaultTextColor()
Description
Returns the default text color used to display the optional text next to new radio buttons.
Prototype
GUI_COLOR RADIO_GetDefaultTextColor (void);
Return value
Default text color used to display the optional text next to new radio buttons.
Additional information
For information about how to add text to a radio widget, refer to "RADIO_SetText()" on page 676.
RADIO_GetText()
Description
Returns the optional text of the given radio button.
Prototype
int RADIO_GetText(RADIO_Handle hObj, unsigned Index,
char
* pBuffer, int
MaxLen);
Parameter hObj Index pBuffer MaxLen
Description
Handle of widget. Index of the desired item. Pointer to buffer to which the text will be copied. Buffer size in bytes.
Return value
Length of the text copied into the buffer.
Additional information
If the desired item of the radio button contains no text the function returns 0 and the buffer remains unchanged.
RADIO_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
671
RADIO_GetValue()
Description
Returns the current button selection.
Prototype
void RADIO_GetValue(RADIO_Handle hObj);
Parameter hObj
Handle of radio button widget.
Description
Return value
The value of the currently selected button. If no button is selected (in case of using a radio button group) the return value is -1.
Additional information
For information about how to use groups of radio buttons, refer to "RADIO_SetGroupID()" on page 675.
RADIO_Inc()
Before
After
Description
Increments the selection by a value of 1.
Prototype
void RADIO_Inc(RADIO_Handle hObj);
Parameter hObj
Handle of radio button widget.
Description
Additional information
Note that the numbering of the buttons always starts from the top with a value of 0; therefore, incrementing the selection will actually move the selection one button down.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
672
RADIO_SetBkColor()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the background color of the radio widget.
Prototype
void RADIO_SetBkColor(RADIO_Handle hObj, GUI_COLOR Color);
Parameter hObj
Color
Description
Handle of radio button widget. Color to be used for the background. (range 0x000000 and 0xFFFFFF or a valid color define) GUI_INVALID_COLOR to make background transparent
Additional information
The background of this widget can either be filled with any available color or transparent. If a valid RGB color is specified, the background is filled with the color, otherwise the background (typically the content of the parent window) is visible. If the background is transparent, the widget is treated as transparent window, otherwise as non-transparent window. Note that using a background color allows more efficient (faster) rendering.
RADIO_SetDefaultFocusColor()
Description
Sets the default focus rectangle color for new radio buttons.
Prototype
GUI_COLOR RADIO_SetDefaultFocusColor(GUI_COLOR Color);
Parameter Color
Description
Default color to be used for new radio buttons.
Return value
Previous default focus rectangle color.
Additional information
For more information, refer to "RADIO_SetFocusColor()" on page 674.
RADIO_SetDefaultFont()
Description
Sets the default font used to display the optional text next to new radio buttons.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
673
Prototype
void RADIO_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to GUI_FONT structure used to show the text of new radio widgets.
Additional information
For information about how to add text to a radio widget, refer to "RADIO_SetText()" on page 676.
RADIO_SetDefaultImage()
Description
Sets the images used to draw new radio buttons.
Prototype
void RADIO_SetDefaultImage(const GUI_BITMAP * pBitmap, unsigned int Index);
Parameter pBitmap Index
Pointer to the bitmap. See table below.
Description
Permitted values for parameter Index
RADIO_BI_INACTIV Outer image used to show a disabled radio button.
RADIO_BI_ACTIV
Outer image used to show a enabled radio button.
RADIO_BI_CHECK
Inner image used to mark the selected item.
Additional information
Two images are used to display a radio button. One image is used to draw the outer frame used to display a unselected radio button. In dependence of the current state it will be the bitmap referenced by RADIO_BI_ACTIV (default) or by RADIO_BI_ACTIV. The second image (referenced by RADIO_BI_CHECK) is used to mark the currently selected button.
RADIO_SetDefaultTextColor()
Description
Sets the default text color used to display the optional text next to new radio buttons.
Prototype
void RADIO_SetDefaultTextColor(GUI_COLOR TextColor);
Parameter TextColor
New color to be used.
Description
Additional information
For information about how to add text to a radio widget, refer to "RADIO_SetText()" on page 676.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
674
RADIO_SetFocusColor()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the color used to render the focus rectangle of the radio button.
Prototype
GUI_COLOR RADIO_SetFocusColor(RADIO_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Description
Handle of widget. Color to be used for the focus rectangle.
Return value
Previous color of the focus rectangle.
Additional information
The focus rectangle is only visible if the widget has the input focus.
RADIO_SetFont()
Before
After
Description
Sets the font used to display the optional text next to the radio button.
Prototype
void RADIO_SetFont(RADIO_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Description
Handle of radio button widget. Pointer to GUI_FONT structure to be used to display the text.
Additional information
For information about how to add text to a radio widget, refer to "RADIO_SetText()" on page 676.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
RADIO_SetGroupID()
Before
675 After
Description
Sets the group ID of the radio widget.
Prototype
void RADIO_SetGroupID(RADIO_Handle hObj, U8 GroupID);
Parameter hObj GroupID
Description
Handle of radio button widget. ID of the radio button group. Must be between 1 and 255. If the value is 0 the radio widget is not assigned to a radio button group.
Additional information
This command can be used to create groups of radio buttons. The behavior of one group is the same as the behavior of one radio button. This makes it possible to create for example 2 RADIO widgets side by side with 3 buttons each and build one group of them.
Example
The following example shows how to create a group of 2 RADIO widgets as shown in the screenshot at the beginning of the function description:
hRadio_0 = RADIO_CreateEx(10, 10, 60, 0, WM_HBKWIN, WM_CF_SHOW, 0, 1234, 3, 20); RADIO_SetText(hRadio_0, "Red", 0); RADIO_SetText(hRadio_0, "Green", 1); RADIO_SetText(hRadio_0, "Blue", 2); hRadio_1 = RADIO_CreateEx(65, 10, 60, 0, WM_HBKWIN, WM_CF_SHOW, 0, 1234, 3, 20); RADIO_SetText(hRadio_1, "Magenta", 0); RADIO_SetText(hRadio_1, "Cyan", 1); RADIO_SetText(hRadio_1, "Yellow", 2); RADIO_SetGroupID(hRadio_0, 1); RADIO_SetGroupID(hRadio_1, 1);
RADIO_SetImage()
Description
Sets the images used to draw the radio button.
Prototype
void RADIO_SetImage(RADIO_Handle hObj, const GUI_BITMAP * pBitmap,
unsigned int Index);
Parameter hObj pBitmap Index
Description
Handle of radio button widget. Pointer to the bitmap.
(see table shown under RADIO_SetDefaultImage)
Additional information
(see RADIO_SetDefaultImage).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
676
RADIO_SetText()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the optional text shown next to the radio buttons.
Prototype
void RADIO_SetText(RADIO_Handle hObj, const char * pText, unsigned Index);
Parameter hObj pText Index
Description
Handle of radio button widget. Pointer to the text to be shown next to the specified radio button. Zero based index of the radio button.
Additional information
If using a RADIO widget without text (old style) the focus rectangle is drawn around the buttons of the widget. If using radio button text the focus rectangle is shown around the text of the currently selected radio button of the widget.
Example
The following example shows how to add the text shown in the screenshot above:
RADIO_SetText(hRadio_0, "Red", 0); RADIO_SetText(hRadio_0, "Green", 1); RADIO_SetText(hRadio_0, "Blue", 2);
RADIO_SetTextColor()
Before
After
Description
Sets the text color used to show the optional text beside the radio buttons.
Prototype
void RADIO_SetTextColor(RADIO_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of radio button widget. Color used to show the text.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
677
Additional information
For information about how to add text to a radio widget, refer to "RADIO_SetText()" on page 676.
RADIO_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
RADIO_SetValue()
Description
Sets the current button selection.
Prototype
void RADIO_SetValue(RADIO_Handle hObj, int v);
Parameter hObj v
Handle of radio button widget. Value to be set.
Description
Additional information
The topmost radio button in a RADIO widget always has the 0 value, the next button down is always 1, the next is 2, etc.
16.21.6 Examples
The Sample folder contains the following example which shows how the widget can be used: · DIALOG_Radio.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of DIALOG_Radio.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
678
CHAPTER
Window Objects (Widgets)
16.22 SCROLLBAR: Scroll bar widget
Scroll bars are used for scrolling through list boxes or any other type of window. They may be created horizontally, as shown below, or vertically.
A scroll bar is typically attached to an existing window, for example the list box shown below:
All SCROLLBAR-related routines are located in the file(s) SCROLLBAR*.c, SCROLLBAR.h. All identifiers are prefixed SCROLLBAR.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.22.1 Configuration options
Type
Macro
N SCROLLBAR_COLOR_SHAFT_DEFAULT N SCROLLBAR_COLOR_ARROW_DEFAULT
N SCROLLBAR_COLOR_THUMB_DEFAULT N SCROLLBAR_THUMB_SIZE_MIN_DEFAULT
Default
Description
0x808080 Color of the shaft.
GUI_BLACK Color of the arrows.
0xc0c0c0 Color of the thumb area.
4
Minimum thumb size.
16.22.2 Predefined IDs
The following symbols define IDs which may be used to make SCROLLBAR widgets distinguishable from creation: GUI_ID_SCROLLBAR0 - GUI_ID_SCROLLBAR3
16.22.3 Notification codes
The following events are sent from a scroll bar widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED
WM_NOTIFICATION_SCROLLBAR_ADDED
WM_NOTIFICATION_VALUE_CHANGED
Description
Scrollbar has been clicked.
Scrollbar has been released. Scroll bar has just been added (attached) to an existing window. The window needs to be informed so that it can initialize the scroll bar. Value of scroll bar has changed, either by moving the thumb or by pressing the arrow buttons.
16.22.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_RIGHT GUI_KEY_DOWN
GUI_KEY_PGDOWN
Reaction
Increments the current value of the scroll bar by 1. Increments the current value of the scroll bar by 1. Increments the current value of the scroll bar by a value which represents 1 page.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
679
Key GUI_KEY_LEFT GUI_KEY_UP
GUI_KEY_PGUP
Reaction
Decrements the current value of the scroll bar by 1. Decrements the current value of the scroll bar by 1. Decrements the current value of the scroll bar by a value which represents 1 page.
16.22.5 SCROLLBAR API
The table below lists the available emWin SCROLLBAR-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine
SCROLLBAR_AddValue()
SCROLLBAR_Create() SCROLLBAR_CreateAttached() SCROLLBAR_CreateEx() SCROLLBAR_CreateIndirect() SCROLLBAR_CreateUser() SCROLLBAR_Dec() SCROLLBAR_GetDefaultWidth() SCROLLBAR_GetNumItems() SCROLLBAR_GetPageSize() SCROLLBAR_GetThumbSizeMin() SCROLLBAR_GetUserData() SCROLLBAR_GetValue() SCROLLBAR_Inc() SCROLLBAR_SetColor() SCROLLBAR_SetDefaultColor() SCROLLBAR_SetDefaultWidth() SCROLLBAR_SetNumItems() SCROLLBAR_SetPageSize() SCROLLBAR_SetState() SCROLLBAR_SetThumbSizeMin() SCROLLBAR_SetUserData() SCROLLBAR_SetValue() SCROLLBAR_SetWidth()
Description
Increment or decrement the value of the scroll bar by a specified value. Creates a SCROLLBAR widget. (Obsolete) Creates a SCROLLBAR widget attached to a window. Creates a SCROLLBAR widget. Creates a SCROLLBAR widget from resource table entry. Creates a SCROLLBAR widget using extra bytes as user data. Decrements the value of the scroll bar by a value of 1. Returns the default width of a scroll bar. Returns the number of items. Returns the page size (in number of items). Returns the minimal thumb size in pixels. Retrieves the data set with SCROLLBAR_SetUserData(). Returns the current item value. Increments the value of the scroll bar by a value of 1. Sets the color of a scroll bar. Sets the default colors for new scroll bars. Sets the default width of a scroll bar. Sets the number of items for scrolling. Sets the page size (in number of items). Sets the state of a scroll bar. Sets the minimal thumb size in pixels. Sets the extra data of a SCROLLBAR widget. Sets the current value of the scroll bar. Sets the width of the scroll bar.
SCROLLBAR_AddValue()
Definition
Increments or decrements the value of the scroll bar by a specified value.
Prototype
void SCROLLBAR_AddValue(SCROLLBAR_Handle hObj, int Add);
Parameter hObj Add
Description
Handle of scroll bar. Number of items to increment or decrement at one time.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
680
CHAPTER
Window Objects (Widgets)
Additional information
The scroll bar cannot exceed the value set in SCROLLBAR_SetNumItems(). For example, if a window contains 200 items and the scroll bar is currently at value 195, incrementing the bar by 3 items will move it to value 198. However, incrementing by 10 items will only move the bar as far as value 200, which is the maximum value for this particular window.
SCROLLBAR_Create()
(Obsolete, SCROLLBAR_CreateEx() should be used instead)
Description
Creates a SCROLLBAR widget of a specified size at a specified location.
Prototype
SCROLLBAR_Handle SCROLLBAR_Create(int x0,
int y0,
int xsize,
int ysize
WM_HWIN hParent, int Id,
int WinFlags, int SpecialFlags);
Parameter
Description
x0
Leftmost pixel of the scroll bar (in parent coordinates).
y0 xsize ysize
Topmost pixel of the scroll bar (in parent coordinates). Horizontal size of the scroll bar (in pixels). Vertical size of the scroll bar (in pixels).
hParent Id
Handle of parent window. ID to be returned.
WinFlags SpecialFlags
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Special creation flags (see indirect creation flags under
SCROLLBAR_CreateIndirect()).
Return value
Handle of the created SCROLLBAR widget; 0 if the function fails.
SCROLLBAR_CreateAttached()
Description
Creates a scroll bar which is attached to an existing window.
Prototype
SCROLLBAR_Handle SCROLLBAR_CreateAttached(WM_HWIN hParent,
int
SpecialFlags);
Parameter hParent SpecialFlags
Description
Handle of parent window. Special creation flags (see indirect creation flags under
SCROLLBAR_CreateIndirect()).
Return value
Handle of the created SCROLLBAR widget; 0 if the function fails.
Additional information
An attached scroll bar is essentially a child window which will position itself on the parent window and operate accordingly.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
681
Vertical attached scrollbars will be automatically placed on the right side of the parent window; horizontal scrollbars on the bottom. Since no more than one horizontal and one vertical scroll bar can be attached to a parent window, no ID needs to be passed as parameter. The following fixed ID's will automatically be assigned when an attached scroll bar is created: GUI_ID_HSCROLL for a horizontal scroll bar, and GUI_ID_VSCROLL for a vertical scroll bar.
Example
Creates a list box with an attached scrollbar:
LISTBOX_Handle hListBox; hListBox = LISTBOX_Create(ListBox, 50, 50, 100, 100, WM_CF_SHOW); SCROLLBAR_CreateAttached(hListBox, SCROLLBAR_CF_VERTICAL);
Screen shots of above example
The picture on the left shows the list box as it appears after creation. On the right it
is shown with the attached vertical scrollbar:
After
After, with attached vertical scrollbar
SCROLLBAR_CreateEx()
Description
Creates a SCROLLBAR widget of a specified size at a specified location.
Prototype
SCROLLBAR_Handle SCROLLBAR_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates).
Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new SCROLLBAR widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Special creation flags (see indirect creation flags under
SCROLLBAR_CreateIndirect()).
Window ID of the widget.
Return value
Handle of the created SCROLLBAR widget; 0 if the function fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
682
CHAPTER
Window Objects (Widgets)
SCROLLBAR_CreateIndirect()
Prototype explained at the beginning of the chapter. The following flags may be used as the Flags element of the resource passed as parameter:
Permitted indirect creation flags ("OR" combinable)
SCROLLBAR_CF_VERTICAL
Creates a vertical scroll bar (default is horizontal).
SCROLLBAR_CF_FOCUSSABLE Gives scroll bar the input focus.
The Para element is not used in the resource table.
SCROLLBAR_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function SCROLLBAR_CreateEx() can be referred to.
SCROLLBAR_Dec()
Description
Decrements the current value of the scroll bar by a value of 1.
Prototype
void SCROLLBAR_Dec(SCROLLBAR_Handle hObj);
Parameter hObj
Handle of scroll bar.
Description
Additional information
The definition of an "item" is application-specific, although in most cases it is equal to one line. Items are numbered top to bottom or left to right, beginning with a value of 0.
SCROLLBAR_GetDefaultWidth()
Description
Returns the default width used to create a scrollbar.
Prototype
int SCROLLBAR_GetDefaultWidth(void);
Return value
Default width used to create a scrollbar.
SCROLLBAR_GetNumItems()
Description
Returns the number of scrollbar items.
Prototype
int SCROLLBAR_GetNumItems(SCROLLBAR_Handle hObj);
Parameter hObj
Handle of scroll bar
Return value
The number of scrollbar items.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
683
SCROLLBAR_GetPageSize()
Description
Returns the page size.
Prototype
int SCROLLBAR_GetValue(SCROLLBAR_Handle hObj);
Parameter hObj
Handle of scroll bar.
Description
Return value
The number of items specified to be one page.
SCROLLBAR_GetThumbSizeMin()
Description
Returns the minimum thumb size in pixels.
Prototype
int SCROLLBAR_GetThumbSizeMin(void);
Return value
Minimum thumb size in pixels.
SCROLLBAR_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
SCROLLBAR_GetValue()
Description
Returns the value of the current item.
Prototype
int SCROLLBAR_GetValue(SCROLLBAR_Handle hObj);
Parameter hObj
Handle of scroll bar.
Description
Return value
The value of the current item.
SCROLLBAR_Inc()
Description
Increments the current value of the scroll bar by a value of 1.
Prototype
void SCROLLBAR_Inc(SCROLLBAR_Handle hObj);
Parameter hObj
Handle of scroll bar.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
684
CHAPTER
Window Objects (Widgets)
Additional information
The definition of an "item" is application-specific, although in most cases it is equal to one line. Items are numbered top to bottom or left to right, beginning with a value of 0.
SCROLLBAR_SetColor()
Before
After
Description
Sets the given color attribute of the scroll bar.
Prototype
GUI_COLOR SCROLLBAR_SetColor(SCROLLBAR_Handle hObj, int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of scroll bar. See table below. Color to be used.
Description
Permitted values for parameter Index
SCROLLBAR_CI_THUMB SCROLLBAR_CI_SHAFT SCROLLBAR_CI_ARROW
Color of thumb area. Color of shaft. Color of arrows.
Return value
Previous color used for the given index.
SCROLLBAR_SetDefaultColor()
Description
Sets the default color attributes for new scroll bars.
Prototype
GUI_COLOR SCROLLBAR_SetDefaultColor(GUI_COLOR Color, unsigned int Index);
Parameter Color Index
Description
Color used as default for new scroll bars.
(see table under SCROLLBAR_SetColor())
Return value
Previous default color.
SCROLLBAR_SetDefaultWidth()
Description
Sets the default width used to create a scrollbar.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
685
Prototype
int SCROLLBAR_SetDefaultWidth(int DefaultWidth);
Parameter
Description
Return value
Previous default width.
SCROLLBAR_SetNumItems()
Description
Sets the number of items for scrolling.
Prototype
void SCROLLBAR_SetNumItems(SCROLLBAR_Handle hObj, int NumItems);
Parameter hObj NumItems
Handle of scroll bar. Number of items to be set.
Description
Additional information
The definition of an "item" is application-specific, although in most cases it is equal to one line. The number of items specified is the maximum value; the scroll bar cannot go beyond this value.
SCROLLBAR_SetPageSize()
Description
Sets the page size.
Prototype
void SCROLLBAR_SetPageSize(SCROLLBAR_Handle hObj, int PageSize);
Parameter hObj PageSize
Handle of scroll bar. Page size (in number of items).
Description
Additional information
Page size is specified as the number of items to one page. If the user pages up or down, either with the keyboard or by mouse-clicking in the scroll bar area, the window will be scrolled up or down by the number of items specified to be one page.
SCROLLBAR_SetState()
Description
Sets the state of a scroll bar.
Prototype
void SCROLLBAR_SetState(SCROLLBAR_Handle
hObj,
const WM_SCROLL_STATE * pState);
Parameter hObj pState
Description
Handle of scroll bar. Pointer to a data structure of type WM_SCROLL_STATE.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
686
CHAPTER
Window Objects (Widgets)
Additional information
The data structure is defined as follows: typedef struct {
int NumItems; int v; int PageSize; } WM_SCROLL_STATE;
SCROLLBAR_SetThumbSizeMin()
Description
Sets the minimum thumb size in pixels.
Prototype
int SCROLLBAR_SetThumbSizeMin(int ThumbSizeMin);
Parameter ThumbSizeMin
Description
Minimum thumb size to be set.
Return value
Old minimum thumb size in pixels.
SCROLLBAR_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
SCROLLBAR_SetValue()
Description
Sets the current value of a scroll bar.
Prototype
void SCROLLBAR_SetValue(SCROLLBAR_Handle hObj, int v);
Parameter hObj v
Handle of scroll bar. Value to be set.
Description
SCROLLBAR_SetWidth()
Description
Sets the width of the scroll bar.
Prototype
void SCROLLBAR_SetWidth(SCROLLBAR_Handle hObj, int Width);
Parameter hObj Width
Handle of scroll bar. Width to be set.
Description
16.22.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_ScrollbarMove.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
687
Screenshot of WIDGET_ScrollbarMove.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
688
CHAPTER
Window Objects (Widgets)
16.23 SLIDER: Slider widget
Slider widgets are commonly used for modifying values through the use of a slider bar. The widget consists of a slider bar and tick marks beside the bar. These tick marks can be used to snap the slider bar while dragging it. For details about how to use the tick marks for snapping refer to the function SLIDER_SetRange().
All SLIDER-related routines are located in the file(s) SLIDER*.c, SLIDER.h. All identifiers are prefixed SLIDER.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
16.23.1 Configuration options
Type
Macro
Default
N
SLIDER_BKCOLOR0_DEFAULT 0xc0c0c0
N SLIDER_COLOR0_DEFAULT
0xc0c0c0
N
SLIDER_FOCUSCOLOR_DEFAULT GUI_BLACK
Description
Background color. Slider (thumb) color. Default color for rendering the focus rectangle.
16.23.2 Predefined IDs
The following symbols define IDs which may be used to make SLIDER widgets distinguishable from creation: GUI_ID_SLIDER0 - GUI_ID_SLIDER9
16.23.3 Notification codes
The following events are sent from a slider widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED
WM_NOTIFICATION_VALUE_CHANGED
Description
Slider widget has been clicked. Slider widget has been released. Value of the slider widget has changed by moving the thumb.
16.23.4 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key GUI_KEY_RIGHT GUI_KEY_LEFT
Reaction
Increments the current value of the slider bar by one item. Decrements the current value of the slider bar by one item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
689
16.23.5 SLIDER API
The table below lists the available emWin SLIDER-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine
Description
SLIDER_Create()
Creates a SLIDER widget. (Obsolete)
SLIDER_CreateEx()
Creates a SLIDER widget.
SLIDER_CreateIndirect()
Creates a SLIDER widget from resource table entry.
SLIDER_CreateUser()
Creates a SLIDER widget using extra bytes as user data.
SLIDER_Dec()
Decrement the value of the slider bar.
SLIDER_GetUserData()
Retrieves the data set with SLIDER_SetUserData().
SLIDER_GetValue()
Return the current value of the slider bar.
SLIDER_Inc()
Increment the value of the slider bar.
SLIDER_SetBkColor()
Sets the background color of the slider bar.
SLIDER_SetDefaultFocusColor() Sets the default focus rectangle color for new slider bars.
SLIDER_SetFocusColor()
Sets the color of the focus rectangle.
SLIDER_SetNumTicks()
Sets the number of tick marks of the slider bar.
SLIDER_SetRange()
Set the range of the slider value.
SLIDER_SetUserData()
Sets the extra data of a SLIDER widget.
SLIDER_SetValue()
Set the current value of the slider bar.
SLIDER_SetWidth()
Set the width of the slider bar.
SLIDER_Create()
(Obsolete, SLIDER_CreateEx() should be used instead)
Description
Creates a SLIDER widget of a specified size at a specified location.
Prototype
SLIDER_Handle SLIDER_Create(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int Id,
int
WinFlags, int SpecialFlags);
Parameter
Description
x0
Leftmost pixel of the slider (in parent coordinates).
y0
Topmost pixel of the slider (in parent coordinates).
xsize ysize
Horizontal size of the slider (in pixels). Vertical size of the slider (in pixels).
hParent
Handle of the parent window.
Id
Id to be returned
WinFlags SpecialFlags
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Special creation flag (see indirect creation flag under
SLIDER_CreateIndirect()).
Return value
Handle of the created SLIDER widget; 0 if the function fails.
SLIDER_CreateEx()
Description
Creates a SLIDER widget of a specified size at a specified location.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
690
CHAPTER
Window Objects (Widgets)
Prototype
SLIDER_Handle SLIDER_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels).
Vertical size of the widget (in pixels). Handle of the parent window. If 0, the new SLIDER widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Special creation flags (see indirect creation flags under
SLIDER_CreateIndirect()).
Window ID of the widget.
Return value
Handle of the created SLIDER widget; 0 if the function fails.
SLIDER_CreateIndirect()
Prototype explained at the beginning of the chapter. The following flag may be used as the Flags element of the resource passed as parameter:
Permitted indirect creation flag SLIDER_CF_VERTICAL Create a vertical slider (default is horizontal).
The Para element is not used in the resource table.
SLIDER_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function SLIDER_CreateEx() can be referred to.
SLIDER_Dec()
Description
Decrements the current value of the slider bar by one item.
Prototype
void SLIDER_Dec(SLIDER_Handle hObj);
Parameter hObj
Handle of slider widget.
Description
SLIDER_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
691
SLIDER_GetValue()
Description
Returns the current value of the slider bar.
Prototype
int SLIDER_GetValue(SLIDER_Handle hObj);
Parameter hObj
Handle of slider widget.
Description
Return value
The current value of the slider.
SLIDER_Inc()
Description
Increments the current value of the slider bar by one item.
Prototype
void SLIDER_Inc(SLIDER_Handle hObj);
Parameter hObj
Handle of slider widget.
Description
SLIDER_SetBkColor()
Description
Sets the background color of the slider.
Prototype
void SLIDER_SetBkColor(SLIDER_Handle hObj, GUI_COLOR Color);
Parameter hObj
Color
Description
Handle of slider widget. Color to be used for the background. (range 0x000000 and 0xFFFFFF or a valid color define) GUI_INVALID_COLOR to make background transparent
Additional information
The background of this widget can either be filled with any available color or transparent. If a valid RGB color is specified, the background is filled with the color, otherwise the background (typically the content of the parent window) is visible. If the background is transparent, the widget is treated as transparent window, otherwise as non-transparent window. Note that using a background color allows more efficient (faster) rendering.
This widget is per default a transparent window. The appearance of a transparent windows background depends on the appearance of the parent window. When a transparent window needs to be redrawn first the background will be drawn by sending a WM_PAINT message to the parent window. If using this function with a valid color the status of the window will be changed from transparent to non transparent and if the window needs to be redrawn the background will be filled with the given color. If GUI_INVALID_COLOR is passed to the function the status will be changed from non transparent to transparent.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
692
CHAPTER
Window Objects (Widgets)
SLIDER_SetDefaultFocusColor()
Description
Sets the default focus rectangle color for new slider bars.
Prototype
GUI_COLOR SLIDER_SetDefaultFocusColor(GUI_COLOR Color);
Parameter Color
Description
Default color to be used for new slider bars.
Return value
Previous default focus rectangle color.
Additional information
For more information, refer to "SLIDER_SetFocusColor()" on page 692.
SLIDER_SetFocusColor()
Before
After
Description
Sets the color used to render the focus rectangle of the slider bar.
Prototype
GUI_COLOR SLIDER_SetFocusColor(SLIDER_Handle hObj, GUI_COLOR Color);
Parameter hObj Color
Description
Handle of widget. Color to be used for the focus rectangle.
Return value
Previous color of the focus rectangle.
Additional information
The focus rectangle is only visible if the widget has the input focus.
SLIDER_SetNumTicks()
Before
After
Description
Sets the number of tick marks of the slider bar.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
693
Prototype
void SLIDER_SetNumTicks(SLIDER_Handle hObj, int NumTicks);
Parameter hObj NumTicks
Handle of slider widget. Number of tick marks drawn.
Description
Additional information
After creating a slider widget the default number of tick marks is 10. The tick marks have no effect to snap the slider bar while dragging it.
SLIDER_SetRange()
Description
Sets the range of the slider.
Prototype
void SLIDER_SetRange(SLIDER_Handle hObj, int Min, int Max);
Parameter hObj Min Max
Handle of slider widget. Minimum value. Maximum value.
Description
Additional information
After creating a slider widget the default range is set to 0 - 100.
Examples
If a value should be modified in the range of 0 - 2499 set the range as follows: SLIDER_SetRange(hSlider, 0, 2499);
If a value should be modified in the range of 100 - 499 set the range as follows: SLIDER_SetRange(hSlider, 100, 499);
If a value should be modified in the range of 0 to 5000 and the slider bar should change the value in steps of 250 set the range and the tick marks as follows. The result returned by SLIDER_GetValue() should be multiplied with 250: SLIDER_SetRange(hSlider, 0, 20); SLIDER_SetNumTicks(hSlider, 21);
SLIDER_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
SLIDER_SetValue()
Description
Sets the current value of the slider bar.
Prototype
void SLIDER_SetValue(SLIDER_Handle hObj, int v);
Parameter hObj v
Handle of slider widget. Value to be set.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
694
SLIDER_SetWidth()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the width of the slider bar.
Prototype
void SLIDER_SetWidth(SLIDER_Handle hObj, int Width);
Parameter hObj Width
Handle of slider widget. Width to be set.
Description
16.23.6 Example
The Sample folder contains the following example which shows how the widget can be used: · DIALOG_SliderColor.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
Screenshot of DIALOG_SliderColor.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
695
16.24 SPINBOX: Spinning box widget
SPINBOX widgets are used to manage values which need to be adjustable in a fast but still precise manner. A SPINBOX consists of 2 buttons and an embedded EDIT widget. All SPINBOX-related routines are located in the file(s) SPINBOX*.c and SPINBOX.h. All identifiers are prefixed SPINBOX.
Skinning...
...is available for this widget. The screenshot above shows the widget using the default skin. For details please refer to the chapter 'Skinning'.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
696
CHAPTER
Window Objects (Widgets)
16.24.1 Configuration options
Type
Macro
Default
Description
N
SPINBOX_DEFAULT_BUTTON_BKCOLOR0 0xAAAAAA
N
SPINBOX_DEFAULT_BUTTON_BKCOLOR1 GUI_WHITE
N
SPINBOX_DEFAULT_BUTTON_BKCOLOR2 GUI_LIGHTGRAY
N
SPINBOX_DEFAULT_BUTTON_UCOLOR0 0xAAAAAA
N
SPINBOX_DEFAULT_BUTTON_UCOLOR1 GUI_WHITE
N
SPINBOX_DEFAULT_BUTTON_UCOLOR2 GUI_LIGHTGRAY
N
SPINBOX_DEFAULT_BUTTON_LCOLOR0 0xAAAAAA
N
SPINBOX_DEFAULT_BUTTON_LCOLOR1 GUI_WHITE
N
SPINBOX_DEFAULT_BUTTON_LCOLOR2 GUI_LIGHTGRAY
N
SPINBOX_DEFAULT_BUTTON_OCOLOR0 0xAAAAAA
N
SPINBOX_DEFAULT_BUTTON_OCOLOR1 GUI_WHITE
N
SPINBOX_DEFAULT_BUTTON_OCOLOR2 GUI_LIGHTGRAY
N SPINBOX_DEFAULT_BKCOLOR0
0xC0C0C0
N SPINBOX_DEFAULT_BKCOLOR1
GUI_WHITE
N SPINBOX_DEFAULT_TEXTCOLOR0
0xC0C0C0
N SPINBOX_DEFAULT_TEXTCOLOR1
GUI_WHITE
N
SPINBOX_DEFAULT_TRIANGLE_COLOR0 0xAAAAAA
N
SPINBOX_DEFAULT_TRIANGLE_COLOR1 GUI_WHITE
N
SPINBOX_DEFAULT_TRIANGLE_COLOR2 GUI_LIGHTGRAY
N SPINBOX_DEFAULT_STEP
1
Background color for the button state disabled.
Background color for the button state pressed.
Background color for the button state unpressed.
Background color for the button state disabled.
Background color for the button state pressed.
Background color for the button state unpressed.
Background color for the button state disabled.
Background color for the button state pressed.
Background color for the button state unpressed.
Background color for the button state disabled.
Background color for the button state pressed.
Background color for the button state unpressed.
Background color for the edit state enabled.
Background color for the edit state disabled.
Background color for the edit state enabled.
Background color for the edit state disabled.
Background color for the button state disabled.
Background color for the button state pressed.
Background color for the button state unpressed.
Value will be increased/ decreased by this amount when a button is clicked.
N SPINBOX_DEFAULT_BUTTON_SIZE N SPINBOX_DEFAULT_EDGE N SPINBOX_TIMER_PERIOD_START N SPINBOX_TIMER_PERIOD
0
X-Size of the buttons.
Determines the position of SPINBOX_EDGE_RIGHT the buttons. See table
below.
Once a button is pressed for
this amount of time, a timer
400
is created to increase/
decrease the value continu-
ously.
Once the timer is created
50
values are adjusted at inter-
vals of this amount of time.
Possible values to be defined as SPINBOX_DEFAULT_EDGE SPINBOX_EDGE_LEFT Buttons are displayed on the left edge of the widget. SPINBOX_EDGE_RIGHT Buttons are displayed on the right edge of the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
697
16.24.2 Predefined IDs
The following symbols define IDs which may be used to make SPINBOX widgets distinguishable from creation: GUI_ID_SPINBOX0 - GUI_ID_SPINBOX9
16.24.3 Notification codes
The following events are sent from the spinbox widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_VALUE_CHANGED
Description
Button has been clicked. Button has been released. Pointer has been moved out of the widget area. The value of the SPINBOX widget has changed.
16.24.4 Keyboard reaction
The widget is able to receive the input focus. All key events are forwarded to the embedded edit widget. Detailed information can be taken from the EDIT widget section.
16.24.5 SPINBOX API
The table below lists the available emWin SPINBOX-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine SPINBOX_CreateEx() SPINBOX_CreateIndirect() SPINBOX_CreateUser() SPINBOX_EnableBlink() SPINBOX_GetBkColor() SPINBOX_GetButtonBkColor() SPINBOX_GetDefaultButtonSize() SPINBOX_GetEditHandle()
SPINBOX_GetUserData()
SPINBOX_GetValue() SPINBOX_SetBkColor() SPINBOX_SetButtonBkColor() SPINBOX_SetDefaultButtonSize() SPINBOX_SetEdge() SPINBOX_SetFont() SPINBOX_SetRange() SPINBOX_SetTextColor()
SPINBOX_SetUserData()
SPINBOX_SetValue()
Description
Creates a SPINBOX widget. Creates a SPINBOX widget. (Obsolete) Creates a SPINBOX widget using extra bytes as user data. Enables/disables blinking of the cursor. Returns the background color of the SPINBOX widget. Returns the background color of the buttons. Returns the default x-size of the buttons. Returns the handle to the attached EDIT widget. Retrieves the data which was previously set with SPINBOX_SetUserData(). Returns the value of the SPINBOX widget. Sets the background color of the SPINBOX widget. Sets the background color of the buttons. Sets the default x-size of the buttons. Sets the edge to display the buttons on. Sets the font used to display the value. Sets the minimum and maximum value. Sets the color of the displayed value. Stores user data using the extra bytes which were reserved by SPINBOX_CreateUser(). Sets the value of the SPINBOX.
SPINBOX_CreateEx()
Description
Creates a SPINBOX widget.
Prototype
SPINBOX_Handle SPINBOX_CreateEx(int x0, int
y0,
int xSize,
int ySize, WM_HWIN hParent, int WinFlags,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
698
CHAPTER
Window Objects (Widgets)
int Id, int
Min,
int Max);
Parameter x0 y0 xSize ySize hParent
WinFlags
Id Min Max
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels).
Vertical size of the widget (in pixels). Handle of the parent window. If 0, the widget will be created as a child of the toplevel window (desktop). Window create flags. In order to make the widget visible immediately WM_CF_SHOW should be used. The complete list of available parameters can be found under "WM_CreateWindow()" on page 357. Window ID to be set for the widget. Minimum permitted value.
Maximum permitted value.
Return value
Handle of the created SPINBOX widget. If an error occurred during creation, 0 is returned.
SPINBOX_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The elements Flags and Para of the resource passed as parameter are not used.
SPINBOX_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function SPINBOX_CreateEx() can be referred to.
SPINBOX_EnableBlink()
Description
Enables/disables blinking of the cursor.
Prototype
void SPINBOX_EnableBlink(SPINBOX_Handle hObj, int Period, int OnOff);
Parameter hObj Period OnOff
Description
Handle of the SPINBOX widget. Period in which the cursor is turned off and on. 1 enables blinking, 0 disables blinking.
SPINBOX_GetBkColor()
Description
Returns the background color of the SPINBOX widget.
Prototype
GUI_COLOR SPINBOX_GetBkColor(SPINBOX_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of the SPINBOX widget. Color index. See table below.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
699
Permitted values for parameter Index
SPINBOX_CI_DISABLED SPINBOX_CI_ENABLED
Color for disabled state. Color for enabled state.
Return value
Background color of the SPINBOX widget.
SPINBOX_GetButtonBkColor()
Description
Returns the background color of the buttons.
Prototype
GUI_COLOR SPINBOX_GetButtonBkColor(SPINBOX_Handle hObj, unsigned int Index);
Parameter hObj Index
Handle of the SPINBOX widget. Color index. See table below.
Description
Permitted values for parameter Index
SPINBOX_CI_DISABLED SPINBOX_CI_ENABLED SPINBOX_CI_PRESSED
Color for disabled state. Color for enabled state. Color for pressed state.
Return value
Background color of the buttons.
SPINBOX_GetDefaultButtonSize()
Description
Returns the default x-size of the buttons.
Prototype
U16 SPINBOX_GetDefaultButtonSize(void);
Return value
Default x-size of the buttons.
SPINBOX_GetEditHandle()
Description
Returns the handle to the attached EDIT widget.
Prototype
EDIT_Handle SPINBOX_GetEditHandle(SPINBOX_Handle hObj);
Parameter hObj
Handle of the SPINBOX widget.
Description
Return value
Handle of the attached EDIT widget.
SPINBOX_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
700
CHAPTER
SPINBOX_GetValue()
Description
Returns the value of the SPINBOX widget.
Prototype
int SPINBOX_GetValue(SPINBOX_Handle hObj);
Parameter hObj
Handle of the SPINBOX widget.
Description
Return value
Value of the SPINBOX widget.
SPINBOX_SetBkColor()
Window Objects (Widgets)
Before
After
Description
Sets the background color of the SPINBOX widget.
Prototype
void SPINBOX_SetBkColor(SPINBOX_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of the SPINBOX widget. Color index. See table below. Color to be used for the background.
Permitted values for parameter Index
SPINBOX_CI_DISABLED SPINBOX_CI_ENABLED
Color for disabled state. Color for enabled state.
SPINBOX_SetButtonBkColor()
Before
After
Description
Sets the background color of the buttons.
Prototype
void SPINBOX_SetButtonBkColor(SPINBOX_Handle hObj,
unsigned int Index,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
701
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of the SPINBOX widget. Color index. See table below. Color to be used for the background.
Permitted values for parameter Index
SPINBOX_CI_DISABLED SPINBOX_CI_ENABLED SPINBOX_CI_PRESSED
Color for disabled state. Color for enabled state. Color for pressed state.
SPINBOX_SetButtonSize()
Before
After
Description
Sets the button size of the given widget.
Prototype
void SPINBOX_SetButtonSize(SPINBOX_Handle hObj, unsigned ButtonSize);
Parameter hObj ButtonSize
Handle of the SPINBOX widget. Button size in pixels to be used.
Description
SPINBOX_SetDefaultButtonSize()
Before
After
Description
Sets the default x-size of the buttons.
Prototype
void SPINBOX_SetDefaultButtonSize(U16 x);
Parameter x
Description
New default x-size of the buttons.
Additional information
If the default button size is set to 0, the size of the button is determined automatically on creation.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
702
SPINBOX_SetEdge()
Before
CHAPTER
Window Objects (Widgets) After
Description
Sets the edge to display the buttons on.
Prototype
void SPINBOX_SetEdge(SPINBOX_Handle hObj, U8 Edge);
Parameter hObj Edge
Handle of the SPINBOX widget. See table below.
Description
Permitted values for parameter Edge
SPINBOX_EDGE_CENTER SPINBOX_EDGE_LEFT SPINBOX_EDGE_RIGHT
Buttons are displayed on the left and the right edge of the widget.
Buttons are displayed on the left edge of the widget.
Buttons are displayed on the right edge of the widget.
SPINBOX_SetFont()
Before
After
Description
Sets the font used to display the value.
Prototype
void SPINBOX_SetFont(SPINBOX_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle to the SPINBOX widget. Pointer to the font to be used.
Description
SPINBOX_SetRange()
Description
Sets the minimum and maximum value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
703
Prototype
void SPINBOX_SetRange(SPINBOX_Handle hObj, int Min, int Max);
Parameter hObj Min Max
Handle to the SPINBOX widget. Minimum value. Maximum value.
Description
SPINBOX_SetTextColor()
Before
After
Description
Sets the color of the displayed value.
Prototype
void SPINBOX_SetTextColor(SPINBOX_Handle hObj, unsigned int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Handle of the SPINBOX widget. Color index. See table below. Color to be set for the text.
Description
Permitted values for parameter Index
SPINBOX_CI_DISABLED SPINBOX_CI_ENABLED
Color for disabled state. Color for pressed state.
SPINBOX_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
SPINBOX_SetValue()
Before
After
Description
Sets the value of the SPINBOX.
Prototype
void SPINBOX_SetValue(SPINBOX_Handle hObj, int v);
Parameter hObj v
Handle of the SPINBOX widget. Value to be set.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
704
CHAPTER
Window Objects (Widgets)
16.24.6 Example
The Sample folder contains the following example which shows how the widget can be used: · WIDGET_Spinbox.c
Screenshot of WIDGET_Spinbox.c:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
705
16.25 TEXT: Text widget
Text widgets are typically used in order to display fields of text in dialog boxes, as shown in the message box below:
Of course, text fields may also be used for labeling other widgets, as follows:
All TEXT-related routines are located in the file(s) TEXT*.c, TEXT.h. All identifiers are prefixed TEXT.
16.25.1 Configuration options
Type
Macro
N TEXT_DEFAULT_BK_COLOR N TEXT_DEFAULT_TEXT_COLOR N TEXT_DEFAULT_WRAPMODE S TEXT_FONT_DEFAULT
Default
GUI_INVALID_COLOR GUI_BLACK GUI_WRAPMODE_NONE &GUI_Font13_1
Description
Transparent background per default Default text color. Default wrapping mode. Font used.
16.25.2 Predefined IDs
The following symbols define IDs which may be used to make TEXT widgets distinguishable from creation: GUI_ID_TEXT0 - GUI_ID_TEXT9
16.25.3 Keyboard reaction
The widget can not gain the input focus and does not react on keyboard input.
16.25.4 TEXT API
The table below lists the available emWin TEXT-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine TEXT_Create() TEXT_CreateAsChild() TEXT_CreateEx() TEXT_CreateIndirect() TEXT_CreateUser() TEXT_GetDefaultFont() TEXT_GetNumLines() TEXT_GetText() TEXT_GetUserData() TEXT_SetBkColor() TEXT_SetDefaultFont() TEXT_SetDefaultTextColor()
Description
Creates a TEXT widget. (Obsolete) Creates a TEXT widget as a child window. (Obsolete) Creates a TEXT widget. Creates a TEXT widget from resource table entry. Creates a TEXT widget using extra bytes as user data. Returns the default font used for text. Returns the number of lines currently displayed in the widget. Copies the text of the given TEXT widget to the given buffer. Retrieves the data set with TEXT_SetUserData(). Sets the background color for the text. Sets the default font used for text. Sets the default text color used for text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
706
CHAPTER
Window Objects (Widgets)
Routine TEXT_SetDefaultWrapMode() TEXT_SetFont() TEXT_SetText() TEXT_SetTextAlign() TEXT_SetTextColor() TEXT_SetUserData() TEXT_SetWrapMode()
Description
Sets the default wrap mode for new text widgets. Sets the font used for a specified text widget. Sets the text for a specified text widget. Sets the text alignment of a specified text widget. Sets the text color of the given widget. Sets the extra data of a TEXT widget. Sets the wrap mode of a specified text widget.
TEXT_Create()
(Obsolete, TEXT_CreateEx() should be used instead)
Description
Creates a TEXT widget of a specified size at a specified location.
Prototype
TEXT_Handle TEXT_Create(int
x0, int y0,
int
xsize, int ysize,
int
Id, int Flags,
const char * s,
int Align);
Parameter x0 y0 xsize ysize Id
Flags
s Align
Description
Leftmost pixel of the text widget (in parent coordinates). Topmost pixel of the text widget (in parent coordinates). Horizontal size of the text widget (in pixels). Vertical size of the text widget (in pixels). ID to be returned.
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Pointer to the text to be displayed. Alignment attribute for the text (see indirect creation flags under
TEXT_CreateIndirect()).
Return value
Handle of the created TEXT widget; 0 if the function fails.
TEXT_CreateAsChild()
(Obsolete, TEXT_CreateEx should be used instead)
Description
Creates a TEXT widget as a child window.
Prototype
TEXT_Handle TEXT_CreateAsChild(int
x0,
int
y0,
int
xsize, int
ysize,
WM_HWIN hParent, int
Id,
int
Flags, const char * s,
int
Align);
Parameter x0 y0 xsize ysize
Description
X-position of the progress bar relative to the parent window. Y-position of the progress bar relative to the parent window. Horizontal size of the text widget (in pixels). Vertical size of the text widget (in pixels).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
707
Parameter
Description
hParent Id Flags s
Align
Handle of parent window. ID to be returned.
Window create flags (see TEXT_Create()).
Pointer to the text to be displayed. Alignment attribute for the text (see indirect creation flags under
TEXT_CreateIndirect()).
Return value
Handle of the created TEXT widget; 0 if the function fails.
TEXT_CreateEx()
Description
Creates a TEXT widget of a specified size at a specified location.
Prototype
TEXT_Handle TEXT_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN
hParent, int WinFlags,
int
ExFlags, int Id,
const char * pText);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id pText
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new TEXT widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). Alignment attribute for the text (see indirect creation flags under
TEXT_CreateIndirect()).
Window ID of the TEXT widget. Pointer to the text to be displayed.
Return value
Handle of the created TEXT widget; 0 if the function fails.
TEXT_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The following flags may be used as the Flags element of the resource passed as parameter:
Permitted indirect creation flags ("OR" combinable)
TEXT_CF_LEFT TEXT_CF_RIGHT TEXT_CF_HCENTER TEXT_CF_TOP TEXT_CF_BOTTOM TEXT_CF_VCENTER
Horizontal alignment: left Horizontal alignment: right Horizontal alignment: center Vertical alignment: top Vertical alignment: bottom Vertical alignment: center
The Para element is not used in the resource table.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
708
CHAPTER
Window Objects (Widgets)
TEXT_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function TEXT_CreateEx() can be referred to.
TEXT_GetDefaultFont()
Description
Returns the default font used for text widgets.
Prototype
const GUI_FONT* TEXT_GetDefaultFont(void);
Return value
Pointer to the default font used for text widgets.
TEXT_GetNumLines()
Description
Returns the number of lines currently displayed in the widget.
Prototype
int TEXT_GetNumLines(TEXT_Handle hObj);
Parameter hObj
Handle of the widget.
Explanation
Return value
Number of lines.
TEXT_GetText()
Description
Copies the text of the given TEXT widget to the given buffer. The 0-Byte at the end of the string is written in any case.
Prototype
int TEXT_GetText(TEXT_Handle hObj, char * pDest, U32 BufferSize);
Parameter hObj pDest BufferSize
Handle of the widget. Pointer to a user defined buffer. Size of the buffer.
Explanation
Return value
Number of bytes copied.
TEXT_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
TEXT_SetBkColor()
Description
Sets the background color of the text widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
709
Prototype
void TEXT_SetBkColor(TEXT_Handle hObj, GUI_COLOR Color);
Parameter hObj
Color
Description
Handle of text widget. Color to be used for the background. (range 0x000000 and 0xFFFFFF or a valid color define) GUI_INVALID_COLOR to make background transparent
Additional information
The background of this widget can either be filled with any available color or transparent. If a valid RGB color is specified, the background is filled with the color, otherwise the background (typically the content of the parent window) is visible. If the background is transparent, the widget is treated as transparent window, otherwise as non-transparent window. Note that using a background color allows more efficient (faster) rendering.
TEXT_SetDefaultFont()
Description
Sets the default font used for text widgets.
Prototype
void TEXT_SetDefaultFont(const GUI_FONT * pFont);
Parameter pFont
Description
Pointer to the font to be set as default.
TEXT_SetDefaultTextColor()
Description
Sets the default text color used for text widgets.
Prototype
void TEXT_SetDefaultTextColor(GUI_COLOR Color);
Parameter Color
Color to be used.
Description
TEXT_SetDefaultWrapMode()
Description
Sets the default text wrapping mode used for new text widgets.
Prototype
GUI_WRAPMODE TEXT_SetDefaultWrapMode(GUI_WRAPMODE WrapMode);
Parameter WrapMode
Description
Default text wrapping mode used for new text widgets. See table below.
Permitted values for parameter WrapMode GUI_WRAPMODE_NONE No wrapping will be performed. GUI_WRAPMODE_WORD Text is wrapped word wise. GUI_WRAPMODE_CHAR Text is wrapped char wise.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
710
CHAPTER
Window Objects (Widgets)
Return value
Previous default text wrapping mode.
Additional information
The default wrapping mode for TEXT widgets is GUI_WRAPMODE_NONE. For details about text wrapping within the text widget, refer to "TEXT_SetWrapMode()" on page 711.
TEXT_SetFont()
Description
Sets the font to be used for a specified text widget.
Prototype
void TEXT_SetFont(TEXT_Handle hObj, const GUI_FONT * pFont);
Parameter hObj pFont
Handle of text widget. Pointer to the font to be used.
Description
TEXT_SetText()
Description
Sets the text to be used for a specified text widget.
Prototype
int TEXT_SetText(TEXT_Handle hObj, const char * s);
Parameter hObj s
Handle of text widget. Text to be displayed.
Description
Return value
0 on success, 1 on error.
TEXT_SetTextAlign()
Description
Sets the text alignment of a specified text widget.
Prototype
void TEXT_SetTextAlign(TEXT_Handle hObj, int Align);
Parameter hObj Align
Description
Handle of text widget.
Text alignment (see TEXT_Create()).
TEXT_SetTextColor()
Description
Sets the text color of a specified text widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
711
Prototype
void TEXT_SetTextColor(TEXT_Handle pObj, GUI_COLOR Color);
Parameter hObj Color
Handle of text widget. New text color.
Description
TEXT_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
TEXT_SetWrapMode()
Description
Sets the wrapping mode of a specified text widget.
Prototype
void TEXT_SetWrapMode(TEXT_Handle hObj, GUI_WRAPMODE WrapMode);
Parameter hObj WrapMode
Handle of text widget. See table below.
Description
Permitted values for parameter WrapMode GUI_WRAPMODE_NONE No wrapping will be performed. GUI_WRAPMODE_WORD Text is wrapped word wise. GUI_WRAPMODE_CHAR Text is wrapped char wise.
Additional information
The default wrapping mode for TEXT widgets is GUI_WRAPMODE_NONE. For more details about text wrapping, refer to "GUI_DispStringInRectWrap()" on page 83.
16.25.5 Examples
There is no special example for this widget. Many of the examples use this widget: · DIALOG_Count.c · DIALOG_Radio.c · WIDGET_GraphXY.c · ...
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
712
CHAPTER
Window Objects (Widgets)
16.26 TREEVIEW: Treeview widget
A treeview widget can be used to show a hierarchical view of information like files in a directory or items of an index, whereas each item can be a node or a leaf. Each node can have a number of sub items and can be closed or opened. A node consists of a button image, which shows a plus sign in closed state or a minus sign in open state, two item images (one for closed and one for open state) and the item text. Pressing the button image or double clicking the item image toggles the state (open or closed) of the node. A leaf consists of an item image and the item text. The current selection can be marked by highlighting the item text or by highlighting the whole row. All items of a tree are joined by lines per default. All TREEVIEW-related routines are located in the file(s) TREEVIEW*.c, TREEVIEW*.h. All identifiers are prefixed TREEVIEW. The table below shows the appearances of the TREEVIEW widget:
Description
TREEVIEW widget
Treeview widget with row selection enabled.
Treeview widget with text selection enabled.
Treeview widget with some application defined bitmaps and lines off.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
713
16.26.1 Description of terms
Item
This means a treeview item which can be a leaf or a node.
Leaf
A leaf is a treeview item which is not able to have any children. It is represented by the leaf bitmap and the item text.
Node
A node is a treeview item which is able to have children. It is represented by the button bitmap, the node bitmap and the item text. The state of the node can be toggled by pressing the button bitmap or by double clicking the node bitmap or the selected area of the item. In open state the children are visible below the node at the next level of indentation.
Button bitmap
This means the bitmap visible at nodes which can be pressed to toggle the state of the node.
Item bitmap
Left beside the item text the item bitmap is shown. Which bitmap is shown depends in the item (leaf or node) and in case of a node it also depends on the state, collapsed or expanded.
Expanded state
In expanded state the children of a node are visible and the minus sign is shown in the button bitmap.
Collapsed state
In collapsed state the children of a node are hidden and the plus sign is shown in the button bitmap.
Joining lines
Lines which are used to connect the items of a tree. The lines connect the button bitmaps of the nodes and the item bitmaps of the leafs according to the hierarchy of the tree.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
714
CHAPTER
Window Objects (Widgets)
16.26.2 Configuration options
Type
Macro
TREEVIEW_FONT_DEFAULT
TREEVIEW_BKCOLOR0_DEFAULT
TREEVIEW_BKCOLOR1_DEFAULT
TREEVIEW_BKCOLOR2_DEFAULT TREEVIEW_TEXTCOLOR0_DEFAULT TREEVIEW_TEXTCOLOR1_DEFAULT
TREEVIEW_TEXTCOLOR2_DEFAULT
TREEVIEW_LINECOLOR0_DEFAULT
TREEVIEW_LINECOLOR1_DEFAULT
TREEVIEW_LINECOLOR2_DEFAULT
Default
&GUI_Font13_1 GUI_WHITE GUI_BLUE 0xC0C0C0 GUI_BLACK GUI_WHITE GUI_GRAY GUI_BLACK GUI_WHITE GUI_GRAY
Description
Default font used to draw the text. Background color for unselected state Background color for selected state. Background color for disabled state. Text color for unselected state. Text color for selected state. Text color for disabled state. Line color for unselected state. Line color for selected state. Line color for disabled state.
TREEVIEW_IMAGE_CLOSED_DEFAULT
Item image for node in closed state.
TREEVIEW_IMAGE_OPEN_DEFAULT
Item image for node in open state.
TREEVIEW_IMAGE_LEAF_DEFAULT
Item image for leaf.
TREEVIEW_IMAGE_PLUS_DEFAULT
Plus sign.
TREEVIEW_IMAGE_MINUS_DEFAULT
TREEVIEW_INDENT_DEFAULT
16
TREEVIEW_TEXT_INDENT_DEFAULT 20
Minus sign.
Number of pixels for indenting. Number of pixels for indenting text.
16.26.3 Predefined IDs
The following symbols define IDs which may be used to make TREEVIEW widgets distinguishable from creation: GUI_ID_TREEVIEW0 - GUI_ID_TREEVIEW3
16.26.4 Notification codes
The following events are sent from a treeview widget to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_MOVED_OUT WM_NOTIFICATION_SEL_CHANGED
Description
Treeview has been clicked. Treeview has been released. Treeview has been clicked and pointer has been moved out of the widget area without releasing. Value (selection) of the treeview widget has changed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
715
16.26.5 Keyboard reaction
The widget reacts to the following keys if it has the input focus:
Key
Reaction
GUI_KEY_RIGHT
If the cursor is at a closed node, the node is opened. If the cursor is at an open node the cursor moves to the first child of the node.
GUI_KEY_DOWN GUI_KEY_LEFT
The cursor moves to the next visible item below the current position.
If the cursor is at a leaf the cursor moves to the parent node of the item. If the cursor is at an open node, the node will be closed. If the cursor is at a closed node, the cursor moves to the next parent node.
GUI_KEY_UP
The cursor moves to the previous visible item above the current position.
16.26.6 TREEVIEW API
The table below lists the available TREEVIEW-related routines of emWin in alphabetical order. Detailed descriptions of the routines follow.
Routine
Description
Common routines
TREEVIEW_AttachItem()
Attaches an already existing item to the given treeview.
TREEVIEW_CreateEx()
Creates a TREEVIEW widget.
TREEVIEW_CreateIndirect() TREEVIEW_CreateUser() TREEVIEW_DecSel()
Creates a TREEVIEW widget from a resource table. Creates a TREEVIEW widget using extra bytes as user data. Moves the cursor to the previous visible item.
TREEVIEW_GetDefaultBkColor()
Returns the default background color.
TREEVIEW_GetDefaultFont()
Returns the default font used to draw the item text.
TREEVIEW_GetDefaultLineColor() Returns the default line color.
TREEVIEW_GetDefaultTextColor() Returns the default text color.
TREEVIEW_GetItem()
Returns the requested item.
TREEVIEW_GetSel()
Returns the currently selected item.
TREEVIEW_GetUserData()
Retrieves the data set with TREEVIEW_SetUserData().
TREEVIEW_IncSel()
Moves the cursor to the next visible item.
TREEVIEW_InsertItem()
Inserts the given item at the given position.
TREEVIEW_SetAutoScrollH()
Manages the automatic use of a horizontal scrollbar.
TREEVIEW_SetAutoScrollV()
Manages the automatic use of a vertical scrollbar.
TREEVIEW_SetBitmapOffset()
Sets the offset of the plus/minus bitmap.
TREEVIEW_SetBkColor()
Sets the background color.
TREEVIEW_SetDefaultBkColor()
Sets the default background color for TREEVIEW widgets.
TREEVIEW_SetDefaultFont()
Sets the default font for TREEVIEW widgets.
TREEVIEW_SetDefaultLineColor() Sets the default line color for TREEVIEW widgets.
TREEVIEW_SetDefaultTextColor() Sets the default text color for TREEVIEW widgets.
TREEVIEW_SetFont()
Sets the font used to draw the item text.
TREEVIEW_SetHasLines()
Manages the visibility of the joining lines.
TREEVIEW_SetImage()
Sets the images used to draw the treeview items.
TREEVIEW_SetIndent()
Sets the indentation distance for treeview items.
TREEVIEW_SetLineColor()
Sets the color used to draw the joining lines.
TREEVIEW_SetOwnerDraw()
Enables the treeview to be owner drawn.
TREEVIEW_SetSel()
Sets the selection of the treeview.
TREEVIEW_SetSelMode()
Manages the highlighting of the current selection.
TREEVIEW_SetTextColor()
Sets the color used to draw the treeview items.
TREEVIEW_SetTextIndent()
Sets the indentation distance for item text.
TREEVIEW_SetUserData()
Sets the extra data of a TREEVIEW widget.
Item related routines
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
716
CHAPTER
Window Objects (Widgets)
Routine TREEVIEW_ITEM_Collapse() TREEVIEW_ITEM_CollapseAll() TREEVIEW_ITEM_Create() TREEVIEW_ITEM_Delete() TREEVIEW_ITEM_Detach() TREEVIEW_ITEM_Expand() TREEVIEW_ITEM_ExpandAll() TREEVIEW_ITEM_GetInfo() TREEVIEW_ITEM_GetText() TREEVIEW_ITEM_GetUserData() TREEVIEW_ITEM_SetImage() TREEVIEW_ITEM_SetText() TREEVIEW_ITEM_SetUserData()
16.26.6.1Common routines
Description
Collapses the given node. Collapses the given node and all subnodes. Creates a new treeview item. Deletes the given treeview item. Detaches the given item without deleting it. Expands the given node. Expands the given node and all subnodes. Returns an information structure of the given item. Returns the item text.
Returns the UserData value of the treeview item.
Sets the images used to draw the individual given item. Sets the text of the given item.
Sets the UserData value of the treeview item.
TREEVIEW_AttachItem()
Description
Attaches an already existing item to the treeview widget.
Prototype
int TREEVIEW_AttachItem(TREEVIEW_Handle
hObj,
TREEVIEW_ITEM_Handle hItem,
TREEVIEW_ITEM_Handle hItemAt, int Position);
Parameter hObj hItem hItemAt Position
Description
Handle of widget. Handle of item to be attached. Handle of a currently attached item which specifies the position to be used. See table below.
Permitted values for parameter Position
TREEVIEW_INSERT_ABOVE TREEVIEW_INSERT_BELOW TREEVIEW_INSERT_FIRST_CHILD
Attaches the item above the given position at the same indent level as the given position.
Attaches the item below the given position at the same indent level as the given position.
Attaches the item below the given position by indenting it. The given position needs to be a node level.
Return value
0 on success, otherwise 1.
Additional information
The function can be used for attaching a single item as well as for attaching a complete tree. Note that in case of attaching a tree, the root item of the tree needs to be passed as hItem. If attaching the first item to an empty treeview the parameters hItem and Position should be 0.
TREEVIEW_CreateEx()
Description
Creates a TREEVIEW widget of a specified size at a specified location.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
717
Prototype
TREEVIEW_Handle TREEVIEW_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN hParent, int WinFlags,
int
ExFlags, int Id);
Parameter x0 y0 xsize ysize hParent
WinFlags
ExFlags Id
Description
Leftmost pixel of the widget (in parent coordinates). Topmost pixel of the widget (in parent coordinates). Horizontal size of the widget (in pixels). Vertical size of the widget (in pixels). Handle of parent window. If 0, the new TEXT widget will be a child of the desktop (top-level window).
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chapter "The Window Manager
(WM)" on page 331 for a list of available parameter values). See table below. Window ID of the widget.
Permitted values for parameter ExFlags
TREEVIEW_CF_HIDELINES TREEVIEW_CF_ROWSELECT TREEVIEW_CF_AUTOSCROLLBAR_H
TREEVIEW_CF_AUTOSCROLLBAR_V
Joining lines are not displayed.
Activates row selection mode.
Enables the use of an automatic horizontal scrollbar. Enables the use of an automatic vertical scrollbar.
Return value
Handle of the created widget. 0, if the function fails.
Additional information
The values of parameter ExFlags can be or-combined.
TREEVIEW_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The Para element of the resource table is not used.
TREEVIEW_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function TREEVIEW_CreateEx() can be referred to.
TREEVIEW_DecSel()
Before
After
Description
Moves the cursor to the previous visible item of the given treeview.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
718
CHAPTER
Window Objects (Widgets)
Prototype
void TREEVIEW_DecSel(TREEVIEW_Handle hObj);
Parameter hObj
Handle of widget.
Description
Additional information
If there is no previous visible item the cursor remains on the current position.
TREEVIEW_GetDefaultBkColor()
Description
Returns the default background color used for new treeview widgets.
Prototype
GUI_COLOR TREEVIEW_GetDefaultBkColor(int Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
TREEVIEW_CI_UNSEL TREEVIEW_CI_SEL
Background color of unselected element. Background color of selected element.
TREEVIEW_CI_DISABLED Background color of disabled element.
Return value
Default background color used for new treeview widgets.
TREEVIEW_GetDefaultFont()
Description
Returns the default font used to draw the item text of new treeview widgets.
Prototype
const GUI_FONT GUI_UNI_PTR * TREEVIEW_GetDefaultFont(void);
Return value
Default font used to draw the item text of new treeview widgets.
TREEVIEW_GetDefaultLineColor()
Description
Returns the default color used to draw the joining lines of new treeview widgets.
Prototype
GUI_COLOR TREEVIEW_GetDefaultLineColor(int Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
TREEVIEW_CI_UNSEL TREEVIEW_CI_SEL TREEVIEW_CI_DISABLED
Line color of unselected element. Line color of selected element. Line color of disabled element.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
719
Return value
Default color used to draw the joining lines of new treeview widgets.
TREEVIEW_GetDefaultTextColor()
Description
Returns the default text color used to draw the item text of new treeview widgets.
Prototype
GUI_COLOR TREEVIEW_GetDefaultTextColor(int Index);
Parameter Index
See table below.
Description
Permitted values for parameter Index
TREEVIEW_CI_UNSEL TREEVIEW_CI_SEL TREEVIEW_CI_DISABLED
Text color of unselected element. Text color of selected element. Text color of disabled element.
Return value
Default text color used to draw the item text of new treeview widgets.
TREEVIEW_GetItem()
Description
Returns the handle of the requested treeview item.
Prototype
TREEVIEW_ITEM_Handle TREEVIEW_GetItem(TREEVIEW_Handle
hObj,
TREEVIEW_ITEM_Handle hItem,
int
Flags);
Parameter hObj hItem Flags
Description
Handle of widget. Handle of treeview item specifying the position to start search from. See table below.
Permitted values for parameter Flags
TREEVIEW_GET_FIRST TREEVIEW_GET_LAST TREEVIEW_GET_NEXT_SIBLING TREEVIEW_GET_PREV_SIBLING
Returns the first item of the treeview widget.
Parameter hItem is not required and can be
0. Returns the last item of the treeview widget.
Parameter hItem is not required and can be
0. Returns the next child item of the parent
node of hItem.
Returns the previous child item of the parent
node of hItem.
TREEVIEW_GET_FIRST_CHILD Returns the first child of the given node.
TREEVIEW_GET_PARENT
Returns the parent node of the given item.
Return value
Handle of the requested treeview item on success, otherwise 0.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
720
CHAPTER
Window Objects (Widgets)
Example
The picture shows a treeview widget with several items. The following shows how parameter Flags can be used for getting treeview items relative to parameter hItem:
· TREEVIEW_GET_NEXT_SIBLING The next sibling of '1.1' is '1.2'.
· TREEVIEW_GET_PREV_SIBLING The previous sibling of '1.2' is '1.1'.
· TREEVIEW_GET_FIRST_CHILD The first child item of '1.1.1' is '1.1.1.1'.
· TREEVIEW_GET_PARENT The parent item of '1.1' is '1'.
The use of TREEVIEW_GET_FIRST and TREEVIEW_GET_LAST should be obvious. If the requested item does not exist, the function returns 0.
TREEVIEW_GetSel()
Description
Returns the handle of the currently selected treeview item.
Prototype
TREEVIEW_ITEM_Handle TREEVIEW_GetSel(TREEVIEW_Handle hObj);
Parameter hObj
Handle of widget.
Description
Return value
Handle of the currently selected treeview item. If no item has been selected the return value is 0.
TREEVIEW_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
TREEVIEW_IncSel()
Before
After
Description
Moves the cursor to the next visible item of the given treeview.
Prototype
void TREEVIEW_IncSel(TREEVIEW_Handle hObj);
Parameter hObj
Handle of widget.
Description
Additional information
If there is no next visible item the cursor remains on the current position.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
TREEVIEW_InsertItem()
Before
721 After
Description
The function creates and inserts one new treeview item relative to the given item.
Prototype
TREEVIEW_ITEM_Handle TREEVIEW_InsertItem(TREEVIEW_Handle
hObj,
int
IsNode,
TREEVIEW_ITEM_Handle hItemPrev,
int
Position,
const char GUI_UNI_PTR * s);
Parameter hObj IsNode hItemPrev Position s
Description
Handle of widget. See table below. Handle of treeview item specifying the position of the new item. See table below. Text of new treeview item.
Permitted values for parameter IsNode
TREEVIEW_ITEM_TYPE_LEAF TREEVIEW_ITEM_TYPE_NODE
New item is a 'leaf'. New item is a 'node'.
Permitted values for parameter Position
TREEVIEW_INSERT_FIRST_CHILD TREEVIEW_INSERT_ABOVE TREEVIEW_INSERT_BELOW
Should be used for the first item of a treeview node.
Inserts the item above the given item with the same indent level.
Inserts the item below the given item with the same indent level.
Return value
Handle of the new item on success, otherwise 0.
TREEVIEW_SetAutoScrollH()
Before
After
Description
Enables or disables the use of an automatic horizontal scrollbar.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
722
CHAPTER
Window Objects (Widgets)
Prototype
void TREEVIEW_SetAutoScrollH(TREEVIEW_Handle hObj, int State);
Parameter hObj State
Description
Handle of widget. 1 for enabling an automatic horizontal scrollbar, 0 for disabling.
TREEVIEW_SetAutoScrollV()
Before
After
Description
Enables or disables the use of an automatic vertical scrollbar.
Prototype
void TREEVIEW_SetAutoScrollV(TREEVIEW_Handle hObj, int State);
Parameter hObj State
Description
Handle of widget. 1 for enabling an automatic vertical scrollbar, 0 for disabling.
TREEVIEW_SetBitmapOffset()
Before
After
Description
Sets the offset of the plus/minus bitmap.
Prototype
void TREEVIEW_SetBitmapOffset(TREEVIEW_Handle hObj, int Index,
int
xOff, int yOff);
Parameter hObj Index xOff yOff
Description
Handle of widget. Currently the only permitted value for this parameter is TREEVIEW_BI_PM. Horizontal offset. Vertical offset.
Additional information
If xOff and yOff are set to 0 (default), the plus/minus bitmap is centered horizontally and vertically in the indentation space left of the actual item. The indentation space is related to the parent item (if exists) or to the left border of the widget. See "before / after" screenshots of the function "TREEVIEW_SetIndent()" on page 725.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
TREEVIEW_SetBkColor()
Before
723 After
Description
Sets the background color of the given widget.
Prototype
void TREEVIEW_SetBkColor(TREEVIEW_Handle hObj, int Index, GUI_COLOR Color);
Parameter hObj Index Color
Handle of widget. See table below. Color to be used.
Description
Permitted values for parameter Index
TREEVIEW_CI_UNSEL
Color of unselected item.
TREEVIEW_CI_SEL TREEVIEW_CI_DISABLED
Color of selected item. Color of disabled item.
TREEVIEW_SetDefaultBkColor()
Description
Sets the default background color used for new treeview widgets.
Prototype
void TREEVIEW_SetDefaultBkColor(int Index, GUI_COLOR Color);
Parameter Index Color
Description
Refer to "TREEVIEW_SetBkColor()" on page 723. Color to be used.
TREEVIEW_SetDefaultFont()
Description
Sets the default font used for new treeview widgets.
Prototype
void TREEVIEW_SetDefaultFont(const GUI_FONT GUI_UNI_PTR * pFont);
Parameter pFont
Description
Pointer to GUI_FONT structure to be used.
TREEVIEW_SetDefaultLineColor()
Description
Sets the default line color used for new treeview widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
724
CHAPTER
Window Objects (Widgets)
Prototype
void TREEVIEW_SetDefaultLineColor(int Index, GUI_COLOR Color);
Parameter Index Color
Description
Refer to "TREEVIEW_SetBkColor()" on page 723. Color to be used.
TREEVIEW_SetDefaultTextColor()
Description
Sets the default text color used for new treeview widgets.
Prototype
void TREEVIEW_SetDefaultTextColor(int Index, GUI_COLOR Color);
Parameter Index Color
Description
Refer to "TREEVIEW_SetBkColor()" on page 723. Color to be used.
TREEVIEW_SetFont()
Before
After
Description
Sets the font to be used to draw the item text of the given treeview widget.
Prototype
void TREEVIEW_SetFont(TREEVIEW_Handle
hObj,
const GUI_FONT GUI_UNI_PTR * pFont);
Parameter hObj pFont
Description
Handle of widget. Pointer to GUI_FONT structure to be used.
TREEVIEW_SetHasLines()
Before
After
Description
Manages the visibility of the joining lines between the treeview items.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
725
Prototype
void TREEVIEW_SetHasLines(TREEVIEW_Handle hObj, int State);
Parameter hObj State
Description
Handle of widget. 1 for showing the lines, 0 for not showing the lines.
Additional information
Per default the lines are shown.
TREEVIEW_SetImage()
Before
After
Description
Sets the images used to draw the treeview items.
Prototype
void TREEVIEW_SetImage(TREEVIEW_Handle hObj,
int Index,
const GUI_BITMAP * pBitmap);
Parameter hObj Index pBitmap
Description
Handle of widget. See table below. Pointer to bitmap structure to be used.
Permitted values for parameter Index
TREEVIEW_BI_CLOSED TREEVIEW_BI_OPEN TREEVIEW_BI_LEAF TREEVIEW_BI_PLUS TREEVIEW_BI_MINUS
Image of closed nodes. Image of open nodes. Image of leaf. Plus sign of closed nodes. Minus sign of open nodes.
Additional information
The function TREEVIEW_SetItemImage() can be used to set individual images for each item.
TREEVIEW_SetIndent()
Before
After
Description
Sets the indentation of treeview items in pixels. Indentation is 16 pixels by default.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
726
CHAPTER
Window Objects (Widgets)
Prototype
int TREEVIEW_SetIndent(TREEVIEW_Handle hObj, int Indent);
Parameter hObj Indent
Description
Handle of widget. Distance (in pixels) to indent treeview items.
Return value
Previous indentation.
TREEVIEW_SetLineColor()
Before
After
Description
Sets the color used to draw the joining lines between the treeview items.
Prototype
void TREEVIEW_SetLineColor(TREEVIEW_Handle hObj, int Index, GUI_COLOR Color);
Parameter hObj Index Color
Description
Handle of widget. Refer to "TREEVIEW_SetBkColor()" on page 723. Color to be used.
TREEVIEW_SetOwnerDraw()
Description
Enables the treeview to be owner drawn.
Prototype
void TREEVIEW_SetOwnerDraw(TREEVIEW_Handle
hObj,
WIDGET_DRAW_ITEM_FUNC * pfDrawItem);
Parameter hObj pfDrawItem
Description
Handle of widget. Pointer to the owner draw function. See "User drawn widgets" on page 410.
TREEVIEW_SetSel()
Before
After
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
727
Description
Sets the currently selected item of the treeview.
Prototype
void TREEVIEW_SetSel(TREEVIEW_Handle hObj, TREEVIEW_ITEM_Handle hItem);
Parameter hObj hItem
Description
Handle of widget. Handle of treeview item to be selected.
Additional information
If the given treeview item is a child of a closed node no selection is visible after calling this function.
TREEVIEW_SetSelMode()
Before
After
Description
Sets the selection mode of the treeview widget.
Prototype
void TREEVIEW_SetSelMode(TREEVIEW_Handle hObj, int Mode);
Parameter hObj Mode
Handle of widget. See table below.
Description
Permitted values for parameter Mode
TREEVIEW_SELMODE_ROW TREEVIEW_SELMODE_TEXT
Activates row selection mode. Activates text selection mode.
Additional information
Default selection mode is text selection. If row selection is activated, the complete row can be used to select the item. If text selection is active, only the item text and the item bitmap can be used for selection.
TREEVIEW_SetTextColor()
Before
After
Description
Sets the color used to draw the treeview items of the given widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
728
CHAPTER
Window Objects (Widgets)
Prototype
void TREEVIEW_SetTextColor(TREEVIEW_Handle hObj, int Index,
GUI_COLOR
Color);
Parameter hObj Index Color
Description
Handle of widget. Refer to "TREEVIEW_SetBkColor()" on page 723. Color to be used.
TREEVIEW_SetTextIndent()
Before
After
Description
Sets the indentation of item text in pixels. Text indentation is 20 pixels by default.
Prototype
int TREEVIEW_SetTextIndent(TREEVIEW_Handle hObj, int TextIndent);
Parameter hObj TextIndent
Handle of widget. Text indentation to be used.
Description
Return value
Previous text indentation.
TREEVIEW_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
16.26.6.2Item related routines
TREEVIEW_ITEM_Collapse()
Before
After
Description
Collapses the given node and shows the plus sign afterwards.
Prototype
void TREEVIEW_ITEM_Collapse(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Description
Handle of the item to be collapsed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
729
Additional information
The given item needs to be a node. Otherwise the function returns immediately.
TREEVIEW_ITEM_CollapseAll()
Before
All nodes collapsed
Expanded again
Description
Collapses the given node and all subnodes and shows the plus sign afterwards.
Prototype
void TREEVIEW_ITEM_CollapseAll(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Description
Handle of the item to be collapsed.
Additional information
This function collapses all subnodes, so if the given node is expanded again, all subnodes are in collapsed state.
TREEVIEW_ITEM_Create()
Description
Creates a new treeview item.
Prototype
TREEVIEW_ITEM_Handle TREEVIEW_CreateItem(int
IsNode,
const char GUI_UNI_PTR * s,
U32
UserData);
Parameter IsNode s UserData
Description
See table below. Pointer to item text to be shown. 32 bit value to be used by the application.
Permitted values for parameter IsNode
TREEVIEW_ITEM_TYPE_NODE TREEVIEW_ITEM_TYPE_LEAF
Used to create a node. Used to create a leaf.
Return value
Handle of new item on success, otherwise 0.
Additional information
After creating a treeview item it contains a copy of the text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
730
CHAPTER
Window Objects (Widgets)
TREEVIEW_ITEM_Delete()
Description
Deletes the given treeview item.
Prototype
void TREEVIEW_ITEM_Delete(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Handle of item to be deleted.
Description
Additional information
If the item is currently not attached to any treeview, the parameter hObj should be 0. The function can be used to delete a single item as well as for deleting a complete tree. In case of deleting a tree the root element of the tree should be passed to the function.
TREEVIEW_ITEM_Detach()
Description
Detaches the given treeview item from the treeview widget.
Prototype
void TREEVIEW_ITEM_Detach(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Handle of item to be detached.
Description
Additional information
The function detaches the given item and all of its children from the treeview.
TREEVIEW_ITEM_Expand()
Before
After
Description
Expands the given node and shows the minus sign afterwards.
Prototype
void TREEVIEW_ITEM_Expand(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Description
Handle of node to be expanded.
Additional information
The given item needs to be a node. Otherwise the function returns immediately.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
TREEVIEW_ITEM_ExpandAll()
Before
731 After
Description
Expands the given node and all subnodes and shows the minus sign afterwards.
Prototype
void TREEVIEW_ITEM_ExpandAll(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Description
Handle of the item to be expanded.
TREEVIEW_ITEM_GetInfo()
Description
Returns a structure with information about the given item.
Prototype
void TREEVIEW_ITEM_GetInfo(TREEVIEW_ITEM_Handle hItem, TREEVIEW_ITEM_INFO * pInfo);
Parameter hItem pInfo
Description
Handle of treeview item.
Pointer to a TREEVIEW_ITEM_INFO structure to be filled by the function.
Elements of TREEVIEW_ITEM_INFO
Data type int int int int int
Element IsNode IsExpanded HasLines HasRowSelect Level
Description
1 if item is a node, 0 if not. 1 if item (node) is open, 0 if closed. 1 if joining lines are visible, 0 if not. 1 if row selection is active, 0 if not. Indentation level of item.
TREEVIEW_ITEM_GetText()
Description
Returns the item text of the given treeview item.
Prototype
void TREEVIEW_ITEM_GetText(TREEVIEW_ITEM_Handle hItem,
U8
* pBuffer,
int
MaxNumBytes);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
732
CHAPTER
Window Objects (Widgets)
Parameter hItem pBuffer MaxNumBytes
Description
Handle of treeview item. Pointer to buffer filled by the function. Size of the buffer in bytes.
Additional information
If MaxNumBytes is less than the item text length the buffer is filled with the first MaxNumBytes of the item text.
TREEVIEW_ITEM_GetUserData()
Description
The function return the 32 bit value associated with the given treeview item which can be used by the application program.
Prototype
U32 TREEVIEW_ITEM_GetUserData(TREEVIEW_ITEM_Handle hItem);
Parameter hItem
Handle of treeview item.
TREEVIEW_ITEM_SetImage()
Description
Before
After
Description
The function sets images to be used only with the given treeview item.
Prototype
void TREEVIEW_ITEM_SetImage(TREEVIEW_ITEM_Handle hItem, int Index,
const GUI_BITMAP
* pBitmap);
Parameter hItem Index pBitmap
Description
Handle if treeview item. See table below. Pointer to bitmap structure to be used.
Permitted values for parameter Index
TREEVIEW_BI_CLOSED TREEVIEW_BI_OPEN TREEVIEW_BI_LEAF
Image of closed node. Image of open node. Image of leaf.
Additional information
This function 'overwrites' the default images of the widget. If no individual image is set the default image is used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
TREEVIEW_ITEM_SetText()
Before
733 After
Description
The function sets the text of the given item.
Prototype
TREEVIEW_ITEM_Handle TREEVIEW_ITEM_SetText(TREEVIEW_ITEM_Handle
hItem,
const char GUI_UNI_PTR * s);
Parameter hItem s
Handle of treeview item. Pointer to text to be used.
Description
Return value
Handle of the treeview item with the new text.
Additional information
The text will be copied into the treeview item. Note that using this function changes the handle of the item. After calling this function, the new handle needs to be used.
TREEVIEW_ITEM_SetUserData()
Description
The function sets a 32 bit value associated with the given treeview item which can be used by the application program.
Prototype
void TREEVIEW_ITEM_SetUserData(TREEVIEW_ITEM_Handle hItem, U32 UserData);
Parameter hItem UserData
Description
Handle of treeview item. 32 bit value to be used by the application program.
16.26.7 Example
The Sample folder contains the following example which shows how the widget can be used: WIDGET_TreeviewTryit.c
Note that several other examples also make use of this widget and may also be helpful to get familiar with the widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
734
CHAPTER
Screenshot of WIDGET_TreeviewTryit.c:
Window Objects (Widgets)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
735
16.27 WINDOW: Window widget
The WINDOW widget is used to create a dialog window from a resource table. It should be used if the dialog should not look like a frame window. The window widget acts as background and as a container for child windows: It can contain child windows and fills the background, typically with gray. It behaves much like a frame-window without frame and title bar and is used for dialogs. All WINDOW-related routines are located in the file(s) WINDOW.c, DIALOG.h.
16.27.1 Configuration options
Type
Macro
Default
Description
S
WINDOW_BKCOLOR_DEFAULT 0xC0C0C0 Default background color for new WINDOW widgets
16.27.2 Keyboard reaction
The widget can not gain the input focus and does not react on keyboard input.
16.27.3 WINDOW API
The table below lists the available emWin WINDOW-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine WINDOW_CreateEx() WINDOW_CreateIndirect() WINDOW_CreateUser() WINDOW_GetUserData() WINDOW_SetBkColor() WINDOW_SetDefaultBkColor() WINDOW_SetUserData()
Description
Creates a WINDOW widget. Creates a WINDOW widget from a resource table entry. Creates a WINDOW widget using extra bytes as user data. Retrieves the data set with WINDOW_SetUserData(). Sets the background color of the given WINDOW widget. Sets the default background color for WINDOW widgets. Sets the extra data of a WINDOW widget.
WINDOW_CreateEx()
Description
Creates a WINDOW widget of a specified size at a specified location.
Prototype
WINDOW_Handle WINDOW_CreateEx(int
x0,
int y0,
int
xsize, int ysize,
WM_HWIN
hParent, int WinFlags,
int
ExFlags, int Id,
WM_CALLBACK * cb);
Parameter x0 y0 xsize ysize hParent
WinFlags
Description
Leftmost pixel of the WINDOW widget (in parent coordinates) Topmost pixel of the WINDOW widget (in parent coordinates) Size of the WINDOW widget in X Size of the WINDOW widget in Y Handle of parent window
Window create flags. Typically WM_CF_SHOW in order to make the widget visible immediately (refer to WM_CreateWindow() in the chap-
ter "The Window Manager (WM)" on page 331 for a list of available parameter values)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
736
CHAPTER
Window Objects (Widgets)
Parameter
Description
ExFlags Id cb
Not used yet, reserved for future use Window ID of the WINDOW widget Pointer to callback routine.
Return value
Handle of the created WINDOW widget; 0 if the function fails.
WINDOW_CreateIndirect()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateIndirect(). The Sample folder contains the file WIDGET_Window.c which shows how to use the WINDOW widget in a dialog resource.
WINDOW_CreateUser()
Prototype explained at the beginning of the chapter as <WIDGET>_CreateUser(). For a detailed description of the parameters the function WINDOW_CreateEx() can be referred to.
WINDOW_GetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_GetUserData().
WINDOW_SetBkColor()
Description
Sets the background color for the given WINDOW widget.
Prototype
void WINDOW_SetBkColor(WM_HWIN hObj, GUI_COLOR Color);
Parameter hObj Color
Handle of the widget. Background color to be used.
Description
WINDOW_SetDefaultBkColor()
Description
Sets the default background color used for WINDOW widgets.
Prototype
void WINDOW_SetDefaultBkColor(GUI_COLOR Color);
Parameter Color
Color to be used.
Description
WINDOW_SetUserData()
Prototype explained at the beginning of the chapter as <WIDGET>_SetUserData().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
737
Chapter 17
Dialogs
Widgets may be created and used on their own, as they are by nature windows themselves. However, it is often desirable to use dialog boxes, which are windows that contain one or more widgets. A dialog box (or dialog) is normally a window that appears in order to request input from the user. It may contain multiple widgets, requesting information from the user through various selections, or it may take the form of a message box which simply provides information (such as a note or warning) and an "OK" button. For common tasks like choosing a file, choosing a color or (as mentioned before) for showing simple text messages emWin offers 'common dialogs'. These dialogs can be configured to achieve the look and feel of the application.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
738
CHAPTER
Dialogs
17.1 Dialog basics
Input focus
The Window Manager remembers the window or window object that was last selected by the user with the touch-screen, mouse, keyboard, or other means. This window receives keyboard input messages and is said to have the input focus. The primary reason for keeping track of input focus is to determine where to send keyboard commands. The window which has input focus will receive events generated by the keyboard. To move the input focus within a dialog to the next focusable dialog item the key GUI_KEY_TAB can be used. To move backwards GUI_KEY_BACKTAB can be used.
Blocking vs. non-blocking dialogs
Dialog windows can be blocking or non-blocking. A blocking dialog blocks the thread of execution. It has input focus by default and must be closed by the user before the thread can continue. A blocking dialog does not disable other dialogs shown at the same time. With other words a blocking dialog is not a modal dialog. Blocking means, the used functions (GUI_ExecDialogBox() or GUI_ExecCreatedDialog()) does not return until the dialog is closed. A non-blocking dialog, on the other hand, does not block the calling thread -- it allows the task to continue while it is visible. The function returns immediately after creating the dialog. Please note that blocking functions should never be called from within callback functions. This may cause malfunction of the application.
Dialog procedure
A dialog box is a window, and it receives messages just like all other windows in the system do. Most messages are handled by the window callback routine of the dialog box automatically; the others are passed to the callback routine specified upon creation of the dialog box, which is known as the dialog procedure.
Dialog messages
There are two types of additional messages which are sent to the dialog procedure: WM_INIT_DIALOG and WM_NOTIFY_PARENT. The WM_INIT_DIALOG message is sent to the dialog procedure immediately before a dialog box is displayed. Dialog procedures typically use this message to initialize widgets and carry out any other initialization tasks that affect the appearance of the dialog box. The WM_NOTIFY_PARENT message is sent to the dialog box by its child windows in order to notify the parent of any events in order to ensure synchronization. The events sent by a child depend on its type and are documented separately for every type of widget.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
739
17.2 Creating a dialog
Two basic things are required to create a dialog box: a resource table that defines the widgets to be included, and a dialog procedure which defines the initial values for the widgets as well as their behavior. Once both items exist, you need only a single function call (GUI_CreateDialogBox() or GUI_ExecDialogBox()) to actually create the dialog.
17.2.1 Resource table
Dialog boxes may be created in a blocking manner (using GUI_ExecDialogBox()) or as non-blocking (using GUI_CreateDialogBox()). A resource table must first be defined which specifies all widgets to be included in the dialog. The example shown below creates a resource table:
static const GUI_WIDGET_CREATE_INFO _aDialogCreate[] = {
{ FRAMEWIN_CreateIndirect, "Dialog", 0,
10, 10, 180, 230, FRAMEWIN_CF_MOVEABLE, 0 },
{ BUTTON_CreateIndirect, "OK",
GUI_ID_OK,
100, 5, 60, 20 },
{ BUTTON_CreateIndirect, "Cancel", GUI_ID_CANCEL, 100, 30, 60, 20 },
{ TEXT_CreateIndirect,
"LText", 0,
10, 55, 48, 15, TEXT_CF_LEFT },
{ TEXT_CreateIndirect,
"RText", 0,
10, 80, 48, 15, TEXT_CF_RIGHT },
{ EDIT_CreateIndirect,
NULL,
GUI_ID_EDIT0, 60, 55, 100, 15, 0, 50 },
{ EDIT_CreateIndirect,
NULL,
GUI_ID_EDIT1, 60, 80, 100, 15, 0, 50 },
{ TEXT_CreateIndirect,
"Hex", 0,
10, 100, 48, 15, TEXT_CF_RIGHT },
{ EDIT_CreateIndirect,
NULL,
GUI_ID_EDIT2, 60, 100, 100, 15, 0, 6 },
{ TEXT_CreateIndirect,
"Bin", 0,
10, 120, 48, 15, TEXT_CF_RIGHT },
{ EDIT_CreateIndirect,
NULL,
GUI_ID_EDIT3, 60, 120, 100, 15 },
{ LISTBOX_CreateIndirect, NULL,
GUI_ID_LISTBOX0,10, 10, 48, 40 },
{ CHECKBOX_CreateIndirect, NULL,
GUI_ID_CHECK0, 10, 140, 0, 0 },
{ CHECKBOX_CreateIndirect, NULL,
GUI_ID_CHECK1, 30, 140, 0, 0 },
{ SLIDER_CreateIndirect, NULL,
GUI_ID_SLIDER0, 60, 140, 100, 20 },
{ SLIDER_CreateIndirect, NULL,
GUI_ID_SLIDER1, 10, 170, 150, 30 }
};
Any widget to be included in a dialog box must be created indirectly with the <WIDGET>_CreateIndirect() function. For more information, refer to the chapter "Window Objects (Widgets)" on page 401.
17.2.2 Dialog procedure
The example above has been created using the blank dialog procedure shown below. This is the basic template which should be used as a starting point when creating any dialog procedure:
/*********************************************************************
*
*
Dialog procedure
*/
static void _cbCallback(WM_MESSAGE * pMsg) {
switch (pMsg->MsgId) {
default:
WM_DefaultProc(pMsg);
}
}
For this example, the dialog box is displayed with the following line of code:
GUI_ExecDialogBox(_aDialogCreate, GUI_COUNTOF(_aDialogCreate), &_cbCallback, 0, 0, 0);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
740
CHAPTER
Dialogs
The resulting dialog box looks as follows, or similar (the actual appearance will depend on your configuration and default settings):
After creation of the dialog box, all widgets included in the resource table will be visible, although as can be seen in the previous screen shot, they will appear "empty". This is because the dialog procedure does not yet contain code that initializes the individual elements. The initial values of the widgets, the actions caused by them, and the interactions between them need to be defined in the dialog procedure.
17.2.2.1 Initializing the dialog
The typical next step is to initialize the widgets with their respective initial values. This is normally done in the dialog procedure as a reaction to the WM_INIT_DIALOG message. The program excerpt below illustrates things:
/*********************************************************************
*
*
Dialog procedure
*/
static void _cbCallback(WM_MESSAGE * pMsg) {
int NCode, Id;
WM_HWIN hEdit0, hEdit1, hEdit2, hEdit3, hListBox;
WM_HWIN hWin = pMsg->hWin;
switch (pMsg->MsgId) {
case WM_INIT_DIALOG:
/* Get window handles for all widgets */
hEdit0 = WM_GetDialogItem(hWin, GUI_ID_EDIT0);
hEdit1 = WM_GetDialogItem(hWin, GUI_ID_EDIT1);
hEdit2 = WM_GetDialogItem(hWin, GUI_ID_EDIT2);
hEdit3 = WM_GetDialogItem(hWin, GUI_ID_EDIT3);
hListBox = WM_GetDialogItem(hWin, GUI_ID_LISTBOX0);
/* Initialize all widgets */
EDIT_SetText(hEdit0, "EDIT widget 0");
EDIT_SetText(hEdit1, "EDIT widget 1");
EDIT_SetTextAlign(hEdit1, GUI_TA_LEFT);
EDIT_SetHexMode(hEdit2, 0x1234, 0, 0xffff);
EDIT_SetBinMode(hEdit3, 0x1234, 0, 0xffff);
LISTBOX_SetText(hListBox, _apListBox);
WM_DisableWindow (WM_GetDialogItem(hWin, GUI_ID_CHECK1));
CHECKBOX_Check( WM_GetDialogItem(hWin, GUI_ID_CHECK0));
CHECKBOX_Check( WM_GetDialogItem(hWin, GUI_ID_CHECK1));
SLIDER_SetWidth( WM_GetDialogItem(hWin, GUI_ID_SLIDER0), 5);
SLIDER_SetValue( WM_GetDialogItem(hWin, GUI_ID_SLIDER1), 50);
break;
default:
WM_DefaultProc(pMsg);
)
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
741
The initialized dialog box now appears as follows, with all widgets containing their initial values:
17.2.2.2 Defining dialog behavior
Once the dialog has been initialized, all that remains is to add code to the dialog procedure which will define the behavior of the widgets, making them fully operable. Continuing with the same example, the final dialog procedure is shown below:
/*********************************************************************
*
*
Dialog procedure
*/
static void _cbCallback(WM_MESSAGE * pMsg) {
int NCode, Id;
WM_HWIN hEdit0, hEdit1, hEdit2, hEdit3, hListBox;
WM_HWIN hWin = pMsg->hWin;
switch (pMsg->MsgId) {
case WM_INIT_DIALOG:
/* Get window handles for all widgets */
hEdit0 = WM_GetDialogItem(hWin, GUI_ID_EDIT0);
hEdit1 = WM_GetDialogItem(hWin, GUI_ID_EDIT1);
hEdit2 = WM_GetDialogItem(hWin, GUI_ID_EDIT2);
hEdit3 = WM_GetDialogItem(hWin, GUI_ID_EDIT3);
hListBox = WM_GetDialogItem(hWin, GUI_ID_LISTBOX0);
/* Initialize all widgets */
EDIT_SetText(hEdit0, "EDIT widget 0");
EDIT_SetText(hEdit1, "EDIT widget 1");
EDIT_SetTextAlign(hEdit1, GUI_TA_LEFT);
EDIT_SetHexMode(hEdit2, 0x1234, 0, 0xffff);
EDIT_SetBinMode(hEdit3, 0x1234, 0, 0xffff);
LISTBOX_SetText(hListBox, _apListBox);
WM_DisableWindow (WM_GetDialogItem(hWin, GUI_ID_CHECK1));
CHECKBOX_Check( WM_GetDialogItem(hWin, GUI_ID_CHECK0));
CHECKBOX_Check( WM_GetDialogItem(hWin, GUI_ID_CHECK1));
SLIDER_SetWidth( WM_GetDialogItem(hWin, GUI_ID_SLIDER0), 5);
SLIDER_SetValue( WM_GetDialogItem(hWin, GUI_ID_SLIDER1), 50);
break;
case WM_KEY:
switch (((WM_KEY_INFO*)(pMsg->Data.p))->Key) {
case GUI_ID_ESCAPE:
GUI_EndDialog(hWin, 1);
break;
case GUI_ID_ENTER:
GUI_EndDialog(hWin, 0);
break;
}
break;
case WM_NOTIFY_PARENT:
Id = WM_GetId(pMsg->hWinSrc); /* Id of widget */
NCode = pMsg->Data.v;
/* Notification code */
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
742
CHAPTER
Dialogs
switch (NCode) {
case WM_NOTIFICATION_RELEASED: /* React only if released */
if (Id == GUI_ID_OK) {
/* OK Button */
GUI_EndDialog(hWin, 0);
}
if (Id == GUI_ID_CANCEL) {
/* Cancel Button */
GUI_EndDialog(hWin, 1);
}
break;
case WM_NOTIFICATION_SEL_CHANGED: /* Selection changed */
FRAMEWIN_SetText(hWin, "Dialog - sel changed");
break;
default:
FRAMEWIN_SetText(hWin, "Dialog - notification received");
}
break;
default:
WM_DefaultProc(pMsg);
}
}
For further details, this entire example is available as Dialog.c in the examples shipped with emWin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
743
17.3 Dialog API
The table below lists the available dialog-related routines in alphabetical order within their respective categories. Detailed descriptions of the routines can be found in the sections that follow:
Routine GUI_CreateDialogBox() GUI_ExecCreatedDialog() GUI_ExecDialogBox() GUI_EndDialog()
Description
Create a non-blocking dialog. Executes an already created dialog. Create and execute a dialog. End a dialog box.
GUI_CreateDialogBox()
Description
Creates a dialog box.
Prototype
WM_HWIN GUI_CreateDialogBox(const GUI_WIDGET_CREATE_INFO * paWidget,
int
NumWidgets, WM_CALLBACK * cb,
WM_HWIN hParent, int
x0,
int
y0);
Parameter paWidget NumWidgets cb hParent x0 y0
Description
Pointer to resource table defining the widgets to be included in the dialog. Total number of widgets included in the dialog. Pointer to an application-specific callback function (dialog procedure). Handle of parent window (0 = no parent window). X-position of the dialog relative to parent window. Y-position of the dialog relative to parent window.
GUI_ExecCreatedDialog()
Description
Executes an already created dialog box.
Prototype
int GUI_ExecCreatedDialog(WM_HWIN hDialog);
Parameter hDialog
Handle to dialog box.
Description
Additional information
This function does not return until the dialog is closed. The WM_CF_SHOW flag is set, so the dialog is drawn the next time the Windows Manager takes action.
Return value
Value returned from GUI_EndDialog.
GUI_ExecDialogBox()
Description
Creates and executes a dialog box.
Prototype
int GUI_ExecDialogBox(const GUI_WIDGET_CREATE_INFO * paWidget,
int
NumWidgets,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
744
CHAPTER
Dialogs
WM_CALLBACK WM_HWIN int int
* cb, hParent, x0, y0);
Parameter paWidget NumWidgets cb hParent x0 y0
Description
Pointer to a resource table defining the widgets to be included in the dialog. Total number of widgets included in the dialog. Pointer to an application-specific callback function (dialog procedure). Handle of parent window (0 = no parent window). X-position of the dialog relative to parent window. Y-position of the dialog relative to parent window.
Return value
Value returned from GUI_EndDialog().
GUI_EndDialog()
Description
Ends (closes) a dialog box.
Prototype
void GUI_EndDialog(WM_HWIN hDialog, int r);
Parameter hDialog r
Description
Handle to dialog box. Value to be returned by GUI_ExecDialogBox.
Return value
Specifies the value to be returned to the calling thread from the function that created the dialog box (typically only relevant with GUI_ExecDialogBox()). With non-blocking dialogs, there is no application thread waiting and the return value is ignored.
Additional information
Note that the handle hDialog is not longer valid after the function has been called. As mentioned above, the function ends the dialog which means that it will be deleted from memory. This also applies to all child windows of the given window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
745
17.4 Common dialogs
Common dialogs can be used by an application for several tasks. They can be opened by calling a simple function instead of creating a new and complex dialog by the application. The following shows the available common dialogs.
17.4.1 CALENDAR
The CALENDAR dialog can be used for selecting or setting a date. The dialog consists of 2 buttons for month wise scrolling, a text which shows the current year and month and a pad of days. A small surrounding frame is shown surrounding the current date and the current selection is highlighted. The keyboard and / or the pointer input device (PID) can be used for selecting a date. The dialog supports the Gregorian calendar which is used since 1582.
17.4.1.1 Notification codes
The following events are sent from the dialog to its parent window as part of a WM_NOTIFY_PARENT message:
Message CALENDAR_NOTIFICATION_MONTH_CLICKED CALENDAR_NOTIFICATION_MONTH_RELEASED WM_NOTIFICATION_CLICKED WM_NOTIFICATION_RELEASED WM_NOTIFICATION_SCROLL_CHANGED WM_NOTIFICATION_SEL_CHANGED
Description
Month/year-text has been clicked. Month/year-text has been released. Widget has been clicked. Widget has been released. One of the scroll buttons has been pressed. The selection has been changed.
17.4.1.2 Keyboard reaction
The dialog reacts to the following keys if it has the input focus:
Key GUI_KEY_PGUP GUI_KEY_PGDOWN GUI_KEY_LEFT GUI_KEY_RIGHT GUI_KEY_UP GUI_KEY_DOWN
Reaction
Selection moves one month back. Selection moves one month further. Selection moves to the left. Selection moves to the right. Selection moves one line up. Selection moves one line down.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
746
CHAPTER
Dialogs
17.4.1.3 CALENDAR API
The table below lists the available CALENDAR-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine CALENDAR_Create() CALENDAR_GetDate() CALENDAR_GetSel() CALENDAR_SetDate() CALENDAR_SetSel() CALENDAR_SetDefaultBkColor() CALENDAR_SetDefaultColor() CALENDAR_SetDefaultDays() CALENDAR_SetDefaultFont() CALENDAR_SetDefaultMonths() CALENDAR_SetDefaultSize()
Description
Creates a CALENDAR dialog. Returns the current date. Returns the selected date. Sets the current date. Sets the selected date. Sets the default background colors to be used. Sets the default foreground colors to be used. Sets the strings to be used to label the days. Sets the default font to be used. Sets the strings to be used to label the months. Sets the default sizes to be used.
CALENDAR_Create()
Description
Creates a CALENDAR dialog.
Prototype
WM_HWIN CALENDAR_Create(WM_HWIN hParent, int xPos, int yPos, int Id, int WinFlags, unsigned Year, unsigned Month, unsigned Day, unsigned FirstDayOfWeek);
Parameter hParent xPos yPos Year Month Day FirstDayOfWeek Id Flags
Description
Handle of the parent window which should receive the notification messages. X position in pixels of the dialog in client coordinates. Y position in pixels of the dialog in client coordinates. Current year (1582-9999). Current month (1-12). Current day (1-31). First weekday to be used (0=SA, 1=SO, ... , 6=FR). Id to be used for the CALENDAR dialog. Additional flags for the WINDOW widget.
Return value
Handle of the dialog on success, otherwise 0.
Additional information
Year, month and day specify the current date. Per default this is also the initial selection. FirstDayOfWeek determines an offset for the first day to be shown. Default is showing Saturday at first.
CALENDAR_GetDate()
Description
Returns the current date.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
747
Prototype
void CALENDAR_GetDate(WM_HWIN hWin, CALENDAR_DATE * pDate);
Parameter hWin pDate
Description
Handle of CALENDAR dialog. Pointer to a CALENDAR_DATE structure.
Elements of CALENDAR_DATE
Data type
Element
Description
int int int
Year Month Day
Year of requested date. Month of requested date. Day of requested date.
Additional information
Current date and selected date are different items. The selection can be moved by the keyboard interface and/or the PID whereas the current date can be specified when creating the dialog or by using the function CALENDAR_SetDate();
CALENDAR_GetSel()
Description
Returns the currently selected date.
Prototype
void CALENDAR_GetSel(WM_HWIN hWin, CALENDAR_DATE * pDate);
Parameter hWin pDate
Description
Handle of CALENDAR dialog. Pointer to a CALENDAR_DATE structure.
Additional information
For information about the CALENDAR_DATE please refer to CALENDAR_GetDate().
CALENDAR_SetDate()
Before
After
Description
Sets the current date.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
748
CHAPTER
Dialogs
Prototype
void CALENDAR_SetDate(WM_HWIN hWin, CALENDAR_DATE * pDate);
Parameter hWin pDate
Description
Handle of CALENDAR dialog. Pointer to a CALENDAR_DATE structure.
Additional information
For information about the CALENDAR_DATE please refer to CALENDAR_GetDate().
CALENDAR_SetSel()
Before
After
Description
Sets the currently selected date.
Prototype
void CALENDAR_SetSel(WM_HWIN hWin, CALENDAR_DATE * pDate);
Parameter hWin pDate
Description
Handle of CALENDAR dialog. Pointer to a CALENDAR_DATE structure.
Additional information
For information about the CALENDAR_DATE please refer to CALENDAR_GetDate().
CALENDAR_SetDefaultBkColor()
Description
Sets the default background color to be used for new CALENDAR dialogs.
Prototype
void CALENDAR_SetDefaultBkColor(GUI_COLOR Color, unsigned Index);
Parameter Index Color
(see table below) Color to be used
Description
Permitted values for parameter Index
CALENDAR_CI_WEEKEND CALENDAR_CI_WEEKDAY CALENDAR_CI_SEL CALENDAR_CI_HEADER
Background color to be used for weekend days. Background color to be used for weekdays. Background color to be used for the selection. Background color to be used for the header area.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
749
CALENDAR_SetDefaultColor()
Description
Sets the default color to be used for new CALENDAR dialogs.
Prototype
void CALENDAR_SetDefaultColor(unsigned Index, GUI_COLOR Color);
Parameter Index Color
(see table below) Color to be used
Description
Permitted values for parameter Index
CALENDAR_CI_WEEKEND Color to be used for weekend days.
CALENDAR_CI_WEEKDAY CALENDAR_CI_SEL CALENDAR_CI_MONTH
Color to be used for weekdays. Color to be used for the selection. Color to be used for the month (and year) text.
CALENDAR_CI_LABEL CALENDAR_CI_FRAME
Color to be used for labeling the days. Color to be used for the frame of the current date.
CALENDAR_SetDefaultDays()
Description
Sets the text to be used to label the days.
Prototype
void CALENDAR_SetDefaultDays(const char ** apDays);
Parameter apDays
Description
Pointer to an array of 7 string pointers containing the strings to be used.
Additional information
The first string of the array should point to the abbreviation of Saturday, the second to Sunday and so on. The array needs to have at least 7 strings. If there are too less strings passed to the function the behavior of emWin becomes undefined.
CALENDAR_SetDefaultFont()
Description
Sets the font(s) to be used for drawing the CALENDAR items.
Prototype
void CALENDAR_SetDefaultFont(unsigned Index, const GUI_FONT GUI_UNI_PTR * pFont);
Parameter Index pFont
(see table below) Font to be used.
Description
Permitted values for parameter Index
CALENDAR_FI_CONTENT CALENDAR_FI_HEADER
Font to be used for labeling and the numbers. Font to be used for month / year.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
750
CHAPTER
Dialogs
CALENDAR_SetDefaultMonths()
Description
Sets the text to be used for the current month / year.
Prototype
void CALENDAR_SetDefaultMonths(const char ** apMonths);
Parameter apMonth
Description
Pointer to an array of 12 string pointers containing the strings to be used.
Additional information
The first string of the array should point to the text for 'January', the second to the text for 'February' and so on. The array needs to have at least 12 strings. If there are too less strings passed to the function the behavior of emWin becomes undefined.
CALENDAR_SetDefaultSize()
Description
Sets the sizes to be used by the dialog.
Prototype
void CALENDAR_SetDefaultSize(unsigned Index, unsigned Size);
Parameter Index Size
(see table below) Size to be used.
Description
Permitted values for parameter Index
CALENDAR_SI_HEADER CALENDAR_SI_CELL_X CALENDAR_SI_CELL_Y
Y-size in pixels used for the header area. (default is 25)
Cell size in X to be used for one item in the day pad. (default is 18)
Cell size in Y to be used for one item in the day pad. (default is 13)
Additional information
The size in x of the complete dialog can be calculated as follows: xSizeDialog = 7 x CellSizeX The size in y of the complete dialog can be calculated as follows: ySizeDialog = 7 x CellSizeY + HeaderSizeY
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
751
17.4.2 CHOOSECOLOR
The CHOOSECOLOR dialog can be used to select a color from a given color array.
17.4.2.1 Notification codes
The following events are sent from the dialog to its parent window as part of a WM_NOTIFY_PARENT message:
Message WM_NOTIFICATION_SEL_CHANGED WM_NOTIFICATION_CHILD_DELETED WM_NOTIFICATION_VALUE_CHANGED
Description
Send immediately after a new color has been selected by the PID or the keyboard.
Send when the dialog has been closed.
If the dialog has been closed with the 'Ok' button and the current selection is different to the initial selection this notification code is send.
17.4.2.2 Keyboard reaction
The dialog reacts to the following keys if it has the input focus:
Key GUI_KEY_ESCAPE GUI_KEY_ENTER GUI_KEY_LEFT GUI_KEY_RIGHT GUI_KEY_UP GUI_KEY_DOWN
Reaction
Dialog execution will be cancelled. Reaction depends on the focussed button. Cursor moves to the left. Cursor moves to the right. Cursor moves one line up. Cursor moves one line down.
17.4.2.3 CHOOSECOLOR API
The table below lists the available CHOOSECOLOR-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine CHOOSECOLOR_Create() CHOOSECOLOR_GetSel() CHOOSECOLOR_SetSel() CHOOSECOLOR_SetDefaultColor()
Description
Creates a CHOOSECOLOR dialog. Returns the index of the current selected color. Sets the current selected color. Sets the colors to be used for color frame and focus.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
752
CHAPTER
Dialogs
Routine
Description
CHOOSECOLOR_SetDefaultSpace()
Sets the space between the items to be used.
CHOOSECOLOR_SetDefaultBorder()
Sets the space between items and border to be used.
CHOOSECOLOR_SetDefaultButtonSize() Sets the button size to be used.
CHOOSECOLOR_Create()
Description
Creates a dialog for choosing a color and returns immediately.
Prototype
WM_HWIN CHOOSECOLOR_Create(WM_HWIN hParent, int xPos, int yPos, int xSize, int ySize, GUI_COLOR * pColor, unsigned NumColors, unsigned NumColorsPerLine, int Sel,
const char * sCaption, int Flags);
Parameter hParent xPos yPos xSize ySize pColor NumColors NumColorsPerLine Sel sCaption Flags
Description
Handle of the parent window which should receive the notification messages. X position in pixels of the dialog in client coordinates. Y position in pixels of the dialog in client coordinates. X-size of the dialog in pixels. Y-size of the dialog in pixels. Pointer to an array of 32 bit color values containing the colors to be used. Number of colors to be shown. Number of colors to be shown per line. Initial index value to be used for the selection / focus. Title to be shown in the title bar. Additional flags for the FRAMEWIN widget.
Return value
Handle of the dialog on success, otherwise 0.
Additional information
The following default values are used: · If (xPos < 0) the dialog will be centered horizontally. · If (yPos < 0) the dialog will be centered vertically. · If (xSize == 0) the half of the display size in x will be used. · If (ySize == 0) the half of the display size in y will be used. · if (sCaption == NULL) 'Choose Color' will be shown in the title bar. As mentioned above the creation routine returns immediately. It becomes visible with the next call of WM_Exec() or it can be executed with GUI_ExecCreatedDialog().
CHOOSECOLOR_GetSel()
Description
Returns the index of the currently selected color.
Prototype
int CHOOSECOLOR_GetSel(WM_HWIN hObj);
Parameter hObj
Description
Handle of the CHOOSECOLOR dialog.
Return value
Index of the currently selected color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
753
CHOOSECOLOR_SetSel()
Description
Sets the current selection.
Prototype
void CHOOSECOLOR_SetSel(WM_HWIN hObj, int Sel);
Parameter hObj Sel
Description
Handle of the CHOOSECOLOR dialog. New selection to be used.
Additional information
The given selection should be smaller than the number of colors. In case of a negative value no initial selection will be shown.
CHOOSECOLOR_SetDefaultColor()
Before
After
Description
Sets the colors to be used to draw the surrounding frame of the colors.
Prototype
void CHOOSECOLOR_SetDefaultColor(unsigned Index, GUI_COLOR Color);
Parameter Index Color
See table below. Color to be used.
Description
Permitted values for parameter Index
CHOOSECOLOR_CI_FRAME CHOOSECOLOR_CI_FOCUS
Color to be used to draw the frame surrounding each color. Default is GUI_GRAY.
Color to be used to draw the focus rectangle. Default is GUI_BLACK.
CHOOSECOLOR_SetDefaultSpace()
Before
After
Description
Determines the space between the color rectangles.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
754
CHAPTER
Prototype
void CHOOSECOLOR_SetDefaultSpace(unsigned Index, unsigned Space);
Parameter Index Space
See table below. Space in pixels to be used.
Description
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Index
Space in X to be used between the colors. Default value is 5. Space in Y to be used between the colors. Default value is 5.
CHOOSECOLOR_SetDefaultBorder()
Before
After
Dialogs
Description
Sets the size of the border between the colors and the dialog frame to be used.
Prototype
void CHOOSECOLOR_SetDefaultBorder(unsigned Index, unsigned Border);
Parameter Index Border
See table below. Border to be used.
Description
GUI_COORD_X GUI_COORD_Y
Permitted values for parameter Index
Space in X to be used between border and colors. Default value is 4. Space in Y to be used between border and colors. Default value is 4.
Additional information
The horizontal value is also used to determine the space between the buttons.
CHOOSECOLOR_SetDefaultButtonSize()
Before
After
Description
Sets the button size to be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
755
Prototype
void CHOOSECOLOR_SetDefaultButtonSize(unsigned Index, unsigned ButtonSize);
Parameter Index ButtonSize
See table below. Size in pixels to be used.
Description
Permitted values for parameter Index
GUI_COORD_X GUI_COORD_Y
Button size in X. Button size in Y.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
756
17.4.3 CHOOSEFILE
CHAPTER
Dialogs
The CHOOSEFILE dialog can be used for browsing through a directory and for selecting a file. It uses a user defined callback routine for retrieving data. So it can be used with any file system.
17.4.3.1 Configuration options
Type
Macro
N CHOOSEFILE_DELIM
Default
\
Description
Default delimiter to be used.
17.4.3.2 Keyboard reaction
The dialog reacts to the following keys if it has the input focus:
Key
Reaction
GUI_KEY_TAB GUI_KEY_BACKTAB GUI_KEY_ENTER GUI_KEY_ESCAPE
The next widget of the dialog gains the input focus. The previous widget of the dialog gains the input focus. The behavior depends on the currently focussed widget. Dialog will be cancelled.
17.4.3.3 File- and path names
The maximum length of path- and file names is limited to 256 bytes.
17.4.3.4 CHOOSEFILE API
The table below lists the available CHOOSEFILE-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine CHOOSEFILE_Create() CHOOSEFILE_EnableToolTips() CHOOSEFILE_SetButtonText() CHOOSEFILE_SetDefaultButtonText() CHOOSEFILE_SetDelim() CHOOSEFILE_SetToolTips() CHOOSEFILE_SetTopMode()
Description
Creates a CHOOSEFILE dialog. Enables ToolTips for the dialog. Default is disabled. Sets the text of the given button. Sets the default text of the given button. Sets the delimiter to be used. Default is a backslash. Sets the text to be shown by the ToolTips. Makes the button bar visible at the top of the dialog.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
757
CHOOSEFILE_Create()
Description
Creates a CHOOSEFILE dialog using the given parameters.
Prototype
WM_HWIN CHOOSEFILE_Create(WM_HWIN hParent, int xPos, int yPos, int xSize, int ySize, const char * apRoot[], int NumRoot, int SelRoot, const char * sCaption, int Flags, CHOOSEFILE_INFO * pInfo);
Parameter hParent xPos yPos xSize ySize apRoot NumRoot SelRoot sCaption Flags pInfo
Description
Handle of parent window. X position in pixels of the dialog in client coordinates. Y position in pixels of the dialog in client coordinates. X-size of the dialog in pixels. Y-size of the dialog in pixels. Pointer to an array of strings containing the root directories to be used. Number of root directories. Initial index of the root directory to be used. Title to be shown in the title bar. Additional flags for the FRAMEWIN widget. Pointer to a CHOOSEFILE_INFO structure.
Return value
Handle of the dialog on success, otherwise 0.
Elements of CHOOSEFILE_INFO
Data type int
const char *
char * char * char * U32 U32
U32
Element Cmd
pMask
pName pExt pAttrib SizeL SizeH
Flags
char *
pRoot
int (*)(CHOOSEFILE_INFO *) pfGetData
Description
See table below.
This parameter is passed to the GetData()
function and contains a mask which can be used for filtering the search result. Pointer to the file name of the requested file.
Pointer to the extension of the requested file. Pointer to the attribute string of the requested file. Lower 32 bit of the file size.
Upper 32 bit of the file size. If the requested file is a directory it should be
set to CHOOSEFILE_FLAG_DIRECTORY,
otherwise it should be set to 0. Pointer to a string containing the complete path of the currently used directory.
Pointer to the GetData() function to be used.
Permitted values for element Cmd
CHOOSEFILE_FINDFIRST CHOOSEFILE_FINDNEXT
The first entry of the current directory should be returned.
The next entry of the current directory should be returned.
Element CHOOSEFILE_FINDFIRST
This command is send to the given callback routine to get the first entry of the current directory. The element pRoot of the CHOOSEFILE_INFO structure pointed by the parameter pInfo of the callback function contains the path to be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
758
CHAPTER
Dialogs
The following elements of the CHOOSEFILE_INFO structure should be used by the application to return information of the requested file: pName, pExt, pAttrib, SizeL, SizeH and Flags. The parameter pAttrib contains a string to be shown in the 'Attrib' column. This string has to be build by the application. So each attributes independent of the used file system can be shown. All strings used to return information about the file are copied by the dialog into its own memory locations. If no file could be found the GetData() function should return 1.
Element CHOOSEFILE_FINDNEXT
This command is send to the given callback routine to get the next entry of the chosen directory. If no further file could be found the GetData() function should return 1.
Parameter apRoot
This parameter should point to an array of string pointers containing the root directories shown in the DROPDOWN widget of the dialog. The directory names do not need to have a delimiter (slash or backslash) at the end. They are copied by the function to their own locations and do not need to remain valid after creating the dialog. Empty strings are not supported and could lead to an undefined behavior of the dialog.
Prototype of GetData() function
int (*)(CHOOSEFILE_INFO * pInfo);
Parameter
Description
pInfo
Pointer to a CHOOSEFILE_INFO structure.
Details about GetData() function
The GetData() function pointed by the element pfGetData has to be provided by the application. This function is responsible to pass information about the requested file to the dialog. It gets a pointer to a CHOOSEFILE_INFO structure which contains all details of the requested file. The following elements are passed by the dialog to the application: · Cmd
Determines if information about the first- or the next file should be returned. · pRoot
Pointer to a string containing the path of the directory to be used. The GetData() function then has to use the following elements for providing information about the requested file to the dialog: · pAttrib
Should point to a string which is shown in the 'Type' column. Because the CHOOSEFILE dialog can be used with any file system there are no special flags but a string which should be passed by the application to the dialog. · pName Should point to a string which contains the file name without path and extension. Shown in the 'Name' column of the dialog. · pExt Should point to a string which contains the extension of the file shown in the 'Type' column of the dialog · SizeL Should be set to the lower 32 bit of the file length. · SizeH Should be set to the upper 32 bit of the file length in case of file larger than 4.294.967.295 bytes. · Flags If the requested file is a directory this element has to be set to CHOOSEFILE_FLAG_DIRECTORY. Otherwise it has to be 0.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
759
Additional information
The following default values are used: · If (xPos < 0) the dialog will be centered horizontally. · If (yPos < 0) the dialog will be centered vertically. · If (xSize == 0) the half of the display size in x will be used. · If (ySize == 0) the half of the display size in y will be used. · if (sCaption == NULL) 'Choose File' will be shown in the title bar.
Example of GetData() function
The following shows an example of the GetData() function which can be used with WIN32. The sample folder also contains a sample which can be used with emFile. Here the WIN32 example:
static const struct { U32 Mask; char c;
} _aAttrib[] = { { FILE_ATTRIBUTE_READONLY , 'R' }, { FILE_ATTRIBUTE_HIDDEN , 'H' }, { FILE_ATTRIBUTE_SYSTEM , 'S' }, { FILE_ATTRIBUTE_DIRECTORY, 'D' }, { FILE_ATTRIBUTE_ARCHIVE , 'A' }, { FILE_ATTRIBUTE_NORMAL , 'N' },
};
static int _GetData(CHOOSEFILE_INFO * pInfo) { static HANDLE hFind; static int NewDir; static char acDrive [_MAX_DRIVE]; static char acDir [_MAX_DIR]; static char acName [_MAX_FNAME]; static char acExt [_MAX_EXT]; static char acMask [_MAX_PATH]; static char acPath [_MAX_PATH]; static char acAttrib[10] = {0}; WIN32_FIND_DATA Context; int i, r; char c;
switch (pInfo->Cmd) { case CHOOSEFILE_FINDFIRST:
if (hFind != 0) { FindClose(hFind);
} // // Split path into drive and directory // _splitpath(pInfo->pRoot, acDrive, acDir, NULL, NULL); NewDir = 1; // // Do not 'break' here... // case CHOOSEFILE_FINDNEXT: if (NewDir) {
_makepath(acMask, acDrive, acDir, NULL, NULL); strcat(acMask, pInfo->pMask); hFind = FindFirstFile(acMask, &Context); if (hFind == INVALID_HANDLE_VALUE) {
FindClose(hFind); hFind = 0; return 1; } } else { r = FindNextFile(hFind, &Context); if (r == 0) { FindClose(hFind); hFind = 0; return 1; } } NewDir = 0; // // Generate attribute string (pInfo->pAttrib) // for (i = 0; i < GUI_COUNTOF(_aAttrib); i++) { c = (Context.dwFileAttributes & _aAttrib[i].Mask) ? _aAttrib[i].c : '-'; acAttrib[i] = c;
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
760
CHAPTER
Dialogs
} // // Make name and extension (pInfo->pName, pInfo->pExt) // if ((Context.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) == 0) {
_splitpath(Context.cFileName, NULL, NULL, acName, acExt); } else {
strcpy(acName, Context.cFileName); acExt[0] = 0; } // // Pass data to dialog // pInfo->pAttrib = acAttrib; pInfo->pName = acName; pInfo->pExt = acExt; pInfo->SizeL = Context.nFileSizeLow; pInfo->SizeH = Context.nFileSizeHigh; pInfo->Flags = (Context.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
? CHOOSEFILE_FLAG_DIRECTORY : 0; } return 0; }
CHOOSEFILE_EnableToolTips()
Before
After
Description
Enables ToolTips for CHOOSEFILE dialogs.
Prototype
void CHOOSEFILE_EnableToolTips(void);
Additional information
The text of the ToolTips can be configured. For details please refer to CHOOSEFILE_SetToolTips().
CHOOSEFILE_SetButtonText()
Before
After
Description
Uses text instead of the default image.
Prototype
void CHOOSEFILE_SetButtonText(WM_HWIN hWin, unsigned ButtonIndex,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
761
const char * pText);
Parameter hWin ButtonIndex pText
Description
Handle of the CHOOSEFILE dialog. See table below. Pointer to a string to be used.
Permitted values for parameter Index
CHOOSEFILE_BI_CANCEL Index of 'cancel' button.
CHOOSEFILE_BI_OK CHOOSEFILE_BI_UP
Index of 'Ok' button. Index of 'Up' button.
Additional information
The function copies the string(s) into its own memory location(s). The size of the buttons depend on the used text. The dialog makes sure, that all buttons which use text instead of an image have the same size.
CHOOSEFILE_SetDefaultButtonText()
Description
Sets the default text to be used for new dialogs.
Prototype
void CHOOSEFILE_SetDefaultButtonText(unsigned ButtonIndex, const char * pText);
Parameter ButtonIndex pText
See table below. Text to be used per default.
Description
Permitted values for parameter Index
CHOOSEFILE_BI_CANCEL CHOOSEFILE_BI_OK CHOOSEFILE_BI_UP
Index of 'cancel' button. Index of 'Ok' button. Index of 'Up' button.
CHOOSEFILE_SetDelim()
Description
Sets the delimiter used within a path. Default is a backslash.
Prototype
void CHOOSEFILE_SetDelim(char Delim);
Parameter Delim
Delimiter to be used.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
762
CHOOSEFILE_SetToolTips()
Before
CHAPTER
After
Dialogs
Description
Sets the text to be shown by the ToolTips.
Prototype
void CHOOSEFILE_SetToolTips(const TOOLTIP_INFO * pInfo, int NumItems);
Parameter pInfo NumItems
Description Pointer to an array of TOOLTIP_INFO structures. Number of items pointed by pInfo.
Additional information
For details about the TOOLTIP_INFO structure please refer to chapter "ToolTips" on page 339.
CHOOSEFILE_SetTopMode()
Before
After
Description
Makes the button bar visible at the top of the dialog.
Prototype
void CHOOSEFILE_SetTopMode(unsigned OnOff);
Parameter OnOff
Description
1 for top mode, 0 (default) for bottom mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
763
17.4.4 MESSAGEBOX
A MESSAGEBOX is used to show a message in a frame window with a title bar, as well as an "OK" button which must be pressed in order to close the window. It requires only one line of code to create or to create and execute a message box. All MESSAGEBOX-related routines are in the file(s) MESSAGEBOX*.c, MESSAGEBOX.h and GUI.h. The table below shows the appearance of the MESSAGEBOX:
Simple message box
17.4.4.1 Configuration options
Type
Macro
N MESSAGEBOX_BORDER
N MESSAGEBOX_XSIZEOK N MESSAGEBOX_YSIZEOK S MESSAGEBOX_BKCOLOR
Default
4 50 20 GUI_WHITE
Description
Distance between the elements of a message box and the elements of the client window frame. X-size of the "OK" button. Y-size of the "OK" button. Color of the client window background.
17.4.4.2 Keyboard reaction
The widget consists of a FRAMEWIN, a TEXT and a BUTTON widget. When executing a message box the BUTTON widget gains the input focus. For more information on how keyboard events are handled by the BUTTON widget, refer to "BUTTON: Button widget" on page 412.
17.4.4.3 MESSAGEBOX API
The table below lists the available emWin MESSAGEBOX-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine GUI_MessageBox() MESSAGEBOX_Create()
Description
Creates and displays a message box. Creates a message box.
GUI_MessageBox()
Description
Creates and displays a message box.
Prototype
int GUI_MessageBox(const char* sMessage, const char* sCaption, int Flags);
Parameter sMessage sCaption Flags
Description
Message to display. Caption for the title bar of the frame window. See table below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
764
CHAPTER
Dialogs
Permitted values for parameter Flags
The message box can be moved by dragging
GUI_MESSAGEBOX_CF_MOVEABLE the title bar or the frame.
0
No function.
Additional information
This function offers the possibility to create and execute a MESSAGEBOX with one line of code. For an example implementation, please refer to DIALOG_MessageBox.c which is located in the Sample folder. For details about dragging, please refer to the additional information of the function "FRAMEWIN_SetMoveable()" on page 496.
MESSAGEBOX_Create()
Description
Creates a message box.
Prototype
WM_HWIN GUI_MessageBox(const char* sMessage, const char* sCaption, int Flags);
Parameter sMessage sCaption Flags
Description
Message to display. Caption for the title bar of the frame window. See table below.
Permitted values for parameter Flags
GUI_MESSAGEBOX_CF_MODAL
Creates a modal message box. The default is creating a non modal message box.
Return value
Handle of the message box window.
Additional information
The function creates a message box consisting of a frame window with the caption text in the title bar, a text widget with the message text and a button widget representing the 'OK' button. After creating the message box the dialog behavior could be changed by using a user defined callback function or the properties of the box items can be modified using the widget API functions. The following IDs can be used for accessing the items:
Id GUI_ID_TEXT0 GUI_ID_OK
Description
Id of the TEXT widget containing the message text. Id of the 'OK' BUTTON widget.
The frame window can be accessed by the handle returned by this function. The function GUI_ExecCreatedDialog() should be used to execute the message box.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
765
Chapter 18 GUIBuilder
The GUIBuilder application is a tool for creating dialogs without any knowledge of the C programming language. Instead of writing source code the widgets can be placed and sized by drag and drop. Additional properties can be added per context menu. Fine tuning can be done by editing the properties of the widgets. This does not require any knowledge of the C programming language. The dialogs can be saved as C files which can be enhanced by adding user defined code. Of course these C files with the embedded user code can be loaded and modified by the GUIBuilder.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
766
CHAPTER
GUIBuilder
18.1 Introduction
The following diagram shows the elements of the graphical user interface of the GUIBuilder:
Widget selection bar
This bar contains all available widgets of the GUIBuilder. They can be added by a single click into the selection bar on the desired widget or by dragging them into the editor area.
Object tree
This area shows all currently loaded dialogs and their child widgets. It can be used for selecting a widget by clicking on the according entry.
Widget properties
It shows the properties of each widget and can be used for editing them.
Editor
The editor window shows the currently selected dialog. It can be used to place and resize the dialog and its widgets.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
767
18.2 Getting started
Before starting a project, the GUIBuilder needs to know the project path. Per default this is the application path of the GUIBuilder. All files are saved in this folder.
Setting up the project path
After the first execution, the GUIBuilder directory contains the configuration file GUIBuilder.ini. Within this file the project path can be changed by editing the value ProjectPath:
[Settings] ProjectPath="C:\Work\MyProject\"
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
768
CHAPTER
GUIBuilder
18.3 Creating a dialog
The following shows how to create a dialog and how to modify the properties of the used widgets.
18.3.1 Selecting a parent widget
Each dialog requires a valid parent widget. So it is required to start with a widget which is able to serve as a parent. Currently there are 2 widgets which can be used at this point:
Frame window widget
Window widget
The table above shows the according buttons of the widget selection bar. To get a widget into the editor the buttons can be single clicked, dragged with the mouse into the editor window or created by using the 'New' menu.
18.3.2 Resizing and positioning in the editor
After placing a widget into the editor area it can be moved by using the mouse or the arrow keys of the keyboard. Resizing can be done by dragging the markers.
18.3.3 Modifying the widget properties
The lower left area of the GUIBuilder contains the property window. After creating a new widget it shows the default properties of the widget: Name, position, size and extra bytes. These properties are available for all kinds of widgets and can not be removed. Contrary to the default properties all additional properties can be removed by the context menu or by pressing <DEL> when the according line is selected. To change a value it can be selected by the keyboard by pressing <ENTER> (if the desired line is selected and the window has the focus) or by single clicking into the value field. Further the 'Edit' entry of the context menu available with a right click can be used to start the edit operation. <ESC> can be used to abort the edit operation.
18.3.4 Adding additional functions to a widget
To get a context menu with the available functions for a widget either a right click in the editor window on the desired widget or a right click in the object tree can be done. Selecting a function adds a new property to the widget and starts the edit operation for the chosen function. In case of numerical or alpha numerical values the edit operation is done within the property window. In case of choosing fonts, text alignments or colors a separate selection window occurs.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
769
Alignment selection
The alignment selection dialog shows the previous selected alignment in green. A single click within the box selects a new alignment. <ESC> aborts the selection.
Color selection
For selecting a color the Windows default color selection dialog occurs. <ESC> aborts the selection.
Font selection
The font selection dialog shows all available fonts of the GUIBuilder. The desired font can be selected by a single click on the desired font. <ESC> aborts the selection.
18.3.5 Deleting a widget property
This can be done easily by using the context menu of the property window or by pressing the <DEL> key if the desired property in the widget property window has the focus.
18.3.6 Deleting a widget
A widget can be deleted by pressing the <DEL> key if the widget is activated in the editor window. It can also be removed by selecting it in the object tree window and then pressing the <DEL> key. Please note that deleting a parent widget also deletes all its child windows.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
770
CHAPTER
GUIBuilder
18.4 Saving the current dialog(s)
With the menu entry 'File/Save...' all currently loaded dialogs will be saved in the project folder. For details about how to set up the project folder please refer to "Getting started" on page 767. Each dialog will be saved as a single C file. Please note that the file names are generated automatically by the widget names of the parent widgets. The file names are build as follows:
<Widget name>DLG.c
If for example the name of the widget is 'Framewin' the file will be named FramewinDLG.c.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
771
18.5 Output of the GUIBuilder
As mentioned above the result of the GUIBuilder are C files only. The following shows
a small sample which is generated by the tool:
/*********************************************************************
*
*
*
SEGGER Microcontroller GmbH & Co. KG
*
*
Solutions for real time microcontroller applications
*
*
*
**********************************************************************
*
*
* C-file generated by:
*
*
*
*
GUI_Builder for emWin version 5.09
*
*
Compiled Mar 23 2011, 09:52:04
*
*
(c) 2011 Segger Microcontroller GmbH & Co. KG
*
*
*
**********************************************************************
*
*
*
Internet: www.segger.com Support: support@segger.com
*
*
*
**********************************************************************
*/
// USER START (Optionally insert additional includes) // USER END
#include "DIALOG.h"
/*********************************************************************
*
*
Defines
*
**********************************************************************
*/
#define ID_FRAMEWIN_0 (GUI_ID_USER + 0x0A)
#define ID_BUTTON_0
(GUI_ID_USER + 0x0B)
// USER START (Optionally insert additional defines) // USER END
/*********************************************************************
*
*
Static data
*
**********************************************************************
*/
// USER START (Optionally insert additional static data) // USER END
/*********************************************************************
*
*
_aDialogCreate
*/
static const GUI_WIDGET_CREATE_INFO _aDialogCreate[] = {
{ FRAMEWIN_CreateIndirect, "Framewin", ID_FRAMEWIN_0, 0, 0, 320, 240, 0, 0, 0 },
{ BUTTON_CreateIndirect, "Button", ID_BUTTON_0, 5, 5, 80, 20, 0, 0, 0 },
// USER START (Optionally insert additional widgets)
// USER END
};
/*********************************************************************
*
*
Static code
*
**********************************************************************
*/
// USER START (Optionally insert additional static code) // USER END
/*********************************************************************
*
*
_cbDialog
*/
static void _cbDialog(WM_MESSAGE * pMsg) {
WM_HWIN hItem;
int Id, NCode;
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
772
CHAPTER
GUIBuilder
// USER START (Optionally insert additional variables) // USER END
switch (pMsg->MsgId) { case WM_INIT_DIALOG:
// // Initialization of 'Framewin' // hItem = pMsg->hWin; FRAMEWIN_SetTextAlign(hItem, GUI_TA_HCENTER | GUI_TA_VCENTER); FRAMEWIN_SetFont(hItem, GUI_FONT_24_ASCII); // // Initialization of 'Button' // hItem = WM_GetDialogItem(pMsg->hWin, ID_BUTTON_0); BUTTON_SetText(hItem, "Press me..."); // USER START (Opt. insert additional code for further widget initialization) // USER END break; case WM_NOTIFY_PARENT: Id = WM_GetId(pMsg->hWinSrc); NCode = pMsg->Data.v; switch(Id) { case ID_BUTTON_0: // Notifications sent by 'Button'
switch(NCode) { case WM_NOTIFICATION_CLICKED:
// USER START (Optionally insert code for reacting on notification message) // USER END break; case WM_NOTIFICATION_RELEASED: // USER START (Optionally insert code for reacting on notification message) // USER END break; // USER START (Opt. insert additional code for further notification handling) // USER END } break; // USER START (Optionally insert additional code for further IDs) // USER END } break; // USER START (Optionally insert additional message handling) // USER END default: WM_DefaultProc(pMsg); break; } }
/*********************************************************************
*
*
Public code
*
**********************************************************************
*/
/*********************************************************************
*
*
CreateFramewin
*/
WM_HWIN CreateFramewin(void) {
WM_HWIN hWin;
hWin = GUI_CreateDialogBox(_aDialogCreate, GUI_COUNTOF(_aDialogCreate), &_cbDialog, WM_HBKWIN, 0, 0);
return hWin; }
// USER START (Optionally insert additional public code) // USER END
/*************************** End of file ****************************/
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
773
18.6 Modifying the C files
As the sample code shows, it contains many sections for custom code. These are the following sections:
// USER START (Optionally insert ...) // USER END
Between these lines any code is allowed to be added. Please note that the code needs to be added between the lines. The comment lines itself are not allowed to be modified in order to keep them editable by the GUIBuilder. The following shows how it should work:
// USER START (Optionally insert additional includes) #ifndef WIN32
#include <ioat91sam9261.h> #endif // USER END
18.7 How to use the C files
As the sample output shows, the code does not contain any code which uses the dialogs or with other words makes them visible on the display. Each file contains a creation routine at the end named Create<Widget name>(). These routines create the according dialog. Simply call these routines to make them occur on the display.
Example
The following code shows how to draw the dialog of the previous output sample on a display:
#include "DIALOG.h"
/*********************************************************************
*
*
Externals
*
**********************************************************************
*/
WM_HWIN CreateFramewin(void);
/*********************************************************************
*
*
Public code
*
**********************************************************************
*/
/*********************************************************************
*
*
MainTask
*/
void MainTask(void) {
WM_HWIN hDlg;
GUI_Init();
//
// Call creation function for the dialog
//
hDlg = CreateFramewin();
//
// May do anything with hDlg
//
...
//
// Keep program allive...
//
while (1) {
GUI_Delay(10);
}
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
774
CHAPTER
GUIBuilder
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
775
Chapter 19 Skinning
Skinning is a method of changing the appearance of one or multiple widgets. It allows changing the look by using a dedicated skin which defines how the widgets are rendered. This makes it easy to change the appearance of a complete group of widgets in a similar way by changing only the skin. Without skinning, widget member functions have to be used to change the look for each single widget or the callback function has to be overwritten.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
776
CHAPTER
Skinning
19.1 What is a 'skin'?
A skin is just a simple callback function which is available for drawing all details of a widget. It works by exactly same way as a 'user draw function' of a widget, an older method of widget customization which was available before 'skinning' was implemented.
19.2 From using API functions to skinning
There are different methods to change the appearance of a widget. Widget API functions, user draw functions, skinning and overwriting the callback function can be used to modify the appearance of a widget. The decision of the method to be used depends on what should be changed. The following explains what can be achieved with each method.
Using widget API functions
The default API functions can be used to change attributes like size, color, font or bitmaps used to draw a widget using the classical design. The following screenshot shows a typical sample of what can be done:
Before
After
Some attributes can be changed but the basic appearance stays the same.
User draw functions
Some widgets like LISTBOX, FRAMEWIN, GRAPH or BUTTON widgets offer user draw functions. These functions can be used to draw some additional details or to replace the default drawing method for some items. The following screenshot shows a user drawn title area of a frame window. The user draw function renders the gradient in the title area, which can't be achieved with the widget API functions:
Before
After
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
777
Skinning
Contrary to the methods mentioned above skinning covers the drawing of the whole widget and not only some details. We also used this opportunity to lift the appearance of the skinnable widgets which look much more up-to-date as the classical widget design. The following table shows the look of the about box from above in comparison with the new default skin:
Classical design
Default skin
Overwriting the callback function of a widget
Before skinning was implemented, the only method of changing the complete appearance of a widget was overwriting the callback function of a widget. This gives full control over the complete message processing of the widget. It can be used in combination with the other methods. The main disadvantages of overwriting the callback function is that lots of code needs to be written by the user. This process is errorprone.
19.3 Skinnable widgets
Skinning only makes sense if a widget consists of several widget specific details. It does not make sense for each kind of widget. A TEXT widget for example does not require a separate skin, because it consists only of the text itself. Currently the following widgets support skinning:
· BUTTON · CHECKBOX · DROPDOWN · FRAMEWIN · HEADER · PROGBAR · RADIO · SCROLLBAR · SLIDER
19.4 Using a skin
The shipment of emWin contains a ready-to-use default skin for all above listed skinnable widgets. They have been named <WIDGET>_SKIN_FLEX. The following table shows the available default skins for all skinnable widgets:
BUTTON CHECKBOX DROPDOWN
Widget
Default skin
BUTTON_SKIN_FLEX CHECKBOX_SKIN_FLEX DROPDOWN_SKIN_FLEX
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
778
CHAPTER
Skinning
FRAMEWIN HEADER PROGBAR RADIO SCROLLBAR SLIDER SPINBOX
Widget
Default skin
FRAMEWIN_SKIN_FLEX HEADER_SKIN_FLEX PROGBAR_SKIN_FLEX RADIO_SKIN_FLEX SCROLLBAR_SKIN_FLEX SLIDER_SKIN_FLEX SPINBOX_SKIN_FLEX
19.4.1 Runtime configuration
To use these skins the function <WIDGET>_SetSkin(<WIDGET>_SKIN_FLEX) can be used. Further it is possible to set a default skin by <WIDGET>_SetDefaultSkin() which is used automatically for each new widget.
Switching from classic design to a skin
The most recommended way of using a skin is first setup the widget behavior and then creating the widget.
Example
The following example shows how a skin can be used:
BUTTON_SetSkin(hButton, BUTTON_SKIN_FLEX); // Sets the skin for the given widget BUTTON_SetDefaultSkin(BUTTON_SKIN_FLEX); // Sets the default skin for new widgets
19.4.2 Compile time configuration
If Skinning should be used by default the compile time configuration macro WIDGET_USE_FLEX_SKIN needs to be defined as 1 in GUIConf.h.
Example
To use skinning per default the macro should be added to the file GUIConf.h:
#define WIDGET_USE_FLEX_SKIN 1
19.5 Simple changes to the look of the 'Flex' skin
Similar to the API functions available for changing the attributes of the classical look the attributes of the 'Flex' skin can also be changed. This can be done without knowing all details of the skinning mechanism. The function(s) <WIDGET>_SetSkinFlexProps() explained in detail later in this chapter can be used to change the attributes. For each skin exist functions for getting and setting the attributes.
Example
The following code shows how to change the attributes of the button skin:
BUTTON_GetSkinFlexProps(&Props, BUTTON_SKINFLEX_FOCUSSED);
Props.aColorFrame[0] = 0x007FB13C;
Props.aColorFrame[1] = 0x008FfF8F;
Props.Radius
= 6;
BUTTON_SetSkinFlexProps(&Props, BUTTON_SKINFLEX_FOCUSSED);
WM_InvalidateWindow(hWin);
Please note that it is required to invalidate the windows which are affected by the skin. Contrary to the widget API functions, which need to be called for each single widget, the skin does not 'know' something about which widget is using it. So there is no automatic widget invalidation and redrawing when changing the skin attributes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Screenshot
Before
779 After
19.6 Major changes to the look of the 'Flex' skin
The drawing mechanism of the default design without skinning is a 'black box' for the application designer. The same is true for skinning if no major changes of the default look are required. If changing the attributes of the default skin is not sufficient to realize the required look, it is required to understand the details of the drawing mechanism of skinning.
19.6.1 The skinning callback mechanism
The drawing mechanism for all skinnable widgets is very similar and looks as follows:
int <WIDGET>_DrawSkin(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) { switch (pDrawItemInfo->Cmd) { case WIDGET_ITEM_DRAW_BACKGROUND: /* Draw the background */ break; case WIDGET_ITEM_DRAW_TEXT: /* Draw the text */ break; case WIDGET_ITEM_CREATE: /* Additional function calls required to create the widget */ break; ...
}
Elements of WIDGET_ITEM_DRAW_INFO
Data type Element
WM_HWIN int int int int int int void *
hWin Cmd ItemIndex x0 y0 x1 y1 p
Description
Handle to the widget. Command to be processed. Index of item to be drawn. Leftmost coordinate in window coordinates. Topmost coordinate in window coordinates. Rightmost coordinate in window coordinates. Bottommost coordinate in window coordinates. Data pointer to widget specific information.
This scheme is identical to all skinnable widgets. The callback function receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The structure pointed by pDrawItemInfo contains a command which has to be processed, a handle to the widget and further information whose meaning may vary by widget. The skinning callback function has to react with drawing a dedicated detail or with returning a dedicated value. How to use the drawing information in detail is explained later in this chapter.
19.6.2 Changing the look of the default skin
Understanding the above callback mechanism is important because changing a skin can easily be done by deriving a new skin from an existing one. A small example should show how the look of the default skin of a widget can be changed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
780
CHAPTER
Skinning
Assuming the default look of the frame window skin should be changed because an icon should be shown on the left side of the title bar. The default appearance of the FRAMEWIN skin is as follows:
This should be changed to the following:
This can be done easily by using a customized skin derived from the default skin. The following code shows how this can be achieved. It shows a custom skinning callback function which is used as skin by the function FRAMEWIN_SetSkin(). Because the icon should be drawn in the text area of the frame window the function overwrites the default behaviour of the text drawing:
case WIDGET_ITEM_DRAW_TEXT: ...
All other tasks should be performed by the default skin:
default: return FRAMEWIN_DrawSkinFlex(pDrawItemInfo);
Example
static int _DrawSkinFlex_FRAME(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) { char acBuffer[20]; GUI_RECT Rect;
switch (pDrawItemInfo->Cmd) {
case WIDGET_ITEM_DRAW_TEXT:
//
// Draw icon at the left side
//
GUI_DrawBitmap(&_bmLogo_30x15, pDrawItemInfo->x0, pDrawItemInfo->y0);
//
// Draw text beneath
//
FRAMEWIN_GetText(pDrawItemInfo->hWin, acBuffer, sizeof(acBuffer));
GUI_SetColor(GUI_BLACK);
Rect.x0 = pDrawItemInfo->x0 // Default position of text
+ _bmLogo_30x15.XSize // + X-size of icon
+ 4;
// + small gap between icon and text
Rect.y0 = pDrawItemInfo->y0;
Rect.x1 = pDrawItemInfo->x1;
Rect.y1 = pDrawItemInfo->y1;
GUI_DispStringInRect(acBuffer, &Rect, GUI_TA_VCENTER);
break;
default:
//
// Use the default skinning routine for processing all other commands
//
return FRAMEWIN_DrawSkinFlex(pDrawItemInfo);
}
return 0;
}
void _SetSkin(WM_HWIN) { // // Set the derived // FRAMEWIN_SetSkin(hFrame, _DrawSkinFlex_FRAME);
}
19.6.3 List of commands
As explained above a skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. There are several commands which are send
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
781
to the skinning routine of a widget. Please note that not all commands are send to all widgets. Further the meaning in detail vary by widgets. Detailed descriptions how to react on the commands follow later in the widget specific details. The following table gives an overview of the commands which are send to the skinning routines:
Command Id (Cmd)
Description
Creation messages
WIDGET_ITEM_CREATE
Sent to each skinnable widget after it has been created but before it is drawn.
Information messages
WIDGET_ITEM_GET_BORDERSIZE_B Used to get the size of the bottom border.
WIDGET_ITEM_GET_BORDERSIZE_L Used to get the size of the left border.
WIDGET_ITEM_GET_BORDERSIZE_R Used to get the size of the right border.
WIDGET_ITEM_GET_BORDERSIZE_T Used to get the size of the top border.
WIDGET_ITEM_GET_BUTTONSIZE
Used to get the button size.
WIDGET_ITEM_GET_XSIZE
Used to get the X-size.
WIDGET_ITEM_GET_YSIZE
Used to get the Y-size.
Drawing messages
WIDGET_ITEM_DRAW_ARROW
Used to draw an arrow.
WIDGET_ITEM_DRAW_BACKGROUND Used to draw the background.
WIDGET_ITEM_DRAW_BITMAP
Used to draw a bitmap.
WIDGET_ITEM_DRAW_BUTTON
Used to draw the button area.
WIDGET_ITEM_DRAW_BUTTON_L
Used to draw the left button area.
WIDGET_ITEM_DRAW_BUTTON_R
Used to draw the right button area.
WIDGET_ITEM_DRAW_FOCUS
Used to draw the focus rectangle.
WIDGET_ITEM_DRAW_FRAME
Used to draw the frame of a widget.
WIDGET_ITEM_DRAW_OVERLAP
Used to draw the overlapping region.
WIDGET_ITEM_DRAW_SEP
Used to draw a separator.
WIDGET_ITEM_DRAW_SHAFT
Used to draw the shaft area.
WIDGET_ITEM_DRAW_SHAFT_L
Used to draw the left shaft area.
WIDGET_ITEM_DRAW_SHAFT_R
Used to draw the right shaft area.
WIDGET_ITEM_DRAW_TEXT
Used to draw the text.
WIDGET_ITEM_DRAW_THUMB
Used to draw the thumb area.
WIDGET_ITEM_DRAW_TICKS
Used to draw tick marks.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
782
CHAPTER
Skinning
19.7 General skinning API
The table below lists available skinning-related routines in alphabetical order. These functions are common to all skinnable widgets, and are listed here in order to avoid repetition. Detailed descriptions of the routines follow. The additional skinning member functions available for each widget may be found in later sections.
Routine
Description
<WIDGET>_DrawSkinFlex()
Skinning callback function of the default skin.
<WIDGET>_GetSkinFlexProps()
Returns the current properties of the skin.
<WIDGET>_SetDefaultSkin()
Sets the default skin used for new widgets.
<WIDGET>_SetDefaultSkinClassic() Sets the classical design as default for new widgets.
<WIDGET>_SetSkin()
Sets a skin for the given widget.
<WIDGET>_SetSkinClassic()
Sets the classical design for the given widget.
<WIDGET>_SetSkinFlexProps()
Sets the properties of the skin.
<WIDGET>_DrawSkinFlex()
Description
These functions are the skinning callback functions of the default skin and are responsible to draw the complete widget.
Prototype
int <WIDGET>_DrawSkinFlex(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
Parameter pDrawItemInfo
Description Pointer to a data structure of type WIDGET_ITEM_DRAW_INFO.
Additional information
A derived skin can use this function for drawing details of the default skin.
<WIDGET>_GetSkinFlexProps()
Description
These functions return the attributes of the default skin. The widget specific explanations later in this chapter explain the skin attributes in detail.
Prototype
void <WIDGET>_GetSkinFlexProps(<WIDGET>_SKINFLEX_PROPS * pProps, int Index);
Parameter pProps Index
Description
Pointer to a skin specific configuration structure of type
<WIDGET>_SKINFLEX_PROPS to be filled by the function.
Widget state (pressed, active, selected, ...) for which the details should be retrieved.
<WIDGET>_SetDefaultSkin()
Description
These functions set the default skin which is used for new widgets of the dedicated type.
Prototype
void <WIDGET>_SetDefaultSkin(WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
Parameter pfDrawSkin
Description
Pointer to a skinning callback function of type WIDGET_DRAW_ITEM_FUNC.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
783
Additional information
The given pointer should point to the skinning callback routine to be used for all new widgets. For more details please also refer to the function <WIDGET>_SetSkin() explained later in this chapter.
<WIDGET>_SetDefaultSkinClassic()
Description
These functions set the classical design for all new widgets of the dedicated type.
Prototype
void <WIDGET>_SetDefaultSkinClassic(void);
Additional information
The behaviour of widgets which use the classical design is completely identical to the behaviour before implementing the skinning feature.
<WIDGET>_SetSkin()
Description
These functions can be used for setting a skin for the given widget.
Prototype
void <WIDGET>_SetSkin(<WIDGET>_Handle
hObj,
WIDGET_DRAW_ITEM_FUNC * pfDrawSkin);
Parameter hObj pfDrawSkin
Description
Handle to the dedicated widget. Pointer to a skinning callback function of type WIDGET_DRAW_ITEM_FUNC.
WIDGET_DRAW_ITEM_FUNC
typedef int WIDGET_DRAW_ITEM_FUNC(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo);
Additional information
Please note that some of the default API functions for the widget have no effect if a skin is used.
<WIDGET>_SetSkinClassic()
Description
These functions switch to the classical design without skinning for the given widget.
Prototype
void <WIDGET>_SetSkinClassic(<WIDGET>_Handle hObj);
Parameter hObj
Handle to the dedicated widget.
Description
Additional information
Please also refer to the function <WIDGET>_SetDefaultSkinClassic().
<WIDGET>_SetSkinFlexProps()
Description
With these functions some attributes of the default skin can be changed without deriving an own skin. The widget specific explanations later in this chapter will explain in detail what can be changed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
784
CHAPTER
Skinning
Prototype
void <WIDGET>_SetSkinFlexProps(const <WIDGET>_SKINFLEX_PROPS * pProps, int Index);
Parameter pProps Index
Description
Pointer to a skin specific configuration structure of type
<WIDGET>_SKINFLEX_PROPS.
Details of the state (pressed, active, selected, ...) for which the details should be valid.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
785
19.8 BUTTON_SKIN_FLEX
The following picture shows the details of the skin:
E F G
ABCD
T
R
The button skin consists of a rounded border and a rectangular inner area which is filled by 2 gradients. The surrounding border is drawn by 2 colors.
Detail A B C D E F G R T
Description
Top color of top gradient. Bottom color of top gradient. Top color of bottom gradient. Bottom color of bottom gradient. Outer color of surrounding frame. Inner color of surrounding frame. Color of area between surrounding frame and inner rectangular area. Radius of rounded corner. Optional text.
19.8.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type BUTTON_SKINFLEX_PROPS are used:
Elements of BUTTON_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[3]
U32
aColorUpper[2]
U32
aColorLower[2]
int
Radius
Description
[0] - Outer color of surrounding frame. [1] - Inner color of surrounding frame. [2] - Color of area between frame and inner area. [0] - First (upper) color of upper gradient. [1] - Second (lower) color of upper gradient. [0] - First (upper) color of lower gradient. [1] - Second (lower) color of lower gradient.
Radius of rounded corner.
19.8.2 Configuration options
The default appearance of the skin can be defined using custom configuration structures of the type BUTTON_SKINFLEX_PROPS in GUIConf.h. The following table shows the identifiers which are used for the different states of the skinned BUTTON widget:
Macro BUTTON_SKINPROPS_PRESSED BUTTON_SKINPROPS_FOCUSSED BUTTON_SKINPROPS_ENABLED BUTTON_SKINPROPS_DISABLED
Description
Defines the default attributes used for pressed state. Defines the default attributes used for focussed state. Defines the default attributes used for enabled state. Defines the default attributes used for disabled state.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
786
CHAPTER
Skinning
19.8.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine BUTTON_DrawSkinFlex() BUTTON_GetSkinFlexProps() BUTTON_SetDefaultSkin() BUTTON_SetDefaultSkinClassic() BUTTON_SetSkin() BUTTON_SetSkinClassic() BUTTON_SetSkinFlexProps()
BUTTON_SetSkinFlexProps()
Description
Skinning callback function of BUTTON_SKIN_FLEX. (Explained at the beginning of the chapter) Returns the properties of the given button skin. (Explained at the beginning of the chapter) Sets the default skin used for new button widgets. (Explained at the beginning of the chapter) Sets the classical design as default for new button widgets. (Explained at the beginning of the chapter) Sets a skin for the given button widget. (Explained at the beginning of the chapter) Sets the classical design for the given button widget. (Explained at the beginning of the chapter)
Sets the properties of the given button skin.
Before
After
Description
The function can be used to change the properties of the skin.
Prototype
void BUTTON_SetSkinFlexProps(const BUTTON_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type BUTTON_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index
BUTTON_SKINFLEX_PI_PRESSED BUTTON_SKINFLEX_PI_FOCUSSED BUTTON_SKINFLEX_PI_ENABLED BUTTON_SKINFLEX_PI_DISABLED
Properties for pressed state. Properties for focussed state. Properties for enabled state. Properties for disabled state.
Additional information
The function passes a pointer to a BUTTON_SKINFLEX_PROPS structure. It can be used to set up the colors and the radius of the skin. The function BUTTON_GetSkinFlexProps() can be used to get the current attributes of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
787
19.8.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the BUTTON_SKIN_FLEX callback function:
Command
Description
WIDGET_ITEM_CREATE
Is sent immediately after creating the widget.
WIDGET_ITEM_DRAW_BACKGROUND The skinning function should draw the background.
WIDGET_ITEM_DRAW_BITMAP
The skinning function should draw the optional button bitmap.
WIDGET_ITEM_DRAW_TEXT
The skinning function should draw the optional button text.
The WIDGET_ITEM_DRAW_INFO structure is explained at the beginning of the chapter.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_BACKGROUND
The background of the widget should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. See table below. Leftmost coordinate in window coordinates, normally 0. Topmost coordinate in window coordinates, normally 0. Rightmost coordinate in window coordinates. Bottommost coordinate in window coordinates.
Permitted values for element ItemIndex
BUTTON_SKINFLEX_PI_PRESSED BUTTON_SKINFLEX_PI_FOCUSSED BUTTON_SKINFLEX_PI_ENABLED BUTTON_SKINFLEX_PI_DISABLED
The widget is pressed. The widget is not pressed but focussed. The widget is not focussed but enabled. The widget is disabled.
WIDGET_ITEM_DRAW_BITMAP
The optional button bitmap should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure
Please refer to WIDGET_ITEM_DRAW_BACKGROUND.
Additional information
The function BUTTON_GetBitmap() can be used to get the optional button bitmap.
WIDGET_ITEM_DRAW_TEXT
The optional button text should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure
Please refer to WIDGET_ITEM_DRAW_BACKGROUND.
Additional information
The function BUTTON_GetText() can be used to get the optional text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
788
CHAPTER
19.9 CHECKBOX_SKIN_FLEX
The following picture shows the details of the skin:
S
Skinning
A SB
C
DF E
T
R
The button area of the checkbox skin consists of a frame and a rectangular inner area which is filled by a gradient. The frame is drawn by 3 colors. If it is checked, a checkmark is shown in the center of the box:
Detail A B C D E F R S T
First color of frame. Second color of frame. Third color of frame. Upper color of gradient. Lower color of gradient. Color of checkmark. Focus rectangle. Size in pixels of button area. Optional text.
Description
19.9.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type CHECKBOX_SKINFLEX_PROPS are used:
Elements of CHECKBOX_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[3]
U32
aColorInner[2]
U32
ColorCheck
int
ButtonSize
Description
[0] - Outer color of frame. [1] - Middle color of frame. [2] - Inner color of frame. [0] - First (upper) color of gradient. [1] - Second (lower) color of gradient.
Color of checkmark.
Size in pixels of the button area. (Obsolete. Use the functions CHECKBOX_GetSkinFlexButtonSize() and CHECKBOX_SetSkinFlexButtonSize().)
19.9.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro
Description
CHECKBOX_SKINPROPS_ENABLED Defines the default attributes used for enabled state. CHECKBOX_SKINPROPS_DISABLED Defines the default attributes used for disabled state.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
789
19.9.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine
Description
CHECKBOX_DrawSkinFlex()
Skinning callback function of CHECKBOX_SKIN_FLEX. (Explained at the beginning of the chapter)
CHECKBOX_GetSkinFlexButtonSize() Returns the button size of the given CHECKBOX widget.
CHECKBOX_GetSkinFlexProps()
Returns the properties of the given checkbox skin. (Explained at the beginning of the chapter)
CHECKBOX_SetDefaultSkin()
Sets the default skin used for new checkbox widgets. (Explained at the beginning of the chapter)
Sets the classical design as default for new checkbox wid-
CHECKBOX_SetDefaultSkinClassic() gets. (Explained at the beginning of the chapter)
CHECKBOX_SetSkin()
Sets a skin for the given checkbox widget. (Explained at the beginning of the chapter)
CHECKBOX_SetSkinClassic()
Sets the classical design for the given checkbox widget. (Explained at the beginning of the chapter)
CHECKBOX_SetSkinFlexButtonSize() Sets button size of the given CHECKBOX widget.
CHECKBOX_SetSkinFlexProps()
Sets the properties of the given checkbox skin.
CHECKBOX_GetSkinFlexButtonSize()
Description
Returns the button size of the specified CHECKBOX widget.
Prototype
int CHECKBOX_GetSkinFlexButtonSize(CHECKBOX_Handle hObj);
Parameter hObj
Handle to a CHECKBOX widget.
Description
Return value
Button size.
CHECKBOX_SetSkinFlexButtonSize()
Description
Sets the button size of the specified CHECKBOX widget.
Prototype
void CHECKBOX_SetSkinFlexButtonSize(CHECKBOX_Handle hObj, int ButtonSize);
Parameter hObj ButtonSize
Handle to a CHECKBOX widget. Size to be set.
Description
CHECKBOX_SetSkinFlexProps()
Before
After
Description
The function can be used to change the properties of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
790
CHAPTER
Skinning
Prototype
void CHECKBOX_SetSkinFlexProps(const CHECKBOX_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type CHECKBOX_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index
CHECKBOX_SKINFLEX_PI_ENABLED Properties for enabled state.
CHECKBOX_SKINFLEX_PI_DISABLED Properties for disabled state.
Additional information
The function passes a pointer to a CHECKBOX_SKINFLEX_PROPS structure. It can be used to set up the colors of the skin. Please note that the size of the widgets using the skin won't be changed if for example the new button size is different to the old button size. This can not be done by the skin, because it does not 'know' which widget is using it. If required resizing should be done by the application, for example with WM_ResizeWindow(). The function CHECKBOX_GetSkinFlexProps() can be used to get the current attributes of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
791
19.9.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the CHECKBOX_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_BUTTON WIDGET_ITEM_DRAW_BITMAP WIDGET_ITEM_DRAW_FOCUS WIDGET_ITEM_DRAW_TEXT
Description
Is sent immediately after creating the widget. The background of the button area should be drawn. The checkmark of the button area should be drawn. The focus rectangle should be drawn. The optional text should be drawn.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_BUTTON
The button area of the widget without checkmark should be drawn. It is typically drawn at the left side of the widget area.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin
Handle to the widget.
x0
Leftmost coordinate of widget area in window coordinates, normally 0.
y0
Topmost coordinate of widget area in window coordinates, normally 0.
x1
Rightmost coordinate of widget area in window coordinates.
y1
Bottommost coordinate of widget area in window coordinates.
The content of hWin, x0, y0, x1 and y1 is the same for all commands of this skin.
WIDGET_ITEM_DRAW_BITMAP
The checkmark should be drawn in the center of the button area.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element ItemIndex hWin,x0,y0,x1,y1
Description
1 - The widget is checked. 2 - Second checked state when using a 3 state button.
(please refer to WIDGET_ITEM_DRAW_BUTTON)
WIDGET_ITEM_DRAW_FOCUS
The focus rectangle should be drawn around the text.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
p hWin,x0,y0,x1,y1
The void pointer points to the zero terminated optional text of the widget.
(please refer to WIDGET_ITEM_DRAW_BUTTON)
Additional information
The element p can be casted to a text pointer. For details please refer to WIDGET_ITEM_DRAW_TEXT.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
792
CHAPTER
Skinning
WIDGET_ITEM_DRAW_TEXT
The optional text should be drawn. The text is typically drawn at the right side of the button area.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
p hWin,x0,y0,x1,y1
The void pointer points to the zero terminated optional text of the widget.
(please refer to WIDGET_ITEM_DRAW_BUTTON)
Additional information
To get a text pointer the element p can be casted to a text pointer:
char * s; s = (char *)pDrawItemInfo->p; GUI_DispString(s);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
793
19.10 DROPDOWN_SKIN_FLEX
The following picture shows the details of the skin:
A
H
B
I
C
R
T
DEF G
The dropdown skin consists of a rounded frame and a rectangular inner area which is filled by two gradients. The rounded frame is drawn by 3 colors. At the right side a small triangle is drawn. Between text and triangle a small separator is drawn:
Detail A B C D E F G H I R T
Description
First color of frame. Second color of frame. Third color of frame. Top color of top gradient. Bottom color of top gradient. Top color of bottom gradient. Bottom color of bottom gradient. Separator between text and triangle. Triangle. Radius of rounded corner. Optional text.
The dropdown widget in open state consists of an additional listbox. Please note that this listbox is not affected by the skin.
19.10.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type DROPDOWN_SKINFLEX_PROPS are used:
Elements of DROPDOWN_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[3]
U32
aColorUpper[2]
U32
aColorLower[2]
U32
ColorArrow
U32
ColorText
U32
ColorSep
int
Radius
Description
[0] - Outer color of surrounding frame. [1] - Inner color of surrounding frame. [2] - Color of area between frame and inner area. [0] - Top color of top gradient. [1] - Bottom color of top gradient. [0] - Top color of bottom gradient. [1] - Bottom color of bottom gradient. Color used to draw the arrow.
Color used to draw the text.
Color used to draw the separator.
Radius of rounded corner.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
794
CHAPTER
Skinning
19.10.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro
Description
DROPDOWN_SKINPROPS_OPEN
Defines the default attributes used for open state.
DROPDOWN_SKINPROPS_FOCUSSED Defines the default attributes used for focussed state.
DROPDOWN_SKINPROPS_ENABLED Defines the default attributes used for enabled state.
DROPDOWN_SKINPROPS_DISABLED Defines the default attributes used for disabled state.
19.10.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine
Description
DROPDOWN_DrawSkinFlex()
Skinning callback function of DROPDOWN_SKIN_FLEX. (Explained at the beginning of the chapter)
DROPDOWN_GetSkinFlexProps()
Returns the properties of the given dropdown skin. (Explained at the beginning of the chapter)
DROPDOWN_SetDefaultSkin()
Sets the default skin used for new dropdown widgets. (Explained at the beginning of the chapter)
Sets the classical design as default for new dropdown wid-
DROPDOWN_SetDefaultSkinClassic() gets. (Explained at the beginning of the chapter)
DROPDOWN_SetSkin()
Sets a skin for the given dropdown widget. (Explained at the beginning of the chapter)
DROPDOWN_SetSkinClassic()
Sets the classical design for the given dropdown widget. (Explained at the beginning of the chapter)
DROPDOWN_SetSkinFlexProps()
Sets the properties of the given dropdown skin.
DROPDOWN_SetSkinFlexProps()
Before
After
Description
The function can be used to change the properties of the skin.
Prototype
void DROPDOWN_SetSkinFlexProps(const DROPDOWN_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type DROPDOWN_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index
DROPDOWN_SKINFLEX_PI_OPEN DROPDOWN_SKINFLEX_PI_FOCUSSED DROPDOWN_SKINFLEX_PI_ENABLED DROPDOWN_SKINFLEX_PI_DISABLED
Properties for open state. Properties for focussed state. Properties for enabled state. Properties for disabled state.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
795
Additional information
The function passes a pointer to a DROPDOWN_SKINFLEX_PROPS structure. It can be used to set up the colors and the radius of the skin. The function DROPDOWN_GetSkinFlexProps() can be used to get the current attributes of the skin.
19.10.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the DROPDOWN_SKIN_FLEX callback function:
Command
Description
WIDGET_ITEM_CREATE
Is sent immediately after creating the widget.
WIDGET_ITEM_DRAW_ARROW
The skinning function should draw the arrow.
WIDGET_ITEM_DRAW_BACKGROUND The skinning function should draw the background.
WIDGET_ITEM_DRAW_TEXT
The skinning function should draw the optional button text.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_ARROW
The triangle (arrow) at the right side should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
WIDGET_ITEM_DRAW_BACKGROUND
The background of the widget should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. See table below. Leftmost coordinate in window coordinates, normally 0. Topmost coordinate in window coordinates, normally 0. Rightmost coordinate in window coordinates. Bottommost coordinate in window coordinates.
Permitted values for element ItemIndex
DROPDOWN_SKINFLEX_PI_EXPANDED DROPDOWN_SKINFLEX_PI_FOCUSSED DROPDOWN_SKINFLEX_PI_ENABLED DROPDOWN_SKINFLEX_PI_DISABLED
The widget is expanded.
The widget is in not pressed but focussed. The widget is in not focussed but enabled.
The widget is disabled.
WIDGET_ITEM_DRAW_TEXT
The text of the currently selected string should be drawn within the button area of the dropdown widget. The text is typically drawn at the left side of the button area.
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
796
CHAPTER
19.11 FRAMEWIN_SKIN_FLEX
The following picture shows the details of the skin:
T
Gt Gb
Skinning
R
Bt
S
A
B
W
C
Bb
Bl
Br
The above picture shows the details of the framewin skin. It consists of a title bar, rounded corners at the top, a gradient used to draw the background of the title bar, a border whose size is configurable and a separator between title bar and client area:
Detail A B C Gt Gb Bt Bb Bl Br W R T
Description
Outer color of surrounding frame. Inner color of surrounding frame. Color of area between frame and inner area. Top color of top title bar gradient. Bottom color of title bar gradient. Top size of border. Bottom size of border. Left size of border. Right size of border. Area of client window. Radius of rounded corner. Optional text.
19.11.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type FRAMEWIN_SKINFLEX_PROPS are used:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
797
Elements of FRAMEWIN_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[3]
U32
aColorTitle[2]
int
Radius
int
SpaceX
int
BorderSizeL
int
BorderSizeR
int
BorderSizeT
int
BorderSizeB
Description
[0] - Outer color of surrounding frame. [1] - Inner color of surrounding frame. [2] - Color of area between frame and inner area. [0] - Top color of top title bar gradient. [1] - Bottom color of title bar gradient. Radius of rounded corners.
Optional space in X between title text and border of title gradient.
Left size of border.
Right size of border.
Top size of border.
Bottom size of border.
19.11.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro
Description
FRAMEWIN_SKINPROPS_ACTIVE Defines the default attributes used for active state. FRAMEWIN_SKINPROPS_INACTIVE Defines the default attributes used for inactive state.
19.11.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine
Description
FRAMEWIN_DrawSkinFlex()
Skinning callback function of FRAMEWIN_SKIN_FLEX. (Explained at the beginning of the chapter)
FRAMEWIN_GetSkinFlexProps()
Returns the properties of the given FRAMEWIN skin. (Explained at the beginning of the chapter)
FRAMEWIN_SetDefaultSkin()
Sets the default skin used for new framewin widgets. (Explained at the beginning of the chapter)
Sets the classical design as default for new framewin wid-
FRAMEWIN_SetDefaultSkinClassic() gets. (Explained at the beginning of the chapter)
FRAMEWIN_SetSkin()
Sets a skin for the given framewin widget. (Explained at the beginning of the chapter)
FRAMEWIN_SetSkinClassic()
Sets the classical design for the given framewin widget. (Explained at the beginning of the chapter)
FRAMEWIN_SetSkinFlexProps()
Sets the properties of the given framewin skin.
FRAMEWIN_SetSkinFlexProps()
Before
After
Description
The function can be used to change the properties of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
798
CHAPTER
Skinning
Prototype
void FRAMEWIN_SetSkinFlexProps(const FRAMEWIN_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type FRAMEWIN_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index
FRAMEWIN_SKINFLEX_PI_ACTIVE
Properties for active state.
FRAMEWIN_SKINFLEX_PI_INACTIVE Properties for inactive state.
Additional information
The function passes a pointer to a FRAMEWIN_SKINFLEX_PROPS structure. It can be used to set up the colors, radius and border size of the skin. The function FRAMEWIN_GetSkinFlexProps() can be used to get the current attributes of the skin. When creating a frame window using this skin the values for inactive state are used for calculating size and position of the client window.
19.11.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the FRAMEWIN_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_BACKGROUND WIDGET_ITEM_DRAW_FRAME WIDGET_ITEM_DRAW_SEP WIDGET_ITEM_DRAW_TEXT WIDGET_ITEM_GET_BORDERSIZE_L WIDGET_ITEM_GET_BORDERSIZE_R WIDGET_ITEM_GET_BORDERSIZE_T WIDGET_ITEM_GET_BORDERSIZE_B WIDGET_ITEM_GET_RADIUS
Description
Is sent immediately after creating the widget. The skinning function should draw the title background. The skinning function should draw the frame. The skinning function should draw the separator. The skinning function should draw the title text. The skinning function should return the left border size. The skinning function should return the right border size. The skinning function should return the top border size. The skinning function should return the bottom border size. The skinning function should return the radius of the corners.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_BACKGROUND
The skinning routine should draw the background of the title area.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
799
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. See table below. Leftmost coordinate of title area in window coordinates. Topmost coordinate of title area in window coordinates. Rightmost coordinate of title area in window coordinates. Bottommost coordinate of title area in window coordinates.
Permitted values for element ItemIndex
FRAMEWIN_SKINFLEX_PI_ACTIVE
The widget is in active state.
FRAMEWIN_SKINFLEX_PI_INACTIVE The widget is in inactive state.
WIDGET_ITEM_DRAW_FRAME
The skinning routine should draw the complete border without the title area and the separator.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. See table below. Leftmost coordinate in window coordinates, normally 0. Topmost coordinate in window coordinates, normally 0. Rightmost coordinate in window coordinates (xSize of window - 1). Bottommost coordinate in window coordinates (ySize of window - 1).
Permitted values for element ItemIndex
FRAMEWIN_SKINFLEX_PI_ACTIVE
The widget is in active state.
FRAMEWIN_SKINFLEX_PI_INACTIVE The widget is in inactive state.
WIDGET_ITEM_DRAW_SEP
The skinning routine should draw the separator between title area and client window.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. See table below. Leftmost coordinate of separator in window coordinates. Topmost coordinate of separator in window coordinates. Rightmost coordinate of separator in window coordinates. Bottommost coordinate of separator in window coordinates.
Permitted values for element ItemIndex
FRAMEWIN_SKINFLEX_PI_ACTIVE
The widget is in active state.
FRAMEWIN_SKINFLEX_PI_INACTIVE The widget is in inactive state.
WIDGET_ITEM_DRAW_TEXT
The skinning routine should draw title text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
800
CHAPTER
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
WIDGET_ITEM_GET_BORDERSIZE_L, WIDGET_ITEM_GET_BORDERSIZE_R, WIDGET_ITEM_GET_BORDERSIZE_T, WIDGET_ITEM_GET_BORDERSIZE_B
The skinning routine should return the size of the according border.
Skinning
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
19.12 HEADER_SKIN_FLEX
The following picture shows the details of the skin:
E
F
I
T
801
P
AB
O
CD
The above picture shows the details of the skin. It consists of a bar with a thin border which is divided into separate items. The background of the bar consists of a top and a bottom gradient. Each item can have a text, a bitmap and an indicator which can be used for example to show the sorting order:
Detail A B C D E F I T P
Top color of top gradient. Bottom color of top gradient. Top color of bottom gradient. Bottom color of bottom gradient. First color of frame. Second color of frame. Indicator. Text (optional). Bitmap (optional).
Description
19.12.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type HEADER_SKINFLEX_PROPS are used:
Elements of HEADER_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[2]
U32
aColorUpper[2]
U32
aColorLower[2]
U32
ColorArrow
Description
[0] - First color of frame and separators. [1] - Second color of frame and separators. [0] - Top color of top gradient. [1] - Bottom color of top gradient. [0] - Top color of bottom gradient. [1] - Bottom color of bottom gradient.
Color of indicator.
19.12.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro HEADER_SKINPROPS
Description
Defines the default attributes used for drawing the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
802
CHAPTER
Skinning
19.12.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine HEADER_DrawSkinFlex() HEADER_GetSkinFlexProps() HEADER_SetDefaultSkin() HEADER_SetDefaultSkinClassic() HEADER_SetSkin() HEADER_SetSkinClassic() HEADER_SetSkinFlexProps()
HEADER_SetSkinFlexProps()
Description
Skinning callback function of HEADER_SKIN_FLEX. (Explained at the beginning of the chapter) Returns the properties of the given HEADER skin. (Explained at the beginning of the chapter) Sets the default skin used for new HEADER widgets. (Explained at the beginning of the chapter) Sets the classical design as default for new HEADER widgets. (Explained at the beginning of the chapter) Sets a skin for the given HEADER widget. (Explained at the beginning of the chapter) Sets the classical design for the given HEADER widget. (Explained at the beginning of the chapter)
Sets the properties of the given HEADER skin.
Before
After
Description
The function can be used to change the properties of the skin.
Prototype
void HEADER_SetSkinFlexProps(const HEADER_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type HEADER_SKINFLEX_PROPS. Should be 0.
Additional information
The function passes a pointer to a HEADER_SKINFLEX_PROPS structure. It can be used to set up the colors of the skin. The function HEADER_GetSkinFlexProps() can be used to get the current attributes of the skin.
19.12.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the HEADER_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_ARROW WIDGET_ITEM_DRAW_BACKGROUND
Description
Is sent immediately after creating the widget. The indicator arrow of the header item should be drawn. The background of the header item should be drawn.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
803
Command WIDGET_ITEM_DRAW_BITMAP WIDGET_ITEM_DRAW_OVERLAP WIDGET_ITEM_DRAW_TEXT
Description
The bitmap of the header item should be drawn. The overlapping region of the widget should be drawn. The test of the header item should be drawn.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_ARROW
The skinning routine should draw the optional direction indicator. The message is only send if the indicator of the header item is enabled.
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
WIDGET_ITEM_DRAW_BACKGROUND
The skinning routine should draw the background of an item area.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. Is always 0. Leftmost coordinate of item area in window coordinates. Topmost coordinate of item area in window coordinates. Rightmost coordinate of item area in window coordinates. Bottommost coordinate of item area in window coordinates.
WIDGET_ITEM_DRAW_BITMAP
The skinning routine should draw the optional item bitmap. The message is only send in case of an existing bitmap.
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
WIDGET_ITEM_DRAW_OVERLAP
The skinning routine should draw the overlapping region.
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
WIDGET_ITEM_DRAW_TEXT
The skinning routine should draw the optional item text. The message is only send in case of an existing text.
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_BACKGROUND)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
804
CHAPTER
19.13 PROGBAR_SKIN_FLEX
The following picture shows the details of the skin:
AB
T
EF
Skinning
CD
I
GH
The above picture shows the details of the skin. It consists of a bar with a thin border. The background is drawn by 4 gradients, a top and a bottom gradient at the left and at the right side and a text which shows the current state per default:
Detail A B C D A B C D I T
Description
Top color of top left gradient. Bottom color of top left gradient. Top color of bottom left gradient. Bottom color of bottom left gradient. Top color of top right gradient. Bottom color of top right gradient. Top color of bottom right gradient. Bottom color of bottom right gradient. Color of frame. Text (optional).
19.13.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type PROGBAR_SKINFLEX_PROPS are used:
Elements of PROGBAR_SKINFLEX_PROPS
Data type
Element
Description
U32 U32 U32 U32
aColorUpperL[2] aColorLowerL[2] aColorUpperR[2] aColorLowerR[2]
[0] - Top color of top gradient. [1] - Bottom color of top gradient.
[0] - Top color of bottom gradient. [1] - Bottom color of bottom gradient.
[0] - Top color of top gradient. [1] - Bottom color of top gradient.
[0] - Top color of bottom gradient. [1] - Bottom color of bottom gradient.
U32
ColorFrame
Color of frame.
U32
ColorText
Color of text.
19.13.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro PROGBAR_SKINPROPS
Description
Defines the default attributes used for drawing the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
805
19.13.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine PROGBAR_DrawSkinFlex() PROGBAR_GetSkinFlexProps() PROGBAR_SetDefaultSkin() PROGBAR_SetDefaultSkinClassic() PROGBAR_SetSkin() PROGBAR_SetSkinClassic() PROGBAR_SetSkinFlexProps()
Description
Skinning callback function of PROGBAR_SKIN_FLEX. (Explained at the beginning of the chapter) Returns the properties of the given PROGBAR skin. (Explained at the beginning of the chapter) Sets the default skin used for new PROGBAR widgets. (Explained at the beginning of the chapter) Sets the classical design as default for new PROGBAR widgets. (Explained at the beginning of the chapter) Sets a skin for the given PROGBAR widget. (Explained at the beginning of the chapter) Sets the classical design for the given PROGBAR widget. (Explained at the beginning of the chapter)
Sets the properties of the given PROGBAR skin.
PROGBAR_SetSkinFlexProps()
Before
After
Description
The function can be used to change the colors of the skin.
Prototype
void PROGBAR_SetSkinFlexProps(const PROGBAR_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type PROGBAR_SKINFLEX_PROPS. Should be 0.
Additional information
The function passes a pointer to a PROGBAR_SKINFLEX_PROPS structure. It can be used to set up the colors of the skin. The function PROGBAR_GetSkinFlexProps() can be used to get the current attributes of the skin.
19.13.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the PROGBAR_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_BACKGROUND WIDGET_ITEM_DRAW_FRAME WIDGET_ITEM_DRAW_TEXT
Description
Is sent immediately after creating the widget. The skinning function should draw the background. The skinning function should draw the frame. The skinning function should draw the text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
806
CHAPTER
Skinning
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_BACKGROUND
The skinning routine should draw the background.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1 p
Handle to the widget. Is always 0. Leftmost coordinate of widget area in window coordinates. Topmost coordinate of widget area in window coordinates. Rightmost coordinate of widget area in window coordinates. Bottommost coordinate of widget area in window coordinates.
Pointer to a PROGBAR_SKINFLEX_INFO structure.
Elements of PROGBAR_SKINFLEX_INFO
Data type int int const char *
Element IsVertical Index pText
Description
0 if the progress bar is horizontal, 1 if it is vertical. See table below. Pointer to the text to be drawn.
Permitted values for element Index
PROGBAR_SKINFLEX_L PROGBAR_SKINFLEX_R
Horizontal progress bar: The left part should be drawn. Vertical progress bar: The top part should be drawn.
Horizontal progress bar: The right part should be drawn. Vertical progress bar: The bottom part should be drawn.
Additional Information
The message is send twice, once for the left/top part and once for the right/bottom part of the progress bar. The information in the PROGBAR_SKINFLEX_INFO structure pointed by element p of the WIDGET_ITEM_DRAW_INFO structure can be used to get the information what exactly should be drawn. The parameters x0, y0, x1 and y1 of the WIDGET_ITEM_DRAW_INFO structure mark only the area which should be drawn, left/right or top/bottom.
WIDGET_ITEM_DRAW_FRAME
The skinning routine should draw the surrounding frame.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. Is always 0. Leftmost coordinate of widget area in window coordinates. Topmost coordinate of widget area in window coordinates. Rightmost coordinate of widget area in window coordinates. Bottommost coordinate of widget area in window coordinates.
WIDGET_ITEM_DRAW_TEXT
The skinning routine should draw the text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
807
Content of the WIDGET_ITEM_DRAW_INFO structure:
(please refer to WIDGET_ITEM_DRAW_FRAME)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
808
CHAPTER
19.14 RADIO_SKIN_FLEX
The following picture shows the details of the skin:
T
Skinning
S
F
AB C D
The above picture shows the details of the skin. It consists of a configurable button and a text for each item. If the widget has the input focus the currently selected item text is surrounded by a focus rectangle:
Detail A B C D F S T
Outer color of button frame. Middle color of button frame. Inner color of button frame. Inner color of button. Focus rectangle. Size of button. Item text.
Description
19.14.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type RADIO_SKINFLEX_PROPS are used:
Elements of RADIO_SKINFLEX_PROPS
Data type
Element
Description
U32
aColorButton[4]
[0] - Outer color of button frame. [1] - Middle color of button frame. [2] - Inner color of button frame. [3] - Inner color of button.
int
ButtonSize
Size of the button in pixels.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
809
19.14.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro RADIO_SKINPROPS_CHECKED RADIO_SKINPROPS_UNCHECKED
Description
Defines the default attributes used for checked state. Defines the default attributes used for unchecked state.
19.14.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine RADIO_DrawSkinFlex() RADIO_GetSkinFlexProps() RADIO_SetDefaultSkin() RADIO_SetDefaultSkinClassic() RADIO_SetSkin() RADIO_SetSkinClassic() RADIO_SetSkinFlexProps()
RADIO_SetSkinFlexProps()
Description
Skinning callback function of RADIO_SKIN_FLEX. (Explained at the beginning of the chapter) Returns the properties of the given RADIO skin. (Explained at the beginning of the chapter) Sets the default skin used for new RADIO widgets. (Explained at the beginning of the chapter) Sets the classical design as default for new RADIO widgets. (Explained at the beginning of the chapter) Sets a skin for the given RADIO widget. (Explained at the beginning of the chapter) Sets the classical design for the given RADIO widget. (Explained at the beginning of the chapter)
Sets the properties of the given RADIO skin.
Before
After
Description
The function can be used to change the colors of the skin and the size of the button.
Prototype
void RADIO_SetSkinFlexProps(const RADIO_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type RADIO_SKINFLEX_PROPS. Should be 0.
Additional information
The function passes a pointer to a RADIO_SKINFLEX_PROPS structure. It can be used to set up the colors and the button size of the skin. The function RADIO_GetSkinFlexProps() can be used to get the current attributes of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
810
CHAPTER
Skinning
19.14.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the RADIO_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_BUTTON WIDGET_ITEM_DRAW_FOCUS WIDGET_ITEM_DRAW_TEXT WIDGET_ITEM_GET_BUTTONSIZE
Description
Is sent immediately after creating the widget. The skinning function should draw the button of one item. The skinning function should draw the focus rectangle. The skinning function should draw the text of one item. The skinning function should return the button size.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_BUTTON
The skinning routine should draw the button of one item.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the button area in window coordinates. Topmost coordinate of the button area in window coordinates. Rightmost coordinate of the button area in window coordinates. Bottommost coordinate of the button area in window coordinates.
WIDGET_ITEM_DRAW_FOCUS
The skinning routine should draw the focus rectangle around the text of the currently selected item.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the focus rectangle in window coordinates. Topmost coordinate of the focus rectangle in window coordinates. Rightmost coordinate of the focus rectangle in window coordinates. Bottommost coordinate of the focus rectangle in window coordinates.
Additional Information
The given rectangular area in x0, y0, x1 and y1 considers the font settings and the item text.
WIDGET_ITEM_DRAW_TEXT
The skinning routine should draw the text of one item.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
811
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the text area in window coordinates. Topmost coordinate of the text area in window coordinates. Rightmost coordinate of the text area in window coordinates. Bottommost coordinate of the text area in window coordinates.
Additional Information
The given rectangular area in x0, y0, x1 and y1 considers the font settings and the item text.
WIDGET_ITEM_GET_BUTTONSIZE
The skinning routine should return the button size.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
812
CHAPTER
Skinning
19.15 SCROLLBAR_SKIN_FLEX
The following picture shows the details of the skin:
ABL
T
E
R
I
J
K
C DS
G
S
F
H
The above picture shows the details of the skin. It consists of a left and a right button with an arrow, a shaft area and a thumb with a grasp:
Detail A B C D E F G H I J K L T R S
Top color of top gradient. Bottom color of top gradient. Top color of bottom gradient. Bottom color of bottom gradient. Top color of shaft gradient. Bottom color of shaft gradient. Grasp of thumb area. Button arrow. Outer frame color. Inner frame color. Color of frame edges. Left button. Thumb area. Right button. Shaft area.
Description
19.15.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type SCROLLBAR_SKINFLEX_PROPS are used:
Elements of SCROLL_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[3]
U32
aColorUpper[2]
U32
aColorLower[2]
U32
aColorShaft[2]
U32
ColorArrow
U32
ColorGrasp
Description
[0] - Outer frame color. [1] - Inner frame color. [2] - Color of frame edges [0] - Top color of top gradient. [1] - Bottom color of top gradient. [0] - Top color of bottom gradient. [1] - Bottom color of bottom gradient. [0] - Top color of shaft gradient. [1] - Bottom color of shaft gradient.
Color of button arrow.
Color of grasp.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
813
19.15.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro
Description
SCROLLBAR_SKINPROPS_PRESSED Defines the default attributes used for pressed state. SCROLLBAR_SKINPROPS_UNPRESSED Defines the default attributes used for unpressed state.
19.15.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine
Description
SCROLLBAR_DrawSkinFlex()
Skinning callback function of SCROLLBAR_SKIN_FLEX. (Explained at the beginning of the chapter)
SCROLLBAR_GetSkinFlexProps()
Returns the properties of the given SCROLLBAR skin. (Explained at the beginning of the chapter)
SCROLLBAR_SetDefaultSkin()
Sets the default skin used for new SCROLLBAR widgets. (Explained at the beginning of the chapter)
Sets the classical design as default for new SCROLLBAR
SCROLLBAR_SetDefaultSkinClassic() widgets. (Explained at the beginning of the chapter)
SCROLLBAR_SetSkin()
Sets a skin for the given SCROLLBAR widget. (Explained at the beginning of the chapter)
SCROLLBAR_SetSkinClassic()
Sets the classical design for the given SCROLLBAR widget. (Explained at the beginning of the chapter)
SCROLLBAR_SetSkinFlexProps()
Sets the properties of the given SCROLLBAR skin.
SCROLLBAR_SetSkinFlexProps()
Before
After
Description
The function can be used to change the colors of the skin.
Prototype
void SCROLLBAR_SetSkinFlexProps(const SCROLLBAR_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type SCROLLBAR_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index
SCROLLBAR_SKINFLEX_PI_PRESSED SCROLLBAR_SKINFLEX_PI_UNPRESSED
Properties for pressed state. Properties for unpressed state.
Additional information
The function passes a pointer to a SCROLLBAR_SKINFLEX_PROPS structure. It can be used to set up the colors of the skin. The function SCROLLBAR_GetSkinFlexProps() can be used to get the current attributes of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
814
CHAPTER
Skinning
19.15.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the SCROLLBAR_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_BUTTON_L WIDGET_ITEM_DRAW_BUTTON_R WIDGET_ITEM_DRAW_OVERLAP WIDGET_ITEM_DRAW_SHAFT_L WIDGET_ITEM_DRAW_SHAFT_R WIDGET_ITEM_DRAW_THUMB WIDGET_ITEM_GET_BUTTONSIZE
Description
Is sent immediately after creating the widget. The skinning function should draw the left button. The skinning function should draw the right button. The skinning function should draw the overlapping area. The skinning function should draw the left part of the shaft. The skinning function should draw the right part of the shaft. The skinning function should draw the thumb. The skinning function should return the button size.
WIDGET_ITEM_DRAW_BUTTON_L, WIDGET_ITEM_DRAW_BUTTON_R
The skinning routine should draw a button.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1 p
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the button in window coordinates. Topmost coordinate of the button in window coordinates. Rightmost coordinate of the button in window coordinates. Bottommost coordinate of the button in window coordinates.
Pointer to a SCROLLBAR_SKINFLEX_INFO structure.
Elements of SCROLLBAR_SKINFLEX_INFO
Data type int int
Element IsVertical State
Description
0 if the progress bar is horizontal, 1 if it is vertical. See table below.
Permitted values for element State PRESSED_STATE_NONE Nothing is pressed. PRESSED_STATE_RIGHT The right button is pressed. PRESSED_STATE_LEFT The left button is pressed. PRESSED_STATE_THUMB The thumb is pressed.
WIDGET_ITEM_DRAW_OVERLAP
The skinning routine should draw the thumb.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
815
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the overlapping area in window coordinates. Topmost coordinate of the overlapping area in window coordinates. Rightmost coordinate of the overlapping area in window coordinates. Bottommost coordinate of the overlapping area in window coordinates.
Additional information
An overlapping area can exist if a dialog has a vertical and a horizontal scrollbar at the borders. Normally the overlapping region looks identically to the shaft area.
Example
The following screenshot shows a window with 2 scrollbars which have an overlapping region at the lower right corner of the client window:
WIDGET_ITEM_DRAW_SHAFT_L, WIDGET_ITEM_DRAW_SHAFT_R
The skinning routine should draw a shaft area.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the shaft area in window coordinates. Topmost coordinate of the shaft area in window coordinates. Rightmost coordinate of the shaft area in window coordinates. Bottommost coordinate of the shaft area in window coordinates.
WIDGET_ITEM_DRAW_THUMB
The skinning routine should draw the thumb.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1 p
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the thumb area in window coordinates. Topmost coordinate of the thumb area in window coordinates. Rightmost coordinate of the thumb area in window coordinates. Bottommost coordinate of the thumb area in window coordinates.
Pointer to a SCROLLBAR_SKINFLEX_INFO structure.
Elements of SCROLLBAR_SKINFLEX_INFO
Please refer to WIDGET_ITEM_DRAW_BUTTON_L.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
816
CHAPTER
Skinning
WIDGET_ITEM_GET_BUTTONSIZE
The skinning routine should return the button size. The button size means the following: · A horizontal scrollbar should return the height of the scrollbar. · A vertical scrollbar should return the width of the scrollbar.
Example
The following code can be used to return the right values in most cases:
int _SkinningCallback(const WIDGET_ITEM_DRAW_INFO * pDrawItemInfo) { SCROLLBAR_SKINFLEX_INFO * pSkinInfo;
pSkinInfo = (SCROLLBAR_SKINFLEX_INFO *)pDrawItemInfo->p; switch (pDrawItemInfo->Cmd) { case WIDGET_ITEM_GET_BUTTONSIZE:
return (pSkinInfo->IsVertical) ? pDrawItemInfo->x1 - pDrawItemInfo->x0 + 1 : pDrawItemInfo->y1 - pDrawItemInfo->y0 + 1;
... } }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
19.16 SLIDER_SKIN_FLEX
The following picture shows the details of the skin:
I
H
C
817
J
D
K
EFG
AB
The above picture shows the details of the skin. It consists of a shaft with slider and tick marks above. Further a focus rectangle is shown if the widget has the input focus. The slider is drawn by a frame and a gradient:
Detail A B C D E F G H I J K
Outer color of slider frame. Inner color of slider frame Top color of gradient. Bottom color of gradient. First color of shaft. Second color of shaft. Third color of shaft. Focus rectangle. Tick marks. Size of a tick mark. Size of the shaft.
Description
19.16.1 Configuration structure
To set up the default appearance of the skin or to change it at run time configuration structures of type SLIDER_SKINFLEX_PROPS are used:
Elements of SLIDER_SKINFLEX_PROPS
Data type
Element
U32
aColorFrame[2]
U32
aColorInner[2]
U32
aColorShaft[3]
U32
ColorTick
U32
ColorFocus
int
TickSize
int
ShaftSize
Description
[0] - Outer frame color. [1] - Inner frame color. [0] - Top color of gradient. [1] - Bottom color of gradient. [0] - First frame color of shaft. [1] - Second frame color of shaft. [2] - Inner color of shaft. Color of tick marks.
Color of focus rectangle.
Size of tick marks.
Size of shaft.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
818
CHAPTER
Skinning
19.16.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro SLIDER_SKINPROPS_PRESSED SLIDER_SKINPROPS_UNPRESSED
Description
Defines the default attributes used for pressed state. Defines the default attributes used for unpressed state.
19.16.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine SLIDER_DrawSkinFlex() SLIDER_GetSkinFlexProps() SLIDER_SetDefaultSkin() SLIDER_SetDefaultSkinClassic() SLIDER_SetSkin() SLIDER_SetSkinClassic() SLIDER_SetSkinFlexProps()
SLIDER_SetSkinFlexProps()
Description
Skinning callback function of SLIDER_SKIN_FLEX. (Explained at the beginning of the chapter) Returns the properties of the given SLIDER skin. (Explained at the beginning of the chapter) Sets the default skin used for new SLIDER widgets. (Explained at the beginning of the chapter) Sets the classical design as default for new SLIDER widgets. (Explained at the beginning of the chapter) Sets a skin for the given SLIDER widget. (Explained at the beginning of the chapter) Sets the classical design for the given SLIDER widget. (Explained at the beginning of the chapter)
Sets the properties of the given SLIDER skin.
Before
After
Description
The function can be used to change colors, tick mark and shaft size of the skin.
Prototype
void SLIDER_SetSkinFlexProps(const SLIDER_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type SLIDER_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index
SLIDER_SKINFLEX_PI_PRESSED SLIDER_SKINFLEX_PI_UNPRESSED
Properties for pressed state. Properties for unpressed state.
Additional information
The function passes a pointer to a SLIDER_SKINFLEX_PROPS structure. It can be used to set up the colors of the skin. The function SLIDER_GetSkinFlexProps() can be used to get the current attributes of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
819
19.16.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the SLIDER_SKIN_FLEX callback function:
Command WIDGET_ITEM_CREATE WIDGET_ITEM_DRAW_FOCUS WIDGET_ITEM_DRAW_SHAFT WIDGET_ITEM_DRAW_THUMB WIDGET_ITEM_DRAW_TICKS
Description
Is sent immediately after creating the widget. The skinning function should draw the focus rectangle. The skinning function should draw the shaft. The skinning function should draw the slider. The skinning function should draw the tick marks.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_FOCUS
The skinning routine should draw the focus rectangle.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the widget in window coordinates. Topmost coordinate of the widget in window coordinates. Rightmost coordinate of the widget in window coordinates. Bottommost coordinate of the widget in window coordinates.
WIDGET_ITEM_DRAW_SHAFT
The skinning routine should draw the shaft.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the widget + 1 in window coordinates. Topmost coordinate of the widget + 1 in window coordinates. Rightmost coordinate of the widget - 1 in window coordinates. Bottommost coordinate of the widget - 1 in window coordinates.
WIDGET_ITEM_DRAW_THUMB
The skinning routine should draw the slider itself.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
820
CHAPTER
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1 p
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the slider in window coordinates. Topmost coordinate of the slider in window coordinates. Rightmost coordinate of the slider in window coordinates. Bottommost coordinate of the slider in window coordinates.
Pointer to a SLIDER_SKINFLEX_INFO structure.
Elements of SLIDER_SKINFLEX_INFO
Data type int int int
Element Width IsPressed IsVertical
Description
With of the slider. 1 if the slider is pressed, 0 if not. 0 if the slider is horizontal, 1 if it is vertical.
WIDGET_ITEM_DRAW_TICKS
The skinning routine should draw the tick marks.
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element
Description
hWin ItemIndex x0 y0 x1 y1 p
Handle to the widget. Index of item to be drawn. Leftmost coordinate of the widget + 1 in window coordinates. Topmost coordinate of the widget + 1 in window coordinates. Rightmost coordinate of the widget - 1 in window coordinates. Bottommost coordinate of the widget - 1 in window coordinates.
Pointer to a SLIDER_SKINFLEX_INFO structure.
Elements of SLIDER_SKINFLEX_INFO
Data type int int int int int
Element Width NumTicks Size IsPressed IsVertical
Description
With of the slider. Number of ticks to be drawn. Length of the tick mark line. 1 if the slider is pressed, 0 if not. 0 if the slider is horizontal, 1 if it is vertical.
Skinning
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
821
19.17 SPINBOX_SKIN_FLEX
The following picture shows the details of the skin:
ABC
D
I
EF G H
The SPINBOX skin consists of a rounded border and 2 rectangular inner areas which are drawn in dependence of the size of the EDIT widget. The background color of the EDIT widget is set to the set color of the inner area of the SPINBOX widget. The 2 buttons are drawn each with a gradient of 2 colors.
Detail A B C D E F G H I
Description
Outer color of surrounding frame. Inner color of surrounding frame. Color of the displayed value. Color of the text cursor (always inverse). Color of the button frame. 2 color gradient of the upper button. Arrow color. 2 color gradient of the lower button. Background color.
19.17.1 Configuration structure
To set up the default appearance of the skin or to change it at run time, configuration structures of type SPINBOX_SKINFLEX_PROPS are used:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
822
CHAPTER
Skinning
Elements of SPINBOX_SKINFLEX_PROPS
Data type
Element
GUI_COLOR aColorFrame[2]
GUI_COLOR aColorUpper[2]
GUI_COLOR
GUI_COLOR GUI_COLOR GUI_COLOR GUI_COLOR
aColorLower[2]
ColorArrow ColorBk ColorText ColorButtonFrame
Description
[0] - Outer color of the surrounding frame. [1] - Inner color of the surrounding frame. [0] - Upper gradient color of the upper button. [1] - Lower gradient color of the upper button. [0] - Upper gradient color of the lower button. [1] - Lower gradient color of the lower button. Color of the button arrows.
Color of the background.
Color of the text.
Color of the button frame.
19.17.2 Configuration options
The default appearance of the skin can be determined by setting custom configuration structures of the above type in GUIConf.h. The following table shows the available configuration options:
Macro SPINBOX_SKINPROPS_PRESSED SPINBOX_SKINPROPS_FOCUSSED SPINBOX_SKINPROPS_ENABLED SPINBOX_SKINPROPS_DISABLED
Description
Defines the default attributes used for pressed state. Defines the default attributes used for focussed state. Defines the default attributes used for enabled state. Defines the default attributes used for disabled state.
19.17.3 Skinning API
The table below lists the available routines in alphabetical order:
Routine SPINBOX_DrawSkinFlex() SPINBOX_GetSkinFlexProps() SPINBOX_SetDefaultSkin() SPINBOX_SetDefaultSkinClassic() SPINBOX_SetSkin() SPINBOX_SetSkinClassic() SPINBOX_SetSkinFlexProps()
Description
Skinning callback function of SPINBOX_SKIN_FLEX. (Explained at the beginning of the chapter) Returns the properties of the given spinbox skin. (Explained at the beginning of the chapter) Sets the default skin used for new spinbox widgets. (Explained at the beginning of the chapter) Sets the classical design as default for new spinbox widgets. (Explained at the beginning of the chapter) Sets a skin for the given spinbox widget. (Explained at the beginning of the chapter) Sets the classical design for the given spinbox widget. (Explained at the beginning of the chapter)
Sets the properties of the given spinbox skin.
SPINBOX_SetSkinFlexProps()
Before
After
Description
The function can be used to change the properties of the skin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
823
Prototype
void SPINBOX_SetSkinFlexProps(const SPINBOX_SKINFLEX_PROPS * pProps,
int
Index);
Parameter pProps Index
Description
Pointer to a structure of type SPINBOX_SKINFLEX_PROPS. See table below.
Permitted values for parameter Index SPINBOX_SKINFLEX_PI_PRESSED Properties for pressed state. SPINBOX_SKINFLEX_PI_FOCUSSED Properties for focussed state. SPINBOX_SKINFLEX_PI_ENABLED Properties for enabled state. SPINBOX_SKINFLEX_PI_DISABLED Properties for disabled state.
Additional information
The function passes a pointer to a SPINBOX_SKINFLEX_PROPS structure. It can be used to set up the colors and the radius of the skin. The function SPINBOX_GetSkinFlexProps() can be used to get the current attributes of the skin.
19.17.4 List of commands
The skinning routine receives a pointer to a WIDGET_ITEM_DRAW_INFO structure. The Cmd member of this structure contains the command which needs to be processed. The following table shows all commands passed to the SPINBOX_SKIN_FLEX callback function:
Command
Description
WIDGET_ITEM_CREATE
Is sent immediately after creating the widget.
WIDGET_ITEM_DRAW_BACKGROUND The skinning function should draw the background.
WIDGET_ITEM_DRAW_BUTTON_L The skinning function should draw the upper button.
WIDGET_ITEM_DRAW_BUTTON_R The skinning function should draw the lower button.
WIDGET_ITEM_DRAW_FRAME
The skinning function should draw the surrounding frame.
The WIDGET_ITEM_DRAW_INFO structure is explained at the beginning of the chapter.
WIDGET_ITEM_CREATE
The skinning routine should, if necessary, set up skin related properties like e.g. transparency or text alignment.
WIDGET_ITEM_DRAW_BACKGROUND
The background should be drawn.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
824
CHAPTER
Skinning
Content of the WIDGET_ITEM_DRAW_INFO structure:
Element hWin ItemIndex x0 y0 x1 y1
Description
Handle to the widget. See table below. Leftmost window coordinate, normally 0. Topmost window coordinate, normally 0. Rightmost window coordinate. Bottommost window coordinate.
Permitted values for element ItemIndex SPINBOX_SKINFLEX_PI_PRESSED The widget is pressed. SPINBOX_SKINFLEX_PI_FOCUSSED The widget is not pressed but focussed. SPINBOX_SKINFLEX_PI_ENABLED The widget is not focussed but enabled. SPINBOX_SKINFLEX_PI_DISABLED The widget is disabled.
WIDGET_ITEM_DRAW_BUTTON_L
The upper button should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure
Please refer to WIDGET_ITEM_DRAW_BACKGROUND.
WIDGET_ITEM_DRAW_BUTTON_R
The lower button should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure
Please refer to WIDGET_ITEM_DRAW_BACKGROUND.
WIDGET_ITEM_DRAW_FRAME
The surrounding frame should be drawn.
Content of the WIDGET_ITEM_DRAW_INFO structure
Please refer to WIDGET_ITEM_DRAW_BACKGROUND.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
825
Chapter 20
Multiple buffering
Multiple buffering is a method of using more than one frame buffer. Basically it works as follows: With multiple buffers enabled there is a front buffer which is used by the display controller to generate the picture on the screen and one or more back buffers which are used for the drawing operations. After completing the drawing operations the back buffer becomes the visible front buffer. With two buffers, one front and one back buffer, it is normally called 'double buffering', with two back buffers and one front buffer it is called 'triple buffering'. In general it is a method which is able to avoid several unwanted effects: · The visible process of drawing a screen item by item · Flickering effects caused by overlapping drawing operations · Tearing effects caused by writing operations outside the vertical blanking period The following section explains in detail how it works, the requirements to be able to use this feature, how to configure emWin and the advantage of 'triple buffering' against 'double buffering'. Further it explains how to configure the optional Window Manager for automatic use of 'multiple buffering'.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
826
CHAPTER
Multiple buffering
20.1 How it works
Multiple buffering is the use of more than one frame buffer, so that the display ever shows a screen which is already completely rendered, even if a drawing operation is in process. When starting the process of drawing the current content of the front buffer is copied into a back buffer. After that all drawing operations take effect only on this back buffer. After the drawing operation has been completed the back buffer becomes the front buffer. Making the back buffer the visible front buffer normally only requires the modification of the frame buffer start address register of the display controller. Now it should be considered that a display is being refreshed continuously by the display controller app. 60 times per second. After each period there is a vertical synchronization signal, normally known as VSYNC signal. The best moment to make the back buffer the new front buffer is this signal. If not considering the VSYNC signal tearing effects can occur.
Tearing effect:
20.1.1 Double buffering
With double buffering only 2 buffers are available: One front and one back buffer. When starting the drawing operation the current content of the front buffer is copied into the back buffer. After completing the operation the back buffer should become the visible front buffer. As explained above the best moment for doing this is reacting on the VSYNC signal of the display controller. Here the disadvantage of double buffering against triple buffering is revealed: Either the frame buffer start address is changed immediately at the end of the drawing operation or after waiting until the next VSYNC signal. This means that either tearing effects could occur or the performance slows down because of waiting for the next VSYNC signal.
20.1.2 Triple buffering
As the name implies there are 3 buffers available: One front and 2 back buffers. When starting the drawing operation the current content of the front buffer is copied into the first back buffer. After completing the operation the back buffer should become the visible front buffer. Contrary to the double buffer solution it is not required to switch to the buffer immediately. Switching to the new front buffer could be done on the next VSYNC signal of the display controller which can be achieved by an interrupt service routine (ISR). Most of the display controllers which are able to deal with more than one frame buffer provide the VSYNC signal as interrupt source. Within the ISR the pending front buffer should become visible. Until the pending front buffer becomes visible it is not used for further drawing operations. If a further drawing operation is initiated before the pending front buffer has become visible the sec-
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
827
ond back buffer is used for the drawing operation. If a new buffer is ready until waiting for the VSYNC signal it becomes the new pending front buffer and so on. This always protects the front buffer against writing operations. It should be mentioned that changing the display buffer start address on some display controllers takes only effect when drawing the next frame. In this case the solution without ISR works as well as without ISR. Only if changing the address takes effect directly an ISR is required to avoid tearing effects.
20.2 Requirements
The following list shows the requirements for using multiple buffers:
· The display controller should support multiple frame buffers. · Enough video RAM for multiple frame buffers should be available. · If tearing effects should be avoided it should be possible to react on the VSYNC
signal of the display controller and triple buffering is recommended to achieve the best performance.
20.3 Limitations
Multiple buffering can not be used with virtual screens.
20.4 Configuration
In general there are 2 routines in the configuration file LCDConf.c which need to be modified, the display configuration routine LCD_X_Config() and the driver callback function LCD_X_DisplayDriver().
20.4.1 LCD_X_Config()
Basically one thing needs to be done here: Enabling the use of multiple buffers.
Basic configuration
The first thing which has to be done before creating the display driver device is configuring the multiple buffer interface. This is normally done in LCD_X_Config(). It is strictly required to enable multiple buffering before creating the display driver device as shown in the following code snippet:
void LCD_X_Config(void) { // // Initialize multibuffering // GUI_MULTIBUF_Config(NUM_BUFFERS); // // Set display driver and color conversion // GUI_DEVICE_CreateAndLink(DISPLAY_DRIVER, COLOR_CONVERSION, 0, 0);
... }
Custom callback routine for copying the buffers
Further a callback routine for copying the buffers can be set. As explained above at the beginning of the drawing operation it is required to copy the content of the current front buffer to the back buffer. Normally a simple memcpy operation is used to do this. But if the used display controller for example consists of a BitBLT-engine which is able to do the copy operation it could be desired to use it for the copy operation. Or a DMA based routine should be used to do the copy operation. In these cases a custom defined callback function can be used for this operation. It can be installed after creating the display driver device as shown in the following code snippet:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
828
CHAPTER
Multiple buffering
static void _CopyBuffer(int LayerIndex, int IndexSrc, int IndexDst) { unsigned long BufferSize, AddrSrc, AddrDst;
// // Calculate the size of one frame buffer //
BufferSize = (XSIZE * YSIZE * BITSPERPIXEL) / 8;
// // Calculate source- and destination address //
AddrSrc = _VRamBaseAddr + BufferSize * IndexSrc; AddrDst = _VRamBaseAddr + BufferSize * IndexDst; memcpy((void *)AddrDst, (void *)AddrSrc, BufferSize); }
void LCD_X_Config(void) { // // Initialize multibuffering // GUI_MULTIBUF_Config(NUM_BUFFERS); // // Set display driver and color conversion // GUI_DEVICE_CreateAndLink(DISPLAY_DRIVER, COLOR_CONVERSION, 0, 0);
// // Set custom callback function for copy operation // LCD_SetDevFunc(0, LCD_DEVFUNC_COPYBUFFER, (void (*)())_CopyBuffer); }
Please note that the above sample implementation normally makes no sense, because a simple memcpy() operation is the default behavior of the driver. It makes only sense to use a custom callback function if there is any acceleration option which should be used.
20.4.2 LCD_X_DisplayDriver()
After the drawing process has been completed the back buffer should become visible. The display driver sends a LCD_X_SHOWBUFFER command to the display driver callback function. The callback function then has to react on the command and should make sure that the buffer becomes visible. This can be done either by an ISR or by directly writing the right address into the frame buffer start address of the display controller.
With ISR
The following code snippet shows a sample implementation:
static void _ISR_EndOfFrame(void) { unsigned long Addr, BufferSize;
if (_PendingBuffer >= 0) {
//
// Calculate address of the given buffer
//
BufferSize = (XSIZE * YSIZE * BITSPERPIXEL) / 8;
Addr
= _VRamBaseAddr + BufferSize * pData->Index;
//
// Make the given buffer visible
//
AT91C_LCDC_BA1 = Addr;
//
// Send a confirmation that the buffer is visible now
//
GUI_MULTIBUF_Confirm(_PendingBuffer);
_PendingBuffer = -1;
}
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
829
int LCD_X_DisplayDriver(unsigned LayerIndex, unsigned Cmd, void * p) { switch (Cmd) { case LCD_X_SHOWBUFFER: { LCD_X_SHOWBUFFER_INFO * pData;
pData = (LCD_X_SHOWBUFFER_INFO *)p; // // Remember buffer index to be used by ISR // _PendingBuffer = pData->Index; } break; ... } }
The above implementation assumes the existence of an ISR which is executed at the next VSYNC signal.
Without ISR
If there is no ISR available alternatively the address can be set directly with the disadvantage that tearing effects could occur. The following code snippet shows a sample implementation:
int LCD_X_DisplayDriver(unsigned LayerIndex, unsigned Cmd, void * p) {
unsigned long Addr, BufferSize;
switch (Cmd) { ... case LCD_X_SHOWBUFFER: {
LCD_X_SHOWBUFFER_INFO * pData;
pData = (LCD_X_SHOWBUFFER_INFO *)p;
//
// Calculate address of the given buffer
//
BufferSize = (XSIZE * YSIZE * BITSPERPIXEL) / 8;
Addr
= _VRamBaseAddr + BufferSize * pData->Index;
//
// Make the given buffer visible
//
AT91C_LCDC_BA1 = Addr;
//
// Send a confirmation that the buffer is visible now
//
GUI_MULTIBUF_Confirm(pData->Index);
}
break;
...
}
}
20.5 Automatic use of multiple buffers with the WM
The optional Window Manager (WM) is able to use the multiple buffer feature automatically. The function WM_MULTIBUF_Enable() can be used to enable this function. If enabled the WM first switches to the back buffer before redrawing the invalid windows. After drawing all invalid windows the new screen becomes visible. This hides the process of drawing a screen window by window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
830
CHAPTER
Multiple buffering
20.6 Multiple buffer API
The following table lists the available routines of the multiple buffer support.
Routine
Description
Basic functions
GUI_MULTIBUF_Begin()
Needs be called before starting the drawing operation.
GUI_MULTIBUF_BeginEx()
Same as above except the parameter LayerIndex.
GUI_MULTIBUF_Config()
Needs to be called to configure the use of multiple buffers.
GUI_MULTIBUF_ConfigEx() GUI_MULTIBUF_Confirm()
Same as above except the parameter LayerIndex.
Should be called immediately after the pending front buffer has become visible.
GUI_MULTIBUF_ConfirmEx()
Same as above except the parameter LayerIndex.
GUI_MULTIBUF_End()
Needs be called after completing the drawing operation.
GUI_MULTIBUF_EndEx()
Same as above except the parameter LayerIndex.
GUI_MULTIBUF_GetNumBuffers() Returns the number of used buffers.
GUI_MULTIBUF_GetNumBuffersEx() Same as above except the parameter LayerIndex.
GUI_MULTIBUF_UseSingleBuffer() Lets the multi buffering use one frame for all layers.
Optional Window Manager functions
WM_MULTIBUF_Enable()
Enables or disables the automatic use of multiple buffers by the optional WM.
(The interface of the above routines may be changed in a later version)
GUI_MULTIBUF_Begin()
Description
Needs to be called immediately before the drawing operation.
Prototype
void GUI_MULTIBUF_Begin(void);
Additional information
This function makes sure that the current front buffer will be copied into the back buffer which then is used for all subsequent drawing operations. The copy operation is normally done by the display driver itself. As explained earlier this can also be achieved by a custom callback function.
GUI_MULTIBUF_BeginEx()
Description
For details please refer to GUI_MULTIBUF_Begin().
Prototype
void GUI_MULTIBUF_BeginEx(int LayerIndex);
Parameter LayerIndex
Layer to be used.
Description
GUI_MULTIBUF_Config()
Description
The function needs to be called during the process of initialization, typically from within LCD_X_Config() to enable the use of multiple buffers.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
831
Prototype
void GUI_MULTIBUF_Config(int NumBuffers);
Parameter NumBuffers
Description
Number of buffers to be used. The following numbers make sense: 2 - Double buffering 3 - Triple buffering
Additional information
The function needs to be called before creating the display driver device.
GUI_MULTIBUF_ConfigEx()
Description
For details please refer to GUI_MULTIBUF_Config().
Prototype
void GUI_MULTIBUF_ConfigEx(int LayerIndex, int NumBuffers);
Parameter LayerIndex
NumBuffers
Description
Layer to be used. Number of buffers to be used. The following numbers make sense: 2 - Double buffering 3 - Triple buffering
GUI_MULTIBUF_Confirm()
Description
This function needs to be called immediately after a new buffer has become visible.
Prototype
void GUI_MULTIBUF_Confirm(int Index);
Parameter Index
Description
Index of buffer which has been made visible.
Additional information
The function is typically called by the ISR which switches to the new front buffer or by the display driver callback function.
GUI_MULTIBUF_ConfirmEx()
Description
For details please refer to GUI_MULTIBUF_Confirm().
Prototype
void GUI_MULTIBUF_ConfirmEx(int LayerIndex, int BufferIndex);
Parameter LayerIndex Index
Description
Layer to be used. Index of buffer which has been made visible.
GUI_MULTIBUF_End()
Description
This function needs to be called after the new screen has been completely drawn.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
832
CHAPTER
Multiple buffering
Prototype
void GUI_MULTIBUF_End(void);
Additional information
When calling this function the display driver sends an LCD_X_SHOWBUFFER command to the display driver callback routine which then has to make the given buffer the front buffer.
GUI_MULTIBUF_EndEx()
Description
For details please refer to GUI_MULTIBUF_End().
Prototype
void GUI_MULTIBUF_EndEx(int LayerIndex);
Parameter LayerIndex
Layer to be used.
Description
GUI_MULTIBUF_GetNumBuffers()
Description
The function returns the number of buffers configured for the current layer.
Prototype
int GUI_MULTIBUF_GetNumBuffers(void);
Return value
The number of buffers configured for the current layer.
GUI_MULTIBUF_GetNumBuffersEx()
Description
For details please refer to GUI_MULTIBUF_GetNumBuffers().
Prototype
int GUI_MULTIBUF_GetNumBuffersEx(int LayerIndex);
Parameter LayerIndex
Layer to be used.
Description
Return value
The number of buffers configured for the specified layer.
GUI_MULTIBUF_UseSingleBuffer()
Description
Lets the multi buffering use one frame for all layers.
Prototype
void GUI_MULTIBUF_UseSingleBuffer(void);
Additional information
The function needs to be called before creating the display driver device.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
833
WM_MULTIBUF_Enable()
Description
The routine can be used to enable the automatic use of multiple buffers as it is explained in the beginning of this chapter.
Prototype
int WM_MULTIBUF_Enable(int OnOff);
Parameter OnOff
Description
1 to enable the automatic use of multiple buffers. 0 to disable the automatic use of multiple buffers.
Return value
Previous state.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
834
CHAPTER
Multiple buffering
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
835
Chapter 21
Virtual screens / Virtual pages
A virtual screen means a display area greater than the physical size of the display. It requires additional video memory and allows instantaneous switching between different screens even on slow CPUs. The following chapter shows · the requirements for using virtual screens, · how to configure emWin · and how to take advantage of virtual screens. If a virtual display area is configured, the visible part of the display can be changed by setting the origin.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
LCD_VYSIZE LCD_YSIZE
LCD_VYSIZE LCD_YSIZE
836
21.1 Introduction
Virtual pages LCD_XSIZE
Visible area (virtual page 0)
Virtual page 1
CHAPTER
Virtual screens / Virtual pages
Panning
LCD_VXSIZE LCD_XSIZE
Visible area Virtual area
Virtual page 2
The virtual screen support of emWin can be used for panning or for switching between different video pages.
Panning
If the application uses one screen which is larger than the display, the virtual screen API functions can be used to make the desired area visible.
Virtual pages
Virtual pages are a way to use the display RAM as multiple pages. If an application for example needs 3 different screens, each screen can use its own page in the display RAM. In this case, the application can draw the second and the third page before they are used. After that the application can switch very fast between the different pages using the virtual screen API functions of emWin. The only thing the functions have to do is setting the right display start address for showing the desired screen. In this case the virtual Y-size typically is a multiple of the display size in Y.
21.2 Requirements
The virtual screen feature requires hardware with more display RAM than required for a single screen and the ability of the hardware to change the start position of the display output.
Video RAM
The used display controller should support video RAM for the virtual area. For example if the display has a resolution of 320x240 and a color depth of 16 bits per pixel and 2 screens should be supported, the required size of the video RAM can be calculated as follows:
Size = LCD_XSIZE * LCD_YSIZE * LCD_BITSPERPIXEL / 8 * NUM_SCREENS Size = 320 x 240 x 16 / 8 x 2 Size = 307200 Bytes
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
837
Configurable display start position
The used display controller needs a configurable display start position. This means the display driver even has a register for setting the frame buffer start address or it has a command to set the upper left display start position.
21.3 Configuration
Virtual screens should be configured during the initialization. The function LCD_SetVSizeEx() needs to be used to define the virtual display size. Further it is required to react on the command LCD_X_SETORG in the driver callback routine by setting the right frame buffer start address.
LCD_SetVSizeEx()
Description
Sets the virtual display size.
Prototype
int LCD_SetVSizeEx(int LayerIndex, int xSize, int ySize);
Parameter LayerIndex xSize ySize
Description
Zero based layer index, typically 0 on single layer systems. Horizontal resolution of virtual display. Vertical resolution of virtual display.
Return value
0 on success, 1 on error.
21.4 Examples
In the following a few examples are shown to make clear how to use virtual screens with emWin.
21.4.1 Basic example
The following example shows how to use a virtual screen of 128x192 and a display of 128x64 for instantaneous switching between 3 different screens.
Configuration
LCD_SetSizeEx (0, 128, 64); LCD_SetVSizeEx(0, 128, 192);
Application
GUI_SetColor(GUI_RED); GUI_FillRect(0, 0, 127, 63); GUI_SetColor(GUI_GREEN); GUI_FillRect(0, 64, 127, 127); GUI_SetColor(GUI_BLUE); GUI_FillRect(0, 128, 127, 191); GUI_SetColor(GUI_WHITE); GUI_SetTextMode(GUI_TM_TRANS); GUI_DispStringAt("Screen 0", 0, 0); GUI_DispStringAt("Screen 1", 0, 64); GUI_DispStringAt("Screen 2", 0, 128); GUI_SetOrg(0, 64); /* Set origin to screen 1 */ GUI_SetOrg(0, 128); /* Set origin to screen 2 */
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
838
CHAPTER
Output
The table below shows the output of the display:
Description
Display output
Virtual screens / Virtual pages Contents of virtual area
Before executing
GUI_SetOrg(0, 64)
After executing
GUI_SetOrg(0, 64)
After executing
GUI_SetOrg(0, 128)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
839
21.4.2 Real time example using the Window Manager
The shipment of emWin contains an example which shows how to use virtual screens in a real time application. It can be found under Sample\Tutorial\VSCREEN_RealTime.c:
Screen 0 / Page 0
Screen 1 / Page 1
After showing a short introduction, the example creates 2 screens on 2 separate pages as shown above. The first screen shows a dialog which includes a graphical representation of 2 temperature curves. When pressing the 'Set color' button, the application switches instantaneously to the second screen, even on slow CPUs. After pressing the 'OK' button of the 'Adjust color' dialog, the application switches back to the first screen. For more details, see the source code of the example.
Viewer Screenshot of the above example
If using the viewer both screens can be shown at the same time. The screenshot above shows the visible display at the left side and the contents of the whole configured virtual display RAM at the right side.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
840
CHAPTER
Virtual screens / Virtual pages
21.4.3 Dialog example using the Window Manager
The second advanced example is available in the folder Sample\GUI\VSCREEN_MultiPage. It uses the virtual screen to show 4 screens on 3 different video pages. The application consists of the following screens:
Main screen / Page 0
Setup screen / Page 1
Calibration screen / Page 2
About screen / Page 2
After a short intro screen the 'Main Screen' is shown on the display using page 0. After the 'Setup' button is pressed, the 'Setup' screen is created on page 1. After the screen has been created, the application makes the screen visible by switching to page 1. The 'Calibration' and the 'About' screen both use page 2. If the user presses one of the buttons 'Calibration' or 'About' the application switches to page 2 and shows the dialog.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Viewer Screenshot of the above example
Visible screen
841
Page 0 always "Main screen"
Page 1 always "Setup" screen
Page 2 used for different screens
The viewer can show all pages at the same time. The screenshot above shows the visible display at the left side and the contents of the whole layer (virtual display RAM) with the pages 0 - 2 at the right side.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
842
CHAPTER
Virtual screens / Virtual pages
21.5 Virtual screen API
The following table lists the available routines of the virtual screen support.
Routine GUI_GetOrg() GUI_SetOrg()
Description
Returns the display start position. Sets the display start position.
GUI_GetOrg()
Description
Returns the display start position.
Prototype
void GUI_GetOrg(int * px, int * py);
Parameter px py
Description
Pointer to variable of type int to store the X position of the display start position. Pointer to variable of type int to store the Y position of the display start position.
Additional information
The function stores the current display start position into the variables pointed by the given pointers.
GUI_SetOrg()
Description
Sets the display start position.
Prototype
void GUI_SetOrg(int x, int y);
Parameter x y
Description
New X position of the display start position. New Y position of the display start position.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
843
Chapter 22
Multi layer / multi display support
If more than 1 display should be accessed or the display controller supports more than 1 layer (and more than one layer should be used) multi layer support of emWin is required. Multi layer support and multi display support work the same way. Each layer / display can be accessed with its own color settings, its own size and its own display driver. Initialization of more than one layer is quite simple: The maximum number of available layers GUI_NUM_LAYERS should be defined in GUIConf.h and each layer needs a display driver device which should be created during the initialization in the configuration routine LCD_X_Config(). There is no limitation regarding the maximum number of available layers.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
844
CHAPTER
Multi layer / multi display support
22.1 Introduction
Windows can be placed in any layer or display, drawing operations can be used on any layer or display. Since there are really only smaller differences from this point of view, multiple layers and multiple displays are handled the same way (Using the same API routines) and are simply referred to as multiple layers, even if the particular embedded system uses multiple displays. The emWin viewer allows you to look at every individual layer (display), but in the case of multiple layer systems also to look at the actual output (the composite view). Currently systems with multiple displays and multiple layers can be used, but not simulated.
22.1.1 Selecting a layer for drawing operations
When drawing directly, per default layer 0 is used. Other layers can be selected by using the function GUI_SelectLayer().
Example
The following example shows how to select a layer for drawing operations:
void MainTask(void) { GUI_Init(); /* Draw something on default layer 0 */ GUI_SetBkColor(GUI_GREEN); GUI_Clear(); GUI_DispStringHCenterAt("Layer 0", 100, 46); /* Draw something on layer 1 */ GUI_SelectLayer(1); /* Select layer 1 */ GUI_SetBkColor(GUI_RED); GUI_Clear(); GUI_SetColor(GUI_BLUE); GUI_FillRect(20, 20, 179, 79); GUI_SetColor(GUI_WHITE); GUI_SetTextMode(GUI_TM_TRANS); GUI_DispStringHCenterAt("Layer 1", 100, 46); while(1) { GUI_Delay(100); }
}
Screenshot of above example
22.1.2 Selecting a layer for a window
The Window Manager automatically keeps track of which window is located in which layer. This is done in a fairly easy way: If the Window Manager is used, every layer has a top level (desktop) window. Any other window in this layer is visible only if it is a descendent (a child or grandchild or ...) of one of these desktop windows. Which layer a window is in depends solely on which desktop window it is a descendent of.
Example
The following example shows how to create 3 windows on 2 different desktop windows:
UM03001 User & Reference Guide for emWin V5.20s
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
845
/* Create 1 child window on destop 0 */ hWin0 = WM_CreateWindowAsChild( 10, 20, 80, 70,
WM_GetDesktopWindowEx(0), WM_CF_SHOW, _cbWin0, 0); /* Create 2 child windows on destop 1 */ hWin1 = WM_CreateWindowAsChild( 10, 20, 80, 70,
WM_GetDesktopWindowEx(1), WM_CF_SHOW, _cbWin1, 0); hWin2 = WM_CreateWindowAsChild(110, 20, 80, 70,
WM_GetDesktopWindowEx(1), WM_CF_SHOW, _cbWin2, 0);
The following table shows the screenshot and the window hierarchy of the above example:
Screenshot
Window hierarchy
Layer 0 Desktop 0
Layer 1 Desktop 1
Window 0
Window 1
Window 2
22.1.2.1 Moving a window from one layer to an other
This can sometime be very desirable and can easily be accomplished: If a window is detached from its parent (The desktop window of one layer or any descendent of this desktop window) and attached to a window which lies in another layer, this window actually moves from one layer to another layer.
Example
The following example shows how to attach a window to a new parent window:
/* Create 1 child window on destop 0 */ hWin0 = WM_CreateWindowAsChild( 10, 20, 80, 70,
WM_GetDesktopWindowEx(0), WM_CF_SHOW, _cbWin0, 0); /* Create 2 child windows on destop 1 */ hWin1 = WM_CreateWindowAsChild( 10, 20, 80, 70,
WM_GetDesktopWindowEx(1), WM_CF_SHOW, _cbWin1, 0); hWin2 = WM_CreateWindowAsChild(110, 20, 80, 70,
WM_GetDesktopWindowEx(1), WM_CF_SHOW, _cbWin2, 0); GUI_Delay(1000); /* Detach window 2 from desktop 1 and attach it to desktop 0 */ WM_AttachWindow(hWin2, WM_GetDesktopWindowEx(0));
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
846
CHAPTER
Multi layer / multi display support
The following table shows the screenshot and the window hierarchy of the above example before attaching the window to the new parent:
Screenshot
Window hierarchy
Layer 0 Desktop 0
Layer 1 Desktop 1
Window 0
Window 1
Window 2
The next table shows the screenshot and the window hierarchy of the above example after attaching the window to the new parent:
Screenshot
Window hierarchy
Layer 0 Desktop 0
Layer 1 Desktop 1
Window 0
Window 1
Window 2
UM03001 User & Reference Guide for emWin V5.20s
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
847
22.2 Using multi layer support
emWin does not distinguish between multiple layers or multiple displays. When using multiple layers normally the size and the driver for each layer is the same. The viewer shows each layer in a separate window. The composite window of the viewer shows all layers; layers with higher index are on top of layers with lower index and can have transparent pixels:
No transparency Pixels can be transparent
Layer 0 Layer 1 . . . Layer n
22.2.1 Transparency
Transparency means that at the position of pixels with color index 0 in a layer > 0, the color of the background layer is visible. Since for all but layer 0 Index 0 means transparency, Index 0 can not be used to display colors. This also means that the color conversion should never yield 0 as best match for a color, since this would result in a transparent pixel. This means that only some fixed palette modes or a custom palette mode should be used and that you need to be careful when defining your own palette. You need to make sure that the color conversion (24 bit RGB -> Index) never yields 0 as result.
Fixed palette modes
86661 is currently the only available fixed palette mode for transparency support. For details, refer to the chapter "Colors" on page 265.
Custom palette mode
If a custom palette should be used in a layer > 0, the first color should not be used from the color conversion routines. The following shows an example definition for a custom palette with 15 gray scales:
static const LCD_COLOR _aColors_16[] = { GUI_TRANSPARENT, 0x000000, 0x222222, 0x333333, 0x444444, 0x555555, 0x666666, 0x777777, 0x888888, 0x999999, 0xAAAAAA, 0xBBBBBB, 0xCCCCCC, 0xDDDDDD, 0xEEEEEE, 0xFFFFFF
};
static const LCD_PHYSPALETTE _aPalette_16 = { 16, _aColors_16
}; void LCD_X_Config(void) {
// // Set display driver and color conversion for 1st layer // . . . // // Set user palette data (only required if no fixed palette is used) // LCD_SetLUTEx(1, _aPalette_16); }
Example
The following example shows how to use transparency. It draws 3 color bars in layer 0. Layer 1 is filled with white and 3 transparent items are drawn.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
848
CHAPTER
Multi layer / multi display support
GUI_SelectLayer(0); GUI_SetColor(GUI_RED); GUI_FillRect(0, 0, 199, 33); GUI_SetColor(GUI_GREEN); GUI_FillRect(0, 34, 199, 66); GUI_SetColor(GUI_BLUE); GUI_FillRect(0, 67, 199, 99); GUI_SelectLayer(1); GUI_SetBkColor(GUI_WHITE); GUI_Clear(); GUI_SetColor(GUI_BLACK); GUI_DispStringHCenterAt("Layer 1", 100, 4); GUI_SetColor(GUI_TRANSPARENT); GUI_FillCircle(100, 50, 35); GUI_FillRect(10, 10, 40, 90); GUI_FillRect(160, 10, 190, 90);
Screenshots of the above example
The table below shows the contents of the separate layers and the composite view, as the result appears on the display:
Layer 0
Layer 1
Display
22.2.2 Alpha blending
Alpha blending is a method of combining two colors for transparency effects. Assumed 2 colors C0 and C1 should be combined with alpha blending A (a value between 0 and 1 where 0 means invisible and 1 means 100% visible) the resulting color Cr can be calculated as follows:
Cr = C0 * (1 - A) + C1 * A
Logical colors are handled internally as 32 bit values. The lower 24 bits are used for the color information and the alpha blending is managed in the upper 8 bits. An alpha value of 0x00 means opaque and 0xFF means completely transparent (invisible).
Different methods
There are 3 different methods of managing the alpha information: · Layer alpha blending: On systems with layer alpha blending the alpha value is
fixed to the layer and can be set with the function LCD_SetAlphaEx(). · Lookup table (LUT) alpha blending: This kind of alpha blending uses the LUT for
managing the alpha information. · Pixel alpha blending: Each pixel of the layer which has to be combined with the
background consists of alpha blending information.
Fixed palette modes
For LUT alpha blending the fixed palette modes 822216 and 84444 can be used. Pixel alpha blending is supported only in 32 bpp mode using the fixed palette mode 8888. For details about the fixed palette modes, refer to the chapter "Colors" on page 265.
Example
The following example shows how to use pixel alpha blending. It draws a circle in layer 0 and a yellow triangle build of horizontal lines with a vertical gradient of alpha values:
GUI_SetColor(GUI_BLUE); GUI_FillCircle(100, 50, 49);
UM03001 User & Reference Guide for emWin V5.20s
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
849
GUI_SelectLayer(1); GUI_SetBkColor(GUI_TRANSPARENT); GUI_Clear(); for (i = 0; i < 100; i++) {
U32 Alpha; Alpha = (i * 255 / 100) << 24; GUI_SetColor(GUI_YELLOW | Alpha); GUI_DrawHLine(i, 100 - i, 100 + i); }
Screenshots of the above example
The table below shows the contents of the separate layers and the composite view, as the result appears on the display:
Layer 0
Layer 1
Display
22.2.3 Hardware cursors
The term 'Hardware cursor' means the use of cursor images in a separate layer with a transparent background. If a hardware supports multiple layers and the ability of layer positioning emWin can be configured to use a separate layer for managing the cursor. The main advantages of this kind of cursor support are a better performance because only a few registers need to be changed on a movement and the ability of custom drawings in the cursor layer. For details about usage, refer to "GUI_AssignCursorLayer()" on page 851.
22.2.4 Multi layer example
For information about a multi-layer example, see the chapter "Simulation" on page 43. Further, the Sample folder contains the following example which shows how to use multiple layer support: · MULTILAYER_AlphaChromaMove.c
Screenshot of above example
22.3 Using multi display support
Each display can be accessed with its own driver and with its own settings.
22.3.1 Enabling multi display support
To enable the multi display support you have to define the maximum number of layers in GUIConf.h:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
850
CHAPTER
Multi layer / multi display support
#define GUI_NUM_LAYERS 2 /* Enables support for 2 displays/layers */
Further you have to create and configure a display driver device for each layer.
22.3.2 Run-time screen rotation
In some cases it may be necessary to change the display orientation at run-time. The multi display support allows to do this. In this case the file LCDConf.c should contain a display configuration for each required display orientation. Switching the display orientation then works as follows:
· Select the configuration with the required display orientation with GUI_SelectLayer().
· If the rotation requires a reinitialization of the display controller the right driver function for reinitializing should be called. This is LCD_L0_Init() for layer 0 and LCD_L0_x_Init() for higher layers, where 'x' means the zero based index of the configuration.
22.3.3 Multi display example
The example below shows a screenshot of the simulation with 2 displays. The fist display is a 8bpp color display with a size of 320 x 240 pixel. The driver is LCD13XX.c configured for an Epson S1D13705 LCD-controller. The second display is a 1bpp bwdisplay with a size of 240 x 128 pixels. The driver is LCDSlin.c configured for a Toshiba T6963 LCD-controller:
22.4 Configuring multi layer support
LCD Configuration of the above multi layer example
void LCD_X_Config(void) {
//
// Set display driver and color conversion for first layer ...
//
GUI_DEVICE_CreateAndLink(GUIDRV_LIN_16, // Display driver
GUICC_655,
// Color conversion
0, 0);
//
// ... and configure it
//
LCD_SetSizeEx (0, 400, 234);
// Physical display size in pixels
LCD_SetVRAMAddrEx(0, (void *)0xc00000); // Video RAM start address
//
// Set display driver and color conversion for second layer ...
//
UM03001 User & Reference Guide for emWin V5.20s
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
851
GUI_DEVICE_CreateAndLink(GUIDRV_LIN_8, // Display driver
GUICC_86661, // Color conversion
0, 1);
//
// ... and configure it
//
LCD_SetSizeEx (1, 400, 234);
// Physical display size in pixels
LCD_SetVRAMAddrEx(1, (void *)0xc00000); // Video RAM start address
}
22.5 Configuring multi display support
Configuration of the above multi display example
void LCD_X_Config(void) {
//
// Set display driver and color conversion for first layer ...
//
GUI_DEVICE_CreateAndLink(GUIDRV_LIN_8, // Display driver
GUICC_8666, // Color conversion
0, 0);
//
// ... and configure it
//
LCD_SetSizeEx (0, 320, 240);
// Physical display size in pixels
LCD_SetVRAMAddrEx(0, (void *)0xc00000); // Video RAM start address
//
// Set display driver and color conversion for second layer ...
//
GUI_DEVICE_CreateAndLink(GUIDRV_LIN_1, // Display driver
GUICC_1,
// Color conversion
0, 1);
//
// ... and configure it
//
LCD_SetSizeEx (1, 240, 128);
// Physical display size in pixels
LCD_SetVRAMAddrEx(1, (void *)0x800000); // Video RAM start address
}
22.6 Multi layer API
The table below lists the available multi layer related routines in alphabetical order. Detailed descriptions follow:
Routine GUI_AssignCursorLayer() GUI_SelectLayer() GUI_SetLayerAlphaEx() GUI_SetLayerPosEx() GUI_SetLayerSizeEx() GUI_SetLayerVisEx() LCD_GetNumLayers()
Description
Assigns a layer to be used to manage a hardware cursor. Selects a layer/display for output operations. Sets the layer alpha blending. Sets the position of the given layer. Sets the size of the given layer. Sets the visibility of the given layer. Returns the number of layers.
GUI_AssignCursorLayer()
Description
The function assigns a layer to be used as cursor layer.
Prototype
void GUI_AssignCursorLayer(unsigned Index, unsigned CursorLayer);
Parameter Index CursorLayer
Description
Layer index. Layer to be used to manage the cursor.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
852
CHAPTER
Multi layer / multi display support
Additional information
Using a hardware cursor means a layer is used as cursor layer. Contrary to the default cursor handling, where the cursor is drawn in the same video memory area as all other items, a hardware cursor is drawn in a separate layer. In this case emWin makes sure the background color of the hardware cursor layer is set to transparency and the selected cursor will be drawn into the layer. Whereas the default cursor management requires more or less calculation time to draw the cursor and to manage the background, moving a hardware cursor requires only the modification of a few registers. Note that using this function requires that the display driver supports layer positioning.
GUI_SelectLayer()
Description
Selects a layer for drawing operations.
Prototype
unsigned int GUI_SelectLayer(unsigned int Index);
Parameter Index
Layer index.
Description
Return value
Index of previous selected layer.
GUI_SetLayerAlphaEx()
Description
Sets the alpha blending of the given layer.
Prototype
int GUI_SetLayerAlphaEx(unsigned Index, int Alpha);
Parameter Index Alpha
Description
Layer index. Alpha blending value of the given layer.
Additional information
To be able to use this function the hardware and the used display driver need to support layer alpha blending. If the driver does not support this feature the function returns immediately. The usable range of alpha values depends on the hardware. In many cases the range of alpha values is limited, for example 0 - 0x3f. emWin does not know something about limitations and passes the given value to the driver. It is the responsibility of the application to make sure that the given value is in a legal range.
GUI_GetLayerPosEx()
Description
Returns the X- and Y-position of the given layer.
UM03001 User & Reference Guide for emWin V5.20s
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
853
Prototype
void GUI_GetLayerPosEx(unsigned Index, int * pxPos, int * pyPos);
Parameter Index pxPos pyPos
Description
Layer index. Pointer to an integer to be used to return the X position of the given layer. Pointer to an integer to be used to return the Y position of the given layer.
Additional information
To be able to use this function the hardware and the used display driver need to support layer positioning. If the driver does not support this feature the function returns immediately.
GUI_SetLayerPosEx()
Description
Sets the X- and Y-position of the given layer.
Prototype
void GUI_GetLayerPosEx(unsigned Index, int xPos, int yPos);
Parameter Index xPos yPos
Description
Layer index. New X position of the given layer. New Y position of the given layer.
Additional information
To be able to use this function the hardware and the used display driver need to support layer positioning. If the driver does not support this feature the function returns immediately.
GUI_SetLayerSizeEx()
Description
Sets the X- and Y-size of the given layer.
Prototype
int GUI_SetLayerSizeEx(unsigned Index, int xSize, int ySize);
Parameter Index xSize ySize
Description
Layer index. New horizontal size in pixels of the given layer. New vertical size in pixels of the given layer.
Additional information
To be able to use this function the hardware and the used display driver need to support layer sizing. If the driver does not support this feature the function returns immediately.
GUI_SetLayerVisEx()
Description
Sets the visibility of the given layer.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
854
CHAPTER
Multi layer / multi display support
Prototype
int GUI_SetLayerVisEx(unsigned Index, int OnOff);
Parameter Index OnOff
Description
Layer index. 1 if layer should be visible, 0 for invisible.
Additional information
To be able to use this function the hardware and the used display driver need to support this feature. If the driver does not support this feature the function returns immediately.
LCD_GetNumLayers()
Description
Returns the number of layers configured in your configuration.
Prototype
int LCD_GetNumLayers(void);
Return value
Number of layers configured in your configuration.
UM03001 User & Reference Guide for emWin V5.20s
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
855
Chapter 23 Pointer Input Devices
emWin provides support for pointer-input-devices. Pointer input devices can be touch-screen, mouse or joystick. The basic emWin package includes a driver for analog touch-screens, a PS2 mouse driver, as well as an example joystick driver. Other types of touch-panel and mouse devices can also be used with the appropriate drivers. The software for input devices is located in the subdirectory GUI\Core.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
856
CHAPTER
Pointer Input Devices
23.1 Description
Pointer input devices are devices such as mice, touch-screens and joysticks. Multiple pointer input devices can be used in a single application to enable simultaneous mouse/touch-screen/joystick use. Basically all a PID driver does is calling the routine GUI_PID_StoreState() whenever an event (such as a moved mouse, or a pressed touch screen) has been detected. PID events are stored in a FIFO which is processed by the Window Manager. If the Window Manager is not used (respectively deactivated), the application is responsible for reacting on PID events.
23.2 Pointer input device API
The table below lists the pointer input device routines in alphabetical order. Detailed descriptions follow. Note: This API is used by the PID-driver; if you use a PID-driver shipped with emWin, your code does not need to call these routines.
Routine GUI_PID_GetCurrentState() GUI_PID_GetState() GUI_PID_IsEmpty() GUI_PID_IsPressed() GUI_PID_StoreState()
Description
Returns the most recently stored state from the PID. Returns the state of the PID. Returns if the PID buffer is empty. Returns if the most recent state of the PID is pressed. Stores the current state of the PID.
Data structure
The structure of type GUI_PID_STATE referenced by the parameter pState is filled by the routine with the current values. The structure is defined as follows:
typedef struct { int x, y; U8 Pressed; U8 Layer;
} GUI_PID_STATE;
Elements of GUI_PID_STATE
Data type int int
U8
U8
Element
Description
x y
Pressed
Layer
X position of pointer input device.
Y position of pointer input device.
If using a touch screen this value can be 0 (unpressed) or 1 (pressed). If using a mouse bit 0 is used for the pressed state of the left button and bit 1 for the right button. The bits are 1 if the button is pressed and 0 if not.
Describes the layer from which the PID state has been received
GUI_PID_GetCurrentState()
Description
Fills the given GUI_PID_STATE structure with the most recently stored PID state.
Prototype
void GUI_PID_GetCurrentState(GUI_PID_STATE * pState);
Parameter pState
Description
Pointer to a GUI_PID_STATE structure.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
857
Additional information
This function performs a non-destructive read on the PID FIFO.
GUI_PID_GetState()
Description
Fills the given GUI_PID_STATE structure with the current state information and returns if the input device is currently pressed.
Prototype
int GUI_PID_GetState(GUI_PID_STATE * pState);
Parameter pState
Description
Pointer to a GUI_PID_STATE structure.
Additional information
This function does a destructive read on the PID FIFO: If the FIFO contains unread values, it reads and eliminates the first value in the FIFO. If the FIFO is empty, it returns the last value written to it. If no value has ever been written into the PID FIFO, all values in pState are set to 0.
Return value
1 if input device is currently pressed; 0 if not pressed.
Example
GUI_PID_STATE State; GUI_PID_GetState(&State);
GUI_PID_IsEmpty()
Description
Returns if the PID buffer is empty.
Prototype
int GUI_PID_IsEmpty(void);
Return value
1, if the PID buffer is empty. 0, if entries were found in the PID buffer.
GUI_PID_IsPressed()
Description
Returns if the most recent state of the PID is pressed.
Prototype
int GUI_PID_IsPressed(void);
Additional information
This function does not modify the PID FIFO.
Return value
1 if input device is currently pressed; 0 if not pressed.
GUI_PID_StoreState()
Description
Stores the current state of the pointer input device.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
858
CHAPTER
Pointer Input Devices
Prototype
void GUI_PID_StoreState(const GUI_PID_STATE * pState);
Parameter pState
Description Pointer to a structure of type GUI_PID_STATE.
Additional information
This function can be used from an interrupt service routine. The PID input manager of emWin contains a FIFO buffer which is able to hold up to 5 PID events per default. If a different size is required this value can be changed. For details please refer to "Advanced GUI configuration options" on page 1049.
23.3 Mouse driver
Mouse support consists of two "layers": a generic layer and a mouse driver layer. Generic routines refer to those functions which always exist, no matter what type of mouse driver you use. The available mouse driver routines, on the other hand, will call the appropriate generic routines as necessary, and may only be used with the PS2 mouse driver supplied with emWin. If you write your own driver, it is responsible for calling the generic routines. The generic mouse routines will in turn call the corresponding PID routines.
23.3.1 Generic mouse API
The table below lists the generic mouse routines in alphabetical order. These functions may be used with any type of mouse driver. Detailed descriptions follow.
Routine GUI_MOUSE_GetState() GUI_MOUSE_StoreState()
Description
Return the current state of the mouse. Store the current state of the mouse.
GUI_MOUSE_GetState()
Description
Returns the current state of the mouse.
Prototype
int GUI_MOUSE_GetState(GUI_PID_STATE * pState);
Parameter pState
Description Pointer to a structure of type GUI_PID_STATE.
Return value
1 if mouse is currently pressed; 0 if not pressed.
Additional information
This function will call GUI_PID_GetState().
GUI_MOUSE_StoreState()
Description
Stores the current state of the mouse.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
859
Prototype
void GUI_MOUSE_StoreState(const GUI_PID_STATE *pState);
Parameter pState
Description Pointer to a structure of type GUI_PID_STATE.
Additional information
This function will call GUI_PID_StoreState(). This function can be used from an interrupt service routine.
Example
GUI_PID_STATE State;
State.x = _MousepositionX; /* Screen position in X of mouse device */
State.y = _MousepositionY; /* Screen position in Y of mouse device */
State.Pressed = 0;
if (_LeftButtonPressed) {
State.Pressed |= 1;
/* Set bit 0 if left button is pressed */
}
if (_RightButtonPressed) {
State.Pressed |= 2;
/* Set bit 1 if right button is pressed */
}
GUI_MOUSE_StoreState(&State);
23.3.2 PS2 mouse driver
The driver supports any type of PS2 mouse.
23.3.2.1 Using the PS2 mouse driver
The driver is very easy to use. In the startup code, the init function GUI_MOUSE_DRIVER_PS2_Init() should be called. The application should somehow notice when a byte is received from the mouse. When this happens, the function GUI_MOUSE_DRIVER_PS2_OnRx() should be called and the byte received passed as parameter. The driver in turn then calls GUI_PID_StoreState as required. The reception of the byte is typically handled in an interrupt service routine.
An example ISR could look as follows: (Note that this is of course different for different systems)
void interrupt OnRx(void) { char Data; Data = UART_REG; GUI_MOUSE_DRIVER_PS2_OnRx(Data);
}
// Read data from the hardware // Pass it on to the driver
23.3.2.2 PS2 mouse driver API
The table below lists the available mouse driver routines in alphabetical order.
Routine GUI_MOUSE_DRIVER_PS2_Init() GUI_MOUSE_DRIVER_PS2_OnRx()
Description
Initialize the mouse driver. Called form receive interrupt routines.
GUI_MOUSE_DRIVER_PS2_Init()
Description
Initializes the mouse driver.
Prototype
void GUI_MOUSE_DRIVER_PS2_Init(void);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
860
CHAPTER
Pointer Input Devices
GUI_MOUSE_DRIVER_PS2_OnRx()
Description
Must be called from receive interrupt routines.
Prototype
void GUI_MOUSE_DRIVER_PS2_OnRx(unsigned char Data);
Parameter Data
Byte of data received by ISR.
Description
Additional information
The PS2 mouse driver is a serial driver, meaning it receives 1 byte at a time. You need to ensure that this function is called from your receive interrupt routine every time a byte (1 character) is received.
23.4 Touch screen driver
A touch screen driver will typically simply call GUI_PID_StoreState() as described earlier. Any type of touch screen can be supported this way. It is the responsibility of the user to write the driver code (which is usually fairly simple). The most common way of interfacing a touch screen is the 4-pin analog interface, for which a driver is supplied.
23.4.1 Generic touch screen API
The generic touch screen API is used with any type of driver (analog, digital, etc.). A driver calls the appropriate routines as necessary. If you write your own driver, it has to call the generic routines. The table below lists the generic touch-screen routines in alphabetical order. These functions may be used with any type of touch-screen driver. Detailed descriptions follow.
Routine GUI_TOUCH_GetState() GUI_TOUCH_StoreState() GUI_TOUCH_StoreStateEx()
Description
Return the current state of the touch-screen. Store the current state of the touch-screen using Xand Y-coordinates. Store the current state of the touch-screen.
GUI_TOUCH_GetState()
Description
Returns the current state of the touch-screen.
Prototype
int GUI_TOUCH_GetState(GUI_PID_STATE *pState);
Parameter pState
Description Pointer to a structure of type GUI_PID_STATE.
Return value
1 if touch-screen is currently pressed; 0 if not pressed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
861
GUI_TOUCH_StoreState()
Description
Stores the current state of the touch screen using X- and Y-coordinates as parameters.
Prototype
void GUI_TOUCH_StoreState(int x, int y);
Parameter x y
X-position. Y-position.
Description
Additional information
If one of the given values is negative, the GUI assumes that the touch panel is not pressed. This function can be used from an interrupt service routine. For a more detailed example of a touch handling routine, please refer to Sample\GUI_X\GUI_X_Touch_StoreState.c.
Example
int x, y;
if (_TouchIsPressed) {
x = _TouchPositionX; /* Current position in X of touch device */
y = _TouchPositionY; /* Current position in Y of touch device */
} else {
x = y = -1;
/* Use -1 if touch is not pressed */
}
GUI_TOUCH_StoreState(x, y);
GUI_TOUCH_StoreStateEx()
Description
Stores the current state of the touch screen.
Prototype
void GUI_TOUCH_StoreStateEx(const GUI_PID_STATE * pState);
Parameter
Description
pState
Pointer to a structure of type GUI_PID_STATE.
Additional information
This function will call GUI_PID_StoreState(). For a more detailed example of a touch handling routine, please refer to Sample\GUI_X\GUI_X_Touch_StoreState.c.
Example
GUI_PID_STATE State; State.x = _TouchPositionX; State.y = _TouchPositionY; if (_TouchIsPressed) {
State.Pressed = 1; } else {
State.Pressed = 0; } GUI_TOUCH_StoreStateEx(&State);
23.4.2 The analog touch screen driver
The emWin touch-screen driver handles analog input (from an 8-bit or better A/D converter), debouncing and calibration of the touch-screen.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
862
CHAPTER
Pointer Input Devices
The touch-screen driver continuously monitors and updates the touch-panel through the use of the function GUI_TOUCH_Exec(), which calls the appropriate generic touchscreen API routines when it recognizes that an action has been performed or something has changed.
How an analog touch screen works
The touch panel consists of 2 thin conducting
layers of glass, normally insulated from each
other. If the user presses the touch panel, the
two layers are connected at that point. If a
voltage is applied to the Y-layer, when
pressed, a voltage can be measured at the X+/X-terminals. This voltage depends on the
X+
touch position. The same thing holds true the
other way round. If a voltage is applied to the
X-layer, when pressed, a voltage can be mea-
sured at the Y+/Y-terminals.
Y+ X-
Y-
23.4.2.1 Setting up the analog touch screen
Putting a touch panel into operation should be done in the following steps: · Implementing the hardware routines · Implementing regular calls to GUI_TOUCH_Exec() · Verifying proper operation with the oscilloscope · Using example to determine calibration values · Adding a call of GUI_TOUCH_Calibrate() to the initialization
LCD_X_Config() using the determined values The following shows a detailed description of each step.
routine
Implementing the hardware routines
The first step of implementing a touch screen should be filling the hardware routines with code. These routines are:
GUI_TOUCH_X_ActivateX(), GUI_TOUCH_X_ActivateY() GUI_TOUCH_X_MeasureX(), GUI_TOUCH_X_MeasureY()
A module GUI_TOUCH_X.c containing the empty routines is located in the folder Sample\GUI_X. You can use this module as a starting point. The activate routines should prepare the measurement by switching on the measurement voltage. GUI_TOUCH_X_ActivateX() for example should prepare the measurement in Y by switching on the measurement voltage in X. Further it should switch of the voltage in Y and disable the measurement in X. The measurement routines should return the measurement result of a A/D converter. Later in this chapter you will find an example implementation of the hardware routines.
Implementing regular calls to GUI_TOUCH_Exec()
The second step of implementing a touch screen is to make sure, that the function GUI_TOUCH_Exec() will be called in regular intervals. The application should call it about 100 times/second. If a real-time operating system is used, the easiest way to make sure this function is called is to create a separate task. When not using a multitasking system, an interrupt service routine may do the job. The function GUI_TOUCH_Exec() measures x- and y-axis in turns. So complete measurements are done once both axes were measured.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
863
Verifying proper operation with the oscilloscope
After implementing the call of GUI_TOUCH_Exec() make sure the hardware works. The easiest way to do this is to measure the supply and measurement voltages of the touch panel with a oscilloscope. The following table shows a typical result. The first column shows the supply voltage of an axis, the second column shows the result of measuring the measurement voltage when pressing in the middle of the touch panel.
Supply voltage
Measurement voltage
Use example to determine calibration values
The third step is to get the minimum and maximum values of the A/D converter. emWin needs this values to convert the measurement result to the touch position in pixels. These 4 values are:
Value
How to get them
GUI_TOUCH_AD_TOP
Press the touch at the top and write down the analog input value in Y.
GUI_TOUCH_AD_BOTTOM Press the touch at the bottom and write down the analog input value in Y.
GUI_TOUCH_AD_LEFT Press the touch at the left and write down the analog input value in X.
GUI_TOUCH_AD_RIGHT Press the touch at the right and write down the analog input value in X. The example folder of emWin contains a small program which can be used to get these values from your touch panel. It is located in the folder Sample\Tutorial and its name is TOUCH_Sample.c. Run this example on your hardware. The output should be similar to the screenshot at the right side.
Use GUI_TOUCH_Calibrate() with the above values
The last step is adding a call to GUI_TOUCH_Calibrate() using the calibration values. The recommended location for calibrating the touch screen is the initialization routine LCD_X_Config() which is located in LCDConf.c. similar to following example:
#define GUI_TOUCH_AD_TOP
877
#define GUI_TOUCH_AD_BOTTOM 273
#define GUI_TOUCH_AD_LEFT 232
#define GUI_TOUCH_AD_RIGHT 918
.
.
.
void LCD_X_Config(void) {
//
// Initialize display driver
//
.
.
.
//
// Set orientation of touch screen (only required when using
//
TouchOrientation = (GUI_MIRROR_X * LCD_GetMirrorX()) |
(GUI_MIRROR_Y * LCD_GetMirrorY()) |
(GUI_SWAP_XY * LCD_GetSwapXY()) ;
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
864
CHAPTER
Pointer Input Devices
GUI_TOUCH_SetOrientation(TouchOrientation); // // Calibrate touch screen // GUI_TOUCH_Calibrate(GUI_COORD_X, 0, 240, TOUCH_AD_TOP , TOUCH_AD_BOTTOM); GUI_TOUCH_Calibrate(GUI_COORD_Y, 0, 320, TOUCH_AD_LEFT, TOUCH_AD_RIGHT); }
23.4.2.2 Runtime calibration
In practice the exact values for the configuration file can be determined only for one touch panel. Because there are small differences between the parts of a series it could be very needful to calibrate each device at run-time. This can be done by using the function GUI_TOUCH_Calibrate(). The Sample folder contains the example TOUCH_Calibrate.c which shows, how a touch screen can be calibrated at run time:
23.4.2.3 Hardware routines
The following four hardware-dependent functions need to be added to your project if you use the driver supplied with emWin, as they are called by GUI_TOUCH_Exec() when polling the touch-panel. A suggested place is in the file GUI_X.c. These functions are as follows:
Routine GUI_TOUCH_X_ActivateX() GUI_TOUCH_X_ActivateY() GUI_TOUCH_X_MeasureX() GUI_TOUCH_X_MeasureY()
Description
Prepares measurement for Y-axis. Prepares measurement for X-axis. Returns the X-result of the A/D converter. Returns the Y-result of the A/D converter.
GUI_TOUCH_X_ActivateX(), GUI_TOUCH_X_ActivateY()
Description
These routines are called from GUI_TOUCH_Exec() to activate the measurement of the X- and the Y-axes. GUI_TOUCH_X_ActivateX() switches on the measurement voltage to the X-axis; GUI_TOUCH_X_ActivateY() switches on the voltage to the Yaxis. Switching on the voltage in X means the value for the Y-axis can be measured and vice versa.
Prototypes
void GUI_TOUCH_X_ActivateX(void); void GUI_TOUCH_X_ActivateY(void);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
865
GUI_TOUCH_X_MeasureX(), GUI_TOUCH_X_MeasureY()
Description
These routines are called from GUI_TOUCH_Exec() to return the measurement values from the A/D converter for the X- and the Y-axes.
Prototypes
int GUI_TOUCH_X_MeasureX(void); int GUI_TOUCH_X_MeasureY(void);
Example implementation
The following shows an example implementation of the touch hardware routines for a Renesas M16C/80 controller:
void GUI_TOUCH_X_ActivateX(void) {
U8 Data;
asm("fclr i");
/* Disable interrupts
*/
Data = P10;
/* Read port data
*/
Data |= (1 << 2) | (1 << 3); /* Switch on power in X
and enable measurement in Y */
Data &= ~((1 << 4) | (1 << 5)); /* Switch off power in Y
and disable measurement in X */
P10 = Data;
/* Write port data
*/
asm("fset i");
/* Enable interrupts
*/
}
void GUI_TOUCH_X_ActivateY(void) {
U8 Data;
asm("fclr i");
/* Disable interrupts
*/
Data = P10;
/* Read port data
*/
Data |= (1 << 5) | (1 << 4); /* Switch on power in Y
and enable measurement in X */
Data &= ~((1 << 3) | (1 << 2)); /* Switch off power in X
and disable measurement in Y */
P10 = Data;
/* Write port data
*/
asm("fset i");
/* Enable interrupts
*/
}
static void ReadADCx(int channel) {
ADCON0 = channel
/* Select channel 0-7
*/
| (0 << 3)
/* One shot mode
*/
| (0 << 6)
/* A-D conversion start (0=stop) */
| (0 << 7);
/* FAD/4 select
*/
ADCON1 = (0 << 0)
/* A-D sweep select (XX)
*/
| (0 << 2)
/* No sweep mode
*/
| (0 << 3)
/* 8 bit mode
*/
| (0 << 4)
/* FAD4 select
*/
| (1 << 5)
/* VRef connected
*/
| (0 << 6);
/* Anex0/1 not used
*/
ADCON2 = (1 << 0);
/* Use example and hold
*/
ADIC = 0;
/* Reset IR flag
*/
ADCON0 |= (1 << 6);
/* Start conversion
*/
while ((ADIC & (1 << 3)) == 0); /* Wait for end of conversion */
ADCON0 &= ~(6 << 0);
/* Start conversion = 0
*/
}
int GUI_TOUCH_X_MeasureX(void) { ReadADCx(0); return AD0;
}
int GUI_TOUCH_X_MeasureY(void) { ReadADCx(1); return AD1;
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
866
CHAPTER
Pointer Input Devices
23.4.2.4 Driver API for analog touch screens
The table below lists the available analog touch screen driver routines in alphabetical order. These functions only apply if you are using the driver included with emWin.
Routine GUI_TOUCH_Calibrate() GUI_TOUCH_Exec() GUI_TOUCH_SetOrientation()
Description
Changes the calibration. Activates the measurement of the X- and Y-axes; needs to be called about 100 times/second. Sets the logical display orientation.
GUI_TOUCH_Calibrate()
Description
Changes the calibration at runtime.
Prototype
int GUI_TOUCH_Calibrate(int Coord, int Log0, int Log1, int Phys0, int Phys1);
Parameter Coord Log0 Log1 Phys0 Phys1
Description GUI_COORD_X for X-axis, GUI_COORD_Y for Y-axis.
Logical value 0 in pixels. Logical value 1 in pixels. A/D converter value for Log0. A/D converter value for Log1.
Additional information
The function takes as parameters the axis to be calibrated, two logical values in pixels for this axis and two corresponding physical values of the A/D converter. Since the logical value Log0 usually is set to 0, Log1 should contain the (x- or y-)size decreased by 1.
GUI_TOUCH_Exec()
Description
Polls the touch-screen by calling the TOUCH_X routines to activate the measurement of the X- and Y-axes. It is required that this function is called for about 100 times per second, since there is only one axis measured per call. Therefore a complete measurement of the touch screen is done with 2 calls of GUI_TOUCH_Exec().
Prototype
void GUI_TOUCH_Exec(void);
Additional information
If you are using a real-time operating system, the easiest way to make sure this function is called is to create a separate task. When not using a multitask system, you can use an interrupt service routine to do the job.
GUI_TOUCH_SetOrientation()
Description
The function configures the touch screen orientation. If the touch screen for example already has been configured to work with the default orientation and the display now needs to be turned or mirrored, this function can be used to configure the touch driver to use the same orientation as the display without changing anything at the hardware routines.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
867
Prototype
void GUI_TOUCH_SetOrientation(unsigned Orientation);
Parameter Orientation
Description
One or more "OR" combined values of the table below.
Permitted values for parameter Orientation
GUI_MIRROR_X GUI_MIRROR_Y GUI_SWAP_XY
Mirroring the X-axis Mirroring the Y-axis Swapping X- and Y-axis
23.4.2.5 Configuring the analog touch-screen driver
The touch screen driver is completely run-time configurable. GUI_TOUCH_Calibrate() should be used to specify the physical values returned by the A/D converter for 2 positions per axis. If the display needs to be turned or mirrored, GUI_TOUCH_SetOrientation() can be used to set a new orientation without changing anything at the hardware routines. Configuring the touch screen should be done before emWin manages any touch input.
Example
#define TOUCH_AD_LEFT 0x3c0 #define TOUCH_AD_RIGHT 0x034 #define TOUCH_AD_TOP 0x3b0 #define TOUCH_AD_BOTTOM 0x034
Orientation = (GUI_MIRROR_X * LCD_GetMirrorXEx(0)) | (GUI_MIRROR_Y * LCD_GetMirrorYEx(0)) | (GUI_SWAP_XY * LCD_GetSwapXYEx (0));
GUI_TOUCH_SetOrientation(Orientation); GUI_TOUCH_Calibrate(GUI_COORD_X, 0, 319, TOUCH_AD_LEFT, TOUCH_AD_RIGHT); GUI_TOUCH_Calibrate(GUI_COORD_Y, 0, 239, TOUCH_AD_TOP, TOUCH_AD_BOTTOM);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
868
CHAPTER
Pointer Input Devices
23.5 Joystick input example
The following example shows how the pointer input device API can be used to process the input from a joystick:
/*********************************************************************
*
*
_JoystickTask
*
* Purpose:
* Periodically read the Joystick and inform emWin using
* GUI_PID_StoreState.
* It supports dynamic acceleration of the pointer.
* The Joystick is a simple, standard 5 switch (digital) type.
*
*/
static void _JoystickTask(void) {
GUI_PID_STATE State;
int Stat;
int StatPrev = 0;
int TimeAcc = 0; // Dynamic acceleration value
int xMax, yMax;
xMax = LCD_GetXSize() - 1; yMax = LCD_GetYSize() - 1; while (1) {
Stat = HW_ReadJoystick(); // // Handle dynamic pointer acceleration // if (Stat == StatPrev) {
if (TimeAcc < 10) { TimeAcc++;
} } else {
TimeAcc = 1; } if (Stat || (Stat != StatPrev)) {
// // Compute the new coordinates // GUI_PID_GetState(&State); if (Stat & JOYSTICK_LEFT) {
State.x -= TimeAcc; } if (Stat & JOYSTICK_RIGHT) {
State.x += TimeAcc; } if (Stat & JOYSTICK_UP) {
State.y -= TimeAcc; } if (Stat & JOYSTICK_DOWN) {
State.y += TimeAcc; } // // Make sure coordinates are still in bounds // if (State.x < 0) {
State.x = 0; } if (State.y < 0) {
State.y = 0; } if (State.x >= xMax) {
State.x = xMax; } if (State.y > yMax) {
State.y = yMax; } // // Inform emWin // State.Pressed = (Stat & JOYSTICK_ENTER) ? 1: 0; GUI_PID_StoreState(&State); StatPrev = Stat; } OS_Delay(40); } }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
869
Chapter 24 Keyboard Input
emWin provides support for any kind of keyboards. Any type of keyboard driver is compatible with emWin. The software for keyboard input is located in the subdirectory GUI\Core and part of the basic package.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
870
CHAPTER
Keyboard Input
24.1 Description
A keyboard input device uses ASCII character coding in order to be able to distinguish between characters. For example, there is only one "A" key on the keyboard, but an uppercase "A" and a lowercase "a" have different ASCII codes (0x41 and 0x61, respectively).
emWin predefined character codes
emWin also defines character codes for other "virtual" keyboard operations. These codes are listed in the table below, and defined in an identifier table in GUI.h. A character code in emWin can therefore be any extended ASCII character value or any of the following predefined emWin values.
Predefined virtual key code GUI_KEY_BACKSPACE GUI_KEY_TAB GUI_KEY_ENTER GUI_KEY_LEFT GUI_KEY_UP GUI_KEY_RIGHT GUI_KEY_DOWN GUI_KEY_HOME GUI_KEY_END GUI_KEY_SHIFT GUI_KEY_CONTROL GUI_KEY_ESCAPE GUI_KEY_INSERT GUI_KEY_DELETE
Description
Backspace key. Tab key. Enter/return key. Left arrow key. Up arrow key. Right arrow key. Down arrow key. Home key (move to beginning of current line). End key (move to end of current line). Shift key. Control key. Escape key. Insert key. Delete key.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
871
24.1.1 Driver layer API
The keyboard driver layer handles keyboard messaging functions. These routines notify the Window Manager when specific keys (or combinations of keys) have been pressed or released. The table below lists the driver-layer keyboard routines in alphabetical order. Detailed descriptions follow.
Routine GUI_StoreKeyMsg() GUI_SendKeyMsg()
Description
Store a message in a specified key. Send a message to a specified key.
GUI_StoreKeyMsg()
Description
Stores the message data (Key, PressedCnt) into the keyboard buffer.
Prototype
void GUI_StoreKeyMsg(int Key, int Pressed);
Parameter Key Pressed
Description
May be any extended ASCII character (between 0x20 and 0xFF) or any predefined emWin character code. Key state. See table below.
Permitted values for parameter Pressed
1
Pressed state.
0
Released (unpressed) state.
Additional information
This function can be used from an interrupt service routine. The keyboard input manager of emWin contains a FIFO buffer which is able to hold up to 10 keyboard events per default. If a different size is required this value can be changed. For details please refer to "Advanced GUI configuration options" on page 1049. The Window Manager polls the keyboard buffer automatically and sends according keyboard messages to the currently focussed window.
GUI_SendKeyMsg()
Description
Sends the keyboard data to the window with the input focus. If no window has the input focus, the function GUI_StoreKeyMsg() is called to store the data to the input buffer.
Prototype
void GUI_SendKeyMsg(int Key, int Pressed);
Parameter Key Pressed
Description
May be any extended ASCII character (between 0x20 and 0xFF) or any predefined emWin character code.
Key state (see GUI_StoreKeyMsg()).
Additional information
This function should not be called from an interrupt service routine.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
872
CHAPTER
Keyboard Input
24.1.2 Application layer API
The table below lists the application-layer keyboard routines in alphabetical order. Detailed descriptions follow.
Routine GUI_ClearKeyBuffer() GUI_GetKey() GUI_GetKeyState() GUI_StoreKey() GUI_WaitKey()
Description
Clear the key buffer. Return the contents of the key buffer. Returns the current key state. Store a key in the buffer. Wait for a key to be pressed.
GUI_ClearKeyBuffer()
Description
Clears the key buffer.
Prototype
void GUI_ClearKeyBuffer(void);
GUI_GetKey()
Description
Returns the current content of the key buffer.
Prototype
int GUI_GetKey(void);
Return value
Codes of characters in the key buffer; 0 if no key is buffered.
GUI_GetKeyState()
Description
Returns the current key state.
Prototype
void GUI_GetKeyState(GUI_KEY_STATE * pState);
Parameter pState
Description
This structure is filled by the function. See elements below.
Elements of GUI_KEY_STATE
Data type
Element
int
Key
int
Pressed
GUI_StoreKey()
Description
Stores a key in the buffer.
Description
Key code. 1, if the key is pressed. 0, if the key is not pressed. -1, if the state could not be determined.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
873
Prototype
void GUI_StoreKey(int Key);
Parameter Key
Description
May be any extended ASCII character (between 0x20 and 0xFF) or any predefined emWin character code.
Additional information
This function is typically called by the driver and not by the application itself.
GUI_WaitKey()
Description
Waits for a key to be pressed.
Prototype
int GUI_WaitKey(void);
Additional information
The application is "blocked", meaning it will not return until a key is pressed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
874
CHAPTER
Keyboard Input
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
875
Chapter 25
Sprites
A 'sprite' is an image which can be shown above all other graphics on the screen. A sprite preserves the screen area it covers. It can be moved or removed at any time, fully restoring the screen content. Animation by use of multiple images is possible. Sprites are completely independent from all other drawing operations as well as window operations: Sprites do not affect drawing or window operations; drawing or window operations do not affect sprites. Sprites can be seen as objects which are sitting "on top" of the screen, similar to cursors.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
876
CHAPTER
Sprites
25.1 Introduction
emWin sprites are implemented as a pure software solution. No additional hardware is required to use emWin sprites. They can be shown, moved and deleted without affecting already visible graphics.
Memory requirements
Each sprite needs a memory area for saving the display data 'behind' the sprite to be able to restore the background on moving operations or on removing the sprite. Further a memory area for a color cache is required. The size of the color cache depends on the number of colors used in the sprite image. So the complete number of bytes required for a sprite can be calculated as follows:
SizeOfSpriteObject (~30 bytes) + (XSize * YSize + NumberOfBitmapColors) * REQUIRED_BYTES_PER_PIXEL
Maximum number of sprites
The number of simultaneous visible sprites is not limited by emWin. It depends only on the available memory.
Performance
Note that drawing a sprite is more computer-bound than drawing a simple bitmap, because it has to manage the background data and intersections with other sprites.
Z-order
Z-order is an ordering of overlapping two-dimensional objects, in this case the sprites. When two sprites overlap, their Z-order determines which one appears on top of the other. The sprite created at last is the topmost sprite.
25.2 Sprite API
The table below lists the available sprite-related routines in alphabetical order. Detailed descriptions follow:
Routine GUI_SPRITE_Create() GUI_SPRITE_CreateAnim() GUI_SPRITE_CreateEx() GUI_SPRITE_CreateExAnim() GUI_SPRITE_CreateHidden() GUI_SPRITE_CreateHiddenEx() GUI_SPRITE_Delete() GUI_SPRITE_GetState() GUI_SPRITE_Hide() GUI_SPRITE_SetBitmap() GUI_SPRITE_SetBitmapAndPosition() GUI_SPRITE_SetPosition() GUI_SPRITE_Show()
Description
Creates a sprite. Creates an animated sprite. Creates a sprite in the given layer. Creates an animated sprite in the given layer. Creates a hidden sprite. Creates a hidden sprite in the given layer. Deletes a sprite. Return if the sprite is visible or not. Hides a sprite. Sets a new bitmap of a sprite. Sets a new bitmap and the position of a sprite. Sets the position of a sprite. Shows the given sprite.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
877
GUI_SPRITE_Create()
Description
Creates a sprite at the given position in the current layer.
Prototype
GUI_HSPRITE GUI_SPRITE_Create(const GUI_BITMAP GUI_UNI_PTR * pBM, int x, int y);
Parameter pBM x y
Description
Pointer to a bitmap structure to be used for drawing the sprite. X-position of the sprite in screen coordinates. Y-position of the sprite in screen coordinates.
Return value
Handle of the new sprite, 0 on failure.
Additional information
The bitmap addressed by the parameter pBM needs to agree with the following requirements: · It should not be compressed. · It needs to be transparent. · It needs to be a palette based bitmap with 1, 2, 4 or 8bpp. Other bitmaps or insufficient memory cause the function to fail.
GUI_SPRITE_CreateAnim()
Description
Creates an animated sprite at the given position in the current layer.
Prototype
GUI_HSPRITE GUI_SPRITE_CreateAnim(const GUI_BITMAP GUI_UNI_PTR ** ppBm, int x, int y, unsigned Period, const unsigned * pPeriod, int NumItems);
Parameter ppBM x y Period pPeriod NumItems
Description
Pointer to an array of bitmap pointers to be used for drawing the sprite. X-position of the sprite in screen coordinates. Y-position of the sprite in screen coordinates. Period to be used to switch between the images. Pointer to an array containing the periods to be used to switch between the images. Number of images.
Return value
Handle of the new sprite, 0 on failure.
Additional information
The bitmaps addressed by the parameter ppBM needs to agree with the following requirements: · They need to have exactly the same X- and Y-size. · They should not be compressed. · They need to be transparent. · They need to be palette based bitmaps with 1, 2, 4 or 8bpp. Other bitmaps or insufficient memory cause the function to fail. The parameter pPeriod is only required if the periods for the images are different. If the same period should be used for all images the parameter Period should be used. In this case pPeriod can be NULL.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
878
CHAPTER
Sprites
GUI_SPRITE_CreateEx()
Description
Creates a sprite at the given position in the desired layer.
Prototype
GUI_HSPRITE GUI_SPRITE_CreateEx(const GUI_BITMAP GUI_UNI_PTR * pBM, int x, int y, int Layer);;
Parameter pBM x y Layer
Description
Pointer to a bitmap structure to be used for drawing the sprite. X-position of the sprite in screen coordinates. Y-position of the sprite in screen coordinates. Layer of sprite.
Return value
Handle of the new sprite, 0 on failure.
Additional information
For more details please refer to "GUI_SPRITE_Create()" on page 877.
GUI_SPRITE_CreateExAnim()
Description
Creates an animated sprite at the given position in the current layer.
Prototype
GUI_HSPRITE GUI_SPRITE_CreateAnim(const GUI_BITMAP GUI_UNI_PTR ** ppBm,
int
x,
int
y,
unsigned
Period,
const unsigned * pPeriod,
int
NumItems,
int
LayerIndex);
Parameter ppBM x y Period pPeriod NumItems LayerIndex
Description
Pointer to an array of bitmap pointers to be used for drawing the sprite. X-position of the sprite in screen coordinates. Y-position of the sprite in screen coordinates. Period to be used to switch between the images. Pointer to an array containing values to be used to switch between the images. Number of images. Layer of sprite.
Return value
Handle of the new sprite, 0 on failure.
Additional information
For more details please refer to "GUI_SPRITE_CreateAnim()" on page 877.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
879
GUI_SPRITE_CreateHidden()
Description
Creates a hidden sprite at the given position in the current layer.
Prototype
GUI_HSPRITE GUI_SPRITE_CreateHidden(const GUI_BITMAP GUI_UNI_PTR * pBM, int x, int y);
Parameter pBM x y
Description
Pointer to a bitmap structure to be used for drawing the sprite. X-position of the sprite in screen coordinates. Y-position of the sprite in screen coordinates.
Return value
Handle of the new sprite, 0 on failure.
Additional information
For more details please refer to "GUI_SPRITE_Create()" on page 877.
GUI_SPRITE_CreateHiddenEx()
Description
Creates a hidden sprite at the given position in the given layer.
Prototype
GUI_HSPRITE GUI_SPRITE_CreateHiddenEx(const GUI_BITMAP GUI_UNI_PTR * pBM, int x, int y, int Layer);
Parameter pBM x y Layer
Description
Pointer to a bitmap structure to be used for drawing the sprite. X-position of the sprite in screen coordinates. Y-position of the sprite in screen coordinates. Layer to be used.
Return value
Handle of the new sprite, 0 on failure.
Additional information
For more details please refer to "GUI_SPRITE_Create()" on page 877.
GUI_SPRITE_Delete()
Description
Deletes the given sprite.
Prototype
void GUI_SPRITE_Delete(GUI_HSPRITE hSprite);
Parameter hSprite
Handle of sprite to be deleted.
Description
Additional information
The function deletes the sprite from the memory and restores its background automatically.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
880
CHAPTER
Sprites
GUI_SPRITE_GetState()
Description
Returns if the given Sprite is visible or not.
Prototype
int GUI_SPRITE_GetState(GUI_HSPRITE hSprite);
Parameter hSprite
Handle of sprite.
Description
Return value
1 if it is visible, 0 if not.
GUI_SPRITE_Hide()
Description
Hides the given sprite.
Prototype
void GUI_SPRITE_Hide(GUI_HSPRITE hSprite);
Parameter hSprite
Handle of sprite to hide.
Description
Additional information
The function removes the given sprite from the list of visible sprites.
GUI_SPRITE_SetBitmap()
Description
Sets a new image for drawing the sprite.
Prototype
int GUI_SPRITE_SetBitmap(GUI_HSPRITE hSprite, const GUI_BITMAP GUI_UNI_PTR * pBM);
Parameter hSprite pBM
Description
Handle of sprite. Pointer to a bitmap structure to be used for drawing the sprite.
Return value
0 on success, 1 if the routine fails.
Additional information
The new bitmap must have exact the same size as the previous one. Passing a pointer to a bitmap of a different size causes the function to fail. The function immediately replaces the visible sprite image on the screen. No further operation is required for showing the new image.
GUI_SPRITE_SetBitmapAndPosition()
Description
Sets the position and the image at once.
Prototype
int GUI_SPRITE_SetBitmapAndPosition(GUI_HSPRITE hSprite,
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
881
const GUI_BITMAP GUI_UNI_PTR * pBM, int x, int y);
Parameter hSprite pBM x y
Description
Handle of sprite. Pointer to the new bitmap structure to be used to draw the sprite. New X-position in screen coordinates. New Y-position in screen coordinates.
Additional information
It makes a difference on using the functions GUI_SPRITE_SetBitmap() and GUI_SPRITE_SetPosition() one after another or using this function. Whereas the image on the screen will be rendered twice on calling GUI_SPRITE_SetBitmap() and GUI_SPRITE_SetPosition() it is rendered only once on using this function, which can be used very well in animations.
GUI_SPRITE_SetPosition()
Description
Moves the sprite to the new position.
Prototype
void GUI_SPRITE_SetPosition(GUI_HSPRITE hSprite, int x, int y);
Parameter hSprite x y
Description
Handle of sprite. New X-position in screen coordinates. New Y-position in screen coordinates.
Additional information
The function moves the given sprite to the new position.
GUI_SPRITE_Show()
Description
Shows the given sprite.
Prototype
void GUI_SPRITE_Show(GUI_HSPRITE hSprite);
Parameter hSprite
Handle of sprite.
Description
Additional information
The function adds the given sprite to the list of visible sprites.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
882
CHAPTER
Sprites
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
883
Chapter 26 Cursors
emWin includes a system-wide cursor which may be changed to other, predefined styles. Also automatically animated cursors are supported. Although the cursor always exists, it is hidden by default. It will not be visible until a call is made to show it, and may be hidden again at any point.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
884
CHAPTER
Cursors
26.1 Available cursors
The following cursor styles are currently available. If a call to GUI_CURSOR_Show() is made and no style is specified with GUI_CURSOR_Select(), the default cursor will be a medium arrow.
Arrow cursors
Cross cursors
GUI_CursorArrowS Small arrow
GUI_CursorCrossS Small cross
GUI_CursorArrowM Medium arrow (default cursor)
GUI_CursorCrossM Medium cross
GUI_CursorArrowL Large arrow
Inverted arrow cursors
GUI_CursorArrowSI Small inverted arrow
GUI_CursorCrossL Large cross
Inverted cross cursors
GUI_CursorCrossSI Small inverted cross
GUI_CursorArrowMI Medium inverted arrow
GUI_CursorCrossMI Medium inverted cross
GUI_CursorArrowLI Large inverted arrow
GUI_CursorCrossLI Large inverted cross
Animated cursors
GUI_CursorAnimHourglassM Medium animated hourglass
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
885
26.2 Cursor API
The table below lists the available cursor-related routines in alphabetical order. Detailed descriptions follow:
Routine GUI_CURSOR_GetState() GUI_CURSOR_Hide() GUI_CURSOR_Select() GUI_CURSOR_SelectAnim() GUI_CURSOR_SetPosition() GUI_CURSOR_Show()
Description
Returns if the cursor is visible or not. Hides the cursor. Sets a specified cursor. Sets an animated cursor. Sets the cursor position. Shows the cursor.
GUI_CURSOR_GetState()
Description
Returns if the cursor is currently visible or not.
Prototype
int GUI_CURSOR_GetState(void);
Return value
1 if the cursor is visible and 0 if not.
GUI_CURSOR_Hide()
Description
Hides the cursor.
Prototype
void GUI_CURSOR_Hide(void);
Additional information
This is the default cursor setting. If the cursor should be visible, the function GUI_CURSOR_Show() needs to be called.
GUI_CURSOR_Select()
Description
Sets a specified cursor style.
Prototype
void GUI_CURSOR_Select(const GUI_CURSOR * pCursor);
Parameter pCursor
Description
Pointer to the cursor to be selected.
Permitted values for parameter pCursor (Predefined cursors)
GUI_CursorArrowS GUI_CursorArrowM GUI_CursorArrowL GUI_CursorArrowSI GUI_CursorArrowMI GUI_CursorArrowLI GUI_CursorCrossS
Small arrow. Medium arrow. Large arrow. Small inverted arrow. Medium inverted arrow. Large inverted arrow. Small cross.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
886
CHAPTER
Cursors
Permitted values for parameter pCursor (Predefined cursors)
GUI_CursorCrossM GUI_CursorCrossL GUI_CursorCrossSI GUI_CursorCrossMI GUI_CursorCrossLI
Medium cross. Large cross. Small inverted cross. Medium inverted cross. Large inverted cross.
Additional information
If this function is not called, the default cursor is a medium arrow.
GUI_CURSOR_SelectAnim()
Description
Sets an animated cursor.
Prototype
int GUI_CURSOR_SelectAnim(const GUI_CURSOR_ANIM GUI_UNI_PTR * pCursorAnim);
Parameter pCursorAnim
Description Pointer to a GUI_CURS_ANIM structure used for the animation.
Permitted values for parameter pCursorAnim (Predefined cursors)
GUI_CursorAnimHourglassM Animated hourglass, medium size.
Elements of GUI_CURSOR_ANIM
Data type
Element
const GUI_BITMAP ** ppBm
int int unsigned unsigned * int
xHot yHot Period pPeriod NumItems
Description
Pointer to an array of pointers to bitmaps to be used for the animated cursor. X-position of hot spot. Details can be found below.
Y-position of hot spot. Details can be found below.
Period to be used to switch between the images. Pointer to an array containing the periods to be used to switch between the images. Number of images used for the animation.
Additional information
The bitmaps addressed by ppBM needs to agree with the following requirements:
· They need to have exactly the same X- and Y-size. · They should not be compressed. · They need to be transparent. · They need to be palette based bitmaps with 1, 2, 4 or 8bpp.
Other bitmaps or insufficient memory cause the function to fail. The pPeriod is only required if the periods for the images are different. If the same period should be used for all images Period should be used instead of pPeriod. In this case pPeriod should be NULL. xHot and yHot determine the hot spot position of the cursor. This means the relative position in X and Y from the upper left corner of the image to the position of the pointer input device. Customized cursors can be realized by passing a pointer to a custom defined GUI_CURSOR_ANIM structure.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
887
GUI_CURSOR_SetPosition()
Description
Sets the cursor position.
Prototype
void GUI_CURSOR_SetPosition(int x, int y);
Parameter x y
X-position of the cursor. Y-position of the cursor.
Description
Additional information
Normally this function is called internally by the Window Manager and does not need to be called from the application.
GUI_CURSOR_Show()
Description
Shows the cursor.
Prototype
void GUI_CURSOR_Show(void);
Additional information
The default setting for the cursor is hidden; therefore this function must be called if you want the cursor to be visible.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
888
CHAPTER
Cursors
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
889
Chapter 27
Antialiasing
Lines are approximated by a series of pixels that must lie at display coordinates. They can therefore appear jagged, particularly lines which are nearly horizontal or nearly vertical. This jaggedness is called aliasing. Antialiasing is the smoothing of lines and curves. It reduces the jagged, stair-step appearance of any line that is not exactly horizontal or vertical. emWin supports different antialiasing qualities, antialiased fonts and high-resolution coordinates. Support for antialiasing is a separate software item and is not included in the emWin basic package. The software for antialiasing is located in the subdirectory GUI\AntiAlias.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
890
CHAPTER
Antialiasing
27.1 Introduction
Antialiasing smoothes curves and diagonal lines by "blending" the background color with that of the foreground. The higher the number of shades used between background and foreground colors, the better the antialiasing result (and the longer the computation time).
27.1.1 Quality of antialiasing
The quality of antialiasing is set by the routine GUI_AA_SetFactor(), which is explained later in this chapter. For an idea of the relationship between the antialiasing factor and the corresponding result, take a look at the image pictured. The first line is drawn without antialiasing (factor 1). The second line is drawn antialiased using factor 2. This means that the number of shades from foreground to background is 2 x 2 = 4. The next line is drawn with an antialiasing factor of 3, so there are 3 x 3 = 9 shades, and so on. Factor 4 should be sufficient for most applications. Increasing the antialiasing factor further does not improve the result significantly, but increases the calculation time dramatically.
27.1.2 Antialiased Fonts
Two types of antialiased fonts, low-quality (2bpp) and high-quality (4bpp), are supported. The routines required to display these fonts are automatically linked when using them. The following table shows the effect on drawing the character C without antialiasing and with both types of antialiased fonts:
Font type
Black on white
White on black
Standard (no antialiasing)
1 bpp 2 shades
Low-quality (antialiased)
2 bpp 4 shades
High-quality (antialiased)
4 bpp 16 shades
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
891
Antialiased fonts can be created using the Font Converter. The general purpose of using antialiased fonts is to improve the appearance of text. While the effect of using high-quality antialiasing will be visually more pleasing than low-quality antialiasing, computation time and memory consumption will increase proportionally. Low-quality (2bpp) fonts require twice the memory of non-antialiased (1bpp) fonts; high-quality (4bpp) fonts require four times the memory.
27.1.3 High-resolution coordinates
When drawing items using antialiasing, the same coordinates are used as for regular (non-antialiasing) drawing routines. This is the default mode. It is not required to consider the antialiasing factor in the function arguments. An antialiased line from (50, 100) to (100, 50) would be drawn with the following function call:
GUI_AA_DrawLine(50, 100, 100, 50);
The high-resolution feature of emWin lets you use the virtual space determined by the antialiasing factor and your display size. The advantage of using high-resolution coordinates is that items can be placed not only at physical positions of your display but also "between" them. The virtual space of a high-resolution pixel is illustrated below based on an antialiasing factor of 3:
High resolution pixel
Physical pixel
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
892
CHAPTER
Antialiasing
To draw a line from pixel (50, 100) to (100, 50) in high-resolution mode with antialiasing factor 3, you would write:
GUI_AA_DrawLine(150, 300, 300, 150);
High-resolution coordinates must be enabled with the routine GUI_AA_EnableHiRes(), and may be disabled with GUI_AA_DisableHiRes(). Both functions are explained later in the chapter. For example programs using the high-resolution feature, see the examples at the end of the chapter.
27.2 Antialiasing API
The table below lists the available routines in the antialiasing package, in alphabetical order within their respective categories. Detailed descriptions of the routines can be found in the sections that follow.
Routine
Description
Control functions
GUI_AA_DisableHiRes()
Disable high-resoluton coordinates.
GUI_AA_EnableHiRes()
Enable high-resolution coordinates.
GUI_AA_GetFactor()
Return the current antialiasing factor.
GUI_AA_SetFactor()
Set the current antialiasing factor.
Drawing functions
GUI_AA_DrawArc()
Draw an antialiased arc.
GUI_AA_DrawLine()
Draw an antialiased line.
GUI_AA_DrawPolyOutline() Draw the outline of an antialiased polygon of max. 10 points.
GUI_AA_DrawPolyOutlineEx() Draw the outline of an antialiased polygon.
GUI_AA_FillCircle()
Draw an antialiased circle.
GUI_AA_FillPolygon()
Draw a filled and antialiased polygon.
GUI_AA_SetDrawMode()
Determines how the background color is fetched for mixing.
27.3 Control functions
GUI_AA_DisableHiRes()
Description
Disables high-resolution coordinates.
Prototype
void GUI_AA_DisableHiRes(void);
Additional information
High-resolution coordinates are disabled by default.
GUI_AA_EnableHiRes()
Description
Enables high-resolution coordinates.
Prototype
void GUI_AA_EnableHiRes(void);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
893
GUI_AA_GetFactor()
Description
Returns the current antialiasing quality factor.
Prototype
int GUI_AA_GetFactor(void);
Return value
The current antialiasing factor.
GUI_AA_SetFactor()
Description
Sets the antialiasing quality factor.
Prototype
void GUI_AA_SetFactor(int Factor);
Parameter Factor
Description
The new antialiasing factor. Minimum: 1 (will result in no antialiasing); maximum: 6.
Additional information
Setting the parameter Factor to 1, though permitted, will effectively disable antialiasing and result in a standard font. We recommend an antialiasing quality factor of 2-4. The default factor is 3.
27.4 Drawing functions
GUI_AA_DrawArc()
Description
Displays an antialiased arc at a specified position in the current window, using the current pen size and the current pen shape.
Prototype
void GUI_AA_DrawArc(int x0, int y0, int rx, int ry, int a0, int a1);
Parameter x0 y0 rx ry a0 a1
Description
Horizontal position of the center. Vertical position of the center. Horizontal radius. Vertical radius. Starting angle (degrees). Ending angle (degrees).
Limitations
Currently the ry parameter is not available. The rx parameter is used instead.
Additional information
If working in high-resolution mode, position and radius must be in high-resolution coordinates. Otherwise they must be specified in pixels.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
894
CHAPTER
Antialiasing
GUI_AA_DrawLine()
Description
Displays an antialiased line at a specified position in the current window, using the current pen size and the current pen shape.
Prototype
void GUI_AA_DrawLine(int x0, int y0, int x1, int y1);
Parameter x0 y0 x1 y1
X-starting position. Y-starting position. X-end position. Y-end position.
Description
Additional information
If working in high-resolution mode, the coordinates must be in high-resolution coordinates. Otherwise they must be specified in pixels.
GUI_AA_DrawPolyOutline()
Description
Displays the outline of an antialiased polygon defined by a list of points, at a specified position in the current window and with a specified thickness. The number of points is limited to 10.
Prototype
void GUI_AA_DrawPolyOutline(const GUI_POINT * pPoint,
int
NumPoints,
int
Thickness,
int
x,
int
y)
Parameter pPoint NumPoints Thickness x y
Description
Pointer to the polygon to display. Number of points specified in the list of points. Thickness of the outline. X-position of origin. Y-position of origin.
Additional information
The polyline drawn is automatically closed by connecting the endpoint to the starting point. The starting point must not be specified a second time as an endpoint. If working in high-resolution mode, the coordinates must be in high-resolution coordinates. Otherwise they must be specified in pixels. Per default the number of points processed by this function is limited to 10. If the polygon consists of more than 10 points the function GUI_AA_DrawPolyOutlineEx() should be used.
Example
#define countof(Array) (sizeof(Array) / sizeof(Array[0]))
static GUI_POINT aPoints[] = { { 0, 0 }, { 15, 30 }, { 0, 20 }, {-15, 30 }
};
void Sample(void) {
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
895
GUI_AA_DrawPolyOutline(aPoints, countof(aPoints), 3, 150, 40); }
Screen shot of above example
GUI_AA_DrawPolyOutlineEx()
Description
Displays the outline of an antialiased polygon defined by a list of points, at a specified position in the current window and with a specified thickness.
Prototype
void GUI_AA_DrawPolyOutlineEx(const GUI_POINT * pPoint,
int
NumPoints,
int
Thickness,
int
x,
int
y,
GUI_POINT
* pBuffer);
Parameter pPoint NumPoints Thickness x y pBuffer
Description
Pointer to the polygon to display. Number of points specified in the list of points. Thickness of the outline. X-position of origin. Y-position of origin. Pointer to a buffer of GUI_POINT elements.
Additional information
The number of polygon points is not limited by this function. Internally the function needs a buffer of GUI_POINT elements for calculation purpose. The number of points of the buffer needs to be >= the number of points of the polygon. For more details, refer to "GUI_AA_DrawPolyOutline()" on page 894.
GUI_AA_FillCircle()
Description
Displays a filled, antialiased circle at a specified position in the current window.
Prototype
void GUI_AA_FillCircle(int x0, int y0, int r);
Parameter x0 y0
r
Description
X-position of the center of the circle in pixels of the client window. Y-position of the center of the circle in pixels of the client window. Radius of the circle (half of the diameter). Minimum: 0 (will result in a point); maximum: 180.
Additional information
If working in high-resolution mode, the coordinates must be in high-resolution coordinates. Otherwise they must be specified in pixels.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
896
CHAPTER
Antialiasing
GUI_AA_FillPolygon()
Description
Fills an antialiased polygon defined by a list of points, at a specified position in the current window.
Prototype
void GUI_AA_FillPolygon(const GUI_POINT * pPoint,
int
NumPoints,
int
x,
int
y);
Parameter pPoint NumPoints x y
Description
Pointer to the polygon to display. Number of points specified in the list of points. X-position of origin. Y-position of origin.
Additional information
The polyline drawn is automatically closed by connecting the endpoint to the starting point. The starting point must not be specified a second time as an endpoint. If working in high-resolution mode, the coordinates must be in high-resolution coordinates. Otherwise they must be specified in pixels.
GUI_AA_SetDrawMode()
Description
This function determines how the background color is fetched for mixing.
Prototype
int GUI_AA_SetDrawMode(int Mode);
Parameter Mode
Description
Mode to be used (see table below)
Permitted values for parameter Mode
GUI_AA_TRANS
Default behavior. Antialiased pixels are mixed with the current content of the frame buffer.
Antialiased pixels are mixed with the current background color
GUI_AA_NOTRANS set with GUI_SetBkColor().
Additional information
The default behavior of antialiasing in emWin is mixing pixels with the current content of the frame buffer. But under certain circumstances using the currently set background color (GUI_SetBkColor()) for mixing may be an advantage. This makes it possible to redraw antialiased items completely without having to redraw the background.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
897
27.5 Examples
Different antialiasing factors
The following example creates diagonal lines with and without antialiasing. The source code is available as AA_Lines.c in the examples shipped with emWin.
/*********************************************************************
*
SEGGER Microcontroller GmbH & Co. KG
*
*
Solutions for real time microcontroller applications
*
*
*
*
emWin example code
*
*
*
**********************************************************************
----------------------------------------------------------------------
File
: AA_Lines.c
Purpose
: Shows lines with different antialiasing qualities
----------------------------------------------------------------------
*/
#include "GUI.H"
/*******************************************************************
*
*
Show lines with different antialiasing qualities
*
********************************************************************
*/
static void DemoAntialiasing(void) { int i, x1, x2; int y = 2; /* Set drawing attributes */ GUI_SetColor(GUI_BLACK); GUI_SetBkColor(GUI_WHITE); GUI_SetPenShape(GUI_PS_FLAT); GUI_Clear(); x1 = 10; x2 = 90; /* Draw lines without antialiasing */ GUI_DispStringHCenterAt("\nNormal", (x1 + x2) / 2, 10); for (i = 1; i < 12; i++) { GUI_SetPenSize(i); GUI_DrawLine(x1, 40 + i * 15, x2, 40 + i * 15 + y); } x1 = 110; x2 = 190; /* Draw lines with antialiasing quality faktor 2 */ GUI_AA_SetFactor(2); GUI_DispStringHCenterAt("Antialiased\n\nusing factor 2", (x1 + x2) / 2, 10); for (i = 1; i < 12; i++) { GUI_SetPenSize(i); GUI_AA_DrawLine(x1, 40 + i * 15, x2, 40 + i * 15 + y); } x1 = 210; x2 = 290; /* Draw lines with antialiasing quality faktor 6 */ GUI_AA_SetFactor(6); GUI_DispStringHCenterAt("Antialiased\n\nusing factor 6", (x1 + x2) / 2, 10); for (i = 1; i < 12; i++) { GUI_SetPenSize(i); GUI_AA_DrawLine(x1, 40 + i * 15, x2, 40 + i * 15 + y); }
}
/*******************************************************************
*
*
main
*
********************************************************************
*/
void main(void) { GUI_Init(); DemoAntialiasing(); while(1) GUI_Delay(100);
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
898
CHAPTER
Screen shot of above example
Antialiasing
Lines placed on high-resolution coordinates
This example shows antialiased lines placed on high-resolution coordinates. It is available as AA_HiResPixels.c.
/*********************************************************************
*
SEGGER Microcontroller GmbH & Co. KG
*
*
Solutions for real time microcontroller applications
*
*
*
*
emWin example code
*
*
*
**********************************************************************
----------------------------------------------------------------------
File
: AA_HiResPixels.c
Purpose
: Demonstrates high resolution pixels
----------------------------------------------------------------------
*/
#include "GUI.H"
/*******************************************************************
*
*
Show lines placed on high resolution pixels
*
********************************************************************
*/
static void ShowHiResPixels(void) {
int i, Factor = 5;
GUI_SetBkColor(GUI_WHITE);
GUI_SetColor(GUI_BLACK);
GUI_Clear();
GUI_SetLBorder(50);
GUI_DispStringAt("This example uses high resolution pixels.\n", 50, 10);
GUI_DispString ("Not only the physical pixels are used.\n");
GUI_DispString ("Enabling high resolution simulates more\n");
GUI_DispString ("pixels by using antialiasing.\n");
GUI_DispString ("Please take a look at the magnified output\n");
GUI_DispString ("to view the result.\n");
GUI_SetPenSize(2);
GUI_SetPenShape(GUI_PS_FLAT);
GUI_AA_EnableHiRes();
/* Enable high resolution */
GUI_AA_SetFactor(Factor); /* Set quality factor */
/* Drawing lines using high resolution pixels */
for (i = 0; i < Factor; i++) {
int x = (i + 1) * 5 * Factor + i - 1;
GUI_AA_DrawLine(x, 50, x, 199);
}
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
899
/*******************************************************************
*
*
main
*
********************************************************************
*/
void main(void) { GUI_Init(); ShowHiResPixels(); while(1) { GUI_Delay(100); }
Magnified screen shot of above example
Moving pointer using high-resolution antialiasing
This example illustrates the use of high-resolution antialiasing by drawing a rotating pointer that turns 0.1 degrees with each step. There is no screen shot of this example because the effects of high-resolution antialiasing are only visible in the movement of the pointers. Without high-resolution the pointer appears to make short "jumps", whereas in high-resolution mode there is no apparent jumping. The example can be found as AA_HiResAntialiasing.c.
/*********************************************************************
*
SEGGER Microcontroller GmbH & Co. KG
*
*
Solutions for real time microcontroller applications
*
*
*
*
emWin example code
*
*
*
**********************************************************************
----------------------------------------------------------------------
File
: AA_HiResAntialiasing.c
Purpose
: Demonstrates high resolution antialiasing
----------------------------------------------------------------------
*/
#include "GUI.H"
/*******************************************************************
*
*
Data
*
********************************************************************
*/
#define countof(Obj) (sizeof(Obj)/sizeof(Obj[0]))
static const GUI_POINT aPointer[] = { { 0, 3}, { 85, 1}, { 90, 0}, { 85, -1}, { 0, -3}
};
static GUI_POINT aPointerHiRes[countof(aPointer)];
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
900
CHAPTER
Antialiasing
typedef struct { GUI_AUTODEV_INFO AutoInfo; GUI_POINT aPoints[countof(aPointer)]; int Factor;
} PARAM;
/*******************************************************************
*
*
Drawing routines
*
********************************************************************
*/
static void DrawHiRes(void * p) { PARAM * pParam = (PARAM *)p; if (pParam->AutoInfo.DrawFixed) { GUI_ClearRect(0, 0, 99, 99); } GUI_AA_FillPolygon(pParam->aPoints, countof(aPointer), 5 * pParam->Factor, 95 * pParam->Factor);
}
static void Draw(void * p) { PARAM * pParam = (PARAM *)p; if (pParam->AutoInfo.DrawFixed) { GUI_ClearRect(100, 0, 199, 99); } GUI_AA_FillPolygon(pParam->aPoints, countof(aPointer), 105, 95);
}
/******************************************************************* * * Demonstrate high resolution by drawing rotating pointers * ******************************************************************** */
static void ShowHiresAntialiasing(void) { int i; GUI_AUTODEV aAuto[2]; PARAM Param; Param.Factor = 3; GUI_DispStringHCenterAt("Using\nhigh\nresolution\nmode", 50, 120); GUI_DispStringHCenterAt("Not using\nhigh\nresolution\nmode", 150, 120); /* Create GUI_AUTODEV objects */ for (i = 0; i < countof(aAuto); i++) { GUI_MEMDEV_CreateAuto(&aAuto[i]); } /* Calculate pointer for high resolution */ for (i = 0; i < countof(aPointer); i++) { aPointerHiRes[i].x = aPointer[i].x * Param.Factor; aPointerHiRes[i].y = aPointer[i].y * Param.Factor; } GUI_AA_SetFactor(Param.Factor); /* Set antialiasing factor */ while(1) { for (i = 0; i < 1800; i++) { float Angle = (i >= 900) ? 1800 - i : i; Angle *= 3.1415926f / 1800; /* Draw pointer with high resolution */ GUI_AA_EnableHiRes(); GUI_RotatePolygon(Param.aPoints, aPointerHiRes, countof(aPointer), Angle); GUI_MEMDEV_DrawAuto(&aAuto[0], &Param.AutoInfo, DrawHiRes, &Param); /* Draw pointer without high resolution */ GUI_AA_DisableHiRes(); GUI_RotatePolygon(Param.aPoints, aPointer, countof(aPointer), Angle); GUI_MEMDEV_DrawAuto(&aAuto[1], &Param.AutoInfo, Draw, &Param); GUI_Delay(2); } }
}
/*******************************************************************
*
*
main
*
********************************************************************
*/
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
901
void main(void) { GUI_Init(); ShowHiresAntialiasing();
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
902
CHAPTER
Antialiasing
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
903
Chapter 28 Language Support
Text written in a language like Arabic, Thai or Chinese contains characters, which are normally not part of the fonts shipped with emWin. This chapter explains the basics like the Unicode standard, which defines all available characters worldwide and the UTF-8 encoding scheme, which is used by emWin to decode text with Unicode characters. It also explains how to enable Arabic language support and how to render text with Shift-JIS (Japanese Industry Standard) encoding.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
904
CHAPTER
Language Support
28.1 Unicode
Unicode is an international standard defined by the Unicode consortium. For each meaningful character or text element of all known cultures it contains a unique digital code point. Further it contains the bidirectional algorithm for right-to-left scripts like Hebrew and Arabic, which are also supported by emWin. The Unicode Standard defines a codespace of 1,114,112 code points in the range from 0 to 0x10FFFF containing a repertoire of more than 110,000 characters covering more than 100 scripts. This codespace is divided into seventeen planes, numbered 0 to 16. emWin supports here the complete 'Basic Multilingual Plane' (BMP, plane 0) which covers the code points from 0x0000 to 0xFFFF. This BMP contains characters for almost all modern languages, and a large number of special characters. Characters outside the BMP are currently not supported.
28.1.1 UTF-8 encoding
ISO/IEC 10646-1 defines a multi-octet character set called the Universal Character Set (UCS) which encompasses most of the world's writing systems. Multi-octet characters, however, are not compatible with many current applications and protocols, and this has led to the development of a few UCS transformation formats (UTF), each with different characteristics. UTF-8 has the characteristic of preserving the full ASCII range, providing compatibility with file systems, parsers and other software that rely on ASCII values but are transparent to other values. In emWin, UTF-8 characters are encoded using sequences of 1 to 3 octets. If the high-order bit is set to 0, the remaining 7 bits being used to encode the character value. In a sequence of n octets, n>1, the initial octet has the n higher-order bits set to 1, followed by a bit set to 0. The remaining bit(s) of that octet contain bits from the value of the character to be encoded. The following octet(s) all have the higherorder bit set to 1 and the following bit set to 0, leaving 6 bits in each to contain bits from the character to be encoded. The following table shows the encoding ranges:
Character range 0000 - 007F 0080 - 07FF 0800 - FFFF
UTF-8 Octet sequence 0xxxxxxx 110xxxxx 10xxxxxx 1110xxxx 10xxxxxx 10xxxxxx
Encoding example
The text "Halöle" contains ASCII characters and European extensions. The following hex dump shows this text as UTF-8 encoded text:
48 61 6C C3 B6 6C 65
Programming examples
If we want to display a text containing non-ASCII characters, we can do this by manually computing the UTF-8 codes for the non-ASCII characters in the string. However, if your compiler supports UTF-8 encoding (Sometimes called multi-byte encoding), even non-ASCII characters can be used directly in strings.
//
// Example using ASCII encoding:
//
GUI_UC_SetEncodeUTF8();
/* required only once to activate UTF-8*/
GUI_DispString("Hal\xc3\xb6le");
//
// Example using UTF-8 encoding:
//
GUI_UC_SetEncodeUTF8();
/* required only once to activate UTF-8*/
GUI_DispString("Halöle");
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
905
28.1.2 Unicode characters
The character output routine used by emWin (GUI_DispChar()) does always take an unsigned 16-bit value (U16) and has the basic ability to display a character defined by Unicode. It simply requires a font which contains the character you want to display.
28.1.3 UTF-8 strings
This is the most recommended way to display Unicode. You do not have to use special functions to do so. If UTF-8-encoding is enabled each function of emWin which handles with strings decodes the given text as UTF-8 text.
28.1.3.1 Using U2C.exe to convert UTF-8 text into C code
The Tool subdirectory of emWin contains the tool U2C.exe to convert UTF-8 text to C code. It reads an UTF-8 text file and creates a C file with C strings. The following steps show how to convert a text file into C strings and how to display them with emWin:
Step 1: Creating a UTF-8 text file
Save the text to be converted in UTF-8 format. You can use Notepad.exe to do this. Load the text under Notepad.exe:
Choose "File/Save As...". The file dialog should contain a combo box to set the encoding format. Choose "UTF-8" and save the text file.
Step 2: Converting the text file into a C-code file
Start U2C.exe. After starting the program you need to select the text file to be converted. After selecting the text file the name of the C file should be selected. Output of U2C.exe: "Japanese:" "1 - \xe3\x82\xa8\xe3\x83\xb3\xe3\x82\xb3\xe3\x83\xbc
"\xe3\x83\x87\xe3\x82\xa3\xe3\x83\xb3\xe3\x82\xb0" "2 - \xe3\x83\x86\xe3\x82\xad\xe3\x82\xb9\xe3\x83\x88" "3 - \xe3\x82\xb5\xe3\x83\x9d\xe3\x83\xbc\xe3\x83\x88" "English:" "1 - encoding" "2 - text" "3 - support"
Step 3: Using the output in the application code
The following example shows how to display the UTF-8 text with emWin:
#include "GUI.h"
static const char * _apStrings[] = { "Japanese:", "1 - \xe3\x82\xa8\xe3\x83\xb3\xe3\x82\xb3\xe3\x83\xbc" "\xe3\x83\x87\xe3\x82\xa3\xe3\x83\xb3\xe3\x82\xb0", "2 - \xe3\x83\x86\xe3\x82\xad\xe3\x82\xb9\xe3\x83\x88", "3 - \xe3\x82\xb5\xe3\x83\x9d\xe3\x83\xbc\xe3\x83\x88", "English:", "1 - encoding", "2 - text", "3 - support"
};
void MainTask(void) { int i; GUI_Init(); GUI_SetFont(&GUI_Font16_1HK); GUI_UC_SetEncodeUTF8();
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
906
CHAPTER
Language Support
for (i = 0; i < GUI_COUNTOF(_apStrings); i++) { GUI_DispString(_apStrings[i]); GUI_DispNextLine();
} while(1) {
GUI_Delay(500); } }
28.1.4 Unicode API
The table below lists the available routines in alphabetical order within their respective categories. Detailed descriptions of the routines can be found in the sections that follow.
Routine
GUI_UC_ConvertUC2UTF8() GUI_UC_ConvertUTF82UC() GUI_UC_EnableBIDI() GUI_UC_Encode() GUI_UC_GetCharCode() GUI_UC_GetCharSize() GUI_UC_SetEncodeNone() GUI_UC_SetEncodeUTF8()
GUI_UC_DispString()
Description UTF-8 functions
Converts a Unicode string into UTF-8 format. Converts a UTF-8 string into Unicode format. Enables/Disables the support for bidirectional fonts. Encodes the given character with the current encoding. Returns the decoded character. Returns the number of bytes used to encode the given character. Disables encoding. Enables UTF-8 encoding.
Double byte functions
Displays a double byte string.
28.1.4.1 UTF-8 functions
GUI_UC_ConvertUC2UTF8()
Description
Converts the given double byte Unicode string into UTF-8 format.
Prototype
int GUI_UC_ConvertUC2UTF8(const U16 GUI_UNI_PTR * s, int Len, char * pBuffer, int BufferSize);
Parameter
Description
s
Pointer to Unicode string to be converted.
Len
Number of Unicode characters to be converted.
pBuffer
Pointer to a buffer to write in the result.
BufferSize Buffer size in bytes.
Return value
The function returns the number of bytes written to the buffer.
Additional information
UTF-8 encoded characters can use up to 3 bytes. To be on the save side the recommended buffer size is: Number of Unicode characters * 3. If the buffer is not big enough for the whole result, the function returns when the buffer is full.
GUI_UC_ConvertUTF82UC()
Description
Converts the given UTF-8 string into Unicode format.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
907
Prototype
int GUI_UC_ConvertUTF82UC(const char GUI_UNI_PTR * s, int Len, U16 * pBuffer, int BufferSize);
Parameter
Description
s
Pointer to UFT-8 string to be converted.
Len
Length in bytes of the string to be converted.
pBuffer
Pointer to a buffer to write in the result.
BufferSize Buffer size in words.
Return value
The function returns the number of Unicode characters written to the buffer.
Additional information
If the buffer is not big enough for the whole result, the function returns when the buffer is full.
GUI_UC_EnableBIDI()
Description
This function enables support for bidirectional text.
Prototype
int GUI_UC_EnableBIDI(int OnOff);
Parameter
Description
OnOff
1 to enable BIDI support, 2 to disable it.
Return value
The previous state of BIDI support.
Additional information
Once this function is linked approximately 60 KBytes of ROM are additionally used.
GUI_UC_Encode()
Description
This function encodes a given character with the current encoding settings.
Prototype
int GUI_UC_Encode(char* s, U16 Char);
Parameter s Char
Description
Pointer to a buffer to store the encoded character. Character to be encoded.
Return value
The number of bytes stored to the buffer.
Additional information
The function assumes that the buffer has at least 3 bytes for the result.
GUI_UC_GetCharCode()
Description
This function decodes a character from a given text.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
908
CHAPTER
Language Support
Prototype
U16 GUI_UC_GetCharCode(const char* s);
Parameter
Description
s
Pointer to the text to be encoded.
Return value
The encoded character.
Related topics
GUI_UC_GetCharSize()
GUI_UC_GetCharSize()
Description
This function returns the number of bytes used to encode the given character.
Prototype
int GUI_UC_GetCharSize(const char* s);
Parameter
Description
s
Pointer to the text to be encoded.
Return value
Number of bytes used to encode the given character
Additional information
This function is used to determine how much bytes a pointer has to be incremented to point to the next character. The following example shows how to use the function:
static void _Display2Characters(const char * pText) {
int Size;
U16 Character;
Size = GUI_UC_GetCharSize(pText);
/* Size to increment pointer */
Character = GUI_UC_GetCharCode(pText); /* Get first character code */
GUI_DispChar(Character);
/* Display first character */
pText += Size;
/* Increment pointer */
Character = GUI_UC_GetCharCode(pText); /* Get next character code */
GUI_DispChar(Character);
/* Display second character */
}
GUI_UC_SetEncodeNone()
Description
Disables character encoding.
Prototype
void GUI_UC_SetEncodeNone(void);
Additional information
After calling this function each byte of a text will be handled as one character. This is the default behavior of emWin.
GUI_UC_SetEncodeUTF8()
Description
Enables UTF-8 encoding.
Prototype
void GUI_UC_SetEncodeUTF8(void);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
909
Additional information
After calling GUI_UC_SetEncodeUTF8 each string related routine of emWin encodes a given sting in accordance to the UTF-8 transformation.
28.1.4.2 Double byte functions
GUI_UC_DispString()
Description
This function displays the given double byte string.
Prototype
void GUI_UC_DispString(const U16 GUI_FAR *s);
Parameter
s
Pointer to double byte string.
Description
Additional information
If you need to display double byte strings you should use this function. Each character has to be defined by a 16 bit value.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
910
CHAPTER
Language Support
28.2 Text- and language resource files
To be able to change the text of an application without modifying one line of code the text- and language resource file API functions can be used. They offer the possibility to use one or more simple text files or one CSV (Comma Separated Value) file containing text in multiple languages. These files can reside in addressable RAM or at any non addressable medium like NAND flash or a file system.
28.2.1 Unicode support
If the used range of characters exceeds the ASCII set the text files should contain UTF-8 text. Other encodings like UC16 are not supported by this module.
28.2.2 Loading files from RAM
When using the files directly from RAM emWin does not allocate the required strings again. It uses the RAM location of the files directly. But because text- and CSV files do not contain zero delimited strings, emWin first have to modify the given text slightly by replacing the line delimiters (CRLF) of text files or the field delimiters of CSV files by a zero byte. Because of that the files have to reside in RAM and not in ROM.
28.2.3 Loading files from non addressable areas
It is also possible to use the files from non addressable areas or any other location in ROM. In these cases emWin uses a GetData function for getting the file data. In the first step (GUI_LANG_LoadTextEx(), GUI_LANG_LoadCSVEx()) emWin only remembers size and file offset of the text locations within the files. Only when accessing the text with GUI_LANG_GetText() the text will be allocated in RAM, read from the file and converted in a legal zero delimited string.
28.2.4 Rules for CSV files
Because the term 'CSV file' does not exactly determines the file format, here are the rules which have to be observed: · Each record is located on a separate line, delimited by a line break (CRLF). · The last record in the file may or may not have an ending line break. · Within each record, there may be one or more fields, separated by delimiters.
Each line should contain the same number of fields throughout the file. Spaces are considered part of a field. The last field in the record must not be followed by a delimiter. · Default field delimiter is a comma. This may be changed using the function GUI_LANG_SetSep(). · Each field may or may not be enclosed in double quotes. If fields are not enclosed with double quotes, then double quotes may not appear inside the fields. · Fields containing line breaks (CRLF), double quotes, and commas should be enclosed in double-quotes. · If double-quotes are used to enclose fields, then a double-quote appearing inside a field must be escaped by preceding it with another double quote.
28.2.5 Rules for text files
A text file is a simple file where each line contains one text element. Rules to be observed: · Each line contains one text item. · Each line must be delimited by a line break (CRLF). · Text items containing line breaks are not supported.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
911
28.2.6 Text- and language resource file API
The table below shows the available routines in alphabetical order. Detailed descriptions of the routines follow.
Routine
Description
Text file functions
GUI_LANG_LoadText()
Loads a simple text file from RAM.
GUI_LANG_LoadTextEx()
Loads a simple text file from a non addressable area.
CSV file functions
GUI_LANG_LoadCSV()
Loads a CSV file from RAM.
GUI_LANG_LoadCSVEx()
Loads a CSV file from a non addressable area.
Common functions
GUI_LANG_GetNumItems() GUI_LANG_GetText() GUI_LANG_GetTextBuffered() GUI_LANG_GetTextBufferedEx() GUI_LANG_GetTextEx()
Returns the number of items available for the given language.
Returns a pointer to the requested text in the current language. Copies the requested text of the current language into the given buffer. Copies the requested text of the given language into the given buffer.
Returns a pointer to the requested text.
GUI_LANG_SetLang()
Sets the current language.
GUI_LANG_SetMaxNumLang()
Sets the maximum of available languages. Default is 10.
GUI_LANG_SetSep()
Sets the separator to be used for reading CSV files.
GUI_LANG_LoadText()
Description
Loads a text file from a RAM location.
Prototype
int GUI_LANG_LoadText(char * pFileData, U32 FileSize, int IndexLang);
Parameter pFileData FileSize IndexLang
Description
Pointer to the first byte of the file. Size of the given file in bytes. Index of the language.
Additional information
The given file needs to reside in RAM. As explained at the beginning of the chapter emWin converts the given text items into zero delimited strings.
GUI_LANG_LoadTextEx()
Description
Loads a text file using the given GetData function from any area.
Prototype
int GUI_LANG_LoadTextEx(GUI_GET_DATA_FUNC * pfGetData, void * p, int IndexLang);
Parameter pfGetData p IndexLang
Description
Pointer to a _GetData() function to be used for file access. Pointer passed to the _GetData() function. Index of the language.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
912
CHAPTER
Language Support
Additional information
Data is accessed by the given GetData function. The pointer p can be used by the application.
Prototype of the 'GetData' function
int GUI_GET_DATA_FUNC(void * p, const U8 ** ppData, unsigned NumBytesReq, U32 Off);
Parameter p ppData NumBytesReq Off
Description
Application defined void pointer. The location the pointer points to has to be filled by the 'GetData' function. Number of requested bytes. Offset to be used to address the requested bytes within the file.
Sample
The following shows a sample implementation of the GetData function for WIN32:
static int _GetData(void * pVoid, const U8 ** ppData, unsigned NumBytes, U32 Off) { DWORD NumBytesRead; HANDLE hFile; U8 * pData;
pData = (U8 *)*ppData; hFile = *(HANDLE *)pVoid; if (SetFilePointer(hFile, Off, 0, FILE_BEGIN) == 0xFFFFFFFF) {
return 0; } if (!ReadFile(hFile, pData, NumBytes, &NumBytesRead, 0)) {
return 0; } if (NumBytesRead != NumBytes) {
return 0; } return NumBytesRead; }
GUI_LANG_LoadCSV()
Description
Loads a CSV file from a RAM location.
Prototype
int GUI_LANG_LoadCSV(char * pFileData, U32 FileSize);
Parameter pFileData FileSize
Description
Pointer to the first byte of the file. Size of the given file in bytes.
Return value
The function returns the number of available languages of the given file.
Additional information
The given file needs to reside in RAM. As explained at the beginning of the chapter emWin converts the given text items into zero delimited strings. This function call first deletes all existing text resources. It is not possible to use a text file for one language and then a CSV file for further languages. Either text files or CSV files should be used.
GUI_LANG_LoadCSVEx()
Description
Loads a CSV file from any location by using a GetData function.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
913
Prototype
int GUI_LANG_LoadCSVEx(GUI_GET_DATA_FUNC * pfGetData, void * p);
Parameter pfGetData p
Description
Pointer to a _GetData() function to be used for file access. Pointer passed to the _GetData() function.
Return value
The function returns the number of available languages.
Additional information
The given file needs to reside in RAM. As explained at the beginning of the chapter emWin converts the given text items into zero delimited strings. This function call first deletes all existing text resources. It is not possible to use a text file for one language and then a CSV file for further languages. Either text files or CSV files should be used.
GUI_LANG_GetNumItems()
Description
Returns the number of available text items of the given language.
Prototype
int GUI_LANG_GetNumItems(int IndexLang);
Parameter IndexLang
Index of the given language.
Description
Return value
Number of available text items of the giben language.
GUI_LANG_GetText()
Description
Returns a pointer to the requested text item of the current language.
Prototype
const char * GUI_LANG_GetText(int IndexText);
Parameter IndexText
Description
Index of the text item to be returned.
Return value
Pointer to the requested text item.
Additional information
If a GetData function is used, the first time a text item is requested it will be allocated, read and converted once. In case of using a GetData function this could save memory if not all text items are used by the application.
GUI_LANG_GetTextBuffered()
Description
Copies the requested text of the current language into the given buffer.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
914
CHAPTER
Language Support
Prototype
int GUI_LANG_GetTextBuffered(int IndexText, char * pBuffer, int SizeOfBuffer);
Parameter
Description
IndexText pBuffer SizeOfBuffer
Index of the text item to be returned. Pointer to an application defined buffer. Size of the application defined buffer.
Return value
0, on success. 1, if the text could not be found.
GUI_LANG_GetTextBufferedEx()
Description
Copies the requested text of the given language into the given buffer.
Prototype
int GUI_LANG_GetTextBufferedEx(int IndexText, int IndexLang, char * pBuffer, int SizeOfBuffer);
Parameter
Description
IndexText
Index of the text item to be returned.
IndexLang pBuffer
Index of the language. Pointer to an application defined buffer.
SizeOfBuffer Size of the application defined buffer.
Return value
0, on success. 1, if the text could not be found.
GUI_LANG_GetTextEx()
Description
Returns a pointer to the requested text item.
Prototype
const char * GUI_LANG_GetTextEx(int IndexText, int IndexLang);
Parameter IndexText IndexLang
Description
Index of the text item to be returned. Index of the requested language.
Return value
Pointer to the requested text item.
Additional information
If a GetData function is used, the first time a text item is requested it will be allocated, read and converted once. In case of using a GetData function this could save memory if not all text items are used by the application.
GUI_LANG_SetLang()
Description
Sets the language to be used by the function GUI_LANG_GetText().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
915
Prototype
int GUI_LANG_SetLang(int IndexLang);
Parameter IndexLang
Description
Index of the language to be used.
Return value
Previous index of the language.
GUI_LANG_SetMaxNumLang()
Description
Sets the maximum number of languages to be used.
Prototype
unsigned GUI_LANG_SetMaxNumLang(unsigned MaxNumLang);
Parameter MaxNumLang Maximum number of languages
Description
Return value
Previous maximum number of languages.
Additional information
This function has to be called before any other function of the language module is called. A good place for the function call would be GUI_X_Config().
GUI_LANG_SetSep()
Description
Sets the separator to be used when reading a CSV file.
Prototype
U16 GUI_LANG_SetSep(U16 Sep);
Parameter
Description
Sep
Separator to be used for CSV files.
Return value
Previously used separator.
Additional information
The default separator is a comma. Some applications use TABs or semicolons as separator. This function can be used to change the separator. It does not check if the given separator makes sense. So it is the applications responsibility to set the right value. The function has no effect on reading text files.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
916
28.3 Arabic support
CHAPTER
Language Support
The basic difference between western languages and Arabic is, that Arabic scripts are written from the right to the left and that it does not know uppercase and lowercase characters. Further the character codes of the text are not identical with the character index in the font file used to render the character, because the notation forms of the characters depend on the positions in the text.
28.3.1 Notation forms
The Arabic base character set is defined in the Unicode standard within the range from 0x0600 to 0x06FF. Unfortunately these character codes can not directly be used to get the character of the font for drawing it, because the notation form depends on the character position in the text. One character can have up to 4 different notation forms:
· One, if it is at the beginning of a word (initial) · One, if it is at the end of a word (final) · One, if it is in the middle of a word (medial) · One, if the character stands alone (isolated)
But not each character is allowed to be joined to the left and to the right (doublejoined). The character 'Hamza' for example always needs to be separated and 'Alef' is only allowed at the end or separated. Character combinations of the letters 'Lam' and 'Alef' should be transformed to a 'Ligature'. This means one character substitutionally for the combination of 'Lam' and 'Alef'. The above explanation shows, that the notation form is normally not identically with the character code of the text. The following table shows how emWin transforms the characters to the notation form in dependence of the text position:
Base 0x0621 0x0622 0x0623 0x0624 0x0625 0x0626 0x0627 0x0628 0x0629 0x062A 0x062B 0x062C 0x062D 0x062E 0x062F 0x0630 0x0631 0x0632
Isolated Final 0xFE80 0xFE81 0xFE82 0xFE83 0xFE84 0xFE85 0xFE86 0xFE87 0xFE88 0xFE89 0xFE8A 0xFE8D 0xFE8E 0xFE8F 0xFE90 0xFE93 0xFE94 0xFE95 0xFE96 0xFE99 0xFE9A 0xFE9D 0xFE9E 0xFEA1 0xFEA2 0xFEA5 0xFEA6 0xFEA9 0xFEAA 0xFEAB 0xFEAC 0xFEAD 0xFEAE 0xFEAF 0xFEB0
Initial 0xFE8B 0xFE91 0xFE97 0xFE9B 0xFE9F 0xFEA3 0xFEA7 -
Medial 0xFE8C 0xFE92 0xFE98 0xFE9C 0xFEA0 0xFEA4 0xFEA8 -
Character Hamza Alef with Madda above Alef with Hamza above Waw with Hamza above Alef with Hamza below Yeh with Hamza above Alef Beh Teh Marbuta Teh Theh Jeem Hah Khah Dal Thal Reh Zain
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
917
Base 0x0633 0x0634 0x0635 0x0636 0x0637 0x0638 0x0639 0x063A 0x0641 0x0642 0x0643 0x0644 0x0645 0x0646 0x0647 0x0648 0x0649 0x064A 0x067E 0x0686 0x0698 0x06A9 0x06AF 0x06CC
Isolated Final
0xFEB1 0xFEB2
0xFEB5 0xFEB6
0xFEB9 0xFEBA
0xFEBD 0xFEBE
0xFEC1 0xFEC2
0xFEC5 0xFEC9 0xFECD
0xFEC6 0xFECA 0xFECE
0xFED1 0xFED2
0xFED5 0xFED6
0xFED9 0xFEDA
0xFEDD 0xFEDE
0xFEE1 0xFEE2
0xFEE5 0xFEE6
0xFEE9 0xFEED 0xFEEF
0xFEEA 0xFEEE 0xFEF0
0xFEF1 0xFEF2
0xFB56 0xFB57
0xFB7A 0xFB7B
0xFB8A 0xFB8B
0xFB8E 0xFB8F
0xFB92 0xFBFC
0xFB93 0xFBFD
Initial 0xFEB3 0xFEB7 0xFEBB 0xFEBF 0xFEC3 0xFEC7 0xFECB 0xFECF 0xFED3 0xFED7 0xFEDB 0xFEDF 0xFEE3 0xFEE7 0xFEEB 0xFEF3 0xFB58 0xFB7C 0xFB90 0xFB94 0xFBFE
Medial 0xFEB4 0xFEB8 0xFEBC 0xFEC0 0xFEC4 0xFEC8 0xFECC 0xFED0 0xFED4 0xFED8 0xFEDC 0xFEE0 0xFEE4 0xFEE8 0xFEEC 0xFEF4 0xFB59 0xFB7D 0xFB91 0xFB95 0xFBFF
Character Seen Sheen Sad Dad Tah Zah Ain Ghain Feh Qaf Kaf Lam Meem Noon Heh Waw Alef Maksura Yeh Peh Tcheh Jeh Keheh Gaf Farsi Yeh
28.3.2 Ligatures
Character combinations of 'Lam' and 'Alef' needs to be transformed to ligatures. The following table shows how emWin transforms these combinations into ligatures, if the first letter is a 'Lam' (code 0x0644):
Second letter 0x622, Alef with Madda above 0x623, Alef with Hamza above 0x625, Alef with Hamza below 0x627, Alef
Ligature (final) 0xFEF6 0xFEF8 0xFEFA 0xFEFC
Ligature (elsewhere) 0xFEF5 0xFEF7 0xFEF9 0xFEFB
28.3.3 Bidirectional text alignment
As mentioned above Arabic is written from the right to the left (RTL). But if for example the Arabic text contains numbers build of more than one digit these numbers should be written from left to right. And if Arabic text is mixed with European text a couple of further rules need to be followed to get the right visual alignment of the text. The Unicode consortium has defined these rules in the Unicode standard. If bidirectional text support is enabled, emWin follows up most of these rules to get the right visual order before drawing the text. emWin also supports mirroring of neutral characters in RTL aligned text. This is important if for example Arabic text contains parenthesis. The mirroring is done by replacing the code of the character to be mirrored with the code of a mirror partner whose image fits to the mirrored image. This is done by a fast way using a table containing all characters with existing mirror partners. Note that support for mirroring further characters is not supported.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
918
CHAPTER
Language Support
The following example shows how bidirectional text is rendered by emWin:
UTF-8 text
Rendering
\xd8\xb9\xd9\x84\xd8\xa7 1, 2, 345 \xd8\xba\xd9\x86\xd9\x8a XYZ \xd8\xa3\xd9\x86\xd8\xa7
28.3.4 Requirements
Arabic support is part of the emWin basic package. emWin standard fonts do not contain Arabic characters. Font files containing Arabic characters can be created using the Font Converter.
Memory
The bidirectional text alignment and Arabic character transformation uses app. 60 KB of ROM and app. 800 bytes of additional stack.
28.3.5 How to enable Arabic support
Per default emWin writes text always from the left to the right and there will be no Arabic character transformation as described above. To enable support for bidirectional text and Arabic character transformation, add the following line to your application:
GUI_UC_EnableBIDI(1);
If enabled, emWin follows the rules of the bidirectional algorithm, described by the Unicode consortium, to get the right visual order before drawing text.
28.3.6 Example
The Sample folder contains the example FONT_Arabic, which shows how to draw Arabic text. It contains an emWin font with Arabic characters and some small Arabic text examples.
28.3.7 Font files used with Arabic text
Font files used to render Arabic text need to include at least all characters defined in the 'Arabic' range 0x600-0x6FF and the notation forms and ligatures listed in the tables of this chapter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
919
28.4 Thai language support
The Thai alphabet uses 44 consonants and 15 basic vowel characters. These are horizontally placed, left to right, with no intervening space, to form syllables, words, and sentences. Vowels are written above, below, before, or after the consonant they modify, although the consonant always sounds first when the syllable is spoken. The vowel characters (and a few consonants) can be combined in various ways to produce numerous compound vowels (diphthongs and triphthongs).
28.4.1 Requirements
As explained above the Thai language makes an extensive usage of compound characters. To be able to draw compound characters in emWin, a new font type is needed, which contains all required character information like the image size, image position and cursor incrementation value. From version 4.00 emWin supports a new font type with this information. This also means that older font types can not be used to draw Thai text. Note that the standard fonts of emWin does not contain font files with Thai characters. To create a Thai font file, the Font Converter of version 3.04 or newer is required.
Memory
The Thai language support needs no additional ROM or RAM.
28.4.2 How to enable Thai support
Thai support does not need to be enabled by a configuration switch. The only thing required to draw Thai text is a font file of type 'Extended' created with the Font Converter from version 3.04 or newer.
28.4.3 Example
The Sample folder contains the example FONT_ThaiText.c, which shows how to draw Thai text. It contains an emWin font with Thai characters and some small Thai text examples.
28.4.4 Font files used with Thai text
Font files used to render Thai text need to include at least all characters defined in the 'Thai' range 0xE00-0xE7F.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
920
CHAPTER
Language Support
28.5 Shift JIS support
Shift JIS (Japanese Industry Standard) is a character encoding method for the Japanese language. It is the most common Japanese encoding method. Shift JIS encoding makes generous use of 8-bit characters, and the value of the first byte is used to distinguish single- and multiple-byte characters. The Shift JIS support of emWin is only needed if text with Shift JIS encoding needs to be rendered. You need no special function calls to draw a Shift JIS string. The main requirement is a font file which contains the Shift JIS characters.
28.5.1 Creating Shift JIS fonts
The Font Converter can generate a Shift JIS font for emWin from any Windows font. When using a Shift JIS font, the functions used to display Shift JIS characters are linked automatically with the library. Detailed information on how to create Shift-JIS fonts and implement them in a project can be found in the chapter "Font Converter" on page 243.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
921
Chapter 29
Display drivers
A display driver supports a particular family of display controllers and all displays which are connected to one or more of these controllers. The drivers can be configured by modifying their configuration files whereas the driver itself does not need to be modified. The configuration files contain all required information for the driver including how the hardware is accessed and how the controller(s) are connected to the display. This chapter provides an overview of the display drivers available for emWin. It explains the following in terms of each driver: · Which display controllers can be accessed, as well as supported color depths and
types of interfaces. · RAM requirements. · Driver specific functions. · How to access the hardware. · Special configuration switches. · Special requirements for particular display controllers.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
922
CHAPTER
Display drivers
29.1 Available display drivers
Since emWin V5 the driver interface has changed. Old display drivers, developed for emWin V4 or earlier, are not longer supported. The display driver interface was changed in order to be able to configure drivers at run-time. This was required because emWin is often used as a precompiled library which should not have to be changed when using a different display.
Warning: Creating a precompiled library including the source files of a compiletime configurable driver precludes configurability using the library.
To be able to support as many display controllers as possible in a short period, we migrated some of the older drivers to the new interface. Please note that these migrated display drivers are not completely run-time configurable. Only completely new developed drivers are run-time configurable. See 29.1.2 and following for the listings of all currently available drivers.
29.1.1 Driver file naming convention
All files belonging to the same display driver begin with the name of the driver. So all files called <DriverName>*.* describe the whole driver.
Example
The following files describe the GUIDRV_IST3088 display driver: · GUIDRV_IST3088.c · GUIDRV_IST3088.h · GUIDRV_IST3088_4.c · GUIDRV_IST3088_Private.h · GUIDRV_IST3088_X_4.c
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
923
29.1.2 Run-time configurable drivers
The following table lists the currently available run-time configurable drivers developed for the current interface of emWin:
Driver
GUIDRV_BitPlains GUIDRV_DCache GUIDRV_Dist
GUIDRV_FlexColor
GUIDRV_IST3088 GUIDRV_Lin GUIDRV_S1D13748 GUIDRV_S1D13781 GUIDRV_S1D15G00 GUIDRV_SLin
GUIDRV_SPage
GUIDRV_SSD1926
Supported display controller / Purpose of driver
Supported bits/pixel
This driver can be used for solutions without display controller. It manages separate 'bitplains' for each color bit. Initially it has been developed to support a solution for an R32C/111 which drives a TFT display without display controller. It can be used for each solution which requires the color bits in separate plains.
Cache driver for managing a double cache. It manages the cache data separately from the driver and converts the data line by line immediately before a drawing operation is required. This driver makes it possible to use for example a 16bpp display driver in 1bpp mode with a cache which only requires 1 bit per pixel.
This driver supports displays with multiple controllers
Epson S1D19122 FocalTech FT1509 Himax HX8301, HX8340, HX8347, HX8352, HX8353, HX8325A Hitachi HD66772 Ilitek ILI9220, ILI9221, ILI9320, ILI9325, ILI9328, ILI9335,
ILI9338, ILI9340, ILI9341, ILI9342, ILI9481 LG Electronics LGDP4531, LGDP4551 Novatek NT39122 OriseTech SPFD5408, SPFD54124C, SPFD5414D Renesas R61505, R61516, R61526, R61580 Samsung S6D0117, S6E63D6 Sitronix ST7628, ST7637, ST7687, ST7712, ST7735 Solomon SSD1355, SSD1961, SSD1963, SSD2119 Syncoam SEPS525
Integrated Solutions Technology IST3088, IST3257
This driver supports every display controller with linear addressable video memory with a direct (full bus) interface. This means that the video RAM is directly addressable by the address lines of the CPU. The driver contains no controller specific code. So it can also be used for solutions without display controller which require a driver which only manages the video RAM.
Epson S1D13748
Epson S1D13781
Epson S1D15G00
Epson S1D13700, S1D13305 (indirect interface only!) Solomon SSD1848 Toshiba T6963 UltraChip UC1617
Epson S1D15E05, S1D15E06, S1D15605, S1D15606, S1D15607, S1D15608, S1D15705, S1D15710, S1D15714, S1D15719, S1D15721
Integrated Solutions Technology IST3020 New Japan Radio Company NJU6676 Novatek NT7502, NT7534, NT7538, NT75451 Samsung S6B0719, S6B0713, S6B0724, S6B1713 Sino Wealth SH1101A Sitronix ST7522, ST7565, ST7567, ST7591 Solomon SSD1805, SSD1303, SSD1815 Sunplus SPLC501C UltraChip UC1601, UC1606, UC1608, UC1611, UC1701
Solomon SSD1926
1 - 8
1 (could be enhanced on demand) Depends on the actual display drivers.
16, 18
4 1, 2, 4, 8, 16, 24, 32 16 8 12 1, 2
1, 2, 4
8
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
924
CHAPTER
Display drivers
29.1.3 Compile-time configurable drivers
The following table lists the currently available drivers which has already been migrated to the current version of emWin:
Driver
GUIDRV_CompactColor_16
GUIDRV_Fujitsu_16
GUIDRV_Page1bpp
GUIDRV_07X1 GUIDRV_1611 GUIDRV_6331 GUIDRV_7529
Supported display controller / Purpose of driver
Ampire FSA506 Epson S1D13742, S1D13743, S1D19122 FocalTech FT1509 Himax HX8301, HX8312A, HX8325A, HX8340, HX8347,
HX8352, HX8352B, HX8353 Hitachi HD66766, HD66772, HD66789 Ilitek ILI9161, ILI9220, ILI9221, ILI9320, ILI9325,
ILI9326, ILI9328, ILI9342, ILI9481 LG Electronics LGDP4531, LGDP4551 MagnaChip D54E4PA7551 Novatek NT39122, NT7573 OriseTech SPFD5408, SPFD54124C, SPFD5414D,
SPFD5420A Renesas R61505, R61509, R61516, R61526, R61580,
R63401 Samsung S6D0110A, S6D0117, S6D0129, S6D04H0 Sharp LCY-A06003, LR38825 Sitronix ST7628, ST7637, ST7712, ST7715, ST7735,
ST7787 Solomon SSD1284, SSD1289, SSD1298, SSD1355,
SSD1961, SSD1963, SSD2119 Toshiba JBT6K71
Fujitsu MB87J2020 (Jasmine) Fujitsu MB87J2120 (Lavender)
Epson S1D10605, S1D15605, S1D15705, S1D15710, S1D15714, S1D15721, S1D15E05, S1D15E06, SED1520, SED1560, SED1565, SED1566, SED1567, SED1568, SED1569, SED1575
Hitachi HD61202 IST IST3020 New Japan Radio Company NJU6676, NJU6679 Novatek NT7502, NT7534, NT7538, NT75451 Philips PCF8810, PCF8811, PCF8535, PCD8544 Samsung KS0108B, KS0713, KS0724, S6B0108B,
S6B0713, S6B0719, S6B0724, S6B1713 Sino Wealth SH1101A Sitronix ST7522, ST7565, ST7567 Solomon SSD1303, SSD1805, SSD1815, SSD1821 ST Microelectronics ST7548, STE2001, STE2002 Sunplus SPLC501C UltraChip UC1601, UC1606, UC1608, UC1701
Novatek NT7506, NT7508 Samsung KS0711, KS0741, S6B0711, S6B0741 Sitronix ST7541, ST7571 Solomon SSD1854 ST Microelectronics STE2010 Tomato TL0350A
Epson S1D15719, S1D15E05, S1D15E06 UltraChip UC1610 UltraChip UC1611, UC1611s
Samsung S6B33B0X, S6B33B1X, S6B33B2X
Sitronix ST7529
Supported bits/pixel
16
1, 2, 4, 8, 16
1
2 2 2 4 16 1, 4, 5
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
925
29.1.4 Available, but not yet migrated drivers
The following table lists all drivers, which are currently available, but not have been migrated to the new interface of the current version of emWin:
Driver
GUIDRV_Mem
GUIDRV_MemC
GUIDRV_Noritake GUIDRV_Page4bpp GUIDRV_SLin (*1) GUIDRV_Vesa GUIDRV_Xylon GUIDRV_0323 GUIDRV_1200 GUIDRV_13701 GUIDRV_159A GUIDRV_161620 GUIDRV_1781 GUIDRV_6642X GUIDRV_66750 GUIDRV_7920 GUIDRV_8822
Supported display controller / Purpose of driver
No controller, writes into main memory Requires ISR or special hardware to refresh LCD (monochrome displays) No controller, writes into main memory Requires ISR or special hardware to refresh LCD (color displays) Noritake display GU256X128C-3900 Sitronix ST7528 Epson SED1330, SED1335 RAIO 8822/8803, 8835 Any VESA compatible hardware FPGA based display controller from Xylon Solomon SSD0323 OLED controller Toppoly C0C0, C0E0 Epson S1D13701 OLED controller Epson SED159A Sitronix ST7632 NEC µPD161620 Solomon SSD1768, SSD1781, SSD1783, SSD1797 Hitachi HD66420, HD66421 Hitachi HD66750, HD66753 Sitronix ST7920 Raio RA8822
Supported bits/pixel
1, 2
3, 6
1 4 1 8, 16 8, 16, 32 4 16 9, 12 8 12 16 2 2 1 2
*1: Currently exists a new driver named 'GUIDRV_SLin'. Please note that this driver currently does not support all of the controllers supported by the not yet migrated version of this driver. Support for these controllers can be added in a short period on demand.
29.1.5 Special purpose drivers
The basic package contains 2 drivers which don't support a specific LCD controller. They can be used as template for a new driver or for measurement purpose:
Driver
GUIDRV_Template
LCD Controller
Driver template. Can be used as a starting point for writing a new driver. Part of the basic package
Supported bits/pixel
-
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
926
CHAPTER
Display drivers
29.2 CPU / Display controller interface
Different display controllers can have different CPU interfaces. Basically there are two different interfaces:
· Direct interface · Indirect interface
Whereas the direct interface accesses the video memory directly by the address bus of the CPU, the indirect interface requires a more complex communication with the display controller to get access to the video memory. This can be done by different kinds of connections:
· Parallel access · 4 pin SPI interface · 3 pin SPI interface · I2C bus interface
The following explains these interfaces and how to configure them. Note that not all configuration macros are always required. For details about which macros are required, refer to "Detailed display driver descriptions" on page 939.
29.2.1 Direct interface
Some display controllers (especially those for displays with higher resolution) require a full address bus, which means they are connected to at least 14 address bits. In a direct interface configuration, video memory is directly accessible by the CPU; the address bus is connected to the display controller. The only knowledge required when configuring a direct interface is information about the address range (which will generate a CHIP-SELECT signal for the LCD controller) and whether 8-, 16- or 32-bit accesses should be used (bus-width to the display controller). In other words, you need to know the following:
· Base address for video memory access · Base address for register access · Distance between adjacent video memory locations (usually 1/2/4-byte) · Distance between adjacent register locations (usually 1/2/4-byte) · Type of access (8/16/32-bit) for video memory · Type of access (8/16/32-bit) for registers
Typical block diagram
CPU
A0...An D0...D7/D15/D31 Control signals
LCD Controller
29.2.2 Indirect interface - Parallel bus
Most controllers for smaller displays use an indirect interface to connect to the CPU. With an indirect interface, only one address bit (usually A0) is connected to the LCD controller. Some of these controllers are very slow, so that the hardware designer may decide to connect it to input/output (I/O) pins instead of the address bus.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
927
Typical block diagram
CPU
A0 D0...D7/D15 Control signals
LCD Controller
8 (16) data bits, one address bit and 2 or 3 control lines are used to connect the CPU and one LCD controller. Four macros inform the LCD driver how to access each controller used. If the LCD controller(s) is connected directly to the address bus of the CPU, configuration is simple and usually consists of no more than one line per macro. If the LCD controller(s) is connected to I/O pins, the bus interface must be simulated, which takes about 5-10 lines of program per macro (or a function call to a routine which simulates the bus interface). The signal A0 is also called C/D (Command/ Data), D/I (Data/Instruction) or RS (Register select), depending on the display controller.
29.2.2.1 Example routines for connection to I/O pins
Examples can be found in the folder Sample\LCD_X:
· LCD_X_6800.c, port routines for the 6800 parallel interface. · LCD_X_8080.c, port routines for the 8080 parallel interface.
29.2.3 Indirect interface - 4 pin SPI
Using a 4 pin SPI interface is very similar to a parallel interface. To connect a LCD display using 4 pin SPI interface the lines A0, CLK, DATA, and CS must be connected to the CPU.
Typical block diagram
A0
CPU
CLK DATA
LCD Controller
CS
29.2.3.1 Example routines for connection to I/O pins
An example can be found in the folder Sample\LCD_X:
· LCD_X_SERIAL.c, port routines for a serial interface
Please note that this sample uses port pins for the communication. This works very slow but on each CPU. This should be optimized by the customer by using the hardware support of the CPU for this kind of communication.
29.2.4 Indirect interface - 3 pin SPI
To connect a LCD display using 4 pin SPI interface the lines CLK, DATA, and CS must be connected to the CPU.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
928
Typical block diagram
CPU
CHAPTER
CLK DATA
CS
Display drivers
LCD Controller
29.2.4.1 Example routines for connection to I/O pins
This interface does not have a separate line for distinguish between data and commands to be transmitted to the display controller. There is no standardized method to manage this. Some controllers use an additional bit for distinguish between data and command, other controllers work different. Examples can be found in the folder Sample\LCD_X:
· LCD_X_Serial_3Pin.c, port routines for a 3 pin serial interface · LCD_X_Serial_3Wire.c, port routines for a 3 pin serial interface
29.2.5 Indirect interface - I2C bus
This kind of interface use only 2 lines and a standardized protocol for the communication with the display controller.
Typical block diagram
CPU
DATA CLK
LCD Controller
29.2.5.1 Example routines for connection to I/O pins
An example can be found in the folder Sample\LCD_X:
· LCD_X_I2CBUS.c, port routines for a I2C bus interface
Similar to the serial communication examples this example uses port lines for the communication which works not very fast. If the CPU support this kind of communication these routines should be optimized by using the hardware functions.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
929
29.3 Hardware interface configuration
The following explains how to configure the hardware communication between display driver and display controller.
29.3.1 Direct interface
The hardware interface configuration of drivers using a direct interface is done by specifying the address of the video memory. Normally the routine LCD_SetVRAMAddrEx() should be used for this. Normally nothing else should be done to enable access to the video memory for the driver. For details please refer to "Display driver API" on page 1008.
29.3.2 Indirect interface
There are 2 kinds of display drivers:
· Run-time configurable drivers · Compile-time configurable drivers
Configuring these kinds of drivers works differently:
· Run-time configuration means the driver can be compiled without being configured. The configuration is done at run-time. This type of driver can still be configured at run-time when placed in a library.
· A compile-time configurable driver requires the configuration in a configuration header file, which is included at compile-time of the driver.
29.3.2.1 Run-time configuration
Run-time configurable drivers do not need to be configured at compile time. So this drivers can be used in a precompiled library. Each driver has its own function(s) for setting up the hardware interface. This is done by passing a pointer to a GUI_PORT_API structure containing function pointers to the hardware routines to be used:
Elements of GUI_PORT_API
Element
pfWrite8_A0 pfWrite8_A1 pfWriteM8_A0 pfWriteM8_A1 pfRead8_A0 pfRead8_A1 pfReadM8_A0
Data type
Description
8 bit interface
void (*)(U8 Data) void (*)(U8 Data) void (*)(U8 * pData, int NumItems) void (*)(U8 * pData, int NumItems) U8 (*)(void) U8 (*)(void) void (*)(U8 * pData, int NumItems)
Pointer to a function which writes one byte to the controller with C/D line low.
Pointer to a function which writes one byte to the controller with C/D line high.
Pointer to a function which writes multiple bytes to the controller with C/D line low.
Pointer to a function which writes multiple bytes to the controller with C/D line high.
Pointer to a function which reads one byte from the controller with C/D line low.
Pointer to a function which reads one byte from the controller with C/D line high.
Pointer to a function which reads multiple bytes from the controller with C/D line low.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
930
CHAPTER
Display drivers
Element
Data type
Description
pfReadM8_A1
Pointer to a function which reads
void (*)(U8 * pData, int NumItems) multiple bytes from the controller
with C/D line high.
16 bit interface
pfWrite16_A0 void (*)(U16 Data)
Pointer to a function which writes one 16 bit value to the controller with C/D line low.
pfWrite16_A1 void (*)(U16 Data)
Pointer to a function which writes one 16 bit value to the controller with C/D line high.
Pointer to a function which writes
pfWriteM16_A0 void (*)(U16 * pData, int NumItems) multiple 16 bit values to the con-
troller with C/D line low.
Pointer to a function which writes
pfWriteM16_A1 void (*)(U16 * pData, int NumItems) multiple 16 bit values to the con-
troller with C/D line high.
pfRead16_A0 U16 (*)(void)
Pointer to a function which reads one 16 bit value from the controller with C/D line low.
pfRead16_A1 U16 (*)(void)
Pointer to a function which reads one 16 bit value from the controller with C/D line high.
pfReadM16_A0
Pointer to a function which reads
void (*)(U16 * pData, int NumItems) multiple 16 bit values from the con-
troller with C/D line low.
pfReadM16_A1
Pointer to a function which reads
void (*)(U16 * pData, int NumItems) multiple 16 bit values from the con-
troller with C/D line high.
32 bit interface
pfWrite32_A0 void (*)(U32 Data)
Pointer to a function which writes one 32 bit value to the controller with C/D line low.
pfWrite32_A1 void (*)(U32 Data)
Pointer to a function which writes one 32 bit value to the controller with C/D line high.
Pointer to a function which writes
pfWriteM32_A0 void (*)(U32 * pData, int NumItems) multiple 32 bit values to the con-
troller with C/D line low.
Pointer to a function which writes
pfWriteM32_A1 void (*)(U32 * pData, int NumItems) multiple 32 bit values to the con-
troller with C/D line high.
pfRead32_A0 U32 (*)(void)
Pointer to a function which reads one 32 bit value from the controller with C/D line low.
pfRead32_A1 U32 (*)(void)
Pointer to a function which reads one 32 bit value from the controller with C/D line high.
pfReadM32_A0
Pointer to a function which reads
void (*)(U32 * pData, int NumItems) multiple 32 bit values from the con-
troller with C/D line low.
pfReadM32_A1
Pointer to a function which reads
void (*)(U32 * pData, int NumItems) multiple 32 bit values from the con-
troller with C/D line high.
SPI interface
pfSetCS
void (*)(U8 NotActive)
Pointer to a function which is able to toggle the CS signal of the controller.
This structure contains function pointers for 8-, 16- and 32 bit access. Not all function pointers are used by each driver. The required functions are listed in the description of the according display driver.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
931
Example
The following shows a configuration example for the driver GUIDRV_SLin. It creates and configures the driver, initializes the required function pointers of the GUI_PORT_API structure and passes them to the driver:
GUI_DEVICE * pDevice; CONFIG_SLIN Config = {0}; GUI_PORT_API PortAPI = {0};
// // Set display driver and color conversion // pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_SLIN_2, GUICC_2, 0, 0); // // Common display driver configuration // LCD_SetSizeEx (0, XSIZE, YSIZE); LCD_SetVSizeEx(0, XSIZE, YSIZE); // // Driver specific configuration // Config.UseCache = 1; GUIDRV_SLin_Config(pDevice, &Config); // // Select display controller // GUIDRV_SLin_SetS1D13700(pDevice); // // Setup hardware access routines // PortAPI.pfWrite16_A0 = _Write0; PortAPI.pfWrite16_A1 = _Write1; PortAPI.pfWriteM16_A0 = _WriteM0; PortAPI.pfRead16_A1 = _Read1; GUIDRV_SLin_SetBus8(pDevice, &PortAPI);
For details please refer to the detailed description of the run-time configurable driver.
29.3.2.2 Compile-time configuration
A compile-time configurable driver requires its configuration in a header file. This configuration file is included when compiling the display driver. The compile-time configurable drivers use distinct macros for accessing the hardware. It depends on the interface details which macros are used. The following shows which macros are used by which kind of interface.
Macros used by an indirect interface
The following table shows the used hardware access macros:
Type
Macro
F
LCD_READ_A0
F
LCD_READ_A1
F
LCD_WRITE_A0
F
LCD_WRITE_A1
F
LCD_WRITEM_A1
Description
Reads a byte from LCD controller with A0 - line low. Reads a byte from LCD controller with A0 - line high. Writes a byte to the display controller with A0 - line low. Writes a byte to the display controller with A0 - line high. Writes several bytes to the LCD controller with A0 - line high.
Macros used by a 4 pin SPI interface
The following table shows the used hardware access macros:
Type
Macro
F
LCD_WRITE_A0
F
LCD_WRITE_A1
F
LCD_WRITEM_A1
Description
Writes a byte to the display controller with A0 (C/D) - line low. Writes a byte to the display controller with A0 (C/D) - line high. Writes several bytes to the LCD controller with A0 (C/D) - line high.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
932
CHAPTER
Display drivers
Macros used by a 3 pin SPI interface
The following table shows the used hardware access macros:
Type
Macro
F
LCD_WRITE
F
LCD_WRITEM
Description
Writes a byte to the display controller. Writes several bytes to the LCD controller.
Macros used by a I2C bus interface
The following table shows the used hardware access macros:
Type
Macro
F
LCD_READ_A0
F
LCD_READ_A1
F
LCD_WRITE_A0
F
LCD_WRITE_A1
F
LCD_WRITEM_A1
Description
Reads a status byte from LCD controller. Reads a data byte from LCD controller. Writes a instruction byte to the display controller. Writes a data byte to the display controller. Writes several data bytes to the LCD controller.
LCD_READ_A0
Description
Reads a byte from LCD controller with A0 (C/D) - line low.
Type
Function replacement
Prototype
#define LCD_READ_A0(Result)
Parameter Result
Description
Result read. This is not a pointer, but a placeholder for the variable in which the value will be stored.
LCD_READ_A1
Description
Reads a byte from LCD controller with A0 (C/D) - line high.
Type
Function replacement
Prototype
#define LCD_READ_A1(Result)
Parameter Result
Description
Result read. This is not a pointer, but a placeholder for the variable in which the value will be stored.
LCD_WRITE_A0
Description
Writes a byte to the display controller with A0 (C/D) - line low.
Type
Function replacement
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
933
Prototype
#define LCD_WRITE_A0(Byte)
Parameter Byte
Byte to write.
Description
LCD_WRITE_A1
Description
Writes a byte to the display controller with A0 (C/D) - line high.
Type
Function replacement
Prototype
#define LCD_WRITE_A1(Byte)
Parameter Byte
Byte to write.
Description
LCD_WRITEM_A1
Description
Writes several bytes to the LCD controller with A0 (C/D) - line high.
Type
Function replacement
Prototype
#define LCD_WRITEM_A1(paBytes, NumberOfBytes)
Parameter
Description
paBytes
Placeholder for the pointer to the first data byte.
NumberOfBytes Number of data bytes to be written.
LCD_WRITE
Description
Writes a byte to the LCD controller.
Type
Function replacement
Prototype
#define LCD_WRITE(Byte)
Parameter Byte
Byte to write.
Description
LCD_WRITEM
Description
Writes several bytes to the LCD controller.
Type
Function replacement
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
934
CHAPTER
Prototype
#define LCD_WRITEM(paBytes, NumberOfBytes)
Parameter
Description
paBytes
Placeholder for the pointer to the first data byte.
NumberOfBytes Number of data bytes to be written.
Display drivers
29.4 Non readable displays
Some display controllers with an indirect interface do not support reading back display data. Especially displays which are connected via SPI interface often have this limitation. In this case we recommend using a display data cache. For details how to enable a display data cache, refer to "Detailed display driver descriptions" on page 939. On systems with a very small RAM it is sometimes not possible to use a display data cache. If a display is not readable and a display data cache can not be used some features of emWin will not work. The list below shows these features:
· Cursors and Sprites · XOR-operations, required for text cursors in EDIT and MULTIEDIT widgets · Alpha blending · Antialiasing
This is valid for all drivers where one data unit (8 or 16 bit) represents one pixel. Display drivers, where one data unit represents more than one pixel, can not be used if no display data cache is available and the display is not readable. An example is the GUIDRV_Page1bpp driver where one byte represents 8 pixels.
29.5 Display orientation
If the original display orientation does not match the requirements, there are different ways to change the display orientation: · Driver based configuration of the desired orientation · Using GUI_SetOrientation()
29.5.1 Driver based configuration of display orientation
If the display driver supports different orientations it is recommended to use the driver for setting up the right orientation. The way how to configure the display orientation then depends on the display driver to be used. Whereas the display orientation of the most common drivers is run-time configurable some drivers need to be configured at compile time.
29.5.1.1 Run-time configuration
The display orientation of the most common driver is determined by creating the display driver device in LCD_X_Config() using the proper macro. Please refer to "GUIDRV_Lin" on page 960 for a listing of all available identifiers to be used to create the driver. It shows all available macros and their respective orientations.
29.5.1.2 Compile-time configuration
The display orientation of some drivers with indirect interface like GUIDRV_CompactColor_16 needs to be configured at compile time in the configuration file of the driver.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
935
Display orientations
There are 8 possible display orientations; the display can be turned 0°, 90°, 180° or 270° and can also be viewed from top or from bottom. The default orientation is 0° and top view. These 4*2 = 8 different display orientations can also be expressed as a combination of 3 binary switches: X-mirroring, Y-mirroring and X/Y swapping. For this purpose, the binary configuration macros listed below can be used with each driver in any combination. If your display is not oriented well, take a look at the config switches in the table below to make it work properly. The orientation is handled as follows: Mirroring in X and Y first, then swapping (if selected).
Display
Orientation macros in driver configuration file
Display
Orientation macros in driver configuration file
No orientation macro required
#define LCD_MIRROR_Y 1
#define LCD_MIRROR_X 1
#define LCD_MIRROR_X 1 #define LCD_MIRROR_Y 1
#define LCD_SWAP_XY 1
#define LCD_SWAP_XY 1 #define LCD_MIRROR_Y 1
#define LCD_SWAP_XY 1 #define LCD_MIRROR_X 1
#define LCD_SWAP_XY 1 #define LCD_MIRROR_X 1 #define LCD_MIRROR_Y 1
For details about how use multiple orientations simultaneously please refer to "Runtime screen rotation" on page 850.
29.5.2 Function based configuration of display orientation
Another possibility to set up the display orientation is to call GUI_SetOrientation(). Using this function is recommended if the display driver can not be used.
GUI_SetOrientation()
Description
This function changes the display orientation by using a rotation device.
Prototype
int GUI_SetOrientation(int Orientation);
Parameter Orientation
Description
See the table below for an overview of valid values.
Resulting display
Value to use for GUI_SetOrientation()
Resulting display
Value to use for GUI_SetOrientation()
0
GUI_MIRROR_Y
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
936
CHAPTER
Display drivers
Resulting display
Value to use for GUI_SetOrientation()
GUI_MIRROR_X
Resulting display
Value to use for GUI_SetOrientation()
GUI_MIRROR_X | GUI_MIRROR_Y
GUI_SWAP_XY
GUI_SWAP_XY | GUI_MIRROR_Y
GUI_SWAP_XY | GUI_MIRROR_X
GUI_SWAP_XY | GUI_MIRROR_X | GUI_MIRROR_Y
Return value
0 on success, 1 on error.
Additional information
The rotation device covers the complete virtual screen within an internal screen buffer. Because of this the use of this function requires additional memory for this additional screen buffer. The number of required bytes can be calculated as follows:
Virtual xSize * Virtual ySize * BytesPerPixel
The number of bytes per pixel is for configurations from 1-8bpp 1, for systems with more than 8bpp up to 16bpp 2 and for systems with more than 16bpp 4. Each drawing operation first updates this buffer. After this the affected pixels are passed to the display driver device.
GUI_SetOrientationEx()
Description
This function changes the orientation in the specified layer by using a rotation device.
Prototype
int GUI_SetOrientation(int Orientation, int LayerIndex);
Parameter Orientation LayerIndex
Description
Refer to "GUI_SetOrientation()" on page 935 for an overview of valid values. Index of the layer which Orientation has to be (re-)configured.
Return value
0 on success, 1 on error.
Additional information
See "GUI_SetOrientation()" on page 935.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
937
29.6 Display driver callback function
A display driver requires a callback function. It is called by the driver for several tasks. One task is putting the display driver into operation which is also explained in the chapter 'Configuration'. It is also called for other tasks which require hardware related operations like switching the display on and off or setting a lookup table entry.
LCD_X_DisplayDriver()
Description
This is the callback function of the display driver. It is called by the display driver for several jobs. It passes a command and a pointer to a data structure to the callback routine. The command tells the callback function what should be done. If the command requires parameters they are passed through the data pointer pData. It points to a structure whose format depends on the command.
Prototype
int LCD_X_DisplayDriver(unsigned LayerIndex, unsigned Cmd, void * pData);
Parameter LayerIndex Cmd pData
Description
Zero based layer index. Command to be executed. Detailed descriptions below. Pointer to a data structure.
Return value
The routine should return -2 if an error occurs, -1 if the command is not handled by the function and 0 if the command has been successfully executed.
29.6.1 Commands passed to the callback function
The following explains the common commands passed to the callback function. For details about display driver specific commands, refer to "Detailed display driver descriptions" on page 939. They are described under the topic 'Additional callback commands'.
LCD_X_INITCONTROLLER
As mentioned above the application should initialize the display controller and put it into operation if the callback routine receives this command. No parameters are passed on this command. Typically an initialization routine which initializes the registers of the display controller should be called in reaction of this command.
Parameters
None.
LCD_X_SETVRAMADDR
This command is passed by the driver to tell the callback routine the start address of the video RAM. The typical reaction should be writing the address to the frame buffer start address register.
Parameters
pData points to a data structure of type LCD_X_SETVRAMADDR_INFO:
Data type Element
void *
pVRAM
Description
Points to the start address of the video RAM. This address is typically written to the video RAM base address register of the display controller.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
938
CHAPTER
Display drivers
LCD_X_ON
This command switches the display on.
Parameters
none
LCD_X_OFF
This command switches the display off.
Parameters
none
LCD_X_SETLUTENTRY
A lookup table entry should be set. The typical reaction should be writing an entry into the lookup table of the display controller.
Parameters
pData points to a data structure of type LCD_X_SETLUTENTRY_INFO:
Data type Element
LCD_COLOR Color
U8
Pos
Description
RGB value of the color to be written to the LUT. Note that the format required by the hardware could be different to the RGB format. Zero based index of the LUT entry to be set.
LCD_X_SETORG
The function is used in relation with virtual screens. It is called if the origin of the display should be set. A typical reaction can be modifying the frame buffer start address.
Parameters
pData points to a data structure of type LCD_X_SETORG_INFO:
Data type int int
Element xPos yPos
Description
New X-position of the physical display position within the virtual screen. New Y-position of the physical display position within the virtual screen.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
939
29.7 Detailed display driver descriptions
29.7.1 GUIDRV_BitPlains
This driver has been developed for systems without display controller. It manages each color bit in a separate plain. This means if the color depth is for example 4 bits per pixel the driver manages 4 bit plains each containing one bit. Initially the driver has been made to drive monochrome and color TFTs with an R323C/111 CPU via SPI interface. But the driver can be used also for similar applications. The driver does only manage the content of the bit plains. It does not contain any display controller specific code.
Supported hardware
Controllers
None.
Bits per pixel
The driver has been developed for a color depth of 1 to 8 bits per pixel.
Interface
It is required to write an application defined routine which uses the content of the bit plains to generate the color signals for the display. The driver comes with a sample for the R32C/111 CPU which refreshes the display via timer interrupt routine using the SPI interface.
Driver selection
To use GUIDRV_BitPlains for the given display, the following command can be used e.g.:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_BITPLAINS, GUICC_M111, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Display data RAM organization
Byte 0
Byte 1
. . .
Byte n
SSSSSSSS
S
EEEEEEEE
E
GGGGGGGG
G
01234567
n
Plain n
Plain 1
Plain 0 COM 0
DDDDDDDD BBBBBBBB 01234567
COM 1
. . .
COM n
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
940
CHAPTER
Display drivers
The picture above shows the relation between the display memory and the SEG and COM lines of the display. The display memory is divided into separate plains for each bit of the colors. This means that bit 0 of each pixel is stored in plain 0, the bit 1 in plain 1 and so on. The advantage of this method is that each color bit of the display data can be accessed very quickly.
RAM requirements
The required size of the display memory area can be calculated as follows:
Size = BitsPerPixel * (LCD_XSIZE + 7) / 8 * LCD_YSIZE
Please note that the pointers to the bit plain areas need to be passed to the configuration routine of the driver. They are not allocated within the driver but from application side.
Hardware configuration
Normally, the hardware interface is an interrupt service routine (ISR) which updates the display. The driver comes with an example written in "C" code. This routine should serve as an example.
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_BitPlains_Config()
LCD_SetVRAMAddrEx()
Description
Passes a pointer to a CONFIG_BITPLAINS structure to the driver. Passes a pointer to a CONFIG_VRAM_BITPLAINS structure to the driver. See the explanation below. A description of the function can be found on page 1014.
Elements of CONFIG_VRAM_BITPLAINS
Data type
Element
U8 *
apVRAM
Description
Array of pointers to the memory locations to be used by the driver for each bit plain. If the driver for example works in 2bpp mode only the first 2 pointers are used (One plain for each bit of the color information).
GUIDRV_BitPlains_Config()
Description
This function passes a pointer to a CONFIG_BITPLAINS structure to the driver.
Prototype
void GUIDRV_BitPlains_Config(GUI_DEVICE
* pDevice,
CONFIG_BITPLAINS * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_BITPLAINS structure explained below.
Elements of CONFIG_BITPLAINS
Data type int
Element Mirror
Description
Config switch to mirror the bits of the display data.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
941
Configuration example
// // Data arrays to be used by the display driver // static U8 _aPlain_0[BYTES_PER_LINE * YSIZE_PHYS]; static U8 _aPlain_1[BYTES_PER_LINE * YSIZE_PHYS]; static U8 _aPlain_2[BYTES_PER_LINE * YSIZE_PHYS];
// // Structure to be passed to the driver // static struct {
U8 * apVRAM[8]; } _VRAM_Desc = {
_aPlain_0, _aPlain_1, _aPlain_2, };
void LCD_X_Config(void) { // // Set display driver and color conversion for 1st layer // GUI_DEVICE_CreateAndLink(GUIDRV_BITPLAINS, COLOR_CONVERSION, 0, 0); // // Display driver configuration, required for Lin-driver // if (LCD_GetSwapXY()) { LCD_SetSizeEx (0, YSIZE_PHYS, XSIZE_PHYS); LCD_SetVSizeEx(0, YSIZE_PHYS, XSIZE_PHYS); } else { LCD_SetSizeEx (0, XSIZE_PHYS, YSIZE_PHYS); LCD_SetVSizeEx(0, XSIZE_PHYS, YSIZE_PHYS); } // // Initialize VRAM access of the driver // LCD_SetVRAMAddrEx(0, (void *)&_VRAM_Desc);
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
942
CHAPTER
Display drivers
29.7.2 GUIDRV_DCache
GUIDRV_DCache has been developed to minimize the communication between emWin and the display controller. It uses 2 caches to be able to check exactly which pixels have been changed between locking and unlocking the cache. When locking the cache the driver makes a copy of the current cache. When unlocking it, it checks exactly which pixels have been changed. Only the changed pixels will be send to the controller. Using this double cache driver makes sense if the performance bottleneck is the communication between CPU and display controller. The driver can not be used stand alone. It is required to use a 'real' display driver for the drawing operations. GUIDRV_DCache is part of the emWin basic package.
Supported hardware
The double cache driver is able to work with each runtime configurable display driver which works with 16bpp color format.
Driver selection
To be able to use this driver the following call has to be made:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_DCACHE, GUICC_1, 0, Layer);
RAM requirements
As the drivers name implies it uses 2 caches. Currently only a color depth of 1bpp is supported by the driver. The RAM usage can be calculated as follows:
Size = 2 * (LCD_XSIZE + 7) / 8 * LCD_YSIZE
Run-time configuration
First the 'real' driver should be created and configured:
pDriver = GUI_DEVICE_Create(DISPLAY_DRIVER, GUICC_XXX, 0, Layer); // // Configuration of 'real' driver // . . .
GUICC_XXX means any 16bpp color conversion scheme. After that the double cache driver can be created and configured:
// // Create and configure (double) cache driver, ... // pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_DCACHE, GUICC_1, 0, Layer); // // ... set size, ... // LCD_SetSizeEx (0, XSIZE_PHYS, YSIZE_PHYS); LCD_SetVSizeEx(0, VXSIZE_PHYS, VYSIZE_PHYS); // // ...set color depth, ... // GUIDRV_DCache_SetMode1bpp(pDevice);
Then the 'real' driver should be added for doing the drawing operations:
// // ... and add real driver. // GUIDRV_DCache_AddDriver(pDevice, pDriver);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
943
Configuration routines
Routine GUIDRV_DCache_AddDriver() GUIDRV_DCache_SetMode1bpp()
Description
Adds the 'real' driver for the drawing operations. Sets the color depth to be used for the cache.
GUIDRV_DCache_AddDriver()
Description
Adds the 'real' driver to the DCache driver which is used for the drawing operations.
Prototype
void GUIDRV_DCache_AddDriver(GUI_DEVICE * pDevice, GUI_DEVICE * pDriver);
Parameter pDevice pDriver
Description
Pointer to the DCache driver device. Pointer to the real driver device.
Additional information
The used driver should work in 16bpp mode because the double cache driver currently only supports 16bpp output.
GUIDRV_DCache_SetMode1bpp()
Description
Sets the 1bpp mode for the DCache driver.
Prototype
void GUIDRV_DCache_SetMode1bpp(GUI_DEVICE * pDevice);
Parameter pDevice
Description
Pointer to the DCache driver device.
Additional information
Currently the DCache driver works only with a color depth of 1bpp.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
944
CHAPTER
Display drivers
29.7.3 GUIDRV_Dist
GUIDRV_Dist has been developed to support displays with multiple controllers. It is able to support multiple display areas each driven by a separate display controller. The distribution driver passes the drawing operations to the according display driver. This also works with overlapping operations. In these cases the operations are divided into sub operations for each affected controller. GUIDRV_Dist is part of the emWin basic package.
Supported hardware
The distribution driver is able to work with each runtime configurable display driver. Please note that it is required that each of the configured display drivers use the same color conversion as the distribution driver.
Driver selection
To be able to use this driver the following call has to be made:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_DIST, COLOR_CONVERSION, 0, Layer);
RAM requirements
None.
Run-time configuration
After the driver has been created the actual display drivers should be also created and added to the distribution device:
pDevice0 = GUI_DEVICE_Create(DISPLAY_DRIVER, COLOR_CONVERSION, 0, -1); pDevice1 = GUI_DEVICE_Create(DISPLAY_DRIVER, COLOR_CONVERSION, 0, -1); GUIDRV_Dist_AddDriver(pDevice, pDevice0, &Rect0); GUIDRV_Dist_AddDriver(pDevice, pDevice1, &Rect1);
GUIDRV_Dist_AddDriver()
Description
Adds a display driver to the distribution driver.
Prototype
void GUIDRV_Dist_AddDriver(GUI_DEVICE * pDevice, GUI_DEVICE * pDriver, GUI_RECT * pRect);
Parameter pDevice pDriver pRect
Description
Pointer to the already created distribution device. Pointer to the already created driver device to be added. Pointer to the rectangle in which outputs have to affect the driver.
Configuration example
void LCD_X_Config(void) { // // Set display driver and color conversion for 1st layer // pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_DIST, COLOR_CONVERSION, 0, 0); // // Display size configuration // LCD_SetSizeEx (0, XSIZE_PHYS, YSIZE_PHYS); LCD_SetVSizeEx(0, VXSIZE_PHYS, VYSIZE_PHYS); // // Create first display driver // pDevice0 = GUI_DEVICE_Create(DISPLAY_DRIVER, COLOR_CONVERSION, 0, -1); //
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
945
// Configuration of first driver // ... // // Create second display driver // pDevice1 = GUI_DEVICE_Create(DISPLAY_DRIVER, COLOR_CONVERSION, 0, -1); // // Configuration of second driver // ... // // Add display drivers to distribution driver // Rect0.x0 = 0; Rect0.y0 = 160; Rect0.x1 = 223; Rect0.y1 = 319; GUIDRV_Dist_AddDriver(pDevice, pDevice0, &Rect0); Rect1.x0 = 0; Rect1.y0 = 0; Rect1.x1 = 223; Rect1.y1 = 159; GUIDRV_Dist_AddDriver(pDevice, pDevice1, &Rect1); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
946
CHAPTER
Display drivers
29.7.4 GUIDRV_FlexColor
Supported hardware
Controllers
The supported display controllers are listed in the description of the function "GUIDRV_FlexColor_SetFunc()" on page 948.
Bits per pixel
Supported color depth is 16 bpp and 18 bpp.
Interfaces
The driver supports 8-bit, 9-bit, 16-bit and 18-bit indirect interface.
Driver selection
To be able to use this driver the following call has to be made:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_FLEXCOLOR, COLOR_CONVERSION, 0, Layer);
In order to choose the proper color conversion, please refer to the chapter "Colors" on page 265 to get detailed information about palette modes.
Display data RAM organization
16 bits per pixel, fixed palette = 565
SEG 0
. . .
COM 0
COM 1 . . .
COM n
R R R R RGGGGGG B B B B B DDDDDDDDDDDDDDDD BBBBBBBBBBBBBBBB 7654321076543210
R R R R RGGGGGG B B B B B
SEG n
18 bits per pixel, fixed palette = 666_9
SEG 0
. . .
SEG n
COM 0
COM 1 . . .
COM n
- - - - - - - RRRRRRGGG - - - - - - - GGGBBBBBB
DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 33222222222211111111110000000000 10987654321098765432109876543210
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
947
RAM requirements
This display driver requires app. 500 Bytes to work. It can also be used with and without a display data cache, containing a complete copy of the content of the display data RAM. The amount of memory used by the cache is:
LCD_XSIZE * LCD_YSIZE * BytesPerPixel
BytesPerPixel is 2 for 16bpp mode and 4 for 18bpp mode. Using a cache avoids reading operations from the display controller in case of XOR drawing operations and further it speeds up string output operations.
Configuration routines
Routine
Description
Common configuration routines
GUIDRV_FlexColor_SetFunc()
Configures bus, cache and hardware routines.
GUIDRV_FlexColor_Config()
Configures orientation and offset of the SEG- and COM-lines.
Detailed interface selection
GUIDRV_FlexColor_SetInterface66712_B9()
Set up bus interface (TYPE_I, TYPE_II).
GUIDRV_FlexColor_SetInterface66712_B18()
Set up bus interface (TYPE_I, TYPE_II).
GUIDRV_FlexColor_SetInterface66715_B9()
Set up bus interface (TYPE_I, TYPE_II).
GUIDRV_FlexColor_SetInterface66715_B18()
Set up bus interface (TYPE_I, TYPE_II).
Configuration of read back function
GUIDRV_FlexColor_SetReadFunc66709_B16()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66712_B9()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66712_B16()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66715_B9()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66715_B16()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66720_B16()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66772_B8()
Read back function settings.
GUIDRV_FlexColor_SetReadFunc66772_B16
Read back function settings.
The above set of configuration functions set up the detailed behavior of the driver. In short they do the following:
GUIDRV_FlexColor_SetFunc()
- Configures the LCD-controller to be used, color depth and cache settings.
GUIDRV_FlexColor_Config()
- Configures display orientation, dummy reads and first SEG- and COM-lines.
GUIDRV_FlexColor_SetInterface()
- Configures the bus interface to be used.
GUIDRV_FlexColor_SetReadFunc()
- Configures the behavior when reading back pixel data.
Calling sequence
The following shows a recommended sequence of configuration function calls:
GUI_DEVICE_CreateAndLink() GUIDRV_FlexColor_Config() LCD_SetSizeEx() LCD_SetVSizeEx() GUIDRV_FlexColor_SetInterface() GUIDRV_FlexColor_SetReadFunc() GUIDRV_FlexColor_SetFunc()
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
948
CHAPTER
Display drivers
GUIDRV_FlexColor_SetFunc()
Description
Configures bus width, cache usage and hardware routines.
Prototype
void GUIDRV_FlexColor_SetFunc(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API, void (* pfFunc)(GUI_DEVICE * pDevice), void (* pfMode)(GUI_DEVICE * pDevice));
Parameter pDevice pHW_API pfFunc pfMode
Description
Pointer to the driver device structure. Pointer to a GUI_PORT_API structure. See required routines below. Controller selection macro. See table below. See table below.
Permitted values for parameter pfFunc Supported display controller
GUIDRV_FLEXCOLOR_F66702 GUIDRV_FLEXCOLOR_F66708
GUIDRV_FLEXCOLOR_F66709
GUIDRV_FLEXCOLOR_F66712 GUIDRV_FLEXCOLOR_F66714 GUIDRV_FLEXCOLOR_F66715 GUIDRV_FLEXCOLOR_F66718 GUIDRV_FLEXCOLOR_F66719 GUIDRV_FLEXCOLOR_F66720 GUIDRV_FLEXCOLOR_F66772
Set up the driver to use one of the following controllers: - Solomon SSD1284, SSD1289, SSD1298
Set up the driver to use one of the following controllers: - FocalTech FT1509 - Ilitek ILI9320, ILI9325, ILI9328, ILI9335 - LG Electronics LGDP4531, LGDP4551 - OriseTech SPFD5408 - Renesas R61505, R61580
Set up the driver to use one of the following controllers: - Epson S1D19122 - Himax HX8353, HX8325A - Ilitek ILI9338, ILI9340, ILI9341, ILI9342, ILI9481 - Novatek NT39122 - Orisetech SPFD54124C, SPFD5414D - Renesas R61516, R61526 - Sitronix ST7628, ST7637, ST7687, ST7735 - Solomon SSD1355
Set up the driver to use one of the following controllers: - Himax HX8340, HX8347, HX8352
Set up the driver to use the following controller: - Solomon SSD2119
Set up the driver to use one of the following controllers: - Himax HX8352B
Set up the driver to use the following controller: - Syncoam SEPS525
Set up the driver to use the following controller: - Samsung S6E63D6
Set up the driver to use one of the following controllers: - Solomon SSD1961, SSD1963
Set up the driver to use one of the following controllers: - Himax HX8301 - Ilitek ILI9220, ILI9221 - Samsung S6D0117 - Sitronix ST7712
The display controllers listed in the table above are the currently known controllers compatible to the driver. Please note that the used numbers of the selection macros are compatible to some of the LCD_CONTROLLER macro of the driver GUIDRV_CompactColor_16. This makes it easy to migrate from the compile time configurable GUIDRV_CompactColor_16 to the runtime configurable GUIDRV_FlexColor.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
949
Permitted values for parameter pfMode
GUIDRV_FLEXCOLOR_M16C0B8
16bpp, no cache, 8 bit bus
GUIDRV_FLEXCOLOR_M16C1B8 GUIDRV_FLEXCOLOR_M16C0B16 GUIDRV_FLEXCOLOR_M16C1B16
16bpp, cache, 8 bit bus 16bpp, no cache, 16 bit bus 16bpp, cache, 16 bit bus
GUIDRV_FLEXCOLOR_M18C0B9 GUIDRV_FLEXCOLOR_M18C1B9 GUIDRV_FLEXCOLOR_M18C0B18
18bpp, no cache, 9 bit bus 18bpp, cache, 9 bit bus 18bpp, no cache, 18 bit bus
GUIDRV_FLEXCOLOR_M18C1B18 18bpp, cache, 18 bit bus
Each controller selection supports different operation modes. The table below shows the supported modes for each controller:
M16C0B8 M16C1B8 M16C0B16 M16C1B16 M18C0B9 M18C1B9 M18C0B18 M18C1B18
Selection macro
GUIDRV_FLEXCOLOR_F66702 GUIDRV_FLEXCOLOR_F66708 GUIDRV_FLEXCOLOR_F66709 GUIDRV_FLEXCOLOR_F66712 GUIDRV_FLEXCOLOR_F66714 GUIDRV_FLEXCOLOR_F66715 GUIDRV_FLEXCOLOR_F66718 GUIDRV_FLEXCOLOR_F66719 GUIDRV_FLEXCOLOR_F66720 GUIDRV_FLEXCOLOR_F66772
XXXX - - - XXXX - - - XXXX - - - XXXXXXXX XXXXXX - XXXXXXXX XXXXXX - XXXX - - - XXXX - - - XXXX - - - -
'-' means not supported 'X' means supported
Required GUI_PORT_API routines
The required GUI_PORT_API routines depend on the used interface. If a cache is used the routines for reading data are unnecessary for each interface:
8 bit interface
Element pfWrite8_A0 pfWrite8_A1 pfWriteM8_A1 pfReadM8_A1
Data type void (*)(U8 Data) void (*)(U8 Data) void (*)(U8 * pData, int NumItems) void (*)(U8 * pData, int NumItems)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
950
CHAPTER
Display drivers
16 bit interface
Element
Data type
pfWrite16_A0 void (*)(U16 Data)
pfWrite16_A1 void (*)(U16 Data)
pfWriteM16_A1 void (*)(U16 * pData, int NumItems) pfReadM16_A1 void (*)(U16 * pData, int NumItems)
18 bit interface
Element
Data type
pfWrite32_A0 void (*)(U32 Data)
pfWrite32_A1 void (*)(U32 Data)
pfWriteM32_A1 void (*)(U32 * pData, int NumItems)
pfReadM32_A1 void (*)(U32 * pData, int NumItems)
9 bit interface
The following describes the behavior of the 9 bit bus variant of the driver. When working with a 9 bit interface the display controller uses the lines D17-D10 or lines D7-D0 (8 bit) for accessing the command register and D17-D9 or D8-D0 (9 bit) for passing data. This means the lines D17-D9 or D8-D0 are connected to the interface lines of the CPU. The driver passes 16 bit values to the hardware routines. In dependence of the selected driver interface (TYPE_I or TYPE_II) the bits 7-0 (TYPE_I) or the bits 8-1 (TYPE_II) already contain the right values to be passed to the controller. No further shift operation is required in the hardware routines. To be able to process pixel data as fast as possible, the driver passes two 16 bit data values per pixel (0000000R RRRRRGGG and 0000000G GGBBBBBB) to the hardware routines. Only the first 9 bits contain pixel data. So nothing need to be shifted in the hardware routines. In case of using the 9 bit interface the driver requires 16 bit hardware routines for communicating with the controller.
Element
Data type
Description
pfWrite16_A0 void (*)(U16 Data) pfWrite16_A1 void (*)(U16 Data)
Routine used to set up the index register. Dependent on used bus interface DB8-DB1 or DB7-DB0 are used.
Routine used to pass register parameters. Dependent on used bus interface DB8-DB1 or DB7-DB0 are used.
pfWriteM16_A1 void (*)(U16 * pData, int NumItems) Data to be written (DB0-DB9)
pfReadM16_A1 void (*)(U16 * pData, int NumItems) Data read (DB0-DB9)
GUIDRV_FlexColor_Config()
Description
Configures orientation and offset of the SEG- and COM-lines.
Prototype
void GUIDRV_FlexColor_Config(GUI_DEVICE
* pDevice,
CONFIG_FLEXCOLOR * pConfig);
Parameter pDevice pConfig
Description
Pointer to the device to configure. Pointer to a CONFIG_FLEXCOLOR structure. See element list below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
951
Elements of CONFIG_FLEXCOLOR
Data type int int int
U16
int
Element
Description
FirstSEG
First segment line.
FirstCOM
First common line.
Orientation One or more "OR" combined values of the table below.
RegEntryMode
Normally the display controller uses 3 bits of one register to define the required display orientation. Normally these are the bits ID0, ID1 and AM. To be able to control the content of the
other bits the RegEntryMode element can be used. The driver
combines this value with the required orientation bits during the initialization process.
NumDummyReads
Defines the number of reading operations which have to be done until valid data can be retrieved. Please note that only values != 0 are accepted. If the controller does not need one or more dummy reads, -1 should be used here.
Permitted values for parameter Orientation
GUI_MIRROR_X Mirroring the X-axis
GUI_MIRROR_Y GUI_SWAP_XY
Mirroring the Y-axis Swapping X- and Y-axis
GUIDRV_FlexColor_SetInterface66712_B9() GUIDRV_FlexColor_SetInterface66715_B9()
Description
Sets the type of interface to be used.
Prototype
void GUIDRV_FlexColor_SetInterface66712_B9(GUI_DEVICE * pDevice, int Type); void GUIDRV_FlexColor_SetInterface66715_B9(GUI_DEVICE * pDevice, int Type);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Type
GUIDRV_FLEXCOLOR_IF_TYPE_I GUIDRV_FLEXCOLOR_IF_TYPE_II
Uses lines DB7-DB0 for register access and lines DB8-DB0 for data access. (default)
Uses lines DB8 to DB1 for register access and lines DB8-DB0 for data access.
Additional information
The difference between the interfaces affects the register access to the controller. Normally there are 2 kinds of possible interfaces available when working with the 18 bit bus interface. TYPE_I uses the lines D7 to D0 for register access whereas TYPE_II uses the lines D8 to D1.
GUIDRV_FlexColor_SetInterface66712_B18() GUIDRV_FlexColor_SetInterface66715_B18()
Description
Sets the type of interface to be used.
Prototype
void GUIDRV_FlexColor_SetInterface66712_B18(GUI_DEVICE * pDevice, int Type);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
952
CHAPTER
Display drivers
void GUIDRV_FlexColor_SetInterface66715_B18(GUI_DEVICE * pDevice, int Type);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Type
GUIDRV_FLEXCOLOR_IF_TYPE_I GUIDRV_FLEXCOLOR_IF_TYPE_II
Uses lines DB7 to DB0for register access and lines DB17-DB0 for data access. (default)
Uses lines DB8 to DB1 for register access and lines DB17-DB0 for data access.
Additional information
The difference between the interfaces affects the register access to the controller. Normally there are 2 kinds of possible interfaces available when working with the 18 bit bus interface. TYPE_I uses the lines D7 to D0 for register access whereas TYPE_II uses the lines D8 to D1.
GUIDRV_FlexColor_SetReadFunc66709_B16()
Description
Sets the function(s) to be used for reading back pixel data.
Prototype
void GUIDRV_FlexColor_SetReadFunc66709_B16(GUI_DEVICE * pDevice, int Func);
Parameter pDevice Func
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Func
GUIDRV_FLEXCOLOR_READ_FUNC_I GUIDRV_FLEXCOLOR_READ_FUNC_II
3 cycles and data conversion required. (default)
2 cycles and no conversion required.
Additional information
The difference between the interfaces affects only reading back pixels. Whereas TYPE_I extracts the index value by assembling it from the second and third word received from the controller, TYPE_II uses the second word as it is. The right interface depends on the used controller.
GUIDRV_FLEXCOLOR_READ_FUNC_I
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd 3rd
Dummy read - - - - - - - - B4 B3 B2 B1 B0 - - G5 G4 G3 G2 G1 G0 - - R4 R3 R2 R1 R0 - - -
In dependence of controller settings red and blue could be swapped.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
953
GUIDRV_FLEXCOLOR_READ_FUNC_II
D0
D1
D2
D3
D4
D5
D6
D7
D8
D9
D10
D11
D12
D13
D14
D15
Cycle
1st 2nd
Dummy read B4 B3 B2 B1 B0 G5 G4 G3 G2 G1 G0 R4 R3 R2 R1 R0
In dependence of controller settings red and blue could be swapped.
GUIDRV_FlexColor_SetReadFunc66712_B9() GUIDRV_FlexColor_SetReadFunc66715_B9()
Description
Sets the function(s) to be used for reading back pixel data.
Prototype
void GUIDRV_FlexColor_SetReadFunc66712_B16(GUI_DEVICE * pDevice, int Func); void GUIDRV_FlexColor_SetReadFunc66715_B16(GUI_DEVICE * pDevice, int Func);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Func
GUIDRV_FLEXCOLOR_READ_FUNC_I
3 cycles and data conversion required. (default)
GUIDRV_FLEXCOLOR_READ_FUNC_II
3 cycles and data conversion required.
Additional information
The right function to be used depends on the behavior of the used controller.
GUIDRV_FLEXCOLOR_READ_FUNC_I
D0
D1
D2
D3
D4
D5
D6
D7
D8
D9
D10
D11
D12
D13
D14
D15
Cycle
1st 2nd 3rd
Dummy read - - - - - - - B5 B4 B3 B2 B1 B0 G5 G4 G3 - - - - - - - G2 G1 G0 R5 R4 R3 R2 R1 R0
In dependence of controller settings red and blue could be swapped.
GUIDRV_FLEXCOLOR_READ_FUNC_II
D0
D1
D2
D3
D4
D5
D6
D7
D8
D9
D10
D11
D12
D13
D14
D15
Cycle
1st 2nd 3rd
Dummy read B5 B4 B3 B2 B1 B0 - - G5 G4 G3 G2 G1 G0 - R5 R4 R3 R2 R1 R0 - - - - - - - - - -
In dependence of controller settings red and blue could be swapped.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
954
CHAPTER
Display drivers
GUIDRV_FlexColor_SetReadFunc66712_B16() GUIDRV_FlexColor_SetReadFunc66715_B16()
Description
Sets the function(s) to be used for reading back pixel data.
Prototype
void GUIDRV_FlexColor_SetReadFunc66712_B16(GUI_DEVICE * pDevice, int Func);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Func
GUIDRV_FLEXCOLOR_READ_FUNC_I
4 cycles and data conversion required. (default)
GUIDRV_FLEXCOLOR_READ_FUNC_II
4 cycles and data conversion required.
GUIDRV_FLEXCOLOR_READ_FUNC_III 3 cycles and data conversion required.
Additional information
The right function to be used depends on the behavior of the used controller.
GUIDRV_FLEXCOLOR_READ_FUNC_I
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd 3rd 4th
Dummy read - - - - - - - - B4 B3 B2 B1 B0 - - - - - - - - - - G5 G4 G3 G2 G1 G0 - - - - - - - - - R4 R3 R2 R1 R0 - - -
In dependence of controller settings red and blue could be swapped.
GUIDRV_FLEXCOLOR_READ_FUNC_II
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd 3rd 4th
Dummy read - - - - - - - - G5 G4 G3 G2 G1 G0 - - - - - - - - - B4 B3 B2 B1 B0 - - - - - - - - - - R4 R3 R2 R1 R0 - - -
In dependence of controller settings red and blue could be swapped.
GUIDRV_FLEXCOLOR_READ_FUNC_III
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd 3rd
Dummy read B4 B3 B2 B1 B0 - - - G5 G4 G3 G2 G1 G0 - R4 R3 R2 R1 R0 - - - - - - - - - - -
In dependence of controller settings red and blue could be swapped.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
955
GUIDRV_FlexColor_SetReadFunc66720_B16()
Description
Sets the function(s) to be used for reading back pixel data.
Prototype
void GUIDRV_FlexColor_SetReadFunc66720_B16(GUI_DEVICE * pDevice, int Func);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Func
GUIDRV_FLEXCOLOR_READ_FUNC_I
3 cycles and data conversion required. (default)
GUIDRV_FLEXCOLOR_READ_FUNC_II 2 cycles and no conversion required.
Additional information
The right function to be used depends on the behavior of the used controller. Whereas ..._FUNC_I extracts the index value by assembling it from the second and third word received from the controller, ..._FUNC_II uses the second word as it is. Please note that the right interface depends on the behavior of the used controller.
GUIDRV_FLEXCOLOR_READ_FUNC_I
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd 3rd
Dummy read - - - - - - - - B4 B3 B2 B1 B0 - - G5 G4 G3 G2 G1 G0 - - R4 R3 R2 R1 R0 - - -
In dependence of controller settings red and blue could be swapped.
GUIDRV_FLEXCOLOR_READ_FUNC_II
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd
Dummy read B4 B3 B2 B1 B0 G5 G4 G3 G2 G1 G0 R4 R3 R2 R1 R0
In dependence of controller settings red and blue could be swapped.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
956
CHAPTER
Display drivers
GUIDRV_FlexColor_SetReadFunc66772_B8()
Description
Sets the function(s) to be used for reading back pixel data.
Prototype
void GUIDRV_FlexColor_SetReadFunc66772_B8(GUI_DEVICE * pDevice, int Func);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Func
GUIDRV_FLEXCOLOR_READ_FUNC_I
3 cycles and no conversion required. (default)
GUIDRV_FLEXCOLOR_READ_FUNC_II 3 cycles and conversion required.
Additional information
The right function to be used depends on the behavior of the used controller. Whereas ..._FUNC_I extracts the index value by assembling it from the second and third word received from the controller, ..._FUNC_II uses the second word as it is. Please note that the right interface depends on the behavior of the used controller.
GUIDRV_FLEXCOLOR_READ_FUNC_I
D0
D1
D2
D3
D4
D5
D6
D7
Cycle
1st 2nd 3rd
B4 B3 B2 B1 B0 G5 G4 G3 G2 G1 G0 R4 R3 R2 R1 R0
In dependence of controller settings red and blue could be swapped.
GUIDRV_FLEXCOLOR_READ_FUNC_II
D0
D1
D2
D3
D4
D5
D6
D7
Cycle
1st 2nd 3rd
R4 R3 R2 R1 R0 G5 G4 G3 G2 G1 G0 B4 B3 B2 B1 B0
In dependence of controller settings red and blue could be swapped.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
957
GUIDRV_FlexColor_SetReadFunc66772_B16()
Description
Sets the function(s) to be used for reading back pixel data.
Prototype
void GUIDRV_FlexColor_SetReadFunc66772_B16(GUI_DEVICE * pDevice, int Func);
Parameter pDevice Type
Description
Pointer to the device to configure. Type of the interface to be used. See possible types below.
Permitted values for parameter Func
GUIDRV_FLEXCOLOR_READ_FUNC_I
2 cycles and no conversion required. (default)
GUIDRV_FLEXCOLOR_READ_FUNC_II 2 cycles and conversion required.
Additional information
The right function to be used depends on the behavior of the used controller. Whereas ..._FUNC_I extracts the index value by assembling it from the second and third word received from the controller, ..._FUNC_II uses the second word as it is. Please note that the right interface depends on the behavior of the used controller.
GUIDRV_FLEXCOLOR_READ_FUNC_I
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd
Dummy read B4 B3 B2 B1 B0 G5 G4 G3 G2 G1 G0 R4 R3 R2 R1 R0
In dependence of controller settings red and blue could be swapped.
GUIDRV_FLEXCOLOR_READ_FUNC_II
D15 D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0
Cycle
1st 2nd
Dummy read R4 R3 R2 R1 R0 G5 G4 G3 G2 G1 G0 B4 B3 B2 B1 B0
In dependence of controller settings red and blue could be swapped.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
958
CHAPTER
Display drivers
29.7.5 GUIDRV_IST3088
Supported hardware
Controllers
This driver works with the following display controllers: · Integrated Solutions Technology IST3088, IST3257
Bits per pixel
The supported color depth is 4 bpp.
Interfaces
The driver supports the 16-bit indirect interface.
Driver selection
To use GUIDRV_IST3088 for the given display, the following command should be used:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_IST3088_4, GUICC_4, 0, 0);
Display data RAM organization
Word 0
P 0
P 1
P 2
P 3
. . .
COM 0
COM 1
. . .
COM n
DDDDDDDD DDDDDDDD BBBBBBBB BBBBBBBB 3 2 1 0 7 6 5 4 11 10 9 8 15 14 13 12
Word n
The delineation above shows the relation between the display memory and the SEG and COM lines of the LCD.
RAM requirements
This display driver can be used with and without a display data cache, containing a complete copy of the content of the display data RAM. The amount of memory used by the cache is: LCD_XSIZE * LCD_YSIZE / 2.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
959
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_IST3088_SetBus16
Description
Tells the driver to use the 16 bit indirect interface and passes pointer to a GUI_PORT_API structure to the driver.
GUIDRV_IST3088_SetBus16()
Description
Tells the driver to use the 16 bit indirect interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_IST3088_SetBus16(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device.
Pointer to a GUI_PORT_API structure. See required routines below.
Required GUI_PORT_API routines
Element
Data type
pfWrite16_A0 void (*)(U16 Data) pfWrite16_A1 void (*)(U16 Data) pfWriteM16_A1 void (*)(U16 * pData, int NumItems)
Special requirements
The driver needs to work in the fixed palette mode GUICC_4. The driver does not work with other palettes or fixed palette modes. You should use GUICC_4 as color conversion.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
960
CHAPTER
Display drivers
29.7.6 GUIDRV_Lin
This driver supports all display controllers with linear video memory accessible via direct interface. It can be used with and without a display controller. The driver does only manage the contents of the video memory. It does not send any commands to the display controller or assumes any specific registers. So it is independent of the register interface of the display controller and can be used for managing each linear mapped video memory.
Supported hardware
Controllers
The driver supports all systems with linear mapped video memory.
Bits per pixel
Supported color depths are 1, 2, 4, 8, 16, 24 and 32 bits per pixel.
Interfaces
The driver supports a full bus interface from the CPU to the video memory. The video memory needs to be accessible 8, 16 or 32 bit wise.
Color depth and display orientation
The driver consists of several files. They are named _[O]_BPP.c. where the optional 'O' stands for the desired display orientation and 'BPP' for the color depth. The following table shows the driver files and the configuration macros which should be used to create and link the driver during the initialization:
Identifier
GUIDRV_LIN_1 GUIDRV_LIN_2 GUIDRV_LIN_4 GUIDRV_LIN_8 GUIDRV_LIN_OX_8 GUIDRV_LIN_OXY_8 GUIDRV_LIN_16 GUIDRV_LIN_OX_16 GUIDRV_LIN_OXY_16 GUIDRV_LIN_OY_16 GUIDRV_LIN_OS_16 GUIDRV_LIN_OSX_16 GUIDRV_LIN_OSY_16 GUIDRV_LIN_24 GUIDRV_LIN_OX_24 GUIDRV_LIN_OXY_24 GUIDRV_LIN_OY_24 GUIDRV_LIN_OS_24 GUIDRV_LIN_OSX_24 GUIDRV_LIN_OSY_24 GUIDRV_LIN_32 GUIDRV_LIN_OX_32 GUIDRV_LIN_OXY_32 GUIDRV_LIN_OY_32 GUIDRV_LIN_OS_32 GUIDRV_LIN_OSX_32 GUIDRV_LIN_OSY_32
Color depth and orientation
1bpp, default orientation 2bpp, default orientation 4bpp, default orientation 8bpp, default orientation 8bpp, X axis mirrored 8bpp, X and Y axis mirrored 16bpp, default orientation 16bpp, X axis mirrored 16bpp, X and Y axis mirrored 16bpp, Y axis mirrored 16bpp, X and Y swapped 16bpp, X axis mirrored, X and Y swapped 16bpp, Y axis mirrored, X and Y swapped 24bpp, default orientation 24bpp, X axis mirrored 24bpp, X and Y axis mirrored 24bpp, Y axis mirrored 24bpp, X and Y swapped 24bpp, X axis mirrored, X and Y swapped 24bpp, Y axis mirrored, X and Y swapped 32bpp, default orientation 32bpp, X axis mirrored 32bpp, X and Y axis mirrored 32bpp, Y axis mirrored 32bpp, X and Y swapped 32bpp, X axis mirrored, X and Y swapped 32bpp, Y axis mirrored, X and Y swapped
The table above shows identifiers which can be used to select the driver. Each combination of orientation and color depth is possible. Please note that currently not all combinations are shipped with the driver. If the required combination is not available, please send a request to obtain the required combination.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
961
Driver selection
To use for the given display, the following command can be used e.g.:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_LIN_OX_16, GUICC_565, 0, 0); Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Display data RAM organization
P0 P1 P2 P3 P4 P5 P6 P7 P8 P9 P10 P11 P12 P13 P14 P15 P16 P17 P18 P19 P20 P21 P22 P23 P24 P25 P26 P27 P28 P29 P30 P31
Little endian
1 bit / pixel 2 bit / pixel 4 bit / pixel 8 bit / pixel 16 bit / pixel 24 bit / pixel 32 bit / pixel
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT 33222222222211111111110000000000 10987654321098765432109876543210
P15 P14 P13 P12 P11 P10 P9 P8 P7 P6 P5 P4 P3 P2 P1 P0
P7 P6 P5 P4 P3 P2 P1 P0
Pixel 3
Pixel 2
Pixel 1
Pixel 0
Pixel 1
Pixel 0
Pixel 1
Pixel 0
Pixel 0
Big endian
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT 33222222222211111111110000000000 10987654321098765432109876543210
P0 P1 P2 P3 P4 P5 P6 P7 P8 P9 P10 P11 P12 P13 P14 P15 P16 P17 P18 P19 P20 P21 P22 P23 P24 P25 P26 P27 P28 P29 P30 P31
1 bit / pixel
2 bit / pixel
P0 P1 P2 P3 P4 P5 P6 P7 P8 P9 P10 P11 P12 P13 P14 P15
4 bit / pixel
P0 P1 P2 P3 P4 P5 P6 P7
8 bit / pixel
Pixel 0
Pixel 1
Pixel 2
Pixel 3
16 bit / pixel
Pixel 0
Pixel 1
24 bit / pixel
Pixel 0
Pixel 1
32 bit / pixel
Pixel 0
The picture above shows the relation between the display memory and the pixels of the LCD in terms of the color depth and the endian mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
962
CHAPTER
Display drivers
Little endian video mode
Least significant bits are used and output first. The least significant bits are for the first (left-most) pixel.
Big endian video mode
Most significant bits are used and output first. The most significant bits are for the first (left-most) pixel.
RAM requirements
None.
Available configuration macros (compile time configuration)
The following table lists the macros which must be defined for hardware access:
Macro LCD_ENDIAN_BIG
Description
Should be set to 1 for big endian mode, 0 (default) for little endian mode.
Available configuration routines (run-time configuration)
The following table lists the available run-time configuration routines:
Routine
Description
LCD_SetDevFunc()
Can be used to set optional or custom defined routines.
LCD_SetSizeEx()
Changes the size of the visible area.
LCD_SetVRAMAddrEx() Changes the video RAM start address.
LCD_SetVSizeEx()
Changes the size of the virtual display area.
Supported values by LCD_SetDevFunc()
The following table shows the supported values of the function:
Value LCD_DEVFUNC_COPYBUFFER LCD_DEVFUNC_COPYRECT LCD_DEVFUNC_DRAWBMP_1BPP
LCD_DEVFUNC_FILLRECT
Description
Can be used to set a custom defined routine for copying buffers. Makes only sense in combination with multiple buffers.
Can be used to set a custom defined routine for copying rectangular areas of the display.
Can be used to se a custom routine for drawing 1bpp bitmaps. Makes sense if a BitBLT engine should be used for drawing text and 1bpp bitmaps.
Can be used to set a custom defined routine for filling rectangles. Makes sense if for example a BitBLT engine should be used for filling operations.
For further information about the LCD layer routines, please refer to "LCD layer routines" on page 1009.
Configuration example
The following shows how to create a display driver device with this driver and how to configure it:
void LCD_X_Config(void) {
//
// Set display driver and color conversion
//
GUI_DEVICE_CreateAndLink(GUIDRV_LIN_8, // Display driver
GUICC_8666,
// Color conversion
0, 0);
//
// Display driver configuration
//
LCD_SetSizeEx (0, 320, 240);
// Physical display size in pixels
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
963
LCD_SetVSizeEx (0, 320, 480);
// Virtual display size in pixels
LCD_SetVRAMAddrEx(0, (void *)0x20000000); // Video RAM start address
}
Using the Lin driver in systems with cache memory
The rules to follow are quite simple:
Rule 1
All caches (if applicable, as in your case) should be fully enabled. This means I- and D- caches in systems with separate caches.
Rule 2
All code and data should be placed in cacheable areas to achieve maximum performance. If other parts of the application require some or all data to be placed in noncacheable areas, this is not a problem but may degrade performance.
Rule 3
The cache settings for the frame buffer memory (which is really a shared memory area, accessed by both the CPU and the LCD-controller DMA) should make sure, that write operations are 'write-through' operations. The physical memory should be always up to date, so that the DMA-access of the LCD-controller always get the current content of the frame buffer. In case of a 'write-back' cache a write operation only changes the content of the cache, which is written to the physical memory not before the cache location is superseded. In many systems with MMU, this can be achieved by mapping the RAM twice into the virtual address space: At its normal address, the RAM is cacheable and bufferable, at the second address, it is cacheable but not bufferable. The address of the VRAM given to the driver should be the non bufferable address. If the CPU does not support a 'write-through' cache the frame buffer memory needs to be uncached.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
964
CHAPTER
Display drivers
29.7.7 GUIDRV_S1D13748
Supported hardware
Controllers
This driver has been tested with the Epson S1D13748.
Bits per pixel
The supported color depth is 16 bpp.
Interfaces
The driver supports the 16-bit indirect interface.
Basic function
The driver currently supports indirect mode only. Only 2 registers, namely register 0 and 2 are used.
Hardware interface
AB[1] = GND AB[2] = Used as Address pin AB[3] = GND
AB[3:0]
000 001 010 011 100 101 110 111
Index Status Data Reserved GPIO Status GPIO Config GPIO Input Enable GPIO Pull-down Control
Register
Reset
The RESET pin should be connected to the system reset. The RESET pin of the Microcontroller / CPU is usually called NRESET.
Driver selection
To use GUIDRV_S1D13748 for the given display, the following command should be used:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_S1D13748, GUICC_M565, 0, 0);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
965
Display data RAM organization
16 bits per pixel, fixed palette = 565
SEG0
Word 0
. . .
Word n
COM 0
COM 1 . . .
COM n
R R R R RGGGGGGB B B B B
D B 1 5
D B 1 4
D B 1 3
D B 1 2
D B 1 1
D B 1 0
D B 9
D B 8
D B 7
D B 6
D B 5
D B 4
D B 3
D B 2
D B 1
D B 0
R R R R RGGGGGGB B B B B
The delineation above shows the relation between the display memory and the SEG and COM lines of the LCD.
RAM requirements
Approximately 500 bytes.
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_S1D13748_Config GUIDRV_S1D13748_SetBus_16
Description
Passes a pointer to a CONFIG_S1D13748 structure to the driver. Configures the driver to use the 16 bit indirect interface by passing a pointer to a GUI_PORT_API structure.
GUIDRV_S1D13748_Config()
Description
Configures the driver to work according to the passed CONFIG_S1D13748 structure.
Prototype
void GUIDRV_S1D13748_Config(GUI_DEVICE
* pDevice,
CONFIG_S1D13748 * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_S1D13748 structure described below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
966
CHAPTER
Display drivers
Elements of CONFIG_S1D13748
Data type
Element
U32
BufferOffset
int
UseLayer
Description
This offset added to the VideoRAM start address, results in the start address used for the selected PIP layer. PIP layer to be used.
GUIDRV_S1D13748_SetBus_16()
Description
Tells the driver to use the 16 bit indirect interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_S1D13748_SetBus_16(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device.
Pointer to a GUI_PORT_API structure. See required routines below.
Required GUI_PORT_API routines
Data type
Element
Description
void (*)(U16 Data)
pfWrite16_A0
Pointer to a function which writes one word to the controller with C/D line low.
void (*)(U16 Data)
pfWrite16_A1
Pointer to a function which writes one word to the controller with C/D line high.
Pointer to a function which writes
void (*)(U16 * pData, int NumItems) pfWriteM16_A1 multiple words to the controller
with C/D line high.
U16 (*)(void)
pfRead16_A1
Pointer to a function which reads one word from the controller with C/D line high.
void (*)(U16 * pData, int NumItems) pfReadM16_A1
Pointer to a function which reads multiple words from the controller with C/D line high.
Special requirements
The driver needs to work with the fixed palette mode GUICC_M565. The driver does not work with other palettes or fixed palette modes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
967
29.7.8 GUIDRV_S1D13781
Supported hardware
Controllers
This driver has been tested with the Epson S1D13781.
Bits per pixel
Currently the supported color depth is 8 bpp. This could be enhanced on demand.
Interfaces
Currently the driver supports only the 8-bit indirect serial host interface. Could be enhanced on demand.
Display orientation
The driver can be used with different orientations. The following table shows the configuration macros which can be used to create and link the driver during the initialization:
Identifier
GUIDRV_S1D13781_8C0 GUIDRV_S1D13781_OXY_8C0 GUIDRV_S1D13781_OSY_8C0 GUIDRV_S1D13781_OSX_8C0
Color depth and orientation
8bpp, default orientation 8bpp, X and Y axis mirrored 8bpp, X axis mirrored, X and Y swapped 8bpp, Y axis mirrored, X and Y swapped
The table above shows identifiers which can be used to select the driver.
Driver selection
To use GUIDRV_S1D13781 for the given display, the following command should be used:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_S1D13781, GUICC_8666, 0, 0);
Display data RAM organization
Pixel 0 Byte 0
8 bits per pixel
Pixel 1
Byte 1
. . .
Byte n
COM 0
COM 1 . . .
COM n
DDDDDDDDDDDDDDDD BBBBBBBBBBBBBBBB 7654321076543210
The delineation above shows the relation between the display memory and the SEG and COM lines of the LCD.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
968
CHAPTER
Display drivers
RAM requirements
Approximately 1KByte.
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_S1D13781_Config() GUIDRV_S1D13781_SetBusSPI()
Description
Passes a pointer to a CONFIG_S1D13781 structure to the driver. Configures the driver to use the 8 bit indirect serial host interface by passing a pointer to a GUI_PORT_API structure.
GUIDRV_S1D13781_Config()
Description
Configures the driver to work according to the passed CONFIG_S1D13781 structure.
Prototype
void GUIDRV_S1D13781_Config(GUI_DEVICE
* pDevice,
CONFIG_S1D13781 * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_S1D13781 structure described below.
Elements of CONFIG_S1D13781
Data type U32
int int int
Element
Description
BufferOffset WriteBufferSize
This offset added to the VideoRAM start address, results in the start address used for the selected PIP layer.
Number of bytes used for the write buffer. The buffer should be large enough to be able to store at least one line of data + 5 bytes. Because the layer size can be changed dynamically, it is required to set up the buffer size during the configuration. The default value of the buffer size is 500 bytes.
UseLayer WaitUntilVNDP
Should be 1 if PIP layer should be used.
Used for multiple buffering configurations only. If set to 1 the driver waits until the next vertical non display period has been reached. This can be used to reduce flickering effects with fast animations.
GUIDRV_S1D13781_SetBusSPI()
Description
Tells the driver to use the 8 bit indirect serial host interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_S1D13781_SetBusSPI(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device.
Pointer to a GUI_PORT_API structure. See required routines below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
969
Required GUI_PORT_API routines
Data type void (*)(U8 Data)
Element pfWrite8_A0
void (*)(U8 Data)
pfWrite8_A1
void (*)(U8 * pData, int NumItems) pfWriteM8_A1
U8 (*)(void)
pfRead8_A1
void (*)(U8 * pData, int NumItems) pfReadM8_A1
void (*)(U8 NotActive)
pfSetCS
Description
Pointer to a function which writes one byte to the controller with C/D line low.
Pointer to a function which writes one byte to the controller with C/D line high.
Pointer to a function which writes multiple bytes to the controller with C/D line high.
Pointer to a function which reads one byte from the controller with C/D line high.
Pointer to a function which reads multiple bytes from the controller with C/D line high.
Routine which is able to toggle the CS signal of the controller: NotActive = 1 means CS = high NotActive = 0 means CS = low
Optional functions available with the driver
The following table shows the optional LCD-functions which are available with this driver:
Routine GUI_SetLayerPosEx() GUI_GetLayerPosEx() GUI_SetLayerSizeEx() GUI_SetLayerVisEx() LCD_SetAlphaEx() LCD_SetChromaMode()
LCD_SetChroma()
Description
Sets the position of the given layer. Returns the position of the given layer. Sets the size of the given layer. Sets the visibility of the given layer. Sets the alpha value for the given layer. Toggles usage of transparent key color. 1 enables transparent key color, 0 disables it. Sets the key color to be used. Only the first color passed by the function is used.
More details about the optional functions can be found in "Multi layer API" on page 851.
Additional information
The display driver automatically initializes the following registers:
Register 0x60824 0x60828 0x60840
xSize of main layer. ySize of main layer. Main layer settings.
Description
This means the above registers do not need to be initialized by the applications initialization code for the display controller.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
970
CHAPTER
Display drivers
29.7.9 GUIDRV_S1D15G00
Supported hardware
Controllers
The driver supports the Epson S1D15G00 controller.
Bits per pixel
Supported color depth is 12bpp.
Interfaces
The driver supports the 8 bit indirect interface.
Driver selection
To use GUIDRV_S1D15G00 for the given display, the following command should be used:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_S1D15G00, GUICC_M444_12, 0, 0);
Display data RAM organization
12 bits per pixel, fixed palette = M444_12
Byte 0
Byte 1
. . .
Byte n
SEG0
COM 0
COM 1
. . .
COM n
RRRRGGGGBBBB - - - DDDDDDDD BBBBBBBB 76543210
RRRRGGGGBBBB - - - -
The picture above shows the relation between the display memory and the SEG and COM lines of the LCD.
RAM requirements
This LCD driver can be used with and without a display data cache, containing a complete copy of the contents of the LCD data RAM. The amount of memory used by the cache is:
LCD_XSIZE x LCD_YSIZE x 2 bytes
Using a cache is recommended only if a lot of drawing operations uses the XOR drawing mode. A cache would avoid reading the display data in this case. Normally the use of a cache is not recommended.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
971
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_S1D15G00_Config GUIDRV_S1D15G00_SetBus8
Description
Passes a pointer to a CONFIG_S1D15G00 structure to the driver. Tells the driver to use the 8 bit indirect interface and passes pointer to a GUI_PORT_API structure to the driver.
GUIDRV_S1D15G00_Config()
Description
Passes a pointer to a CONFIG_S1D15G00 structure to the driver.
Prototype
void GUIDRV_S1D15G00_Config(GUI_DEVICE
* pDevice,
CONFIG_S1D15G00 * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_S1D15G00 structure described below.
Elements of CONFIG_S1D15G00
Data type
Element
int
FirstSEG
int
FirstCOM
int
UseCache
Description
First segment address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0.
First common address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0.
Enables or disables use of a data cache. Should be set to 1 for enabling and to 0 for disabling.
GUIDRV_S1D15G00_SetBus8()
Description
Tells the driver to use the 8 bit indirect interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_S1D15G00_SetBus8(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device.
Pointer to a GUI_PORT_API structure. See required routines below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
972
CHAPTER
Display drivers
Required GUI_PORT_API routines
Data type
Element
void (*)(U8 Data) pfWrite8_A0
void (*)(U8 Data) pfWrite8_A1
void (*)(U8 * pData, pfWriteM8_A1
int NumItems)
U8 (*)(void)
pfRead8_A1
Description
Pointer to a function which writes one byte to the controller with C/D line low. Pointer to a function which writes one byte to the controller with C/D line high.
Pointer to a function which writes multiple bytes to the controller with C/D line high.
Pointer to a function which reads one byte from the controller with C/D line high.
Configuration Example
#define XSIZE 130 #define YSIZE 130
GUI_PORT_API _PortAPI;
void LCD_X_Config(void) { GUI_DEVICE * pDevice; CONFIG_S1D15G00 Config = {0};
// // Set display driver and color conversion for 1st layer // pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_S1D15G00, GUICC_M444_12, 0, 0); // // Display driver configuration, required for Lin-driver // LCD_SetSizeEx (0, XSIZE, YSIZE); LCD_SetVSizeEx(0, XSIZE, YSIZE); // // Driver specific configuration // Config.FirstCOM = 2; GUIDRV_S1D15G00_Config(pDevice, &Config); // // Setup hardware access routines // _PortAPI.pfWrite8_A0 = _Write_A0; _PortAPI.pfWrite8_A1 = _Write_A1; _PortAPI.pfWriteM8_A1 = _WriteM_A1; GUIDRV_S1D15G00_SetBus8(pDevice, &_PortAPI); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
973
29.7.10 GUIDRV_SLin
Supported hardware
Controllers
The driver works with the following display controllers: · Epson S1D13700, S1D13305 (indirect interface only!) · Solomon SSD1848 · Ultrachip UC1617 · Toshiba T6963
Bits per pixel
Supported color depth is 1 and 2 bits per pixel. Please note that the Toshiba T6963 controller does only support the 1bpp mode.
Interfaces
The driver supports the 8 bit indirect interface.
Color depth and display orientation
The driver can be used with different orientations and color depths. The following table shows the configuration macros which can be used to create and link the driver during the initialization:
Identifier
GUIDRV_SLIN_1 GUIDRV_SLIN_OY_1 GUIDRV_SLIN_OX_1 GUIDRV_SLIN_OXY_1 GUIDRV_SLIN_OS_1 GUIDRV_SLIN_OSY_1 GUIDRV_SLIN_OSX_1 GUIDRV_SLIN_OSXY_1 GUIDRV_SLIN_2 GUIDRV_SLIN_OY_2 GUIDRV_SLIN_OX_2 GUIDRV_SLIN_OXY_2 GUIDRV_SLIN_OS_2 GUIDRV_SLIN_OSY_2 GUIDRV_SLIN_OSX_2 GUIDRV_SLIN_OSXY_2
Color depth and orientation
1bpp, default orientation 1bpp, Y axis mirrored 1bpp, X axis mirrored 1bpp, X and Y axis mirrored 1bpp, X and Y swapped 1bpp, X and Y swapped, Y axis mirrored 1bpp, X and Y swapped, X axis mirrored 1bpp, X and Y swapped, X and Y axis mirrored 2bpp, default orientation 2bpp, Y axis mirrored 2bpp, X axis mirrored 2bpp, X axis mirrored, Y axis mirrored 2bpp, X and Y swapped 2bpp, X and Y swapped, Y axis mirrored 2bpp, X and Y swapped, X axis mirrored 2bpp, X and Y swapped, Y and X axis mirrored
Driver selection
To use GUIDRV_SLin for the given display, the following command can be used e.g.:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_SLIN_OX_1, GUICC_1, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
974
CHAPTER
Display data RAM organization
Display drivers
COM 0
COM 1 . . .
COM n
DDDDDDDD BBBBBBBB 76543210
P0 P0
P1 P2 P1 P3 P4 P2 P5 P6 P3 P7 Pn Pn
1 bit / pixel 2 bit / pixel
Byte 0
Byte 1
. . .
Byte n
The picture above shows the relation between the display memory and the SEG and COM lines of the display.
RAM requirements
This display driver may be used with or without a display data cache, containing a complete copy of the LCD data RAM. If a cache is not used, there are no additional RAM requirements. It is recommended to use this driver with a data cache for faster LCD-access. The amount of memory used by the cache may be calculated as follows:
Size of RAM (in bytes) = BitsPerPixel * (LCD_XSIZE + 7) / 8 * LCD_YSIZE
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_SLin_Config
GUIDRV_SLin_SetBus8
GUIDRV_SLin_SetS1D13700 GUIDRV_SLin_SetSSD1848 GUIDRV_SLin_SetT6963 GUIDRV_SLin_SetUC1617
Description
Passes a pointer to a CONFIG_SLIN structure to the driver.
Tells the driver to use the 8 bit indirect interface and passes pointer to a GUI_PORT_API structure to the driver. Tells the driver to use an Epson S1D13700 or S1D13305 controller. Tells the driver to use a Solomon SSD1848 controller. Tells the driver to use a Toshiba T6963 controller. Tells the driver to use an Ultrachip UC1617 controller.
GUIDRV_SLin_Config()
Description
Passes a pointer to a CONFIG_SLIN structure to the driver.
Prototype
void GUIDRV_SLin_Config(GUI_DEVICE * pDevice, CONFIG_SLIN * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_SLIN structure described below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
975
Elements of CONFIG_SLIN
Data type int
int int int
Element FirstSEG
FirstCOM UseCache UseMirror
Description
First segment address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0. First common address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0. Enables or disables use of a data cache. Should be set to 1 for enabling and to 0 for disabling.
Only used with SSD1848. Should be normally 1.
GUIDRV_SLin_SetBus8()
Description
Tells the driver to use the 16 bit indirect interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_Slin_SetBus8(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device
Pointer to a GUI_PORT_API structure. See required routines below.
Required GUI_PORT_API routines
Element pfWrite8_A0 pfWrite8_A1 pfWriteM8_A0 pfWriteM8_A1 pfRead8_A1
Data type void (*)(U8 Data) void (*)(U8 Data) void (*)(U8 * pData, int NumItems) void (*)(U8 * pData, int NumItems) U8 (*)(void)
GUIDRV_SLin_SetS1D13700()
Description
Tells the driver that an Epson S1D13700 or S1D13305 controller should be used.
Prototype
void GUIDRV_SLin_SetS1D13700(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
GUIDRV_SLin_SetSSD1848()
Description
Tells the driver that a Solomon SSD1848 controller should be used.
Prototype
void GUIDRV_SLin_SetSSD1848(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
976
CHAPTER
GUIDRV_SLin_SetT6963()
Description
Tells the driver that a Toshiba T6963 controller should be used.
Prototype
void GUIDRV_SLin_SetT6963(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
GUIDRV_SLin_SetUC1617()
Description
Tells the driver that an Ultrachip UC1617 controller should be used.
Prototype
void GUIDRV_SLin_SetUC1617(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
Configuration Example
#define XSIZE 320 #define YSIZE 240
void LCD_X_Config(void) { GUI_DEVICE * pDevice; CONFIG_SLIN Config = {0}; GUI_PORT_API PortAPI = {0};
// // Set display driver and color conversion // pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_SLIN_2, GUICC_2, 0, 0); // // Common display driver configuration // LCD_SetSizeEx (0, XSIZE, YSIZE); LCD_SetVSizeEx(0, XSIZE, YSIZE); // // Driver specific configuration // Config.UseCache = 1; GUIDRV_SLin_Config(pDevice, &Config); // // Select display controller // GUIDRV_SLin_SetS1D13700(pDevice); // // Setup hardware access routines // PortAPI.pfWrite16_A0 = _Write0; PortAPI.pfWrite16_A1 = _Write1; PortAPI.pfWriteM16_A0 = _WriteM0; PortAPI.pfRead16_A1 = _Read1; GUIDRV_SLin_SetBus8(pDevice, &PortAPI); }
Display drivers
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
977
29.7.11 GUIDRV_SPage
Supported hardware
Controllers
The driver works with the following display controllers: · Epson S1D15E05, S1D15E06, S1D15605, S1D15606, S1D15607, S1D15608,
S1D15705, S1D15710, S1D15714, S1D15719, S1D15721 · Integrated Solutions Technology IST3020 · New Japan Radio Company NJU6676 · Novatek NT7502, NT7534, NT7538, NT75451 · Samsung S6B0713, S6B0719, S6B0724, S6B1713 · Sino Wealth SH1101A · Sitronix ST7522, ST7565, ST7567, ST7591 · Solomon SSD1303, SSD1805, SSD1815 · Sunplus SPLC501C · UltraChip UC1601, UC1606, UC1608, UC1611, UC1701
Bits per pixel
The driver currently supports 1, 2 and 4 bpp resolutions.
Interfaces
The driver supports the indirect interface (8 bit) of the display controller. Parallel, 4pin SPI or I2C bus can be used.
Color depth and display orientation
The driver can be used with different orientations and color depths. The following table shows the configuration macros which can be used to create and link the driver during the initialization:
Identifier
GUIDRV_SPAGE_1C0 GUIDRV_SPAGE_OY_1C0 GUIDRV_SPAGE_OX_1C0 GUIDRV_SPAGE_OXY_1C0 GUIDRV_SPAGE_OS_1C0 GUIDRV_SPAGE_OSY_1C0 GUIDRV_SPAGE_OSX_1C0 GUIDRV_SPAGE_OSXY_1C0 GUIDRV_SPAGE_1C1 GUIDRV_SPAGE_OY_1C1 GUIDRV_SPAGE_OX_1C1 GUIDRV_SPAGE_OXY_1C1 GUIDRV_SPAGE_OS_1C1 GUIDRV_SPAGE_OSY_1C1 GUIDRV_SPAGE_OSX_1C1 GUIDRV_SPAGE_OSXY_1C1 GUIDRV_SPAGE_2C0 GUIDRV_SPAGE_OY_2C0 GUIDRV_SPAGE_OX_2C0 GUIDRV_SPAGE_OXY_2C0 GUIDRV_SPAGE_OS_2C0 GUIDRV_SPAGE_OSY_2C0 GUIDRV_SPAGE_OSX_2C0 GUIDRV_SPAGE_OSXY_2C0 GUIDRV_SPAGE_2C1 GUIDRV_SPAGE_OY_2C1 GUIDRV_SPAGE_OX_2C1 GUIDRV_SPAGE_OXY_2C1
Color depth Cache
1bpp
No
1bpp
No
1bpp
No
1bpp
No
1bpp
No
1bpp
No
1bpp
No
1bpp
No
1bpp
Yes
1bpp
Yes
1bpp
Yes
1bpp
Yes
1bpp
Yes
1bpp
Yes
1bpp
Yes
1bpp
Yes
2bpp
No
2bpp
No
2bpp
No
2bpp
No
2bpp
No
2bpp
No
2bpp
No
2bpp
No
2bpp
Yes
2bpp
Yes
2bpp
Yes
2bpp
Yes
Orientation
default Y axis mirrored X axis mirrored X and Y axis mirrored X and Y swapped X and Y swapped, Y axis mirrored X and Y swapped, X axis mirrored X and Y swapped, X and Y axis mirrored default Y axis mirrored X axis mirrored X and Y axis mirrored X and Y swapped X and Y swapped, Y axis mirrored X and Y swapped, X axis mirrored X and Y swapped, X and Y axis mirrored default Y axis mirrored X axis mirrored X and Y axis mirrored X and Y swapped X and Y swapped, Y axis mirrored X and Y swapped, X axis mirrored X and Y swapped, X and Y axis mirrored default Y axis mirrored X axis mirrored X and Y axis mirrored
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
978
CHAPTER
Display drivers
Identifier
GUIDRV_SPAGE_OS_2C1 GUIDRV_SPAGE_OSY_2C1 GUIDRV_SPAGE_OSX_2C1 GUIDRV_SPAGE_OSXY_2C1 GUIDRV_SPAGE_4C0 GUIDRV_SPAGE_OY_4C0 GUIDRV_SPAGE_OX_4C0 GUIDRV_SPAGE_OXY_4C0 GUIDRV_SPAGE_OS_4C0 GUIDRV_SPAGE_OSY_4C0 GUIDRV_SPAGE_OSX_4C0 GUIDRV_SPAGE_OSXY_4C0 GUIDRV_SPAGE_4C1 GUIDRV_SPAGE_OY_4C1 GUIDRV_SPAGE_OX_4C1 GUIDRV_SPAGE_OXY_4C1 GUIDRV_SPAGE_OS_4C1 GUIDRV_SPAGE_OSY_4C1 GUIDRV_SPAGE_OSX_4C1 GUIDRV_SPAGE_OSXY_4C1
Color depth Cache
2bpp
Yes
2bpp
Yes
2bpp
Yes
2bpp
Yes
4bpp
No
4bpp
No
4bpp
No
4bpp
No
4bpp
No
4bpp
No
4bpp
No
4bpp
No
4bpp
Yes
4bpp
Yes
4bpp
Yes
4bpp
Yes
4bpp
Yes
4bpp
Yes
4bpp
Yes
4bpp
Yes
Orientation
X and Y swapped X and Y swapped, Y axis mirrored X and Y swapped, X axis mirrored X and Y swapped, X and Y axis mirrored default Y axis mirrored X axis mirrored X and Y axis mirrored X and Y swapped X and Y swapped, Y axis mirrored X and Y swapped, X axis mirrored X and Y swapped, X and Y axis mirrored default Y axis mirrored X axis mirrored X and Y axis mirrored X and Y swapped X and Y swapped, Y axis mirrored X and Y swapped, X axis mirrored X and Y swapped, X and Y axis mirrored
Important note for mirroring
As far as we know nearly all supported controllers of this driver support hardware mirroring for X- and Y-axis. If one or both of axis need to be mirrored it is highly recommended to use the hardware commands for mirroring within the initialization sequence of the controller, because software mirroring could cause a negative effect on the performance.
Driver selection
To use GUIDRV_SPage for the given display, the following call may be used in the function LCD_X_Config:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_SPAGE_4C0, GUICC_4, 0, 0);
Please refer to the chapter "Colors" on page 265 to get more information about using the proper palette mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
979
Display data RAM organization
4BPP
2BPP
SEG SEG SEG
0
1
2
. . .
SEG n
Page 0
COM 0
COM 0 COM 1
COM 1
COM 2 COM 3
DB0 DB1 DB2 DB3 DB4 DB5 DB6 DB7
. ..
Page n
COM n
COM n
DB0 DB1 DB2 DB3 DB4 DB5 DB6 DB7
The picture above shows the relation between the display memory and the SEG and COM lines of the display.
RAM requirements
This display driver can be used with or without a display data cache. The data cache contains a complete copy of the LCD data RAM. If no cache is used, there are no additional RAM requirements. It is highly recommended to use this driver with a data cache for faster LCD-access. Not using a cache degrades the performance of this driver seriously. The amount of memory used by the cache may be calculated as follows:
Size of RAM (in bytes) = (LCD_YSIZE + (8 / LCD_BITSPERPIXEL - 1)) / 8 * LCD_BITSPERPIXEL * LCD_XSIZE
Run-time configuration
The table below shows the available run-time configuration routines for this driver:
Routine GUIDRV_SPage_Config
GUIDRV_SPage_SetBus8
GUIDRV_SPage_SetS1D15 GUIDRV_SPage_SetST7591 GUIDRV_SPage_SetUC1611
Description
Passes a pointer to a CONFIG_SPAGE structure. Tells the driver to use the 8 bit indirect interface and passes pointer to a GUI_PORT_API structure to the driver. Tells the driver to use an Epson S1D15xxx controller. Tells the driver to use a Sitronix ST7591 controller. Tells the driver to use an UltraChip UC1611 controller.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
980
CHAPTER
Display drivers
GUIDRV_SPage_Config()
Description
Passes a pointer to a CONFIG_SPAGE structure to the driver.
Prototype
void GUIDRV_SPage_Config(GUI_DEVICE * pDevice, CONFIG_SPAGE * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_SPAGE structure described below.
Elements of CONFIG_SPAGE
Data type
Element
int
FirstSEG
int
FirstCOM
Description
First segment address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0.
First common address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0.
GUIDRV_SPage_SetBus8()
Description
Tells the driver to use the 8 bit indirect interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_SPage_SetBus8(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device.
Pointer to a GUI_PORT_API structure. See required routines below.
Required GUI_PORT_API routines
Element pfWrite8_A0 pfWrite8_A1 pfWriteM8_A1 pfRead8_A1
Data type void (*)(U8 Data) void (*)(U8 Data) void (*)(U8 * pData, int NumItems) U8 (*)(void)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
981
GUIDRV_SPage_Set1510()
Description
Configures the driver to use one of the following controllers: · Epson S1D15605, S1D15606, S1D15607, S1D15608, S1D15705, S1D15710,
S1D15714 · Integrated Solutions Technology IST3020 · New Japan Radio Company NJU6676 · Novatek NT7502, NT7534, NT7538, NT75451 · Samsung S6B0713, S6B0719, S6B0724, S6B1713 · Sino Wealth SH1101A · Sitronix ST7522, ST7565, ST7567 · Solomon SSD1303, SSD1805, SSD1815, SSD1821 · Sunplus SPLC501C · UltraChip UC1601, UC1606, UC1608, UC1701
Prototype
void GUIDRV_SPage_Set1510(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
GUIDRV_SPage_Set1512()
Description
Configures the driver to use one of the following controllers: · Epson S1D15E05, S1D15E06, S1D15719, S1D15721
Prototype
void GUIDRV_SPage_Set1512(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
GUIDRV_SPage_SetST7591()
Description
Configures the driver to use the Sitronix ST7591 controller.
Prototype
void GUIDRV_SPage_SetST7591(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
GUIDRV_SPage_SetUC1611()
Description
Configures the driver use to the UltraChip UC1611 controller.
Prototype
void GUIDRV_SPage_SetUC1611(GUI_DEVICE * pDevice);
Parameter pDevice
Pointer to the driver device.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
982
CHAPTER
Display drivers
Configuration Example
void LCD_X_Config(void) { CONFIG_SPAGE Config = {0}; GUI_DEVICE * pDevice; GUI_PORT_API PortAPI = {0};
// // Set display driver and color conversion for 1st layer // pDevice = GUI_DEVICE_CreateAndLink(DISPLAY_DRIVER, COLOR_CONVERSION, 0, 0); // // Display size configuration // if (LCD_GetSwapXY()) {
LCD_SetSizeEx (0, YSIZE_PHYS, XSIZE_PHYS); LCD_SetVSizeEx(0, VYSIZE_PHYS, VXSIZE_PHYS); } else { LCD_SetSizeEx (0, XSIZE_PHYS, YSIZE_PHYS); LCD_SetVSizeEx(0, VXSIZE_PHYS, VYSIZE_PHYS); } // // Driver configuration // Config.FirstSEG = 0;//256 - 224; GUIDRV_SPage_Config(pDevice, &Config); // // Configure hardware routines // PortAPI.pfWrite8_A0 = _Write8_A0; PortAPI.pfWrite8_A1 = _Write8_A1; PortAPI.pfWriteM8_A1 = _WriteM8_A1; PortAPI.pfReadM8_A1 = LCD_X_8080_8_ReadM01; GUIDRV_SPage_SetBus8(pDevice, &PortAPI); // // Controller configuration // GUIDRV_SPage_SetUC1611(pDevice); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
983
29.7.12 GUIDRV_SSD1926
Supported hardware
Controllers
This driver works with the Solomon SSD1926 display controller.
Bits per pixel
Currently supported color depth is 8. The display controller supports up to 32 bits per pixel. The driver can be extended on demand if support for an other color depth is required.
Interfaces
The driver supports the 16 bit indirect interface.
Color depth and display orientation
This driver can be used with different orientations. The following table shows the configuration macros which can be used to create and link the driver during the initialization:
Identifier
GUIDRV_SSD1926_8 GUIDRV_SSD1926_OY_8 GUIDRV_SSD1926_OX_8 GUIDRV_SSD1926_OXY_8 GUIDRV_SSD1926_OS_8 GUIDRV_SSD1926_OSY_8 GUIDRV_SSD1926_OSX_8 GUIDRV_SSD1926_OSXY_8
Color depth and orientation
8bpp, default orientation 8bpp, Y axis mirrored 8bpp, X axis mirrored 8bpp, X and Y axis mirrored 8bpp, X and Y swapped 8bpp, X and Y swapped, Y axis mirrored 8bpp, X and Y swapped, X axis mirrored 8bpp, X and Y swapped, X and Y axis mirrored
Driver selection
To use GUIDRV_SSD1926 for the given display, the following command can be used e.g.:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_SSD1926, GUICC_323, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Display data RAM organization
SEG 0 SEG 1 SEG 2 . . . SEG n
COM 0 COM 1 COM 2
. . .
COM n
Byte 0 Byte 1 Byte 2
Byte n
The picture above shows the relation between the display memory and the SEG and COM lines of the display.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
984
CHAPTER
Display drivers
RAM requirements
This display driver may be used with or without a display data cache, containing a complete copy of the LCD data RAM. If no cache is used, there are no additional RAM requirements. It is recommended to use this driver with a data cache for faster LCD-access. The amount of memory used by the cache may be calculated as follows:
Size of RAM (in bytes) = LCD_XSIZE * LCD_YSIZE
Additional run-time configuration
The table below shows the available run-time configuration routines of this driver:
Routine GUIDRV_SSD1926_Config GUIDRV_SSD1926_SetBus16
Description
Passes a pointer to a CONFIG_SSD1926 structure to the driver. Tells the driver to use the 16 bit indirect interface and passes pointer to a GUI_PORT_API structure to the driver.
GUIDRV_SSD1926_Config()
Description
Passes a pointer to a CONFIG_SSD1926 structure to the driver.
Prototype
void GUIDRV_SSD1926_Config(GUI_DEVICE * pDevice, CONFIG_SSD1926 * pConfig);
Parameter pDevice pConfig
Description
Pointer to the driver device.
Pointer to a CONFIG_SSD1926 structure described below.
Elements of CONFIG_SSD1926
Data type int int int
Element FirstSEG FirstCOM UseCache
Description
First segment address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0.
First common address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation. The value is normally 0.
Enables or disables use of a data cache. Should be set to 1 for enabling and to 0 for disabling.
GUIDRV_SSD1926_SetBus16()
Description
Tells the driver to use the 16 bit indirect interface and passes a pointer to a GUI_PORT_API structure to the driver containing function pointers to the hardware routines to be used.
Prototype
void GUIDRV_SSD1926_SetBus16(GUI_DEVICE * pDevice, GUI_PORT_API * pHW_API);
Parameter pDevice pHW_API
Description
Pointer to the driver device.
Pointer to a GUI_PORT_API structure. See required routines below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
985
Required GUI_PORT_API routines
Data type
void (*)(U16 Data)
void (*)(U16 Data) void (*)(U16 * pData, int NumItems) void (*)(U16 * pData, int NumItems) U16 (*)(void)
Element
Description
pfWrite16_A0 pfWrite16_A1
Pointer to a function which writes one word to the controller with C/D line low.
Pointer to a function which writes one word to the controller with C/D line high.
Pointer to a function which writes multiple words to
pfWriteM16_A0 the controller with C/D line low.
Pointer to a function which writes multiple words to
pfWriteM16_A1 the controller with C/D line high.
pfRead16_A1
Pointer to a function which reads one word from the controller with C/D line high.
Configuration Example
#define XSIZE 320L #define YSIZE 240L
GUI_PORT_API _PortAPI;
void LCD_X_Config(void) { GUI_DEVICE * pDevice_0; CONFIG_SSD1926 Config_0 = {0};
// // Set display driver and color conversion // pDevice_0 = GUI_DEVICE_CreateAndLink(GUIDRV_SSD1926_8, GUICC_8666, 0, 0); // // Common display driver configuration // LCD_SetSizeEx (0, XSIZE, YSIZE); LCD_SetVSizeEx(0, XSIZE, YSIZE); // // Set driver specific configuration items // Config_0.UseCache = 1; // // Set hardware access routines // _PortAPI.pfWrite16_A0 = LCD_X_8080_16_Write00_16; _PortAPI.pfWrite16_A1 = LCD_X_8080_16_Write01_16; _PortAPI.pfWriteM16_A0 = LCD_X_8080_16_WriteM00_16; _PortAPI.pfWriteM16_A1 = LCD_X_8080_16_WriteM01_16; _PortAPI.pfRead16_A1 = LCD_X_8080_16_Read01_16; GUIDRV_SSD1926_SetBus16(pDevice, &_PortAPI); // // Pass configuration structure to driver // GUIDRV_SSD1926_Config(pDevice, &Config_0); }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
986
CHAPTER
Display drivers
29.7.13 GUIDRV_CompactColor_16
This driver comes with the run-time configurable GUIDRV_FlexColor at no additional cost.
Controllers
This driver works with the following display controllers: · Ampire FSA506 · Epson S1D13742, S1D13743, S1D19122 · FocalTech FT1509 · Himax HX8301, HX8312A, HX8325A, HX8340, HX8347, HX8352, HX8352B,
HX8353 · Hitachi HD66766, HD66772, HD66789 · Ilitek ILI9161, ILI9220, ILI9221, ILI9320, ILI9325, ILI9326, ILI9328, ILI9342,
ILI9481 · LG Electronics LGDP4531, LGDP4551 · MagnaChip D54E4PA7551 · Novatek NT39122, NT7573 · OriseTech SPFD5408, SPFD54124C, SPFD5414D, SPFD5420A · Renesas R61505, R61509, R61516, R61526, R61580, R63401 · Samsung S6D0110A, S6D0117, S6D0129, S6D04H0 · Sharp LCY-A06003, LR38825 · Sitronix ST7628, ST7637, ST7687, ST7712, ST7715, ST7735, ST7787 · Solomon SSD1284, SSD1289, SSD1298, SSD1355, SSD1961, SSD1963,
SSD2119 · Toshiba JBT6K71
Bits per pixel
Supported color depth is 16 bpp.
Interfaces
The driver supports the indirect interface (8- and 16-bit) and the 3 pin SPI interface. Default mode is 8-bit indirect.
Driver selection and configuration
To be able to use this driver the following macro definition needs to be added to the configuration file LCDConf.h:
#define LCD_USE_COMPACT_COLOR_16
After this define has been added the display driver assumes the driver specific configuration file LCDConf_CompactColor_16.h in the configuration folder. All further compile time configuration macros should be defined in this file. To create a driver device using the GUIDRV_CompactColor_16 for the given display, e.g. the following command can be used:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_COMPACT_COLOR_16, GUICC_565, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
987
Display data RAM organization
16 bits per pixel, fixed palette = 565
SEG0
Byte 0
Byte 1
. . .
COM 0
COM 1
. . .
COM n
RRRRRGGGGGGBBBBB DDDDDDDDDDDDDDDD BBBBBBBBBBBBBBBB 7654321076543210
RRRRRGGGGGGBBBBB
Byte n
The picture above shows the relation between the display memory and the SEG and COM lines of the LCD.
RAM requirements
This LCD driver can be used with and without a display data cache, containing a complete copy of the contents of the LCD data RAM. The amount of memory used by the cache is: LCD_XSIZE * LCD_YSIZE * 2 bytes. Using a cache is only recommended if it is intended to use a lot of drawing operations using the XOR drawing mode. A cache would avoid reading the display data in this case. Normally the use of a cache is not recommended.
The driver uses a write buffer for drawing multiple pixels of the same color. If multiple pixels of the same color should be drawn, the driver first fills the buffer and then performs a single call of the LCD_WRITEM_A1 macro to transfer the data to the display controller at once. The default buffer size is 500 bytes.
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the
configuration file LCDConf_CompactColor_16.h. The following table shows the values to be used to select the appropriate controller:
Number 66700
66701
66702 66703 66704 66705 66706 66707
Supported Controller
Sharp LR38825 Ilitek ILI9326 OriseTech SPFD5420A Renesas R61509, R63401 Solomon SSD1284, SSD1289, SSD1298 Toshiba JBT6K71 Sharp LCY-A06003 Samsung S6D0129 MagnaChip D54E4PA7551 Himax HX8312
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
988
CHAPTER
Display drivers
Number
66708
66709
66710 66711 66712 66713 66714 66715 66716 66717 66766
66772
66789
Supported Controller
FocalTech FT1509 Ilitek ILI9320, ILI9325, ILI9328 LG Electronics LGDP4531, LGDP4551 OriseTech SPFD5408 Renesas R61505, R61580 Epson S1D19122 Himax HX8353 Ilitek ILI9342, ILI9481 Novatek NT39122 Orisetech SPFD54124C, SPFD5414D Renesas R61516, R61526 Samsung S6D04H0 Sitronix ST7628, ST7637, ST7687, ST7715, ST7735 Solomon SSD1355, SSD1961, SSD1963
Novatek NT7573
Epson S1D13742, S1D13743
Himax HX8347, HX8352
Himax HX8340
Solomon SSD2119
Himax HX8352B
Ampire FSA506
Sitronix ST7787
Hitachi HD66766 Ilitec ILI9161 Samsung S6D0110A Himax HX8301 Hitachi HD66772 Ilitec ILI9220, ILI9221 Samsung S6D0117 Sitronix ST7712
Hitachi HD66789
Display configuration
The following table shows the available configuration macros:
Macro LCD_MIRROR_X LCD_MIRROR_Y LCD_SWAP_XY
Description
Activate to mirror X-axis. Activate to mirror Y-axis. Activate to swap X- and Y-axis.
For details, refer to "Display orientation" on page 934.
Hardware access
The following table shows the available configuration macros which can be defined in this file for configuring the hardware access:
Macro LCD_NUM_DUMMY_READS LCD_REG01 LCD_SERIAL_ID
Description
Number of required dummy reads if a read operation should be executed. The default value is 2. If using a serial interface the display controllers HD66766 and HD66772 need 5 dummy reads. Sharp LR38825 needs 3 dummy reads with a 8-bit bus.
This macro is only required if a Himax HX8312A is used. Unfortunately the register 0x01 (Control register 1) contains orientation specific settings as well as common settings. So this macro should contain the contents of this register.
With a serial 3 wire interface this macro defines the ID signal of the device ID code. It should be 0 (default) or 1. Please note: This macro is only used with the 3 wire protocol for Hitachi HD66772, Samsung S6D0117, Himax HX8301 and Ilitek ILI9220.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
989
Macro
LCD_USE_SERIAL_3PIN
LCD_USE_PARALLEL_16
LCD_WRITE_BUFFER_SIZE
LCD_WRITE_A0 LCD_WRITE_A1 LCD_READM_A1 LCD_WRITEM_A1 LCD_WRITEM_A0
Description
This configuration macro has been implemented to support the 3 wire serial interface of the following controllers: Hitachi HD66772, Samsung S6D0117, Himax HX8301, Ilitek ILI9220. Should be set to 1 if the 3 wire serial interface is used. Default is 0. Please note: Do not use this macro with other display controllers!
Should be set to 1 if the 16 bit parallel interface is used. Default is 0.
Defines the size of the write buffer. Using a write buffer increases the performance of the driver. If multiple pixels should be written with the same color, the driver first fills the buffer and then writes the content of the buffer using LCD_WRITEM_A1 instead of multiple calls of LCD_WRITE_A1. The default buffer size is 500 bytes.
Write a byte to display controller with RS-line low.
Write a byte to display controller with RS-line high.
Read multiple bytes (8 bit parallel interface) or multiple words (16 bit parallel interface) from display controller with RS-line high. Write multiple bytes (8 bit parallel interface) or multiple words (16 bit parallel interface) to display controller with RS-line high. Write multiple bytes (8 bit parallel interface) or multiple words (16 bit parallel interface) to display controller with RS-line low.
The 'Driver Output Mode' and 'Entry Mode' registers are initialized automatically.
Available configuration routines (run-time configuration)
The following table lists the available run-time configuration routines:
Routine LCD_SetSizeEx()
Description
Changes the size of the visible area.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
990
CHAPTER
Display drivers
Configuration example
The following shows how to select the driver and how it can be configured:
LCDConf.h
As explained above it should include the following for selecting the driver:
#define LCD_USE_COMPACT_COLOR_16
LCDConf_CompactColor_16.h
This file contains the display driver specific configuration and could look as the fol-
lowing:
//
// General configuration of LCD
//
#define LCD_CONTROLLER
66709 // Renesas R61516
#define LCD_BITSPERPIXEL
16
#define LCD_USE_PARALLEL_16
1
#define LCD_MIRROR_Y
1
//
// Indirect interface configuration
//
void LCD_X_Write01_16(unsigned short c);
void LCD_X_Write00_16(unsigned short c);
void LCD_X_WriteM01_16(unsigned short * pData, int NumWords);
void LCD_X_WriteM00_16(unsigned short * pData, int NumWords);
void LCD_X_ReadM01_16 (unsigned short * pData, int NumWords);
#define LCD_WRITE_A1(Word) LCD_X_Write01_16(Word)
#define LCD_WRITE_A0(Word) LCD_X_Write00_16(Word)
#define LCD_WRITEM_A1(Word, NumWords) LCD_X_WriteM01_16(Word, NumWords)
#define LCD_WRITEM_A0(Word, NumWords) LCD_X_WriteM00_16(Word, NumWords)
#define LCD_READM_A1(Word, NumWords) LCD_X_ReadM01_16(Word, NumWords)
LCDConf.c
The following shows how to create a display driver device with this driver and how to configure it:
void LCD_X_Config(void) {
//
// Set display driver and color conversion
//
GUI_DEVICE_CreateAndLink(GUIDRV_COMPACT_COLOR_16, // Display driver
GUICC_M565,
// Color conversion
0, 0);
//
// Display driver configuration
//
LCD_SetSizeEx(0, 240, 320);
// Physical display size in pixels
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
991
29.7.14 GUIDRV_Fujitsu_16
This driver supports the Fujitsu Graphic display controllers. It has been tested with "Jasmine", but it should also work with "Lavender", since all relevant registers are compatible.
Supported hardware
Controllers
This driver works with the following display controllers: · Fujitsu Jasmine · Fujitsu Lavender
Bits per pixel
Supported color depths are 1, 2, 4, 8 and 16 bpp.
Interfaces
The driver has been tested with a 32 bit interface to the CPU. If a 16 bit interface is used, the 32-bit accesses can be replaced by 2 16-bit accesses.
Driver selection
To use GUIDRV_Fujitsu_16 for the given display, the following command can be used e.g.:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_FUJITSU_16, GUICC_556, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the configuration file LCDConf_Fujitsu_16.h. The following table shows the values to be used to select the appropriate controller:
8720 8721
Number
Fujitsu Jasmine Fujitsu Lavender
Supported Controller
Display data RAM organization
The display controller uses DRAM in an optimized, non-linear way (described in the Fujitsu documentation). Direct memory access is not used by the driver.
RAM requirements
About 16 bytes for some static variables.
Hardware configuration
This driver requires a direct interface for hardware access as described in the chapter "Configuration" on page 1039. The following table lists the macros which must be defined for hardware access:
Macro LCD_READ_REG LCD_WRITE_REG
Description
Read a register of the display controller. (as 32 bit value) (optional) Write a register of the display controller. (as 32 bit value) (optional)
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
992
CHAPTER
Display drivers
The driver contains a default for hardware access macros, which configures 32 bit access on the Fujitsu demonstration platform (Using an MB91361 or MB91362 and a Jasmine chip at address 0x30000000); if the target hardware is compatible with these settings, then LCD_READ_REG(), LCD_WRITE_REG() do not need to be defined.
Color format (R/B swap)
It seems that on some target systems, Red and blue are swapped. This can be changed via software if the Config switch LCD_SWAP_RB is toggled in the configuration file.
Hardware initialization
The display controller requires a complicated initialization. Example code is available from Fujitsu in the GDC module. This code is not part of the driver, since it depends on the actual chip used, on the clock settings, the display and a lot of other things. We recommend using the original Fujitsu code, since the documentation of the chips is not sufficient to write this code. Before calling GUI_Init(), the GDC should be initialized using this code (typically called as GDC_Init(0xff)).
Example:
LCDConf.h for VGA display, 8bpp, Jasmine:
#define LCD_XSIZE
640 // X-resolution of LCD, Logical color
#define LCD_YSIZE
480 // Y-resolution of LCD, Logical color
#define LCD_BITSPERPIXEL 8
#define LCD_CONTROLLER 8720 // Jasmine
Additional configuration switches
The following table shows optional configuration macros available for this driver:
Macro LCD_ON LCD_OFF
Description
Function replacement macro which switches the display on. Function replacement macro which switches the display off.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
993
29.7.15 GUIDRV_Page1bpp
Supported hardware
Controllers
This driver works with the following display controllers: · Epson S1D10605, S1D15605, S1D15705, S1D15710, S1D15714, S1D15721,
S1D15E05, S1D15E06, SED1520, SED1560, SED1565, SED1566, SED1567, SED1568, SED1569, SED1575 · Hitachi HD61202 · Integrated Solutions Technology IST3020 · New Japan Radio Company NJU6676, NJU6679 · Novatek NT7502, NT7534, NT7538, NT75451 · Philips PCF8810, PCF8811, PCF8535, PCD8544 · Samsung KS0108B, KS0713, KS0724, S6B0108B, S6B0713, S6B0719, S6B0724, S6B1713 · Sino Wealth SH1101A · Sitronix ST7522, ST7565, ST7567 · Solomon SSD1303, SSD1805, SSD1815, SSD1821 · ST Microelectronics ST7548, STE2001, STE2002 · Sunplus SPLC501C · UltraChip UC1601, UC1606, UC1608, UC1701
It should be assumed that it will also work with every similar organized controller.
Bits per pixel
Supported color depth is 1bpp.
Interfaces
The driver supports the indirect interface (8 bit) of the display controller. Parallel, 4pin SPI or I2C bus can be used.
Driver selection
To use GUIDRV_Page1bpp for the given display, the following command should be used:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_PAGE1BPP, GUICC_1, 0, 0);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
994
CHAPTER
Display drivers
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the configuration file LCDConf_Page1bpp.h. The following table shows the values to be used to select the appropriate controller:
1501
1502 1503 1504 1505 1506 1507 1508 1509
Number
1510
1511 1512 1513 1520 1560
1565
1566 1567 1568 1569 1575
Supported Controller
Samsung KS0713, KS0724, S6B0713, S6B0724 UltraChip UC1601, UC1606 Samsung KS0108B S6B0108B
Hitachi HD61202
Philips PCF8810, PCF8811
Philips PCF8535
New Japan Radio Company NJU6679
Philips PCD8544
Epson S1D15710
Solomon SSD1303 OLED controller Epson S1D15714 Integrated Solutions Technology IST3020 New Japan Radio Company NJU6676 Novatek NT7538, NT75451 Samsung S6B0719 Sino Wealth SH1101A Sitronix ST7522, ST7565, ST7567 Solomon SSD1805, SSD1821 UltraChip UC1608, UC1701 Epson S1D15721
Epson S1D15E05, S1D15E06
ST Microelectronics ST7548, STE2001, STE2002
Epson SED1520
Epson SED1560 Epson SED1565, S1D10605, S1D15605 Novatek NT7502, NT7534 Samsung S6B1713 Solomon SSD1815 Sunplus SPLC501C Epson SED1566
Epson SED1567
Epson SED1568
Epson SED1569
Epson SED1575, S1D15705
RAM requirements
This LCD driver can be used with or without a display data cache in the most cases. If one display contains more than 1 LCD controller you can not disable the cache. The data cache contains a complete copy of the contents of the LCD data RAM. If a cache is not used, there are no additional RAM requirements. It is recommended to use this driver with a data cache for faster LCD-access. The amount of memory used by the cache may be calculated as follows: Size of RAM (in bytes) = (LCD_YSIZE + 7) / 8 * LCD_XSIZE
Additional driver functions
LCD_ControlCache
For information about this function, please refer to page 1016.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
995
Hardware configuration
This driver accesses the hardware via indirect interface as described in the chapter "Configuration" on page 1039. The following table lists the macros which must be defined for hardware access:
Macro LCD_READ_A0 LCD_READ_A1 LCD_WRITE_A0 LCD_WRITE_A1 LCD_WRITEM_A1
Description
Read a byte from LCD controller with A-line low. Read a byte from LCD controller with A-line high. Write a byte to LCD controller with A-line low. Write a byte to LCD controller with A-line high. Write multiple bytes to LCD controller with A-line high.
Display orientation
Some of the supported display controllers supports hardware mirroring of x/y axis. It is recommended to use these functions instead of the display orientation macros of emWin. If mirroring of the X axis is needed, the command 0xA1 (ADC select reverse) should be used in the initialization macro. This causes the display controller to reverse the assignment of column address to segment output. If the display size in X is smaller than the number of segment outputs of the display controller, the macro LCD_FIRSTSEG0 can be used to add an offset to the column address to make sure, the right RAM address of the LCD controller is accessed. If mirroring of the Y axis is needed the command 0xC8 (SHL select revers) should be used in the initialization macro and the macro LCD_FIRSTCOM0 should be used to define the offset needed to access the right RAM address of the display controller.
Additional configuration switches
The following table shows optional configuration switches available for this driver:
Macro LCD_CACHE LCD_FIRSTCOM0
LCD_FIRSTSEG0 LCD_SUPPORT_CACHECONTROL
Description
When set to 0, no display data cache is used, which slows down the speed of the driver. Default is 1 (cache activated). This macro can be used to define the first common address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display doc. This macro can be used to define the first segment address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display doc.
When set to 1, LCD_ControlCache() can be used.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
996
CHAPTER
Display drivers
29.7.16 GUIDRV_07X1
Supported hardware
Controllers
This driver works with the following LCD controllers: · Novatek NT7506, NT7508 · Samsung KS0711, KS0741, S6B0711, S6B0741 · Solomon SSD1854 · Sitronix ST7541, ST7571 · ST Microelectronics STE2010 · Tomato TL0350A
Bits per pixel
Supported color depth is 2 bpp.
Interface
The controller supports either the 8-bit parallel interface as well as the 4-pin or 3-pin serial peripheral interface (SPI). The current version of the driver supports the 8-bit parallel or 4-pin SPI interface. 3 pin SPI is currently not supported.
Driver selection
To use GUIDRV_07X1 for the given display, the following command can be used e.g.: pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_07X1, GUICC_2, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the configuration file LCDConf_07X1.h. The following table shows the values to be used to select the appropriate controller:
Number 701 702 711
741
Supported Controller
Novatek NT7506 Solomon SSD1854
ST Microelectronics STE2010
Samsung KS0711, S6B0711
Novatek NT7508 Samsung KS0741, S6B0741 Sitronix ST7541, ST7571 Tomato TL0350A
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
997
Display data RAM organization
SEG SEG SEG
0
1
2
. . .
SEG n
Page 0
Pane 1 Pane 0
COM 0 COM 1 COM 2 COM 3 COM 4 COM 5 COM 6 COM 7
DB0 DB1 DB2 DB3 DB4 DB5 DB6 DB7
...
Page n
COM n
DB0 DB1 DB2 DB3 DB4 DB5 DB6 DB7
The picture above shows the relation between the display memory and the SEG and COM lines of the LCD. The display memory is divided into two panes for each pixel. The lower bit of each pixel is stored in pane 0 and the higher bit is stored in pane 1.
RAM requirements
This LCD driver may be used with or without a display data cache, containing a complete copy of the contents of the LCD data RAM. If a cache is not used, there are no additional RAM requirements. It is recommended to use this driver with a data cache for faster LCD-access. The amount of memory used by the cache may be calculated as follows: Size of RAM (in bytes) = (LCD_YSIZE + 7) / 8 * LCD_XSIZE * 2
Additional driver functions
LCD_ControlCache
For information about this function, please refer to page 1016.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
998
CHAPTER
Display drivers
Hardware configuration
This driver accesses the hardware using the indirect interface as described in the chapter "Configuration" on page 1039. The following table lists the macros which must be defined for hardware access:
Macro LCD_READ_A0
LCD_READ_A1 LCD_WRITE_A0 LCD_WRITE_A1 LCD_WRITEM_A1
Description
Read a byte from LCD controller with A-line low. (Used only if working without cache) Read a byte from LCD controller with A-line high. (Used only if working without cache) Write a byte to LCD controller with A-line low.
Write a byte to LCD controller with A-line high.
Write multiple bytes to LCD controller with A-line high.
Display orientation
The supported display controllers supports hardware mirroring of x/y axis. It is recommended to use these functions instead of the display orientation macros of emWin. If mirroring of the X axis is needed, the command 0xA1 (ADC select reverse) should be used in the initialization macro. This causes the display controller to reverse the assignment of column address to segment output. If the display size in X is smaller than the number of segment outputs of the display controller, the macro LCD_FIRSTSEG0 can be used to add an offset to the column address to make sure, the right RAM address of the LCD controller is accessed. If mirroring of the Y axis is needed the command 0xC8 (SHL select revers) should be used in the initialization macro and the macro LCD_FIRSTCOM0 should be used to define the offset needed to access the right RAM address of the display controller.
Additional configuration switches
The following table shows optional configuration switches available for this driver:
Macro LCD_FIRSTCOM0 LCD_FIRSTSEG0
Description
This macro can be used to define the first common address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation.
This macro can be used to define the first segment address to be used in the data RAM of the display controller. The value can be determined experimentally or taken from the display documentation.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
999
29.7.17 GUIDRV_1611
Supported hardware
Controllers
This driver works with the following display controllers: · Epson S1D15E05, S1D15E06, S1D15719 · UltraChip UC1610, UC1611, UC1611s
Bits per pixel
Supported color depth is 2bpp (UC1610, S1D15E05, S1D15E06, S1D15719) and 4bpp (UC1611).
Interfaces
The driver supports the indirect interface (8 bit) of the display controller. Parallel, 4pin SPI or I2C bus can be used.
Driver selection
To select GUIDRV_1611 as the driver to be used by your application, you can use e.g. the following command in the function LCD_X_Config() (LCDConf.c):
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_1611, GUICC_2, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the configuration file LCDConf_1611.h. The following table shows the values to be used to select the appropriate controller:
1701 1702 1800 1801 1802
Number
Epson S1D15E05 Epson S1D15719 UltraChip UC1611 UltraChip UC1610 UltraChip UC1611s
Supported Controller
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1000
CHAPTER
Display data RAM organization
4BPP
2BPP
SEG SEG SEG
0
1
2
. . .
SEG n
Page 0
COM 0
COM 0 COM 1
COM 1
COM 2 COM 3
DB0 DB1 DB2 DB3 DB4 DB5 DB6 DB7
Display drivers
. ..
Page n
COM n
COM n
DB0 DB1 DB2 DB3 DB4 DB5 DB6 DB7
The picture above shows the relation between the display memory and the SEG and COM lines of the LCD.
RAM requirements
This display driver can be used with or without a display data cache. The data cache contains a complete copy of the LCD data RAM. If no cache is used, there are no additional RAM requirements. It is highly recommended to use this driver with a data cache for faster LCD-access. Not using a cache degrades the performance of this driver seriously. The amount of memory used by the cache may be calculated as follows:
Size of RAM (in bytes) = (LCD_YSIZE + (8 / LCD_BITSPERPIXEL - 1)) / 8 * LCD_BITSPERPIXEL * LCD_XSIZE
Hardware configuration
This driver accesses the hardware with the indirect interface. The following table lists the macros which need to be defined for hardware access:
Macro LCD_READ_A0 LCD_READ_A1 LCD_WRITE_A0 LCD_WRITE_A1 LCD_WRITEM_A1
Description
Read a byte from LCD controller with A-line low. Read a byte from LCD controller with A-line high. Write a byte to LCD controller with A-line low. Write a byte to LCD controller with A-line high. Write multiple bytes to LCD controller with A-line high.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1001
Additional configuration switches
The following table shows optional configuration switches available for this driver:
Macro LCD_CACHE
Description
When set to 0, no display data cache is used, which slows down the speed of the driver. Default is 1 (cache activated).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1002
CHAPTER
Display drivers
29.7.18 GUIDRV_6331
Supported hardware
Controllers
This driver works with the following display controllers:
· Samsung S6B33B0X, S6B33B1X, S6B33B2X
Bits per pixel
Supported color depth is 16 bpp.
Interfaces
The driver supports the indirect interface (8 bit) of the display controller. Parallel or 4-pin SPI bus can be used.
Driver selection
To select GUIDRV_6331 as the driver to be used by your application, you should use the following command:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_6331, GUICC_565, 0, 0);
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the configuration file LCDConf_6331.h. The table below shows the values to be used to select the appropriate controller:
6331
Number
Supported Controller
Samsung S6B33B0X, S6B33B1X, S6B33B2X
Display data RAM organization
16 bits per pixel, fixed palette = 565
SEG0
Byte 0
Byte 1
. . .
COM 0
COM 1
. . .
COM n
R R R R RGGGGGGB B B B B DDDDDDDDDDDDDDDD BBBBBBBBBBBBBBBB 7654321076543210
R R R R RGGGGGGB B B B B
Byte n
The picture above shows the relation between the display memory and the SEG and COM lines of the LCD.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1003
RAM requirements
This display driver can be used with or without a display data cache, containing a complete copy of the LCD data RAM. The amount of memory used by the cache is: LCD_XSIZE x LCD_YSIZE x 2 bytes.
Hardware configuration
This driver accesses the hardware with the indirect interface. The following table lists the macros which must be defined for hardware access:
Macro
Description
LCD_WRITE_A0
Write a byte to display controller with A-line low.
LCD_WRITE_A1
Write a byte to display controller with A-line high.
LCD_WRITEM_A1
Write multiple bytes to display controller with A-line high.
'Display Line Number' (DLN) selection bits of the 'Driver Output
LCD_DRIVER_OUTPUT_MODE_DLN Mode Set' instruction. For details please refer to the display con-
troller documentation.
Data bus width selection bit of the 'Entry Mode Set' instruction.
LCD_DRIVER_ENTRY_MODE_16B For details please refer to the display controller documentation.
The 'Driver Output Mode' and 'Entry Mode' are initializes automatically.
Additional configuration switches
The following table shows optional configuration switches available for this driver:
Macro LCD_CACHE
Description
When set to 0, no display data cache is used, which slows down the speed of the driver. Default is 1 (cache activated).
Special requirements
The driver needs to work with the fixed palette mode 565. The driver does not work with other palettes or fixed palette modes. Further the driver needs to swap the red and the blue part of the color index. You should use the following macro definitions in the configuration file LCDConf.h:
#define LCD_FIXEDPALETTE 565
#define LCD_SWAP_RB
1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1004
CHAPTER
Display drivers
29.7.19 GUIDRV_7529
Supported hardware
Controllers
This driver works with the Sitronix ST7529 display controller.
Bits per pixel
Supported color depths are 5 bpp (default), 4 bpp and 1bpp.
Interfaces
The driver supports the indirect interface (8 and 16 bit) of the display controller. Parallel, 3-pin SPI or 4-pin SPI access can be used.
Driver selection
To select GUIDRV_7529 as the driver to be used by your application, you can use e.g. the following command:
pDevice = GUI_DEVICE_CreateAndLink(GUIDRV_7529, GUICC_5, 0, 0);
Please refer to chapter "Colors" on page 265 to get more information about using the proper palette mode.
Available configuration macros (compile time configuration)
Controller selection
To select the desired controller the macro LCD_CONTROLLER should be used in the configuration file LCDConf_7529.h. The following table shows the values to be used to select the appropriate controller:
7529
Number
Sitronix ST7529
Supported Controller
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1005
Display data RAM organization
5 bits per pixel, fixed palette = 5 (default)
Byte 0
Byte 1
. . .
Byte n
P0
P1
Pn
COM 0 COM 1
. . . COM n
DDDDDDDD BBBBBBBB 76543210
4 bits per pixel, fixed palette = 4
Byte 0
Byte 1
. . .
Byte n
P0
P1
P2
Pn-1
Pn
COM 0 COM 1
. . . COM n
DDDDDDDD BBBBBBBB 76543210
1 bit per pixel, fixed palette = 1
Byte 0
Byte 1
. . .
PPPPPPPP 01234567
Byte n
P n
COM 0 COM 1
. . . COM n
DDDDDDDD BBBBBBBB 76543210
The picture above shows the relation between the display memory and the SEG and COM lines of the LCD.
RAM requirements
This display driver can be used with or without a display data cache, containing a complete copy of the LCD data RAM. If no cache is used, there are no additional RAM requirements. It is optional (but recommended) to use this driver with a data cache for faster LCDaccess. The amount of memory used by the cache may be calculated as follows:
5bpp mode: Size of RAM (in bytes) = (LCD_XSIZE + 2) / 3 * 3 * LCD_YSIZE 4bpp mode: Size of RAM (in bytes) = ((LCD_XSIZE + 2) / 3 * 3 + 1) / 2 * LCD_YSIZE 1bpp mode: Size of RAM (in bytes) = ((LCD_XSIZE + 2) / 3 * 3 + 7) / 8 * LCD_YSIZE
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1006
CHAPTER
Display drivers
Hardware configuration
This driver accesses the hardware with the indirect interface. The following table lists the macros which must be defined for hardware access:
Macro LCD_WRITE_A0 LCD_WRITE_A1 LCD_WRITEM_A1 LCD_READM_A1
LCD_FIRSTPIXEL0
Description
Write a byte to LCD controller with A-line low.
Write a byte to LCD controller with A-line high.
Write multiple bytes to display controller with A-line high. Read multiple bytes from display controller with A-line high. Required only if no display data cache is configured. If the display size in X is smaller than the number of segment outputs of the display controller, this macro can be used for defining the first visible pixel of the display. It should be used if the first segment lines of the display controller are not connected to the display.
Additional configuration switches
The following table shows optional configuration switches available for this driver:
Macro LCD_CACHE
Description
When set to 0, no display data cache is used, which slows down the speed of the driver. Default is 1 (cache activated).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1007
29.7.20 GUIDRV_Template - Template for a new driver
This driver is part of the basic package and can be easily adapted to each display controller. It contains the complete functionality needed for a display driver.
Adapting the template driver
To adapt the driver to a currently not supported display controller you only have to adapt the routines _SetPixelIndex() and _GetPixelIndex(). The upper layers calling this routines already make sure that the given coordinates are in range, so that no check on the parameters needs to be performed. If a display is not readable the function _GetPixelIndex() won't be able to read back the contents of the display data RAM. In this case a display data cache should be implemented in the driver, so that the contents of each pixel is known by the driver. If no data cache is available in this case some functions of emWin will not work right. These are all functions which need to invert pixels. Especially the XOR draw mode and the drawing of text cursors (which also uses the XOR draw mode) will not work right. A simple application which does not use the XOR draw mode will also work without adapting the function _GetPixelIndex(). In a second step it should be optimized to improve drawing speed.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1008
CHAPTER
Display drivers
29.8 LCD layer and display driver API
emWin requires a driver for the hardware. This chapter explains what an LCD driver for emWin does and what routines it supplies to emWin (the application programming interface, or API). Under most circumstances, you probably do not need to read this chapter, as most calls to the LCD layer of emWin will be done through the GUI layer. In fact, we recommend that you only call LCD functions if there is no GUI equivalent (for example, if you wish to modify the lookup table of the LCD controller directly). The reason for this is that LCD driver functions are not thread-safe, unlike their GUI equivalents. They should therefore not be called directly in multitask environments.
29.8.1 Display driver API
The table below lists the available emWin LCD-related routines in alphabetical order. Detailed descriptions of the routines can be found in the sections that follow.
LCD layer routines
Routine
LCD_GetBitsPerPixel() LCD_GetBitsPerPixelEx() LCD_GetNumColors() LCD_GetNumColorsEx() LCD_GetVXSize() LCD_GetVXSizeEx() LCD_GetVYSize() LCD_GetVYSizeEx() LCD_GetXMag() LCD_GetXMagEx() LCD_GetXSize() LCD_GetXSizeEx() LCD_GetYMag() LCD_GetYMagEx() LCD_GetYSize() LCD_GetYSizeEx()
LCD_SetDevFunc() LCD_SetMaxNumColors() LCD_SetSizeEx() LCD_SetVRAMAddrEx() LCD_SetVSizeEx()
LCD_ControlCache()
Description "Get" group
Return the number of bits per pixel. Returns the number of bits per pixel of given layer/display. Return the number of available colors. Returns the number of available colors of given layer/display. Return virtual X-size of LCD in pixels. Returns virtual X-size of given layer/display in pixels. Return virtual Y-size of LCD in pixels. Returns virtual Y-size of given layer/display in pixels. Returns the magnification factor in x. Returns the magnification factor of given layer/display in x. Return physical X-size of LCD in pixels. Returns physical X-size of given layer/display in pixels. Returns the magnification factor in y. Returns the magnification factor of given layer/display in y. Return physical Y-size of LCD in pixels. Returns physical Y-size of given layer/display in pixels.
Configuration group
Sets optional or custom defined routines for the display driver. Sets the maximum number of colors used by the application. Sets the physical size in pixels of the given layer. Sets the address of the video RAM of the given layer. Sets the size of the virtual display area in pixels of the given layer.
Cache group
Locks, unlocks and flushes the cache of the display controller if it is supported.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1009
29.8.2 LCD layer routines
29.8.2.1 "Get" group
LCD_GetBitsPerPixel()
Description
Returns the number of bits per pixel.
Prototype
int LCD_GetBitsPerPixel(void);
Return value
Number of bits per pixel.
LCD_GetBitsPerPixelEx()
Description
Returns the number of bits per pixel.
Prototype
int LCD_GetBitsPerPixelEx(int Index);
Parameter Index
Layer index.
Description
Return value
Number of bits per pixel.
LCD_GetNumColors()
Description
Returns the number of currently available colors on the LCD.
Prototype
int LCD_GetNumColors(void);
Return value
Number of available colors
LCD_GetNumColorsEx()
Description
Returns the number of currently available colors on the LCD.
Prototype
U32 LCD_GetNumColorsEx(int Index);
Parameter Index
Layer index.
Return value
Number of available colors.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1010
CHAPTER
Display drivers
LCD_GetVXSize(), LCD_GetVYSize()
Description
Returns the virtual X- or Y-size, respectively, of the LCD in pixels. In most cases, the virtual size is equal to the physical size.
Prototype
int LCD_GetVXSize(void) int LCD_GetVYSize(void)
Return value
Virtual X/Y-size of the display.
LCD_GetVXSizeEx(), LCD_GetVYSizeEx()
Description
Returns the virtual X- or Y-size, respectively, of the LCD in pixels. In most cases, the virtual size is equal to the physical size.
Prototype
int LCD_GetVXSizeEx(int Index); int LCD_GetVYSizeEx(int Index);
Parameter Index
Layer index.
Description
Return value
Virtual X/Y-size of the display.
LCD_GetXMag(), LCD_GetYMag()
Description
Returns the magnification factor in X- or Y-axis, respectively.
Prototype
int LCD_GetXMag(int Index); int LCD_GetYMag(int Index);
Return value
Magnification factor in X- or Y-axis.
LCD_GetXMagEx(), LCD_GetYMagEx()
Description
Returns the magnification factor in X- or Y-axis, respectively.
Prototype
int LCD_GetXMagEx(int Index);
Parameter Index
Layer index.
Return value
Magnification factor in X- or Y-axis.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1011
LCD_GetXSize(), LCD_GetYSize()
Description
Returns the physical X- or Y-size, respectively, of the LCD in pixels.
Prototypes
int LCD_GetXSize(void) int LCD_GetYSize(void)
Return value
Physical X/Y-size of the display.
LCD_GetXSizeEx(), LCD_GetYSizeEx()
Description
Returns the physical X- or Y-size, respectively, of the LCD in pixels.
Prototype
int LCD_GetXSizeEx(int Index); int LCD_GetYSizeEx(int Index);
Parameter Index
Layer index.
Return value
Physical X/Y-size of the display.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1012
CHAPTER
Display drivers
29.8.2.2 Configuration group
LCD_SetDevFunc()
Description
The function sets additional and / or user defined functions of the display driver.
Prototype
int LCD_SetDevFunc(int LayerIndex, int IdFunc, void (* pDriverFunc)(void));
Parameter LayerIndex IdFunc pDriverFunc
Description
Layer index. See table below. Pointer to function which should be used.
Permitted values for element IdFunc
LCD_DEVFUNC_COPYBUFFER LCD_DEVFUNC_COPYRECT LCD_DEVFUNC_DRAWBMP_1BPP
LCD_DEVFUNC_FILLRECT
Can be used to set a custom defined routine for copying buffers. Makes only sense in combination with multiple buffers.
Can be used to set a custom defined routine for copying rectangular areas.
Can be used to se a custom routine for drawing 1bpp bitmaps. Makes sense if a BitBLT engine should be used for drawing text and 1bpp bitmaps.
Can be used to set a custom defined routine for filling rectangles. Makes sense if for example a BitBLT engine should be used for filling operations.
LCD_DEVFUNC_COPYBUFFER
Can be used to set up a function which copies a frame buffer to the desired location. This can make sense if for example a BitBLT engine is available to do the job. The function pointed by pDriverFunc should be of the following type:
void CopyBuffer(int LayerIndex, int IndexSrc, int IndexDst);
Parameter LayerIndex IndexSrc IndexDst
Description
Layer index. Index of the source frame buffer to be copied. Index of the destination frame buffer to be overwritten.
LCD_DEVFUNC_COPYRECT
Can be used to set up a function which copies a rectangular area of the screen to the desired location. This can make sense if for example a BitBLT engine is available to do the job. The function pointed by pDriverFunc should be of the following type:
void CopyRect(int LayerIndex, int x0, int y0, int x1, int y1,
int xSize,
int ySize);
Parameter LayerIndex x0 y0 x1
Description
Layer index. Leftmost pixel of the source rectangle. Topmost pixel of the source rectangle. Leftmost pixel of the destination rectangle.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1013
Parameter
Description
y1 xSize ySize
Topmost pixel of the destination rectangle. X-size of the rectangle. Y-size of the rectangle
LCD_DEVFUNC_FILLRECT
Can be used to set a custom function for filling operations. The function pointed by pDriverFunc should be of the following type: void FillRect(int LayerIndex, int x0, int y0, int x1, int y1,
U32 PixelIndex);
Parameter
Description
LayerIndex x0 y0 x1 y1 PixelIndex
Layer index. Leftmost coordinate to be filled in screen coordinates. Topmost coordinate to be filled in screen coordinates. Rightmost coordinate to be filled in screen coordinates. Bottommost coordinate to be filled in screen coordinates. Color index to be used to fill the specified area.
LCD_DEVFUNC_DRAWBMP_1BPP
Can be used to set up a function which draws 1bpp bitmaps which includes also text. This can make sense if for example a BitBLT engine is available to do the job. The function pointed by pDriverFunc should be of the following type: void DrawBMP1(int LayerIndex,
int x, int y, U8 const * p, int Diff, int xSize, int ySize,
int BytesPerLine, const LCD_PIXELINDEX * pTrans);
Parameter
Description
LayerIndex x y p Diff xSize ySize BytesPerLine
pTrans
Layer index. Leftmost coordinate in screen coordinates of the bitmap to be drawn. Topmost coordinate in screen coordinates of the bitmap to be drawn. Pointer to the pixel data of the bitmap.
Offset to the first pixel pointed by parameter p. Supported values are 0-7.
xSize in pixels of the bitmap to be drawn. ySize in pixels of the bitmap to be drawn. Number of bytes of one line of bitmap data. Pointer to an array of color indices to be used to draw the bitmap data. The first color index defines the background color, the second color index defines the foreground color.
Return value
0 on success, 1 on error.
Additional information
Please note that it depends on the display driver which values for parameter IdFunc are supported or not.
LCD_SetMaxNumColors()
Description
Sets the maximum number of colors used in palette based bitmaps.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1014
CHAPTER
Display drivers
Prototype
int LCD_SetMaxNumColors(unsigned MaxNumColors);
Parameter MaxNumColors
Description
Maximum number of colors used in palette based bitmaps. Default is 256.
Return value
0 on success, 1 on error.
Additional information
During the process of initialization emWin allocates a buffer required for converting the color values of the bitmaps into index values for the controller. This buffer requires 4 bytes per color. If the system is short on RAM and only a few colors are used, this function could spare up to 1016 bytes of dynamically RAM. Per default the buffer uses 1024 bytes of RAM. But if for example only 2 colors are used (typically b/w-configuration) only 8 bytes for 2 colors are required.
LCD_SetSizeEx()
Description
Sets the physical size of the visible area of the given display/layer.
Prototype
int LCD_SetSizeEx(int LayerIndex, int xSize, int ySize);
Parameter LayerIndex xSize ySize
Description
Layer index. X-Size in pixels of the visible area of the given layer. Y-Size in pixels of the visible area of the given layer.
Return value
0 on success, 1 on error.
Additional information
The function requires a display driver which is able to manage dynamically changes of the display size. If the display driver does not support this feature the function fails.
LCD_SetVRAMAddrEx()
Description
Sets the address of the video RAM.
Prototype
int LCD_SetVRAMAddrEx(int LayerIndex, void * pVRAM);
Parameter LayerIndex pVRAM
Description
Layer index. Pointer to start address of video RAM.
Return value
0 on success, 1 on error.
Additional information
The function requires a display driver which is able to manage dynamically changes of the video RAM address. If the display driver does not support this feature the function fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1015
LCD_SetVSizeEx()
Description
Sets the size of the virtual display area.
Prototype
int LCD_SetVSizeEx(int LayerIndex, int xSize, int ySize);
Parameter LayerIndex xSize ySize
Description
Layer index. X-Size in pixels of the virtual area of the given layer. Y-Size in pixels of the virtual area of the given layer.
Return value
0 on success, 1 on error.
Additional information
The function requires a display driver which is able to manage dynamically changes of the virtual display size. If the display driver does not support this feature the function fails.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1016
CHAPTER
Display drivers
29.8.2.3 Cache group
LCD_ControlCache()
Description
Locks, unlocks and flushes the cache of the display controller if it is supported.
Prototype
int LCD_ControlCache(int Cmd);
Parameter Cmd
See table below.
Description
LCD_CC_FLUSH LCD_CC_LOCK LCD_CC_UNLOCK
Permitted values for element Cmd
Flushes the cache. The content of the cache which has changed since the last flushing operation is output to the display.
Locks the cache. Drawing operations are cached, but not output to the display.
Unlocks the cache. The cached data is flushed immediatelly. Further drawing operations are cached and output. (Write Through)
Return value
0 on success, 1 on error.
Additional information
The function requires a display driver which is able to manage dynamically changes of the virtual display size. If the display driver does not support this feature the function fails. This function is automatically used for drawing operations of windows and strings.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1017
Chapter 30
VNC Server
The emWin VNC server can be used for administration of the embedded target and a variety of other purposes. It supports compressed (hextile) encoding. VNC stands for 'Virtual Network Computing'. It is, a client server system based on a simple display protocol which allows the user to view and control a computing 'desktop' environment from anywhere on the Internet and from a wide variety of machine architectures, communicating via TCP/IP. In other words: The display contents of the embedded device are visible on the screen of the machine running the client (for example, your PC); your mouse and keyboard can be used to control the target. This feature is available in the emWin simulation and trial versions. emWin VNC support is available as a separate package and is therefore not included in the basic package. VNC support requires emWin color.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1018
CHAPTER
VNC Server
30.1 Introduction
VNC consists of two types of components. A server, which generates a display, and a viewer, which actually draws the display on your screen. The remote machine (target or simulation) can not only be viewed, but also controlled via mouse or keyboard. The server and the viewer may be on different machines and on different architectures. The protocol which connects the server and viewer is simple, open, and platform independent. No state is stored at the viewer. Breaking the viewer's connection to the server and then reconnecting will not result in any loss of data. Because the connection can be remade from somewhere else, you have easy mobility. Using the VNC server, you may control your target from anywhere and you can make screenshots (for example, for a manual) from a "live" system.
30.1.1 Requirements
TCP/IP stack
Since the communication between the server and the viewer is based on a TCP/IP connection, VNC requires a TCP/IP stack. In the Win32 simulation environment, TCP/ IP (WinSock) is normally present. In the target, a TCP/IP stack needs to be present. The TCP/IP stack is NOT part of emWin. The flexible interface ensures that any TCP/ IP stack can be used.
Multi tasking
The VNC server needs to run as a separate thread. Therefore a multi tasking system is required to use the emWin VNC server.
30.1.2 Notes on this implementation
Supported client to server messages
The emWin VNC server supports pointer event messages and keyboard event messages.
Encoding
The server supports raw encoding and hextile encoding.
Performance
Most viewers support hextile encoding, which supports descent compression. A typical quarter VGA screen requires typically 20 - 50 kb of data. An implementation running on an ARM7 platform (50 MHZ, with Cache) requires app. 200 - 300 ms for an update of the entire screen. The server handles incremental updates; in most cases the updated display area is a lot smaller than the entire display and less data needs to be transmitted. A typical ARM7 system therefore allows real time updates.
Multiple servers
The implementation is fully thread safe and reentrant; multiple VNC-servers can be started on the same CPU for different layers or displays. If your target (of course the same holds true for the simulation) has multiple displays or multiple layers, this can be a useful option. Only one VNC server may be started per layer at any given time; once the connection to a Viewer ends, another one can connect.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1019
30.2 The VNC viewer
Availability
The VNC viewer is not part of the emWin package. There are several VNC viewer tools which are freely available and can be download from the website of the respective licenser. Popular VNC viewing tools are RealVNC, TightVNC and UltraVNC.
Platforms
VNC viewing tools are also available for different platforms. Detailed information about VNC tools for different platforms are provided by the respective developer of the used VNC viewer.
Compatibility
The VNC server was tested with different VNC viewers. It should work with all currently available VNC viewers.
30.2.1 How to use the VNC viewer
Once the VNC viewer was started, it will prompt for the VNC server to be connected:
Connecting to a VNC server using the simulation on the same PC
When running VNC Viewer and simulation on the same PC, type 'localhost:0' to connect. ':0' means server index 0. If you omit the server index the viewer assumes server 0. So in the most cases you can type 'localhost' to connect to the simulation.
Connecting to a VNC server running on a different PC or the target
To connect to VNC server running on a different PC or on the target system, enter the name or IP address of the machine (optionally followed by a ':' and the server number). To connect to a VNC server on the computer 'Joerg' with IP address 192.168.1.2, you may enter '192.168.1.2:0', or 'Joerg:0' or 'Joerg'. To connect to a target with IP address 192.168.1.254, enter '192.168.1.254'.
Screenshot
The following screenshots shows the viewer:
Connected to the simulation
Connected to the target
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1020
CHAPTER
VNC Server
30.3 emWin VNC server
30.3.1 Starting the emWin VNC server
The one and only thing to start the VNC server is to call the function GUI_VNC_X_StartServer():
void MainTask(void) { GUI_Init(); GUI_VNC_X_StartServer(0, 0); ...
}
/* Layer index */ /* Server index */
The above function call creates a thread which listens on port 5900 for an incoming connection. After a connection has been detected GUI_VNC_Process() will be called.
Ports
The VNC server listens on port 590x, where x is the server index. So for most PC servers, the port will be 5900, because they use display 0 by default.
Example
A ready to use example (in executable form) is available on our website. The trial version also contains the VNC server; it takes no more than one line of code (using GUI_VNC_X_StartServer()) to activate it.
30.3.2 How the server starts...
When using the simulation, only the function GUI_VNC_X_StartServer() needs to be called. It creates a thread which listens on port 590x until an incoming connection is detected and then calls GUI_VNC_Process(), which is the implementation of the actual server.
30.3.3 Integration of the VNC server on the target
Before the function GUI_VNC_X_StartServer() can be used, it has to be adapted to the used TCP/IP stack and the multi tasking system. An implementation example is available under Sample\GUI_X\GUI_VNC_X_StartServer.c, which should require only smaller modifications. Since this example does not use dynamic memory allocation to allocate memory for the GUI_VNC_CONTEXT structure, which is described, this implementation allows starting only one server.
30.4 Requirements
ROM
About 4.9 kb on ARM7 with hextile encoding, about 3.5 kb without hextile encoding.
RAM
The VNC support does not use static data. For each instance one GUI_VNC_CONTEXT structure (app. 60 bytes) is used.
Others
Each instance needs one TCP/IP socket and one thread.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1021
30.5 Configuration options
Type
Macro
Default
Description
N GUI_VNC_BUFFER_SIZE
1000
Size of the receive buffer. The buffer is located on the stack. Typically bigger sizes result in only minor accelerations. A reasonable buffer size is app. 200 bytes.
B GUI_VNC_LOCK_FRAME
0
Enabling this option is required for systems using an indirect interface to the display controller. If the VNC server sends the content of the display to the client, it calls the display driver to get the current content. With direct interface this is not a problem. When using an indirect interface this option ensures, that writing operations of the GUI task will not be interrupted by reading operations.
S GUI_VNC_PROGNAME
This macro defines the name of the target shown in
the title bar of the viewer. If using the viewer in the
(see expla- simulation the default is:
nation)
"Embedded GUI on WIN32"
On the target the default is:
"Embedded GUI"
B GUI_VNC_SUPPORT_HEXTILE 1
Enables or disables hextile encoding. Hextile encoding is faster but needs bigger code (app. 1.4 k more).
30.6 VNC Server API
The following table lists the available VNC-related functions in alphabetical order. Detailed description of the routines can be found in the sections that follow.
Routine
GUI_VNC_AttachToLayer() GUI_VNC_EnableKeyboardInput() GUI_VNC_GetNumConnections() GUI_VNC_Process() GUI_VNC_RingBell() GUI_VNC_SetLockFrame() GUI_VNC_SetPassword() GUI_VNC_SetProgName() GUI_VNC_SetSize() GUI_VNC_X_StartServer()
Description
Attaches a VNC server to a layer. Without a multi display configuration the given index must be 0. Enables or disables keyboard input via VNC.
Return the number of connections to the server. The actual VNC server; initializes the communication with the viewer. Ring a bell on the client if it has one. Configures the VNC server not to read the display while the GUI performs drawing operations. Sets the password required to connect with the server.
Sets the text to be shown in the viewers title bar.
Sets the area to be transmitted to the client.
Routine to be called to start a VNC viewer.
GUI_VNC_AttachToLayer()
Description
This function attaches the given layer to the VNC server. Normally, with single layer configurations, this parameter should be 0.
Prototype
void GUI_VNC_AttachToLayer(GUI_VNC_CONTEXT * pContext, int LayerIndex);
Parameter pContext LayerIndex
Description
Pointer to a GUI_VNC_CONTEXT structure. Zero based index of layer to be handled by the server.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1022
CHAPTER
VNC Server
Return value
0 if the function succeed, != 0 if the function fails.
GUI_VNC_EnableKeyboardInput()
Description
Enables or disables keyboard input via VNC.
Prototype
void GUI_VNC_EnableKeyboardInput(int OnOff);
Parameter OnOff
Description
1 for enabling keyboard input, 0 for disabling.
GUI_VNC_GetNumConnections()
Description
Returns the number of currently existing connections to the server.
Prototype
int GUI_VNC_GetNumConnections(void);
Return value
Number of connections.
GUI_VNC_Process()
Description
The function sets the send and receive function used to send and receive data and starts the communication with the viewer.
Prototype
void GUI_VNC_Process(GUI_VNC_CONTEXT * pContext,
GUI_tSend
pfSend,
GUI_tReceive
pfReceive,
void
* pConnectInfo);
Parameter
Description
pContext pfSend pfReceive pConnectInfo
Pointer to a GUI_VNC_CONTEXT structure. Pointer to the function to be used by the server to send data to the viewer. Pointer to the function to be used by the server to read from the viewer. Pointer to be passed to the send and receive function.
Additional information
The GUI_VNC_CONTEXT structure is used by the server to store connection state information's. The send and receive functions should return the number of bytes successfully send/ received to/from the viewer. The pointer pConnectInfo is passed to the send and receive routines. It can be used to pass a pointer to a structure containing connection information or to pass a socket number. The following types are used as function pointers to the routines used to send and receive bytes from/to the viewer:
typedef int (*GUI_tSend) (const U8 * pData, int len, void * pConnectInfo);
typedef int (*GUI_tReceive)(
U8 * pData, int len, void * pConnectInfo);
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1023
Example
static GUI_VNC_CONTEXT _Context; /* Data area for server */
static int _Send(const U8* buf, int len, void * pConnectionInfo) { SOCKET Socket = (SOCKET)pConnectionInfo;
... } static int _Recv(U8* buf, int len, void * pConnectionInfo) {
SOCKET Socket = (SOCKET)pConnectionInfo; ... } static void _ServerTask(void) { int Socket; ... GUI_VNC_Process(&_Context, _Send, _Recv, (void *)Socket); ... }
GUI_VNC_RingBell()
Description
Ring a bell on the client if it has one.
Prototype
void GUI_VNC_RingBell(void);
GUI_VNC_SetLockFrame
Description
Configures the VNC server not to read the display while the GUI performs drawing operations.
Prototype
void GUI_VNC_SetLockFrame(unsigned OnOff);
Parameter OnOff
Description
If set to a value >0 frame locking will be enabled.
Additional information
This can be configured at compile time by using the compile time switch GUI_VNC_LOCK_FRAME.
GUI_VNC_SetPassword()
Description
Sets a password required to connect to the server.
Prototype
void GUI_VNC_SetPassword(U8 * sPassword);
Parameter sPassword
Description
Password required to connect to the server.
Additional information
Per default no password is required.
GUI_VNC_SetProgName()
Description
Sets the title to be displayed in the title bar of the client window.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1024
CHAPTER
VNC Server
Prototype
void GUI_VNC_SetProgName(const char * sProgName);
Parameter sProgName
Description
Title to be displayed in the title bar of the client window.
GUI_VNC_SetSize()
Description
Sets the display size to be transmitted to the client.
Prototype
void GUI_VNC_SetSize(unsigned xSize, unsigned ySize);
Parameter xSize ySize
X-size to be used. Y-size to be used.
Description
Additional information
Per default the server uses the layer size. The size passed to this function can be smaller or larger than the real display.
GUI_VNC_X_StartServer()
Description
Starts a VNC viewer with the given server index to display the given layer in the viewer. The function has to be written by the customer because the implementation depends on the used TCP/IP stack and on the used operating system. The emWin shipment contains an example implementation under Sample\GUI_X\GUI_VNC_X_StartServer.c. It could be used as a starting point for adapting it to other systems.
Prototype
int GUI_VNC_X_StartServer(int LayerIndex, int ServerIndex);
Parameter LayerIndex ServerIndex
Description
Layer to be shown by the viewer. Server index.
Additional information
There is no difference to start a VNC server in the simulation or on the target. In both cases you should call this function. The simulation contains an implementation of this function, the hardware implementation has to be done by the customer.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1025
Chapter 31
Touch drivers
A touch driver supports a particular family of touch controllers and all touch pads which are connected to one of these controllers. The drivers can be configured by modifying their configuration files whereas the driver itself does not need to be modified. The configuration files contain all required information for the driver including how the hardware is accessed and how the controller(s) are connected to the display. This chapter provides an overview of the touch drivers available for emWin. It explains the following in terms of each driver: · Which touch controllers can be accessed and which interface can be used. · RAM requirements. · Driver specific functions. · How to access the hardware. · Special configuration switches. · Special requirements for particular touch controllers.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1026
CHAPTER
Touch drivers
31.1 GUITDRV_ADS7846
Supported hardware
This driver works with the following controller: · Texas Instruments ADS7846 touch screen controller
Driver initialization
A good place for initializing the touch driver is the routine LCD_X_Config(). This makes sure, that the touch driver and the display driver has been initialized before emWin is used by the application.
First part
The first part of initializing the driver is calling the drivers configuration function. It sets up the following things:
· Function pointers for hardware communication routines · Touch panel orientation to be used · Logical and physical AD values to be able to calculate the right position depend-
ing on the AD values of the controller
Second part
To be able to do its work the drivers execution function needs to be called periodically. We recommend an interval of 20-30 ms. The function call can be done from within a timer interrupt routine or from a separate task.
GUITDRV_ADS7846 API
The following table shows the available functions of the driver.
Routine
Description
GUITDRV_ADS7846_Config()
Configuration function.
GUITDRV_ADS7846_Exec()
Execution function.
GUITDRV_ADS7846_GetLastVal() Retrieves the last stored values.
GUITDRV_ADS7846_Config()
Description
Passes a pointer to a GUITDRV_ADS7846_CONFIG structure to the driver. This structure contains all required function pointers and values required by the driver.
Prototype
void GUITDRV_ADS7846_Config(GUITDRV_ADS7846_CONFIG * pConfig);
Parameter pConfig
Description Pointer to a GUITDRV_ADS7846_CONFIG structure described below.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1027
Elements of GUITDRV_ADS7846_CONFIG
Data type void (*)(U8 Data)
U16 (*)(void)
char (*)(void) void (*)(char OnOff) unsigned int int int int int int int int
char (*)(void)
int int int
Element pfSendCmd
pfGetResult
pfGetBusy pfSetCS Orientation xLog0 xLog1 xPhys0 xPhys1 yLog0 yLog1 yPhys0 yPhys1
pfGetPENIRQ
PressureMin PressureMax PlateResistanceX
Description
Hardware routine for sending a byte to the controller via its SPI interface.
Hardware routine for getting the AD conversion result of the controller via its SPI interface. The driver uses the 12 bit conversion mode. Per conversion the controller uses 16 clocks. Only the first 12 bits contain the result to be returned by this routine.
Hardware routine for getting the busy state of the controller. The routine should return 1 if the controller is busy and 0 if not.
Routine for toggling the CS signal of the controller. When receiving 1 the signal should become high and vice versa.
One or more "OR" combined values of the table below.
Logical X value 0 in pixels.
Logical X value 1 in pixels.
A/D converter value for xLog0.
A/D converter value for xLog1.
Logical Y value 0 in pixels.
Logical Y value 1 in pixels.
A/D converter value for yLog0.
A/D converter value for yLog1.
If the PENIRQ line of the touch controller is connected to a port of the target hardware a touch event can be detected by the driver. Upon polling the driver's exec routine the driver can check if a touch event is ready to be sampled by checking the PENIRQ line. Without PENIRQ line the driver will always try to sample a touch event even if no touch happened which will consume time even if not necessary. Without PENIRQ it is the responsibility of the user's pfGetResult() routine to return 0xFFFF if the measured AD value is out of bounds. If both, the PENIRQ and the touch pressure recognition are enabled first the PENIRQ will signal that there is a touch event. Afterwards the touch pressure measurement is used to confirm that this was a valid touch and the touch had enough pressure to deliver good measurements. The routine should return 1 if a touch event is recognized and 0 if not.
Minimum pressure threshold. A measured pressure below this value means we do not have a valid touch event.
Maximum pressure threshold. A measured pressure above this value means we do not have a valid touch event.
Resistance of the X-plate of the touch screen. This value is needed for calculation of the touch pressure.
Permitted values for element Orientation
GUI_MIRROR_X
Mirroring the X-axis
GUI_MIRROR_Y
Mirroring the Y-axis
GUI_SWAP_XY
Swapping X- and Y-axis
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1028
CHAPTER
Touch drivers
GUITDRV_ADS7846_Exec()
Description
Execution function of the touch driver.
Prototype
char GUITDRV_ADS7846_Exec(void);
Additional information
We recommend to call the routine each 20-30 ms. If the routine detects a valid touch event it stores the result into the touch buffer via a function call to GUI_TOUCH_StoreStateEx(). Please note that the driver needs some function pointers to be filled correctly to be able to communicate with the external peripheral. The correct assignment of these function pointers is checked during driver configuration and leads to an abort to GUI_Error() on missing pointers.
GUITDRV_ADS7846_GetLastVal()
Description
Retrieves the last stored values for some internal variables that might be needed for calibration of the driver without knowing its internals.
Prototype
void GUITDRV_ADS7846_GetLastVal(GUITDRV_ADS7846_LAST_VAL * p);
Parameter p
Description
Pointer to a GUITDRV_ADS7846_LAST_VAL structure.
Elements of GUITDRV_ADS7846_LAST_VAL
Data type int int int int int int
Element
Description
xPhys
Last measured x value
yPhys
Last measured y value
z1Phys Last measured z1 value
z2Phys Last measured z2 value
PENIRQ Last sampled PENIRQ state if PENIRQ callback has been set
Pressure Last measured touch pressure if touch pressure measurement is enabled
Additional information
This function is an optional function and not required to be able to use the driver.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1029
Chapter 32 Timing- and execution-related functions
Some widgets, as well as our demonstration code, require time-related functions. The other parts of the emWin graphic library do not require a time base. The demonstration code makes heavy use of the routine GUI_Delay(), which delays for a given period of time. A unit of time is referred to as a tick.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1030
CHAPTER
Timing- and execution-related functions
32.1 Timing and execution API
The table below lists the available timing- and execution-related routines in alphabetical order. Detailed descriptions of the routines follow.
Routine GUI_Delay() GUI_Error() GUI_Exec() GUI_Exec1() GUI_GetTime()
Description
Delays the user application for the specified period of time. Shows a message box and stops execution. Executes all pending emWin tasks. Executes the next pending emWin task. Returns the current system time.
GUI_Delay()
Description
Delays for a specified period of time.
Prototype
void GUI_Delay(int Period);
Parameter Period
Description
Period in ticks until function should return.
Additional information
The time unit (tick) is usually milliseconds (depending on GUI_X_ functions). GUI_Delay() only executes idle functions for the given period. If the Window Manager is used, the delay time is used for the updating of invalid windows (through execution of WM_Exec()). This function will call GUI_X_Delay().
GUI_Error()
Description
This function is called by emWin in case of serious errors which causes the system to stop execution. It gets a pointer to a string which should contain a short error description. It should contain module and function where the error occurred and a short description. The simulation automatically shows a message box with error description in debug mode. To be able to intercept these major errors on the target system, the function GUI_SetOnErrorFunc() can be used to set up a custom routine which is called by GUI_Error().
Prototype
void GUI_Error(const char * s);
Parameter s
Description
Error string which is passed on to the function GUI_X_ErrorOut() and to the user defined error handling function.
Additional information
Detailed information on how to set up a user defined error handling function can be found in the description of the function GUI_SetOnErrorFunc in the chapter Configuration on page 1046.
GUI_Exec()
Description
Executes callback functions (typically redrawing of windows).
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1031
Prototype
int GUI_Exec(void);
Return value
0 if there were no jobs performed. 1 if a job was performed.
Additional information
This function will automatically call GUI_Exec1() repeatedly until it has completed all jobs -- essentially until a 0 value is returned. Normally this function does not need to be called by the user application. It is called automatically by GUI_Delay().
GUI_Exec1()
Description
Executes a callback function (one job only -- typically redrawing a window).
Prototype
int GUI_Exec1(void);
Return value
0 if there were no jobs performed. 1 if a job was performed.
Additional information
This routine may be called repeatedly until 0 is returned, which means all jobs have been completed. This function is called automatically by GUI_Exec().
GUI_GetTime()
Description
Returns the current system time.
Prototype
int GUI_GetTime(void);
Return value
The current system time in ticks.
Additional information
This function will call GUI_X_GetTime().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1032
CHAPTER
Timing- and execution-related functions
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1033
Chapter 33
Performance and Resource Usage
High performance combined with low resource usage has always been a major design consideration. emWin runs on 8/16/32-bit CPUs. Depending on which modules are being used, even single-chip systems with less than 64 Kbytes ROM and 2 Kbytes RAM can be supported by emWin. The actual performance and resource usage depends on many factors (CPU, compiler, memory model, optimization, configuration, display controller interface, etc.). This chapter contains benchmarks and information about resource usage in typical systems which can be used to obtain sufficient estimates for most target systems.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1034
CHAPTER
Performance and Resource Usage
33.1 Performance
The following chapter shows driver benchmarks on different targets and performance values of image drawing operations.
33.1.1 Driver benchmark
We use a benchmark test to measure the speed of the display drivers on available targets. This benchmark is in no way complete, but it gives an approximation of the length of time required for common operations on various targets.
Configuration and performance table
LCD Controller
(Driver) bpp
Bench1 Filling Bench2 Small fonts Bench3 Big fonts Bench4 Bitmap 1bpp Bench5 Bitmap 2bpp Bench6 Bitmap 4bpp Bench7 Bitmap 8bpp Bench8 DDP bitmap
CPU
V850SB1 (20MHz)
V850SB1 (20MHz)
ARM720T (50MHz)
ARM926EJ-S (200MHz)
S1D13806 (1300)
8
S1D13806 (1300)
16
(internal) (3200)
16
(internal) (3200)
16
16.7M 8.33M 7.14M 123M
339K 326K 581K 3.79M
1.59M 1.45M 1.85M 5.21M
1.52M 1.49M 1.96M 7.59M
240K 391K 694K 2.27M
459K 388K 645K 2.21M
83K 214K 410K 1.77M
1.25M 806K 2.94M 15.2M
M - Megapixels / second K - Kilopixels / second
Bench1: Filling
Bench the speed of filling. An area of 64*64 pixels is filled with different colors.
Bench2: Small fonts
Bench the speed of small character output. An area of 60*64 pixels is filled with small-character text.
Bench3: Big fonts
Bench the speed of big character output. An area of 65*48 pixels is filled with bigcharacter text.
Bench4: Bitmap 1bpp
Bench the speed of 1bbp bitmaps. An area of 58*8 pixels is filled with a 1bpp bitmap.
Bench 5: Bitmap 2bpp
Bench the speed of 2bbp bitmaps. An area of 32*11 pixels is filled with a 2bpp bitmap.
Bench6: Bitmap 4bpp
Bench the speed of 4bbp bitmaps. An area of 32*11 pixels is filled with a 4bpp bitmap.
Bench7: Bitmap 8bpp
Bench the speed of 8bbp bitmaps. An area of 32*11 pixels is filled with a 8bpp bitmap.
Bench8: Device-dependent bitmap, 8 or 16 bpp
Bench the speed of bitmaps 8 or 16 bits per pixel. An area of 64*8 pixels is filled with a bitmap. The color depth of the tested bitmap depends on the configuration. For configurations <= 8bpp, a bitmap with 8 bpp is used; 16bpp configurations use a 16bpp bitmap.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1035
33.1.2 Image drawing performance
The purpose of the following table is to show the drawing performance of the various image formats supported by emWin. The measurement for the following table has been done on an ARM922T CPU (Sharp LH7A404) running with 200MHz and with 15 bpp display color depth (fixed palette = 555) using GUIDRV_Lin:
Image format
Internal bitmap format: 1bpp C file Internal bitmap format: 4bpp C file Internal bitmap format: 8bpp C file Internal bitmap format: 8bpp C file, without palette Internal bitmap format: 16bpp C file, high color 555 Internal bitmap format: 16bpp C file, high color 565 Internal bitmap format: 24bpp C file, true color 888 Internal bitmap format: RLE4 C file Internal bitmap format: RLE8 C file Internal bitmap format: RLE16 C file BMP file 8bpp BMP file 16bpp BMP file 24bpp BMP file 32bpp BMP file RLE4 BMP file RLE8 GIF file JPEG file, gray JPEG file, gray, progressive JPEG file, H1V1 JPEG file, H1V1, progressive JPEG file, H2V2 JPEG file, H2V2, progressive
Megapixels / second
17.186 3.897 4.017 4.478 13.363 1.336 1.671 6.144 6.806 3.740 4.115 1.134 1.544 1.525 6.998 6.345 1.285 0.516 0.438 0.402 0.280 0.602 0.431
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1036
CHAPTER
Performance and Resource Usage
33.2 Memory requirements
The operation area of emWin varies widely, depending primarily on the application and features used. In the following sections, memory requirements of different modules are listed as well as memory requirement of example applications. The memory requirements of the GUI components have been measured on a system as follows:
ARM7, IAR Embedded Workbench V4.42A, Thumb mode, Size optimization
33.2.1 Memory requirements of the GUI components
The following table shows the memory requirements of the main components of emWin. These values depend a lot on the compiler options, the compiler version and the used CPU. Note that the listed values are the requirements of the basic functions of each module and that there are several additional functions available which have not been considered in the table:
Component
Window Manager Memory Devices Antialiasing
Driver
ROM
RAM
+ 6.2 Kbytes + 2.5 Kbyte
+ 4.7 Kbytes + 7 Kbytes
+ 4.5 Kbytes
+ 2 * LCD_XSIZE
+ 2 - 8 Kbytes
20 Bytes
Multilayer
+ 2 - 8 Kbytes
-
Core
Core / JPEG Core / GIF Core / Sprites
Core / Fonts
5.2 Kbytes 80 Bytes
12 Kbytes 3.3 Kbytes 4.7 Kbytes
38 Kbytes 17 Kbytes 16 Bytes
(see description)
-
Widgets
4.5 Kbytes -
Widget / BUTTON
1 Kbytes
Widget / CHECKBOX
1 Kbytes
Widget / DROPDOWN 1.8 Kbytes
Widget / EDIT
2.2 Kbytes
Widget / FRAMEWIN
2.2 Kbytes
Widget / GRAPH
2.9 Kbytes
Widget / GRAPH_DATA_XY
0.7 Kbytes
Widget / GRAPH_DATA_YT
0.6 Kbytes
Widget / HEADER
2.8 Kbytes
Widget / LISTBOX
3.7 Kbytes
Widget / LISTVIEW
3.6 Kbytes
Widget / MENU
5.7 Kbytes
Widget / MULTIEDIT
7.1 Kbytes
Widget / MULTIPAGE
3.9 Kbytes
Widget / PROGBAR
1.3 Kbytes
Widget / RADIOBUTTON 1.4 Kbytes
40 Bytes 52 Bytes 52 Bytes 28 Bytes 12 Bytes 48 Bytes
-
-
32 Bytes 56 Bytes 44 Bytes 52 Bytes 16 Bytes 32 Bytes 20 Bytes 32 Bytes
Description
Additional memory requirements of a 'Hello world' application when using the Window Manager. Additional memory requirements of a 'Hello world' application when using memory devices. Additional memory requirements for the antialiasing software item. The memory requirements of the driver depend on the configured driver and if a data cache is used or not. With a data cache, the driver requires more RAM. For details, refer to the chapter "Display drivers" on page 921. If working with a multi layer or a multi display configuration additional memory for each additional layer is required, because each layer requires its own driver. Memory requirements of a typical 'Hello world' application without using additional software items. Basic routines for drawing JPEG files. Basic routines for drawing GIF files. Routines for drawing sprites and cursors. Details of the ROM requirements of the standard fonts shipped with emWin can be found in the chapter "Fonts" on page 195. This is the approximately basic ROM requirement for the widgets depending on the individual core functions used by the widgets. *1 *1 *1 *1 *1 *1
*1
*1
*1 *1 *1 *1 *1 *1 *1 *1
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1037
Component
ROM
RAM
Widget / SCROLLBAR 2 Kbytes
14 Bytes
*1
Widget / SLIDER
1.3 Kbytes 16 Bytes
*1
Widget / TEXT
0.4 Kbytes 16 Bytes
*1
Description
*1. The listed memory requirements of the widgets contain the basic routines required for creating and drawing the widget. Depending on the specific widget there are several additional functions available which are not listed in the table.
33.2.2 Stack requirements
The basic stack requirement is app. 600 bytes. If using the Window Manager additional 600 bytes should be calculated. For memory devices further additional 200 bytes are recommended. Please note that the stack requirement also depends on the application, the used compiler and the CPU.
33.3 Memory requirements of example applications
This section shows the requirements of some example applications. The following table contains the summary of the memory requirements. The values are in bytes unless specified other:
Application
To t a l
Stack
GUI core
To t a l
Library
Startup code
Application
Fonts
Example GUI core
Hello world
ROM
RAM
5.9 kB 1.8 kB 38 B
0.3 kB 0.1 kB 8.1 kB 62 B
-
272 B 334 B
Window application
43 kB 12.5 kB 2.7 kB 0.3 kB 1.5 kB 60 kB 5.2 kB 40 B
1.4 kB 6.6 kB
For details about the examples, refer to the following sections.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1038
CHAPTER
Performance and Resource Usage
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1039
Chapter 34
Configuration
Before emWin can be used on a target system, the software needs to be configured. Configuring means modifying the configuration files which usually reside in the (sub)directory Config. We try to keep the configuration as simple as possible, but there are some configuration routines which need to be modified in order for the system to work properly. The following items need to be configured: · Memory area to be used by emWin · Display driver to be used for drawing operations · Color conversion routines to be used · Display controller initialization The following chapter explains the configuration of emWin in detail.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1040
CHAPTER
Configuration
34.1 What needs to be configured?
The configuration is basically divided into two parts: GUI-configuration and LCD-configuration. GUI-configuration means configuration of available features, default colors and -fonts and the configuration of available memory. The LCD-configuration is more hardware dependent and has to define the physical size of the display, the display driver and the color conversion routines to be used. For details about color conversion routines, refer to the chapter "Colors" on page 265. A further part is configuring the simulation. But this is not required for the target hardware and not part of this chapter. For details about configuring the simulation, refer to the chapter "Simulation" on page 43.
34.2 Run-time- and compile-time configuration
There are C and include files to be configured. The configuration in the header files is fixed at compile time and can not be changed whereas the configuration done in the C files can be changed at run-time. This makes it possible to create a library which is largely configuration independent and can be used with any display and any driver. This requires that the configuration routines described in this chapter are not part of the library but of the application.
34.3 Initialization process of emWin
The illustration shows the process of initialization. To initialize emWin, the application only has to call GUI_Init(). The configuration routines explained below are called during the internal initialization process.
GUI_X_Config()
It is called at the very first beginning of the initialization process to make sure that memory is assigned to emWin. Within this routine GUI_ALLOC_AssignMemory() must be called to assign a memory block to emWin and set the average memory block size. The functions are explained later in this chapter.
GUI_Init()
GUI_X_Config()
GUI_ALLOC_AssignMemory() /* Required */
GUI_ALLOC_SetAvBlockSize() /* Optional */
LCD_X_Config()
GUI_DEVICE_CreateAndLink() /* Required */
LCD_SetVSizeEx()
/* Required */
LCD_SetSizeEx()
/* Required */
LCD_SetVRAMAddrEx()
/* Optional */
GUI_TOUCH_Calibrate()
/* Optional */
GUI_TOUCH_SetOrientation() /* Optional */
LCD_X_DisplayDriver()
LCD_X_Config()
This function is called immediately after GUI_X_Config(). The main purpose of this routine is creating a display driver device and selecting the color conversion routines. Further it is responsible for setting the display size. If a touch screen is used it should also be configured here.
LCD_X_DisplayDriver()
At a later point of the initialization process the function LCD_X_DisplayDriver() is called. It is called directly by the display driver. During the initialization process the task of this routine is putting the display controller into operation. A detailed explanation of the routine follows later in this chapter.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1041
34.4 Run-time configuration
The following table shows the available run-time configuration files located in the subfolder Config:
Configuration file
Purpose
GUIConf.c LCDConf.c SIMConf.c GUI_X.c
Configuration of available memory. Configuration of the display size, the display driver and the color conversion routines. Configuration of the simulation (not part of this chapter).
Configuration of timing routines.
34.4.1 Customizing GUIConf.c
The purpose of this module is to provide emWin with the function GUI_X_Config() which is responsible for assigning a memory block to the memory management system. This requires knowledge about the memory requirement of the used components. The separate chapter 'Performance and Resource Usage' contains a detailed description of the memory requirements (RAM and ROM) of the individual emWin modules. Per default GUIConf.c is located in the (sub)directory Config and contains the routine GUI_X_Config() which is responsible to assign a memory block to emWin. It is not cogently required to leave it in the file GUIConf.c. The routine GUI_X_Config() can be located anywhere in the application.
GUI_X_Config()
Description
Calling this function is the very first thing done by the initialization process. It is responsible to assign a memory block to emWin. This block is managed by the internal memory management system. The memory block needs to be accessible 8, 16 and 32 bit wise.
Prototype
void GUI_X_Config(void);
Additional information
Note that not the complete memory block can be used by the application, because a small overhead of the memory is used by the management system itself. Each memory block requires approximately 12 bytes for management purpose.
34.4.1.1 API functions to be used in GUI_X_Config()
The following table shows the API functions which must be called within GUI_X_Config():
Routine
Description
GUI_ALLOC_AssignMemory() Assigns a memory block for the memory management system.
Sets the average size of the memory blocks. The bigger the block
GUI_ALLOC_SetAvBlockSize() size, the less number of memory blocks are available.
GUI_SetOnErrorFunc()
Sets a hook function which is called by the GUI on major errors which causes the system to stop.
GUITASK_SetMaxTask()
Sets the maximum number of tasks from which emWin can be accessed when multitasking is enabled.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1042
CHAPTER
Configuration
GUI_ALLOC_AssignMemory()
Description
The function assigns the one and only memory block to emWin which is used by the internal memory management system. This function should be called typically from GUI_X_Config().
Prototype
void GUI_ALLOC_AssignMemory(void * p, U32 NumBytes);
Parameter p NumBytes
Description
Pointer to the memory block which should be used by emWin. Size of the memory block in bytes.
Additional information
The complete memory block can be used by the application, because a small overhead of the memory is used by the management system itself. The assigned memory is used by emWin to manage data required e.g. for buffers for drawing operations, for windows, for Memory Devices or for a display driver cache. It is never used as frame buffer.
GUI_ALLOC_SetAvBlockSize()
(Obsolete)
Description
Average block size to be used to calculate the initial available number of memory blocks. If the memory manager is short on available memory blocks the number is increased automatically. This function should be called typically from GUI_X_Config().
Prototype
void GUI_ALLOC_SetAvBlockSize(U32 BlockSize);
Parameter BlockSize
Average block
Description
Additional information
The average block size is used to calculate the maximum number of available memory blocks:
Max. # of blocks = Size of memory in bytes / (BlockSize + sizeof(BLOCK_STRUCT))
BlockStruct means an internal structure whose size depends on GUI_DEBUG_LEVEL. If it is >0 the size will be 12 bytes, otherwise 8 bytes. Note that the structure size also depends on the used compiler.
GUI_SetOnErrorFunc()
Description
Sets the hook function which is called from GUI_Error().
Prototype
void GUI_SetOnErrorFunc(void (* pFunc)(const char * s));
Parameter
Description
pFunc
Pointer to the function which should be called by GUI_Error().
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1043
Additional information
The hook function gets a short error description in the string passed to the routine. It should contain the module and the function where the error occurred and a short description. The description of the function GUI_Error() can be found on page 1030.
GUITASK_SetMaxTask()
Description
Sets the maximum number of tasks from which emWin can be accessed when multitasking is enabled.
Prototype
void GUITASK_SetMaxTask(int MaxTask);
Parameter MaxTask
Description
Number of tasks from which emWin is used at most.
Additional information
This function is intended to be called from GUI_X_Config(). It is necessary to use this function when working with a pre-compiled library. Otherwise GUI_MAXTASK can be defined. For further information please refer to "GUI_MAXTASK" on page 325.
34.4.2 Customizing LCDConf.c
The purpose of this module is to provide emWin with the required display configuration routine and the callback function for the display driver. These are the following functions:
Routine LCD_X_Config() LCD_X_DisplayDriver()
Description
Configuration routine for creating the display driver device, setting the color conversion routines and the display size. Callback routine called by the display driver for putting the display controller into operation.
LCD_X_Config()
Description
As described in the table above this routine is responsible to create a display driver device, set the right color conversion routines and for configuring the physical display size.
Prototype
void LCD_X_Config(void);
Additional information
Depending on the used display driver it could also be required to set the video RAM address, initialize a custom palette or some else. For information about any additional requirements, refer to "Detailed display driver descriptions" on page 939. The functions available for configuration purpose in this routine are listed and explained later in this chapter.
Example
The following shows a typical example implementation: // // Set display driver and color conversion for 1st layer // GUI_DEVICE_CreateAndLink(GUIDRV_LIN_16, GUICC_565, 0, 0); // // Display driver configuration, required for Lin-driver //
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1044
CHAPTER
Configuration
LCD_SetSizeEx (0, 320, 240); LCD_SetVSizeEx (0, 320, 240); LCD_SetVRAMAddrEx(0, (void *)0x200000);
LCD_X_DisplayDriver()
Description
This is the callback function of the display driver. It is called for several purposes. During the process of initialization only a few are of interest, actually the display controller initialization and the setting of the video RAM address.
Prototype
int LCD_X_DisplayDriver(unsigned LayerIndex, unsigned Cmd, void * pData);
Parameter LayerIndex Cmd pData
Description
Zero based layer index. See table below.
Pointer to a data structure of a type that depends on Cmd
Permitted values for element Cmd during the initialization process
LCD_X_INITCONTROLLER
The display controller should become initialized. Typically an initialization routine which initializes the registers of the display controller should be called in reaction of this command.
LCD_X_SETVRAMADDR
pData is NULL
The element pVRAM of the data structure pointed by pData points to the start address of the video
RAM. This address is typically written to the video RAM base address register of the display controller.
pData points to a LCD_X_SETVRAMADDR_INFO structure.
Elements of LCD_X_SETVRAMADDR:
Data type
Element
Description
void *
pVRAM
Pointer to the start address of the video RAM.
Return value
The routine should return -2 if an error occurs, -1 if the command is not handled by the function and 0 if the command has been successfully executed.
Additional information
For more information about the commands passed to the routine by the display driver, refer to "Display drivers" on page 921.
Examples
The folder Sample\LCDConf\ contains a lot of example implementations of this routine which can be used as starting point.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1045
34.4.2.1 API functions to be used in LCD_X_Config()
The following table shows the API functions which are available for configuration purpose within LCD_X_Config():
Routine
Description
GUI_DEVICE_CreateAndLink()
Creates a display driver device and associates the color conversion routines to be used.
Sets the orientation of the touch screen. This routine is only
GUI_TOUCH_SetOrientation() required if a touch screen is used which does not operates in its
default orientation.
GUI_TOUCH_Calibrate()
Calibrates the touch screen.
LCD_SetLUTEx()
Initializes the lookup table with the given palette. This function is only required if a custom palette should be used.
LCD_SetSizeEx()
Required to set the physical size of the display.
LCD_SetVRAMAddrEx() LCD_SetVSizeEx()
Sets the address of the video RAM. It is only required if a display driver with linear mapped video RAM is used.
Required only if the virtual display size is different to the physical size.
For information about LCD_..., refer to chapter "Display drivers" on page 921. For information about GUI_TOUCH_..., refer to "Touch screen driver" on page 860.
GUI_DEVICE_CreateAndLink()
Description
This routine creates the display driver device, sets the color conversion routines to be used for accessing the display and it links the driver device into the device list of the given layer. LCD_X_Config() is called immediately after GUI_X_Config(). This makes sure that the memory configuration already has been done and the driver is able to allocate memory. The required memory for a display driver device is app. 50 bytes + the driver specific memory. For details about the memory requirements of the individual display drivers, refer to the chapter "Display drivers" on page 921.
Prototype
GUI_DEVICE * GUI_DEVICE_CreateAndLink(const GUI_DEVICE_API * pDeviceAPI, const LCD_API_COLOR_CONV * pColorConvAPI, U16 Flags, int LayerIndex);
Parameter pDeviceAPI
pColorConvAPI Flags LayerIndex
Description
Pointer to the display driver to be used. The chapter 'Display drivers' contains a table of the available display drivers. Pointer to the color conversion routines to be used. The chapter 'Colors' contains a table with the available color conversion routines. Should be zero.
Layer which should be managed by the driver.
Return value
On success the function returns a pointer to the created device object, otherwise it returns NULL.
Additional information
Note that the used driver also determines the display orientation in some cases. This differs from driver to driver. For details about the display orientation, refer to the chapter "Display drivers" on page 921.
34.4.3 Customizing GUI_X.c
This file is the location of the timing routines, the debugging routines and the kernel interface routines:
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1046
CHAPTER
Configuration
34.4.3.1 Timing routines
GUI_X_Delay()
Description
Returns after a specified time period in milliseconds.
Prototype
void GUI_X_Delay(int Period)
Parameter
Period
Period in milliseconds.
Description
GUI_X_ExecIdle()
Description
Called only from non-blocking functions of the Window Manager.
Prototype
void GUI_X_ExecIdle(void);
Additional information
Called when there are no longer any messages which require processing. In this case the GUI is up to date.
GUI_X_GetTime()
Description
Used by GUI_GetTime to return the current system time in milliseconds.
Prototype
int GUI_X_GetTime(void)
Return value
The current system time in milliseconds, of type integer.
34.4.3.2 Debug routines
GUI_X_ErrorOut(), GUI_X_Warn(), GUI_X_Log()
Description
These routines are called by emWin with debug information in higher debug levels in case a problem (Error) or potential problem is discovered. The routines can be blank; they are not required for the functionality of emWin. In a target system, they are typically not required in a release (production) build, since a production build typically uses a lower debug level. Fatal errors are output using GUI_X_ErrorOut() if (GUI_DEBUG_LEVEL >= 3) Warnings are output using GUI_X_Warn() if (GUI_DEBUG_LEVEL >= 4) Messages are output using GUI_X_Log() if (GUI_DEBUG_LEVEL >= 5)
Prototypes
void GUI_X_ErrorOut(const char * s); void GUI_X_Warn(const char * s); void GUI_X_Log(const char * s);
Parameter
s
Pointer to the string to be sent.
Description
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1047
Additional information
This routine is called by emWin to transmit error messages or warnings, and is required if logging is enabled. The GUI calls this function depending on the configuration macro GUI_DEBUG_LEVEL. The following table lists the permitted values for GUI_DEBUG_LEVEL:
Value
Symbolic name
0
GUI_DEBUG_LEVEL_NOCHECK
1
GUI_DEBUG_LEVEL_CHECK_PARA
2
GUI_DEBUG_LEVEL_CHECK_ALL
3
GUI_DEBUG_LEVEL_LOG_ERRORS
4
GUI_DEBUG_LEVEL_LOG_WARNINGS
5
GUI_DEBUG_LEVEL_LOG_ALL
Description
No run-time checks are performed. Parameter checks are performed to avoid crashes. (Default for target system) Parameter checks and consistency checks are performed. Errors are recorded. Errors and warnings are recorded. (Default for PC-simulation) Errors, warnings and messages are recorded.
34.4.3.3 Kernel interface routines
Detailed descriptions for these routines may be found in 'Execution Model: Single Task/Multitask'.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1048
CHAPTER
Configuration
34.5 Compile time configuration
The following table shows the available compile time configuration files located in the subfolder Config:
Configuration file
Purpose
GUIConf.h
Configuration of available features, number of layers, default fonts and default colors.
LCDConf.h
Configuration of the used display driver(s).
34.5.1 Customizing GUIConf.h
As described above the file should contain the configuration of available features and the configuration of the default font. Each emWin shipment comes with a GUIConf.h file which includes a basic configuration which can be used as a starting point.
34.5.1.1 Configuring the available features of emWin
The following table shows the available configuration macros:
Type
B
GUI_OS
Macro
B GUI_SUPPORT_CURSOR
B GUI_SUPPORT_MEMDEV B GUI_SUPPORT_MOUSE B GUI_SUPPORT_ROTATION B GUI_SUPPORT_TOUCH B GUI_WINSUPPORT
Default
0
(see expl.)
0 0 1 0 0
Description
Activate to enable multitasking support with multiple tasks calling emWin (see the chapter "Execution Model: Single Task / Multitask" on page 319. Per default cursors are enabled if either
GUI_SUPPORT_TOUCH or GUI_SUPPORT_MOUSE has been
enabled. If cursors should be shown without enabling one of these options it should be set to 1.
Enables optional memory device support.
Enables the optional mouse support.
Enables text rotation support.
Enables optional touch-screen support.
Enables optional Window Manager support.
34.5.1.2 Default font and default color configuration
The following table shows the available configuration macros:
Type
Macro
N GUI_DEFAULT_BKCOLOR N GUI_DEFAULT_COLOR
S GUI_DEFAULT_FONT
Default
Description
GUI_BLACK Define the default background color.
GUI_WHITE Define the default foreground color.
Defines which font is used per default after
GUI_Init(). If you do not use the
default font, it makes sense to change to a
different default, as the default font is ref-
&GUI_Font6x8
erenced by the code always be linked.
and
will
therefore
Please also refer to
GUI_SetDefaultFont() which can be
used for runtime configuration of the default font.
The default colors and fonts of the widgets which are part of the optional Window Manager can also be configured. For details, refer to the chapter "Window Objects (Widgets)" on page 401.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1049
34.5.1.3 Advanced GUI configuration options
The following table shows the available configuration macros:
Type
Macro
S GUI_DEBUG_LEVEL
N GUI_MAXTASK
F
GUI_MEMCPY
F
GUI_MEMSET
N GUI_NUM_LAYERS
B GUI_TRIAL_VERSION B GUI_WINSUPPORT N GUI_PID_BUFFER_SIZE
N GUI_KEY_BUFFER_SIZE
Default
Description
Defines the debug level, which determines
1 (target) 4 (simulation)
how many checks (assertions) are performed by emWin and if debug errors, warnings and messages are output.
Higher debug levels generate bigger code.
Define the maximum number of tasks from
which emWin is called to access the display
4
when multitasking support is enabled (see
the chapter "Execution Model: Single Task /
Multitask" on page 319.
---
This macro allows replacement of the memcpy function.
---
Replacement of the memset function of the GUI.
1
Defines the maximum of available layers/ displays.
0
Marks the compiler output as evaluation version.
0
Enables optional Window Manager support.
5
Maximum number of PID events managed by the input buffer.
10
Maximum number of key events managed by the input buffer.
GUI_MEMCPY
This macro allows replacement of the memcpy function of the GUI. On a lot of systems, memcpy takes up a considerable amount of time because it is not optimized by the compiler manufacturer. emWin contains an alternative memcpy routine, which has been optimized for 32 bit CPUs. On a lot of systems this routine should generate faster code than the default memcpy routine. However, this is still a generic C routine, which in a lot of systems can be replaced by faster code, typically using either a different C routine, which is better optimized for the particular CPU or by writing a routine in Assembly language. To use the optimized emWin routine add the following define to the file GUIConf.h:
#define GUI_MEMCPY(pSrc, pDest, NumBytes) GUI__memcpy(pSrc, pDest, NumBytes)
GUI_MEMSET
This macro allows replacement of the memset function of the GUI. On a lot of systems, memset takes up a considerable amount of time because it is not optimized by the compiler manufacturer. We have tried to address this by using our own memset() Routine GUI__memset. However, this is still a generic C routine, which in a lot of systems can be replaced by faster code, typically using either a different C routine, which is better optimized for the particular CPU, by writing a routine in Assembly language or using the DMA. If you want to use your own memset replacement routine, add the define to the GUIConf.h file.
GUI_TRIAL_VERSION
This macro can be used to mark the compiler output as an evaluation build. It should be defined if the software is given to a third party for evaluation purpose (typically with evaluation boards). Note that a special license is required to do this; the most common licenses do not permit redistribution of emWin in source or object code (relinkable) form. Contact sales@segger.com if you would like to do this.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1050
CHAPTER
Configuration
If GUI_TRIAL_VERSION is defined, the following message is shown when calling GUI_Init():
This message is always shown in the upper left corner of the display and is normally visible for 1 second. The timing is implemented by a call GUI_X_Delay(1000). The functionality of emWin is in no way limited if this switch is active.
Example
#define GUI_TRIAL_VERSION 1
34.5.2 Customizing LCDConf.h
This file contains general configuration options required for compiling the display driver(s) which need not to be changed at run-time. The available configuration options depend on the used display driver. For details about the available configuration options, refer to the chapter "Display drivers" on page 921. The detailed driver description shows the available configuration options for each display driver.
34.6 Request available memory
The following functions allow control of memory usage at runtime. They can be used to e.g. prevent waste of memory.
Routine
GUI_ALLOC_GetNumFreeBytes() GUI_ALLOC_GetNumUsedBytes()
Description
Returns the actual number of free bytes. Returns the actual number of bytes used by the application.
GUI_ALLOC_GetNumFreeBytes()
Description
This function returns the number of bytes which can be used for emWin functions.
Prototype
I32 GUI_ALLOC_GetNumFreeBytes(void);
Return value
Number of free bytes.
GUI_ALLOC_GetNumUsedBytes()
Description
This function returns the number of bytes which are already used by emWin functions.
Prototype
I32 GUI_ALLOC_GetNumUsedBytes(void);
Return value
Number of used bytes.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1051
Chapter 35 Support
This chapter should help if any problem occurs. This could be a problem with the tool chain, with the hardware, the use of the GUI functions or with the performance and it describes how to contact the emWin support.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1052
CHAPTER
Support
35.1 Problems with tool chain (compiler, linker)
The following shows some of the problems that can occur with the use of your tool chain. The chapter tries to show what to do in case of a problem and how to contact the emWin support if needed.
35.1.1 Compiler crash
You ran into a tool chain (compiler) problem, not a problem of emWin. If one of the tools of your tool chain crashes, you should contact your compiler support: "Tool internal error, please contact support"
35.1.2 Compiler warnings
The code of emWin has been tested on different target systems and with different compilers. We spend a lot of time on improving the quality of the code and we do our best to avoid compiler warnings. But the sensitivity of each compiler regarding warnings is different. So we can not avoid compiler warnings for unknown tools.
Warnings you should not see
This kind of warnings should not occur: "Function has no prototype" "Incompatible pointer types" "Variable used without having been initialized" "Illegal redefinition of macro"
Warnings you may see
Warnings such as the ones below should be ignored: "Integer conversion, may loose significant bits" "Statement not reached" "Descriptionless statements were deleted during op-timization" "Condition is always true/false" "Unreachable code"
Most compilers offers a way to suppress selected warnings.
Warning "Parameter not used"
Depending of the used configuration sometimes not all of the parameters of the functions are used. To avoid compiler warnings regarding this problem you can define the macro GUI_USE_PARA in the file GUIConf.h like the following example:
#define GUI_USE_PARA(para) (void)para
emWin uses this macro wherever necessary to avoid this type of warning.
35.1.3 Compiler errors
emWin assumes that the used compiler is ANSI C compatible. The compiler should cover at least one of the following standards:
· ISO/IEC/ANSI 9899:1990 (C90) with support for C++ style comments (//) · ISO/IEC 9899:1999 (C99) · ISO/IEC 14882:1998 (C++)
Limited number of arguments in a function pointer call
But some compilers are not 100% ANSI C compatible and have for example a limitation regarding the number of arguments in a function pointer call:
typedef int tFunc(int a, int b, int c, int d, int e, int f, int g, int h, int i, int j);
static int _Func(int a, int b, int c, int d, int e, int f, int g, int h, int i, int j) {
return a + b + c + d + e + f + g + h; }
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1053
static void _Test(void) { int Result; tFunc * pFunc; pFunc = _Func; Result = pFunc(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
}
If the example above can not be compiled, only the core version of emWin can be used. The additional packages of emWin like the Window Manager or the memory device module sometimes need to pass up to 10 parameters with a function pointer call. The core package of emWin needs only up to 2 parameters in a function pointer call. But you can also use emWin if your compiler only supports one argument in a function pointer call. If so some functions are not available, for example rotating text or UTF-8 encoding. For details about how to configure emWin in this case take a look at the chapter 'High-Level Configuration'.
35.1.4 Linker problems
Undefined externals
If your linker shows the error message "Undefined external symbols...", check if the following files have been included to the project or library: · All source files shipped with emWin · In case of a simple bus interface: One of the hardware routines located in the
folder Sample\LCD_X? For details about this, refer to the chapter "Configuration" on page 1039. · One of the files located in the folder Sample\GUI_X? For details about this, refer to the chapter "Configuration" on page 1039.
Executable to large
Some linkers are not able to link only the modules/functions referenced by the project. This results is an executable with a lot of unused code. In this case the use of a library would be very helpful. For details about how to build an emWin library, refer to the chapter "Getting Started" on page 35.
35.2 Problems with hardware/driver
If your tools are working fine but your display does not work may one of the following helps to find the problem.
Stack size to low?
Make sure that there have been configured enough stack. Unfortunately we can not estimate exactly how much stack will be used by your configuration and with your compiler. Further the required stack size depends a lot on the application.
Initialization of the display wrong?
Please check if the controller initialization has been adapted to your needs.
Display interface configured wrong?
When starting to work with emWin and the display does not show something you should use an oscilloscope to measure the pins connected with the display/controller. If there is a problem, check the following: · If using a simple bus interface: Probably the hardware routines have not been
configured correctly. If possible use an emulator and step through these routines. · If using a full bus interface: Probably the register/memory access have not been configured correctly.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1054
CHAPTER
Support
35.3 Problems with API functions
If your tool chain and your hardware works fine but the API functions do not function as documented, make a small example as described in "Contacting support" on page 1055. This allows us to easily reproduce the problem and solve it quickly.
35.4 Problems with the performance
If there is any performance problem with emWin it should be determined, which part of the software causes the problem.
Does the driver causes the problem?
To determine the cause of the problem the first step should be writing a small test routine which executes some test code and measures the time used to execute this code. Starting point should be the file ProblemReport.c described above. To measure the time used by the real hardware driver the shipment of emWin contains the driver LCDNull.c. This driver can be used if no output to the hardware should be done. To activate the driver the LCD_CONTROLLER macro in LCDConf.h as follows:
#define LCD_CONTROLLER -2
The difference between the used time by the real driver and the LCDNull driver shows the execution time spent in the real hardware driver.
Driver not optimized?
If there is a significant difference between the use of the real driver and the LCDNull driver the cause of the problem could be a not optimized driver mode. If using one of the following macros: LCD_MIRROR_X, LCD_MIRROR_Y, LCD_SWAP_XY or LCD_CACHE the driver may not be optimized for the configured mode. In this case, contact our support, we should be able to optimize the code.
Slow display controller?
Also, refer to the chapter "Display drivers" on page 921. If using a slow display controller like the Epson SED1335 this chapter may answer the question, why the driver works slow.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1055
35.5 Contacting support
If you need to contact the emWin support, send the following information to the support: · A detailed description of the problem may written as comment in the example
code. · The configuration files GUIConf.c, GUIConf.h, LCDConf.c, LCDConf.h. · An example source file which can be compiled in the simulation without any addi-
tional files as described in the following. · If there are any problems with the tool chain, also send the error message of the
compiler/linker. · If there are any problems with the hardware/driver and a simple bus interface is
used, also send the hardware routines including the configuration.
Problem report
The following file can be used as a starting point when creating a problem report. Also fill in the CPU, the used tool chain and the problem description. It can be found under Sample\Tutorial\ProblemReport.c:
/*********************************************************************
*
SEGGER Microcontroller GmbH & Co. KG
*
*
Solutions for real time microcontroller applications
*
*
*
*
emWin problem report
*
*
*
**********************************************************************
----------------------------------------------------------------------
File
: ProblemReport.c
CPU
:
Compiler/Tool chain :
Problem description :
----------------------------------------------------------------------
*/
#include "GUI.h" /* Add further GUI header files here as required. */
/*******************************************************************
*
*
Static code
*
********************************************************************
*
* Please insert helper functions here if required.
*/
/*******************************************************************
*
*
MainTask
*/
void MainTask(void) {
GUI_Init();
/*
To do: Insert the code here which demonstrates the problem.
*/
while (1); /* Make sure program does not terminate */
}
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1056
CHAPTER
Support
35.6 FAQ's
Q: I use a different LCD controller. Can I still use emWin? A: Yes. The hardware access is done in the driver module and is completely indepen-
dent of the rest of the GUI. The appropriate driver can be easily written for any controller (memory-mapped or bus-driven). Please get in touch with us.
Q: Which CPUs can I use emWin with? A: emWin can be used with any CPU (or MPU) for which a C compiler exists. Of
course, it will work faster on 16/32-bit CPUs than on 8-bit CPUs.
Q: Is emWin flexible enough to do what I want to do in my application? A: emWin should be flexible enough for any application. If for some reason you do
not think it is in your case, please contact us. Believe it or not, the source code is available.
Q: Does emWin work in a multitask environment? A: Yes, it has been designed with multitask kernels in mind.
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1057
Index
A
Access addresses, defining ....................41 Access routines, defining ......................41 Active window ................................... 332 Additional software ..............................39 Alias macro .........................................40 ANSI ..................................................11 Antialias, 2 Bit ............................247, 256 Antialias, 4 Bit ............................247, 256 Antialiased ........................................ 247 Antialiased mode ............................... 261 Antialiasing ..................248, 252, 889901
API .........................................892, 896 Examples ................................ 897901 Factors .................................... 897898 Fonts ...................................... 890891 High-resolution coordinates 889, 891892 Lines ...................................... 898899 Movement ............................... 899901 Quality ........................................... 890 Software ........................................ 889 API ....................................................29 Application Programming Interface .........29 Arcs, drawing ............................. 140141 ASCII ........................... 76, 195, 216, 218 ASCII 8 Bit + ISO 8859 ...................... 248 Auto device ................................ 308311
B
Background window ........................... 335 Banding memory device .............. 307308 Basic drawing routines ........................ 110 Best palette option ...............180, 190, 192 Binary switch macro .............................40 Binary values .................................... 100 Bitmap Converter ..................31, 177193
command line usage ................. 190191 supported input formats ................... 179 using for color conversion ................. 180 Bitmaps ..................................... 177193 color conversion of .......................... 180 device-dependent (DDB) .................. 182 device-independent (DIB) ................. 182
UM03001 User & Reference Guide for emWin V5.20
drawing ...................................119912 full-color mode ................................180 generating "C" files from ...177178, 182
185 manipulating ...................................178 RLE compressed ............... 182, 187, 193 Blocking dialog ...........................738739 BMP file support ..........................148154 API ................................................148 BmpCvt.exe ...............................190191 Bottom window ..................................333 BUTTON widget ................... 402, 412427 API .........................................413426 Configuration ..................................412 Examples .......................................426 Notification .....................................413 Predefined IDs ................................413 BUTTON_3D_MOVE_X .........................412 BUTTON_3D_MOVE_Y .........................412 BUTTON_ALIGN_DEFAULT ...................412 BUTTON_BI_DISABLED ............... 416, 419 BUTTON_BI_PRESSED ................ 416, 419 BUTTON_BI_UNPRESSED ............ 416, 419 BUTTON_BKCOLOR0_DEFAULT .............412 BUTTON_BKCOLOR1_DEFAULT .............412 BUTTON_CI_DISABLED 416417, 419422,
426, ........................ 699701, 703 BUTTON_CI_PRESSED . 416417, 419422,
426 BUTTON_CI_UNPRESSED 416417, 419422,
..............................................426 BUTTON_Create .................................414 BUTTON_CreateAsChild .......................414 BUTTON_CreateEx ..............................415 BUTTON_CreateIndirect ......................415 BUTTON_CreateUser ...........................416 BUTTON_DrawSkinFlex ............... 782, 786 BUTTON_FOCUSCOLOR_DEFAULT .........412 BUTTON_FONT_DEFAULT .....................412 BUTTON_GetBitmap ...........................416 BUTTON_GetBkColor ..........................416 BUTTON_GetDefaultBkColor ................416 BUTTON_GetDefaultFont .....................417
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1058
Index
BUTTON_GetDefaultTextAlign .............. 417 BUTTON_GetDefaultTextColor .............. 417 BUTTON_GetFont .............................. 418 BUTTON_GetSkinFlexProps .......... 782, 786 BUTTON_GetText ............................... 418 BUTTON_GetTextAlign ........................ 418 BUTTON_GetTextColor ....................... 418 BUTTON_GetUserData ........................ 419 BUTTON_IsPressed ............................ 419 BUTTON_REACT_ON_LEVEL ................ 412 BUTTON_SetBitmap ........................... 419 BUTTON_SetBitmapEx ........................ 419 BUTTON_SetBkColor .......................... 420 BUTTON_SetBMP ............................... 420 BUTTON_SetBMPEx ........................... 421 BUTTON_SetDefaultBkColor ................ 421 BUTTON_SetDefaultFocusColor ............ 421 BUTTON_SetDefaultFont ..................... 422 BUTTON_SetDefaultSkin .............. 782, 786 BUTTON_SetDefaultSkinClassic .... 783, 786 BUTTON_SetDefaultTextAlign .............. 422 BUTTON_SetDefaultTextColor .............. 422 BUTTON_SetFocusColor ...................... 422 BUTTON_SetFocussable ...................... 423 BUTTON_SetFont ............................... 423 BUTTON_SetPressed .......................... 423 BUTTON_SetReactOnLevel .................. 424 BUTTON_SetReactOnTouch ................. 424 BUTTON_SetSkin ........................ 783, 786 BUTTON_SetSkinClassic ....... 783, 786, 789 BUTTON_SetSkinFlexProps .......... 783, 786 BUTTON_SetStreamedBitmap ............. 424 BUTTON_SetStreamedBitmapEx .......... 424 BUTTON_SetText ............................... 425 BUTTON_SetTextAlign ........................ 425 BUTTON_SetTextColor ........................ 425 BUTTON_SetTextOffset ....................... 426 BUTTON_SetUserData ........................ 426 BUTTON_SKINFLEX_PROPS ................. 785 BUTTON_SKINPROPS_DISABLED ......... 785 BUTTON_SKINPROPS_ENABLED .......... 785 BUTTON_SKINPROPS_FOCUSSED ........ 785 BUTTON_SKINPROPS_PRESSED .......... 785 BUTTON_TEXTCOLOR0_DEFAULT ......... 412 BUTTON_TEXTCOLOR1_DEFAULT ......... 412
C
"C" compiler ................................ 43, 182 "C" files
converting bitmaps into 177178, 182185 converting fonts into ....................... 219 inclusion of in emWin ........................ 39 C programming language ..................... 11 CALENDAR_Create ............................ 746 CALENDAR_GetDate .......................... 746 CALENDAR_GetSel ............................ 747 CALENDAR_NOTIFICATION_MONTH_CLICKED
............................................ 745 CALENDAR_NOTIFICATION_MONTH_RELEASE
D .......................................... 745 CALENDAR_SetDate .......................... 747 CALENDAR_SetDefaultBkColor ............ 748 CALENDAR_SetDefaultColor ................ 749 CALENDAR_SetDefaultDays ................ 749 CALENDAR_SetDefaultFont ................. 749 CALENDAR_SetDefaultMonths ............. 750
CALENDAR_SetDefaultSize .................. 750 Callback ........................................... 406 Callback mechanism ..............31, 333350 Callback routines ..........................56, 332
using ...................................... 334350 Character sets ............................ 216218 CHECKBOX widget
Predefined IDs ................................ 429 Checkbox widget ................. 402, 428443
API ......................................... 429442 Configuration .................................. 428 Example ......................................... 443 Keyboard reaction ........................... 429 Notification ..................................... 429 CHECKBOX_ALIGN_DEFAULT ............... 428 CHECKBOX_BKCOLOR_DEFAULT .......... 428 CHECKBOX_BKCOLOR0_DEFAULT ........ 428 CHECKBOX_BKCOLOR1_DEFAULT ........ 428 CHECKBOX_Check ............................. 430 CHECKBOX_Create ............................ 430 CHECKBOX_CreateEx ......................... 431 CHECKBOX_CreateIndirect .................. 431 CHECKBOX_CreateUser ...................... 432 CHECKBOX_DrawSkinFlex ............ 782, 789 CHECKBOX_FGCOLOR0_DEFAULT ........ 428 CHECKBOX_FGCOLOR1_DEFAULT ........ 428 CHECKBOX_FOCUSCOLOR_DEFAULT .... 428 CHECKBOX_FONT_DEFAULT ................ 428 CHECKBOX_GetDefaultBkColor ............ 432 CHECKBOX_GetDefaultFont ................. 432 CHECKBOX_GetDefaultSpacing ............ 432 CHECKBOX_GetDefaultTextAlign .......... 432 CHECKBOX_GetDefaultTextColor .......... 433 CHECKBOX_GetSkinFlexButtonSize ...... 789 CHECKBOX_GetSkinFlexProps ...... 782, 789 CHECKBOX_GetState ......................... 433 CHECKBOX_GetText ........................... 433 CHECKBOX_GetUserData .................... 434 CHECKBOX_IMAGE0_DEFAULT ............. 428 CHECKBOX_IMAGE1_DEFAULT ............. 428 CHECKBOX_IsChecked ....................... 434 CHECKBOX_SetBkColor ...................... 434 CHECKBOX_SetBoxBkColor ................. 435 CHECKBOX_SetDefaultBkColor ............ 435 CHECKBOX_SetDefaultFocusColor ........ 435 CHECKBOX_SetDefaultFont ................. 436 CHECKBOX_SetDefaultImage .............. 436 CHECKBOX_SetDefaultSkin .......... 782, 789 CHECKBOX_SetDefaultSkinClassic . 783, 789 CHECKBOX_SetDefaultSpacing ............ 437 CHECKBOX_SetDefaultTextAlign .......... 437 CHECKBOX_SetDefaultTextColor .......... 437 CHECKBOX_SetFocusColor .................. 438 CHECKBOX_SetFont ........................... 438 CHECKBOX_SetImage ........................ 438 CHECKBOX_SetNumStates .................. 439 CHECKBOX_SetSkin .................... 783, 789 CHECKBOX_SetSkinClassic .......... 783, 789 CHECKBOX_SetSkinFlexProps ....... 783, 789 CHECKBOX_SetSpacing ...................... 439 CHECKBOX_SetState ......................... 440 CHECKBOX_SetText ........................... 440 CHECKBOX_SetTextAlign .................... 441 CHECKBOX_SetTextColor .................... 441 CHECKBOX_SetUserData .................... 441 CHECKBOX_SKINFLEX_DISABLED ........ 790 CHECKBOX_SKINFLEX_ENABLED ......... 790
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1059
CHECKBOX_SKINFLEX_PROPS ............. 788 CHECKBOX_SKINPROPS_DISABLED ..... 788 CHECKBOX_SKINPROPS_ENABLED ....... 788 CHECKBOX_SPACING_DEFAULT ........... 428 CHECKBOX_TEXTCOLOR_DEFAULT ....... 428 CHECKBOX_Uncheck .......................... 442 Child window .......................332, 358, 738 CHOOSECOLOR ................................. 751 CHOOSECOLOR_Create ...................... 752 CHOOSECOLOR_GetSel ...................... 752 CHOOSECOLOR_SetDefaultBorder ........ 754 CHOOSECOLOR_SetDefaultButtonSize .. 754 CHOOSECOLOR_SetDefaultColor .......... 753 CHOOSECOLOR_SetDefaultSpace ......... 753 CHOOSECOLOR_SetSel ....................... 753 CHOOSEFILE ..................................... 756 CHOOSEFILE_Create .......................... 757 CHOOSEFILE_DELIM .......................... 756 CHOOSEFILE_EnableToolTips ............... 760 CHOOSEFILE_SetButtonText ................ 760 CHOOSEFILE_SetDefaultButtonText ...... 761 CHOOSEFILE_SetDelim ....................... 761 CHOOSEFILE_SetToolTips ................... 762 CHOOSEFILE_SetTopMode .................. 762 Circles, drawing ................................. 138 Client area, of windows ...................... 332 Client rectangle ................................. 108 Clip area, of windows ......................... 332 Clipping .....................................103, 332 Color
API, basic ................................ 282283 API, conversion ........................ 284285 Color bar test routine .................. 266267 Color conversion, of bitmaps ........178, 180 Color palettes best palette option ............180, 190, 192 custom ...................................181, 280 fixed ................................180, 267276 Colors .............................................. 265 API ................................................ 281 converting ...................................... 265 logical ............................................ 265 physical ......................................... 265 predefined ...................................... 266 Command line usage of Bitmap Converter ................. 190191 Common dialogs ......................... 745764 Compatibility ..................................... 251 Compile time switches ..........................30 Compile-time configuration ................. 931 Compiling, with simulator demo program ............................ 45, 47 for your application ............................47 samples ...........................................45 Compound characters ......................... 247 Config folder ........................ 40, 46, 1039 Configuration ......................... 10391050 Configuration, of emWin .......................40 Control characters ........................76, 195 Controls (see Widgets) Coordinates .................................32, 332 High-resolution ................. 889, 891892 Create .............................................. 258 Cursor distance ................................. 251 Cursors ................................... 8831028 API ....................................... 8851028 Available styles ............................... 884
UM03001 User & Reference Guide for emWin V5.20
Custom palettes defining for hardware .......................280 file formats, for color conversion ........181 for color conversion .........................181
D
Data types ......................................... 33 Decimal values .............................. 9396 Demos ............................................... 31 Depth coordinate ...............................333 Description ........................................748 Description of terms ...........................332 Desktop coordinates ...........................332 Desktop window ................................332 Device.bmp ................................... 49, 56 Device1.bmp ................................. 50, 56 Device-dependent bitmap (DDB) ..........182 Device-independent bitmap (DIB) ........182 Dialog
Behavior .........................................741 Dialog messages ................................738 Dialog procedure .........................738742 Dialogs ......................................737744
API .........................................743744 Basics ............................................738 Blocking ..................................738739 Creating .........................................739 creating ?? .....................................742 defining behavior of ..................741742 Initialization .............................740741 Messages .......................................738 Non-blocking ............................738739 Direct interface .......................... 926, 929 Directories, inclusion of ........................ 36 Directory structure for emWin ....................................... 36 for simulator .................................... 46 for Visual C++ workspace .................. 46 Display driver ..................................... 44 Available, but not yet migrated ..........925 Available compile-time configurable drivers
924 Run-time configurable drivers ............923 Special purpose drivers ....................925 Display driver API ................... 10081016 Display drivers .......................... 9211016 Display properties ..............................257 Displaying bitmap files .................147175 Drawing modes ...........................107108 DROPDOWN widget Predefined IDs ................................445 Dropdown widget ................ 402, 444458 API .........................................445458 Configuration ..................................444 Example .........................................458 Keyboard reaction ............................445 Notification .....................................445 DROPDOWN_AddString .......................446 DROPDOWN_ALIGN_DEFAULT ..............444 DROPDOWN_BKCOLOR0_DEFAULT .......444 DROPDOWN_BKCOLOR1_DEFAULT .......444 DROPDOWN_BKCOLOR2_DEFAULT .......444 DROPDOWN_CF_AUTOSCROLLBAR .......447 DROPDOWN_CF_UP ...........................447 DROPDOWN_Collapse .........................446 DROPDOWN_Create ...........................446
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1060
Index
DROPDOWN_CreateEx ....................... 447 DROPDOWN_CreateIndirect ................ 448 DROPDOWN_CreateUser .................... 448 DROPDOWN_DecSel .......................... 448 DROPDOWN_DecSelExp ..................... 448 DROPDOWN_DeleteItem .................... 448 DROPDOWN_DrawSkinFlex .......... 782, 794 DROPDOWN_Expand .......................... 448 DROPDOWN_FONT_DEFAULT .............. 444 DROPDOWN_GetItemDisabled ............. 449 DROPDOWN_GetListbox ..................... 449 DROPDOWN_GetNumItems ................ 450 DROPDOWN_GetSel ........................... 450 DROPDOWN_GetSelExp ..................... 450 DROPDOWN_GetSkinFlexProps ..... 782, 794 DROPDOWN_GetUserData .................. 450 DROPDOWN_IncSel ........................... 450 DROPDOWN_IncSelExp ...................... 451 DROPDOWN_InsertString ................... 451 DROPDOWN_KEY_EXPAND ................. 444 DROPDOWN_KEY_SELECT .................. 444 DROPDOWN_SetAutoScroll ................. 451 DROPDOWN_SetBkColor .................... 452 DROPDOWN_SetColor ........................ 452 DROPDOWN_SetDefaultColor .............. 453 DROPDOWN_SetDefaultFont ............... 453 DROPDOWN_SetDefaultScrollbarColor .. 453 DROPDOWN_SetDefaultSkin ........ 782, 794 DROPDOWN_SetDefaultSkinClassic 783, 794 DROPDOWN_SetFont ......................... 453 DROPDOWN_SetItemDisabled ............. 454 DROPDOWN_SetItemSpacing .............. 456 DROPDOWN_SetScrollbarColor ............ 454 DROPDOWN_SetScrollbarWidth ........... 455 DROPDOWN_SetSel ........................... 455 DROPDOWN_SetSelExp ...................... 455 DROPDOWN_SetSkin .................. 783, 794 DROPDOWN_SetSkinClassic ......... 783, 794 DROPDOWN_SetSkinFlexProps ..... 783, 794 DROPDOWN_SetTextAlign ................... 456 DROPDOWN_SetTextColor .................. 456 DROPDOWN_SetTextHeight ................ 457 DROPDOWN_SetUpMode .................... 457 DROPDOWN_SetUserData .................. 458 DROPDOWN_SKINFLEX_DISABLED ...... 795 DROPDOWN_SKINFLEX_ENABLED ....... 795 DROPDOWN_SKINFLEX_EXPANDED ..... 795 DROPDOWN_SKINFLEX_FOCUSSED ..... 795 DROPDOWN_SKINFLEX_PROPS ........... 793 DROPDOWN_SKINPROPS_DISABLED ... 794 DROPDOWN_SKINPROPS_ENABLED ..... 794 DROPDOWN_SKINPROPS_FOCUSSED .. 794 DROPDOWN_SKINPROPS_OPEN .......... 794 DROPDOWN_TEXTCOLOR0_DEFAULT ... 444 DROPDOWN_TEXTCOLOR1_DEFAULT ... 444 DROPDOWN_TEXTCOLOR2_DEFAULT ... 444
E
Edit ................................................. 258 EDIT widget
Predefined IDs ................................ 459 Edit widget ......................... 402, 459477
API ........................................ 460477 Configuration ................................. 459 Examples ....................................... 477 Keyboard reaction ........................... 460
UM03001 User & Reference Guide for emWin V5.20
Notification ..................................... 459 EDIT_AddKey ...................... 461, 639640 EDIT_ALIGN_DEFAULT ........................ 459 EDIT_BKCOLOR0_DEFAULT ................. 459 EDIT_BKCOLOR1_DEFAULT ................. 459 EDIT_BORDER_DEFAULT ..................... 459 EDIT_Create ..................................... 461 EDIT_CreateAsChild ........................... 462 EDIT_CreateEx .................................. 462 EDIT_CreateIndirect .......................... 463 EDIT_CreateUser ............................... 463 EDIT_EnableBlink .............................. 463 EDIT_FONT_DEFAULT ......................... 459 EDIT_GetBkColor ............................... 463 EDIT_GetCursorCharPos ..................... 464 EDIT_GetCursorPixelPos ..................... 464 EDIT_GetDefaultBkColor ..................... 464 EDIT_GetDefaultFont ......................... 465 EDIT_GetDefaultTextAlign ................... 465 EDIT_GetDefaultTextColor .................. 465 EDIT_GetFloatValue ........................... 465 EDIT_GetFont ................................... 466 EDIT_GetNumChars ........................... 466 EDIT_GetText .................................... 466 EDIT_GetTextColor ............................ 467 EDIT_GetUserData ............................. 467 EDIT_GetValue .................................. 467 EDIT_SetBinMode .............................. 467 EDIT_SetBkColor ............................... 467 EDIT_SetCursorAtChar ....................... 468 EDIT_SetCursorAtPixel ....................... 468 EDIT_SetDecMode ............................. 468 EDIT_SetDefaultBkColor ..................... 469 EDIT_SetDefaultFont .......................... 469 EDIT_SetDefaultTextAlign ................... 469 EDIT_SetDefaultTextColor ................... 470 EDIT_SetFloatMode ............................ 470 EDIT_SetFloatValue ........................... 470 EDIT_SetFocussable ........................... 471 EDIT_SetFont .................................... 471 EDIT_SetHexMode ............................. 471 EDIT_SetInsertMode .......................... 471 EDIT_SetMaxLen ............................... 472 EDIT_SetpfAddKeyEx ......................... 472 EDIT_SetSel ..................................... 472 EDIT_SetText .................................... 473 EDIT_SetTextAlign ............................. 473 EDIT_SetTextColor ............................. 474 EDIT_SetTextMode ............................. 474 EDIT_SetUlongMode .......................... 474 EDIT_SetUserData ............................. 474 EDIT_SetValue .................................. 475 EDIT_TEXTCOLOR0_DEFAULT .............. 459 EDIT_TEXTCOLOR1_DEFAULT .............. 459 EDIT_XOFF ....................................... 459 Effects sheet ..................................... 257 Ellipses, drawing ................................ 139 embOS ............................................. 319
Kernel interface routines .................. 329 emWin
as trial version .................................. 44 configuration of ................................. 40 data types used (see Data types) directory structure for ........................ 36 Driver benchmark .................10341035 Features .......................................... 30 in multitask environments .................. 41
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1061
initialization of ..................................40 memory requirements .................... 1036 updating to newer versions .................36 emWinView .............................. 31, 6974 Enable .............................................. 258 Example programs ...............................31 Execution model ......................... 319330 supported types .............................. 320 Execution-related functions ...... 10291031 Exit .................................................. 258 Extended character information ........... 247 Extended mode ................................. 263 External Binary Font ........................... 253
F
Fixed color palettes ............................ 180 Fixed palette modes .................... 267276 Flickering .......................................... 287 Flickering of display ........................... 392 Floating point values ...................... 9799 Floating-point calculations ................... 103 Font Converter 31, 198, 219, 243263, 891,
920 Font editor ........................................ 219 Font files
linking ....................................198, 219 naming convention .......................... 221 Font format ....................................... 251 Font generation ................................. 245 Font height ....................................... 251 Font mapper ..................................... 249 Font type .......................................... 248 Fonts ...................................31, 195241 adding ........................................... 219 Antialiased .......................196, 890891 API ......................................... 203215 converting (see Font converter) creating additional ........................... 198 declaring .................................198, 219 Default .......................................... 202 defining ...........................................31 Digit fonts (monospaced) .......... 240241 Digit fonts (proportional) ........... 238239 editing ........................................... 219 External Bitmap Fonts (XBF) ............. 199 file naming convention ..................... 221 Formats ......................................... 198 Framed .......................................... 196 generating "C" files from .................. 219 Included with emWin ....................... 195 included with emWin ..........................31 Monospaced ................................... 196 monospaced .....................220, 231237 naming convention ................... 220221 Proportional .................................... 196 proportional ...................... 220, 222229 scaling .............................................31 Selecting ........................................ 202 System Independent Fonts (SIF) ....... 198 Types ............................................. 196 usage of ......................................... 198 Frame window widget ........... 402, 478501 API ......................................... 480501 Configuration .................................. 480 Example ......................................... 501 Keyboard reaction ........................... 480
UM03001 User & Reference Guide for emWin V5.20
Structure ........................................479 FRAMEWIN_AddButton .......................481 FRAMEWIN_AddCloseButton ................482 FRAMEWIN_AddMaxButton ..................483 FRAMEWIN_AddMenu .........................484 FRAMEWIN_AddMinButton ...................484 FRAMEWIN_ALLOW_DRAG_ON_FRAME .480 FRAMEWIN_BARCOLOR_ACTIVE_DEFAULT ..
480 FRAMEWIN_BARCOLOR_INACTIVE_DEFAULT
480 FRAMEWIN_BORDER_DEFAULT ............480 FRAMEWIN_CLIENTCOLOR_DEFAULT ....480 FRAMEWIN_Create .............................485 FRAMEWIN_CreateAsChild ...................485 FRAMEWIN_CreateEx .........................486 FRAMEWIN_CreateIndirect ..................487 FRAMEWIN_CreateUser .......................487 FRAMEWIN_DEFAULT_FONT .................480 FRAMEWIN_DrawSkinFlex ........... 782, 797 FRAMEWIN_FRAMECOLOR_DEFAULT .....480 FRAMEWIN_GetActive .........................487 FRAMEWIN_GetBarColor .....................487 FRAMEWIN_GetBorderSize ..................488 FRAMEWIN_GetDefaultBarColor ...........488 FRAMEWIN_GetDefaultBorderSize ........488 FRAMEWIN_GetDefaultClientColor ........488 FRAMEWIN_GetDefaultFont .................489 FRAMEWIN_GetDefaultTextColor ..........489 FRAMEWIN_GetDefaultTitleHeight ........490 FRAMEWIN_GetFont ...........................489 FRAMEWIN_GetSkinFlexProps ...... 782, 797 FRAMEWIN_GetText ...........................489 FRAMEWIN_GetTextAlign .....................490 FRAMEWIN_GetTitleHeight ..................490 FRAMEWIN_GetUserData ....................490 FRAMEWIN_IBORDER_DEFAULT ...........480 FRAMEWIN_IsMaximized .....................490 FRAMEWIN_IsMinimized ......................491 FRAMEWIN_Maximize .........................491 FRAMEWIN_Minimize ..........................492 FRAMEWIN_OwnerDraw ......................492 FRAMEWIN_Restore ...........................492 FRAMEWIN_SetActive .........................493 FRAMEWIN_SetBarColor .....................493 FRAMEWIN_SetBorderSize ..................494 FRAMEWIN_SetClientColor ..................494 FRAMEWIN_SetDefaultBarColor ............495 FRAMEWIN_SetDefaultBorderSize ........495 FRAMEWIN_SetDefaultClient Color .......495 FRAMEWIN_SetDefaultFont .................495 FRAMEWIN_SetDefaultSkin ......... 782, 797 FRAMEWIN_SetDefaultSkinClassic 783, 797 FRAMEWIN_SetDefaultTextColor ..........495 FRAMEWIN_SetDefaultTitleHeight .........496 FRAMEWIN_SetFont ...........................496 FRAMEWIN_SetMoveable ....................496 FRAMEWIN_SetOwnerDraw .................497 FRAMEWIN_SetResizeable ...................498 FRAMEWIN_SetSkin ................... 783, 797 FRAMEWIN_SetSkinClassic .......... 783, 797 FRAMEWIN_SetSkinFlexProps ...... 783, 797 FRAMEWIN_SetText ............................498 FRAMEWIN_SetTextAlign .....................499 FRAMEWIN_SetTextColor ....................499 FRAMEWIN_SetTextColorEx .................500 FRAMEWIN_SetTitleHeight ..................500
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1062
Index
FRAMEWIN_SetTitleVis ....................... 501 FRAMEWIN_SetUserData .................... 501 FRAMEWIN_SKINFLEX_PROPS ............. 797 FRAMEWIN_SKINPROPS_ACTIVE ......... 797 FRAMEWIN_SKINPROPS_INACTIVE ...... 797 FRAMEWIN_TITLEHEIGHT_DEFAULT ..... 480 Full-color mode, of bitmaps ................ 180 Function replacement macro ................. 40 Function-level linking ........................... 37
G
Gamma correction ............................. 252 GIF
API ........................................ 162169 Conversion to C file ......................... 161 Displaying ...................................... 161 Memory usage ................................ 161 GIF file support .......................... 161169 GRAPH widget Predefined IDs ................................ 504 Graph widget ...................... 402, 502527 API ........................................ 504527 API Common ........................... 506514 API GRAPH_DATA_XY ............... 518521 API GRAPH_DATA_YT ................ 514518 API GRAPH_SCALE ................... 522527 Configuration ................................. 504 Create ........................................... 503 Delete ........................................... 503 Drawing ......................................... 503 Examples ....................................... 527 Keyboard reaction ........................... 504 Structure ....................................... 502 Types ............................................ 503 GRAPH_AttachData ............................ 506 GRAPH_AttachScale ........................... 506 GRAPH_CreateEx .............................. 507 GRAPH_CreateIndirect ....................... 507 GRAPH_CreateUser ............................ 507 GRAPH_DATA_XY_AddPoint ................. 518 GRAPH_DATA_XY_Create .................... 518 GRAPH_DATA_XY_Delete .................... 519 GRAPH_DATA_XY_SetLineStyle ........... 520 GRAPH_DATA_XY_SetOffX .................. 519 GRAPH_DATA_XY_SetOffY .................. 519 GRAPH_DATA_XY_SetOwnerDraw ........ 520 GRAPH_DATA_XY_SetPenSize ............. 521 GRAPH_DATA_YT_AddValue ................ 514 GRAPH_DATA_YT_Clear ...................... 515 GRAPH_DATA_YT_Create .................... 515 GRAPH_DATA_YT_Delete .................... 516 GRAPH_DATA_YT_MirrorX ................... 516 GRAPH_DATA_YT_SetAlign ................. 517 GRAPH_DATA_YT_SetOffY .................. 517 GRAPH_DetachData ........................... 507 GRAPH_DetachScale .......................... 508 GRAPH_GetUserData ......................... 508 GRAPH_SCALE_Create ....................... 522 GRAPH_SCALE_Delete ....................... 523 GRAPH_SCALE_SetFactor ................... 523 GRAPH_SCALE_SetFont ...................... 524 GRAPH_SCALE_SetNumDecs ............... 524 GRAPH_SCALE_SetOff ........................ 525 GRAPH_SCALE_SetPos ....................... 525 GRAPH_SCALE_SetTextColor ............... 526 GRAPH_SCALE_SetTickDist ................. 526
UM03001 User & Reference Guide for emWin V5.20
GRAPH_SetBorder ............................. 508 GRAPH_SetColor ............................... 509 GRAPH_SetGridDistX .......................... 509 GRAPH_SetGridDistY .......................... 509 GRAPH_SetGridFixedX ........................ 510 GRAPH_SetGridOffY ........................... 510 GRAPH_SetGridVis ............................. 511 GRAPH_SetLineStyleH ........................ 512 GRAPH_SetLineStyleV ........................ 512 GRAPH_SetUserData .......................... 512 GRAPH_SetUserDraw ......................... 512 GRAPH_SetVSizeX ............................. 513 GRAPH_SetVSizeY ............................. 513 Graphic
API ......................................... 104145 Graphic library .............30, 103145, 1029 Grayscales ................................. 180, 265 GUI subdirectories ............................... 36 GUI_AA_DisableHiRes ........................ 892 GUI_AA_DrawArc .............................. 893 GUI_AA_DrawLine ............................. 894 GUI_AA_DrawPolyOutline ................... 894 GUI_AA_DrawPolyOutlineEx ................ 895 GUI_AA_EnableHiRes ......................... 892 GUI_AA_FillCircle ............................... 895 GUI_AA_FillPolygon ............................ 896 GUI_AA_GetFactor ............................. 893 GUI_AA_SetDrawMode ....................... 896 GUI_AA_SetFactor ............................. 893 GUI_ALLOC_AssignMemory ............... 1042 GUI_ALLOC_SetAvBlockSize .............. 1042 GUI_AssignCursorLayer ...................... 851 GUI_AUTODEV .................................. 309 GUI_AUTODEV_INFO ......................... 309 GUI_BITMAP structures ...................... 178 GUI_BITMAPSTREAM_INFO ................. 127 GUI_BITMAPSTREAM_PARAM .............. 128 GUI_BMP_Draw ................................. 149 GUI_BMP_DrawEx ............................. 149 GUI_BMP_DrawScaled ........................ 150 GUI_BMP_DrawScaledEx .................... 150 GUI_BMP_GetXSize ............................ 151 GUI_BMP_GetXSizeEx ........................ 151 GUI_BMP_GetYSize ............................ 151 GUI_BMP_GetYSizeEx ........................ 152 GUI_BMP_Serialize ............................ 152 GUI_BMP_SerializeEx ......................... 153 GUI_BMP_SerializeExBpp .................... 153 GUI_CalcColorDist ............................. 284 GUI_CalcVisColorError ........................ 284 GUI_Clear .......................................... 90 GUI_ClearKeyBuffer ........................... 872 GUI_ClearRect .................................. 110 GUI_Color2Index ............................... 284 GUI_Color2VisColor ........................... 284 GUI_ColorIsAvailable .......................... 285 GUI_CopyRect ................................... 110 GUI_CreateBitmapFromStream ............ 122 GUI_CreateBitmapFromStream24 ........ 123 GUI_CreateBitmapFromStream555 ...... 123 GUI_CreateBitmapFromStream565 ...... 123 GUI_CreateBitmapFromStreamAlpha .... 123 GUI_CreateBitmapFromStreamIDX ...... 123 GUI_CreateBitmapFromStreamM555 .... 123 GUI_CreateBitmapFromStreamM565 .... 123 GUI_CreateBitmapFromStreamRLE16 ... 123 GUI_CreateBitmapFromStreamRLE32 ... 123
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1063
GUI_CreateBitmapFromStreamRLE4 ..... 123 GUI_CreateBitmapFromStreamRLE8 ..... 123 GUI_CreateBitmapFromStreamRLEAlpha 123 GUI_CreateBitmapFromStreamRLEM16 . 123 GUI_CreateDialogBox ..................739, 743 GUI_CURSOR_GetState ...................... 885 GUI_CURSOR_Hide ............................ 885 GUI_CURSOR_Select .......................... 885 GUI_CURSOR_SelectAnim ................... 886 GUI_CURSOR_SelectAnimHourglassM ... 887 GUI_CURSOR_SetPosition ................... 887 GUI_CURSOR_Show ........................... 887 GUI_DEBUG_LEVEL .......................... 1049 GUI_DEFAULT_BKCOLOR .................. 1048 GUI_DEFAULT_COLOR ...................... 1048 GUI_DEFAULT_FONT ........................ 1048 GUI_Delay ............................. 10291030 GUI_DEVICE_CreateAndLink ............. 1045 GUI_DispBin ..................................... 100 GUI_DispBinAt .................................. 100 GUI_DispCEOL ....................................90 GUI_DispChar .....................................78 GUI_DispCharAt ..................................78 GUI_DispChars ....................................79 GUI_DispDec .......................................93 GUI_DispDecAt ....................................93 GUI_DispDecMin ..................................94 GUI_DispDecShift ................................94 GUI_DispDecSpace ..............................95 GUI_DispFloat .....................................97 GUI_DispFloatFix .................................98 GUI_DispFloatMin ................................98 GUI_DispHex .................................... 101 GUI_DispHexAt ................................. 101 GUI_DispNextLine ................................79 GUI_DispSDec .....................................95 GUI_DispSDecShift ..............................96 GUI_DispSFloatFix ...............................99 GUI_DispSFloatMin ..............................99 GUI_DispString ...................................79 GUI_DispStringAt ................................80 GUI_DispStringAtCEOL .........................80 GUI_DispStringHCenterAt .....................80 GUI_DispStringInRect ..........................81 GUI_DispStringInRectEx .......................82 GUI_DispStringInRectWrap ...................83 GUI_DispStringLen ..............................84 GUI_DrawArc .................................... 140 GUI_DrawBitmap ............................... 119 GUI_DrawBitmapEx ........................... 120 GUI_DrawBitmapHWAlpha .................. 120 GUI_DrawBitmapMag ......................... 121 GUI_DrawCircle ................................. 138 GUI_DrawEllipse ................................ 139 GUI_DrawGradientH ........................... 110 GUI_DrawGradientRoundedH ............... 111 GUI_DrawGradientRoundedV ............... 112 GUI_DrawGradientV ........................... 111 GUI_DrawGraph ................................ 142 GUI_DrawHLine ................................. 129 GUI_DrawLine ................................... 129 GUI_DrawLineRel ............................... 129 GUI_DrawLineTo ................................ 130 GUI_DRAWMODE_XOR ....................... 107 GUI_DrawPie ..................................... 143 GUI_DrawPixel .................................. 112 GUI_DrawPoint .................................. 113
UM03001 User & Reference Guide for emWin V5.20
GUI_DrawPolygon ..............................133 GUI_DrawPolyLine ..............................130 GUI_DrawRect ...................................113 GUI_DrawRoundedRect ................113114 GUI_DrawStreamedBitmap ...........124125 GUI_DrawStreamedBitmap24Ex ...........126 GUI_DrawStreamedBitmap555Ex .........126 GUI_DrawStreamedBitmap565Ex .........126 GUI_DrawStreamedBitmapEx ..............125 GUI_DrawStreamedBitmapExAuto ........125 GUI_DrawStreamedBitmapM555Ex .......126 GUI_DrawStreamedBitmapM565Ex .......126 GUI_DrawVLine ..........................130131 GUI_EditBin ......................................475 GUI_EditDec ......................................475 GUI_EditFloat ....................................476 GUI_EditHex .....................................476 GUI_EditString ..................................477 GUI_EnableAlpha ...............................116 GUI_EndDialog ..................................744 GUI_EnlargePolygon ...........................133 GUI_Error ....................................... 1030 GUI_Exec ........................................ 1030 GUI_Exec1 ...................................... 1031 GUI_ExecCreatedDialog ......................743 GUI_ExecDialogBox .................... 739, 743 GUI_Exit ............................................ 41 GUI_FillCircle .....................................138 GUI_FillEllipse ...................................139 GUI_FillPolygon .................................134 GUI_FillRect ......................................114 GUI_FillRectEx ...................................114 GUI_FillRoundedRect ..........................115 GUI_FONT structures ..........................219 GUI_GetBkColor ................................282 GUI_GetBkColorIndex .........................282 GUI_GetCharDistX .............................212 GUI_GetClientRect .............................108 GUI_GetColor ....................................282 GUI_GetColorIndex ............................282 GUI_GetDispPosX ................................ 90 GUI_GetDispPosY ................................ 90 GUI_GetDrawMode .............................107 GUI_GetFont .....................................212 GUI_GetFontDistY ..............................212 GUI_GetFontInfo ................................212 GUI_GetFontSizeY ..............................213 GUI_GetKey ......................................872 GUI_GetKeyState ...............................872 GUI_GetLayerPosEx .....................852853 GUI_GetLeadingBlankCols ...................213 GUI_GetLineStyle ...............................131 GUI_GetOrg ......................................842 GUI_GetPenSize ................................109 GUI_GetStreamedBitmapInfo ..............126 GUI_GetStreamedBitmapInfoEx ...........127 GUI_GetStringDistX ............................213 GUI_GetTextAlign ................................ 87 GUI_GetTextExtend ............................213 GUI_GetTextMode ............................... 86 GUI_GetTime .................................. 1031 GUI_GetTrailingBlankCols ....................214 GUI_GetVersionString .........................102 GUI_GetYDistOfFont ...........................214 GUI_GetYSizeOfFont ...........................214 GUI_GIF_Draw ..................................162 GUI_GIF_DrawEx ...............................163
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1064
Index
GUI_GIF_DrawSub ............................ 163 GUI_GIF_DrawSubEx ......................... 164 GUI_GIF_DrawSubScaled ................... 164 GUI_GIF_DrawSubScaledEx ................ 165 GUI_GIF_GetComment ...................... 165 GUI_GIF_GetCommentEx ................... 166 GUI_GIF_GetImageInfo ..................... 166 GUI_GIF_GetImageInfoEx .................. 167 GUI_GIF_GetInfo .............................. 167 GUI_GIF_GetInfoEx ........................... 168 GUI_GIF_GetXSize ............................ 168 GUI_GIF_GetXSizeEx ......................... 168 GUI_GIF_GetYSize ............................ 169 GUI_GIF_GetYSizeEx ......................... 169 GUI_GotoX ......................................... 89 GUI_GotoXY ....................................... 89 GUI_GotoY ......................................... 89 GUI_Index2Color .............................. 285 GUI_Init ............................................. 40 GUI_InvertRect ................................. 115 GUI_IsInFont .................................... 215 GUI_JPEG_Draw ................................ 157 GUI_JPEG_DrawEx ............................ 157 GUI_JPEG_DrawScaled ....................... 158 GUI_JPEG_DrawScaledEx ................... 159 GUI_JPEG_GetInfo ............................ 160 GUI_JPEG_GetInfoEx ......................... 160 GUI_JPEG_INFO ................................ 160 GUI_KEY_BUFFER_SIZE ....................1049 GUI_KEY_STATE ................................ 872 GUI_LANG_GetNumItems ................... 913 GUI_LANG_GetText ........................... 913 GUI_LANG_GetTextBuffered ................ 913 GUI_LANG_GetTextBufferedEx ............ 914 GUI_LANG_GetTextEx ........................ 914 GUI_LANG_LoadCSV .......................... 912 GUI_LANG_LoadCSVEx ...................... 912 GUI_LANG_LoadText .......................... 911 GUI_LANG_LoadTextEx ...................... 911 GUI_LANG_SetLang ........................... 914 GUI_LANG_SetMaxNumLang ............... 915 GUI_LANG_SetSep ............................ 915 GUI_MagnifyPolygon .......................... 134 GUI_MAXTASK ......................... 325, 1049 GUI_MEASDEV_ClearRect ................... 311 GUI_MEASDEV_Create ....................... 311 GUI_MEASDEV_Delete ....................... 311 GUI_MEASDEV_GetRect ..................... 312 GUI_MEASDEV_Select ........................ 312 GUI_MEMCPY ...................................1049 GUI_MEMDEV_Clear .......................... 293 GUI_MEMDEV_CopyFromLCD .............. 293 GUI_MEMDEV_CopyToLCD .................. 294 GUI_MEMDEV_CopyToLCDAA .............. 294 GUI_MEMDEV_CopyToLCDAt ............... 294 GUI_MEMDEV_Create ........................ 295 GUI_MEMDEV_CreateAuto .................. 309 GUI_MEMDEV_CreateFixed ................. 295 GUI_MEMDEV_Delete ......................... 297 GUI_MEMDEV_DeleteAuto .................. 309 GUI_MEMDEV_Draw .......................... 307 GUI_MEMDEV_DrawAuto .................... 309 GUI_MEMDEV_DrawPerspectiveX ......... 297 GUI_MEMDEV_FadeDevices ................ 313 GUI_MEMDEV_FadeInWindow ............. 314 GUI_MEMDEV_FadeOutWindow ........... 314 GUI_MEMDEV_GetDataPtr .................. 299
UM03001 User & Reference Guide for emWin V5.20
GUI_MEMDEV_GetYSize ...................... 300 GUI_MEMDEV_MarkDirty .................... 300 GUI_MEMDEV_MoveInWindow ............. 315 GUI_MEMDEV_MoveOutWindow ........... 315 GUI_MEMDEV_ReduceYSize ................ 300 GUI_MEMDEV_Rotate ......................... 301 GUI_MEMDEV_RotateHQ ..................... 301 GUI_MEMDEV_Select ......................... 303 GUI_MEMDEV_SerializeBMP ................ 303 GUI_MEMDEV_SetAnimationCallback .... 313 GUI_MEMDEV_SetOrg ........................ 304 GUI_MEMDEV_ShiftInWindow .............. 316 GUI_MEMDEV_ShiftOutWindow ........... 316 GUI_MEMDEV_SwapWindow ............... 316 GUI_MEMDEV_Write .......................... 304 GUI_MEMDEV_WriteAlpha ................... 304 GUI_MEMDEV_WriteAlphaAt ................ 305 GUI_MEMDEV_WriteAt ........................ 305 GUI_MEMDEV_WriteEx ................ 305306 GUI_MEMSET .................................. 1049 GUI_MessageBox ............................... 763 GUI_MOUSE_DRIVER_PS2_Init ............ 859 GUI_MOUSE_DRIVER_PS2_OnRx ......... 860 GUI_MOUSE_GetState ........................ 858 GUI_MoveRel .................................... 131 GUI_MULTIBUF_Begin ........................ 830 GUI_MULTIBUF_BeginEx ..................... 830 GUI_MULTIBUF_Config ....................... 830 GUI_MULTIBUF_ConfigEx .................... 831 GUI_MULTIBUF_Confirm ..................... 831 GUI_MULTIBUF_ConfirmEx .................. 831 GUI_MULTIBUF_End ........................... 831 GUI_MULTIBUF_EndEx ....................... 832 GUI_MULTIBUF_GetNumBuffers ........... 832 GUI_MULTIBUF_GetNumBuffersEx ....... 832 GUI_MULTIBUF_UseSingleBuffer .......... 832 GUI_NUM_LAYERS ........................... 1049 GUI_OS ................................... 325, 1048 GUI_PID_BUFFER_SIZE .................... 1049 GUI_PID_GetCurrentState .................. 856 GUI_PID_GetState ............................. 857 GUI_PID_IsEmpty .............................. 857 GUI_PID_IsPressed ............................ 857 GUI_PID_STATE ................................ 856 GUI_PID_StoreState .......................... 857 GUI_PNG_Draw ................................. 171 GUI_PNG_DrawEx .............................. 171 GUI_PNG_GetXSize ............................ 172 GUI_PNG_GetXSizeEx ........................ 172 GUI_PNG_GetYSize ............................ 172 GUI_PNG_GetYSizeEx ........................ 173 GUI_RestoreContext .......................... 144 GUI_RestoreUserAlpha ....................... 118 GUI_RotatePolygon ............................ 135 GUI_SaveContext .............................. 144 GUI_SelectLCD .................................. 307 GUI_SelLayer .................................... 852 GUI_SendKeyMsg .............................. 871 GUI_SetAlpha ................................... 117 GUI_SetBkColor ................................ 283 GUI_SetBkColorIndex ........................ 283 GUI_SetClipRect ................................ 145 GUI_SetColor .................................... 283 GUI_SetColorIndex ............................ 283 GUI_SetDefaultFont ........................... 215 GUI_SetDrawMode ............................. 107 GUI_SetFont ..................................... 204
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1065
GUI_SetLayerAlphaEx ........................ 852 GUI_SetLayerSizeEx .......................... 853 GUI_SetLayerVisEx ............................ 853 GUI_SetLBorder ..................................87 GUI_SetLineStyle .............................. 131 GUI_SetOrg ...................................... 842 GUI_SetPenSize ................................ 109 GUI_SetSignalEventFunc .................... 323 GUI_SetStreamedBitmapHook ............. 127 GUI_SetTextAlign .................................88 GUI_SetTextMode ................................86 GUI_SetTextStyle ................................87 GUI_SetUserAlpha ............................. 118 GUI_SetWaitEventFunc ....................... 323 GUI_SetWaitEventTimedFunc .............. 324 GUI_SIF_CreateFont .......................... 205 GUI_SIF_DeleteFont .......................... 206 GUI_SPRITE_Create ........................... 877 GUI_SPRITE_CreateAnim .................... 877 GUI_SPRITE_CreateEx ....................... 878 GUI_SPRITE_CreateExAnim ................ 878 GUI_SPRITE_CreateHidden ................. 879 GUI_SPRITE_CreateHiddenEx .............. 879 GUI_SPRITE_Delete ........................... 879 GUI_SPRITE_GetState ........................ 880 GUI_SPRITE_Hide .............................. 880 GUI_SPRITE_SetBitmap ...................... 880 GUI_SPRITE_SetBitmapAndPosition ...... 880 GUI_SPRITE_SetPosition ..................... 881 GUI_StoreKey ................................... 872 GUI_StoreKeyMsg .............................. 871 GUI_SUPPORT_CURSOR ................... 1048 GUI_SUPPORT_MEMDEV ................... 1048 GUI_SUPPORT_MOUSE ..................... 1048 GUI_SUPPORT_ROTATION ................. 1048 GUI_SUPPORT_TOUCH ..................... 1048 GUI_TA_BOTTOM .................. 88, 473, 522 GUI_TA_HCENTER ................ 88, 473, 522 GUI_TA_LEFT ....................... 88, 473, 522 GUI_TA_RIGHT ..................... 88, 473, 522 GUI_TA_TOP ........................ 88, 473, 522 GUI_TA_VCENTER ................. 88, 473, 522 GUI_TEXTMODE_NORMAL .....................86 GUI_TEXTMODE_REV ...........................86 GUI_TEXTMODE_TRANS .......................86 GUI_TEXTMODE_XOR ...........................86 GUI_TOUCH_Calibrate ........................ 866 GUI_TOUCH_Exec .............................. 866 GUI_TOUCH_GetState ........................ 860 GUI_TOUCH_SetOrientation ................ 866 GUI_TOUCH_StoreState ..............858, 861 GUI_TOUCH_StoreStateEx .................. 861 GUI_TOUCH_X_ActivateX .................... 864 GUI_TOUCH_X_ActivateY .................... 864 GUI_TOUCH_X_MeasureX ................... 865 GUI_TOUCH_X_MeasureY ................... 865 GUI_TRIAL_VERSION ....................... 1049 GUI_TTF_CreateFont .......................... 207 GUI_TTF_DestroyCache ...................... 208 GUI_TTF_Done .................................. 208 GUI_TTF_GetFamilyName ................... 208 GUI_TTF_GetStyleName ..................... 209 GUI_TTF_SetCacheSize ...................... 209 GUI_UC_ConvertUC2UTF8 ................... 906 GUI_UC_ConvertUTF82UC ................... 906 GUI_UC_DispString ............................ 909 GUI_UC_EnableBIDI .......................... 907
UM03001 User & Reference Guide for emWin V5.20
GUI_UC_Encode ................................907 GUI_UC_GetCharCode ........................907 GUI_UC_GetCharSize .........................908 GUI_UC_SetEncodeNone .....................908 GUI_UC_SetEncodeUTF8 .....................908 GUI_VNC_AttachToLayer ................... 1021 GUI_VNC_EnableKeyboardInput ......... 1022 GUI_VNC_GetNumConnections .......... 1022 GUI_VNC_Process ............................ 1022 GUI_VNC_RingBell ........................... 1023 GUI_VNC_SetPassword ..................... 1023 GUI_VNC_SetProgName .................... 1023 GUI_VNC_SetSize ............................ 1024 GUI_VNC_X_StartServer ................... 1024 GUI_WaitKey .....................................873 GUI_WINSUPPORT .................. 10481049 GUI_WrapGetNumLines ....................... 84 GUI_X_Config .................................. 1041 GUI_X_Delay .......................... 1030, 1046 GUI_X_ErrorOut .............................. 1046 GUI_X_ExecIdle ............................... 1046 GUI_X_GetTaskID ..............................327 GUI_X_GetTime ...................... 1031, 1046 GUI_X_InitOS ....................................327 GUI_X_Lock ......................................327 GUI_X_Log ..................................... 1046 GUI_X_SIGNAL_EVENT .......................325 GUI_X_SignalEvent ............................328 GUI_X_Unlock ...................................328 GUI_X_WAIT_EVENT ..........................326 GUI_X_WAIT_EVENT_TIMED ...............326 GUI_X_WaitEvent ...............................328 GUI_X_WaitEventTimed ......................328 GUI_X_Warn ................................... 1046 GUI_XBF_CreateFont ..........................210 GUI_XBF_DeleteFont ..........................211 GUIBuilder ........................... 31, 765773 GUICC_0 ..........................................277 GUICC_1 ..........................................268 GUICC_111 .......................................269 GUICC_16 .........................................269 GUICC_1616I ....................................270 GUICC_2 ..........................................269 GUICC_222 .......................................270 GUICC_233 .......................................270 GUICC_323 .......................................271 GUICC_332 .......................................272 GUICC_4 ..........................................269 GUICC_444_12 ..................................273 GUICC_444_16 ..................................273 GUICC_5 ..........................................269 GUICC_555 .......................................273 GUICC_556 .......................................274 GUICC_565 .......................................274 GUICC_655 .......................................274 GUICC_666 .......................................274 GUICC_666_9 ...................................275 GUICC_822216 ..................................275 GUICC_84444 ...................................275 GUICC_8666 .....................................276 GUICC_8666_1 ..................................276 GUICC_888 .......................................277 GUICC_8888 .....................................277 GUICC_M111 .....................................269 GUICC_M1555I ..................................274 GUICC_M222 .....................................270 GUICC_M233 .....................................271
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1066
Index
GUICC_M323 .................................... 271 GUICC_M332 .................................... 272 GUICC_M444_12 ............................... 273 GUICC_M444_12_1 ........................... 273 GUICC_M444_16 ............................... 273 GUICC_M4444I ................................. 273 GUICC_M555 .................................... 273 GUICC_M556 .................................... 274 GUICC_M565 .................................... 274 GUICC_M655 .................................... 274 GUICC_M666 .................................... 275 GUICC_M666_9 ................................ 275 GUICC_M888 .................................... 277 GUICC_M8888 .................................. 277 GUIConf.h ................................. 202, 291 GUIDRV_07X1 ........................... 996998 GUIDRV_1611 ..........................9991001 GUIDRV_6331 ........................ 10021003 GUIDRV_7529 ........................ 10041006 GUIDRV_BitPlains ....................... 939941 GUIDRV_BitPlains_Config ................... 940 GUIDRV_CompactColor_16 driver . 986990 GUIDRV_DCache ............................... 942 GUIDRV_DCache_AddDriver ............... 943 GUIDRV_DCache_SetMode1bpp .......... 943 GUIDRV_Dist .................................... 944 GUIDRV_Dist_AddDriver .................... 944 GUIDRV_FlexColor ...................... 946957 GUIDRV_FlexColor_Config .................. 950 GUIDRV_FLEXCOLOR_F66702 ............. 948 GUIDRV_FLEXCOLOR_F66708 ............. 948 GUIDRV_FLEXCOLOR_F66709 ............. 948 GUIDRV_FLEXCOLOR_F66712 ............. 948 GUIDRV_FLEXCOLOR_F66714 ............. 948 GUIDRV_FLEXCOLOR_F66715 ............. 948 GUIDRV_FLEXCOLOR_F66718 ............. 948 GUIDRV_FLEXCOLOR_F66719 ............. 948 GUIDRV_FLEXCOLOR_F66720 ............. 948 GUIDRV_FLEXCOLOR_F66772 ............. 948 GUIDRV_FLEXCOLOR_M16C0B16 ........ 949 GUIDRV_FLEXCOLOR_M16C0B8 .......... 949 GUIDRV_FLEXCOLOR_M16C1B16 ........ 949 GUIDRV_FLEXCOLOR_M16C1B8 .......... 949 GUIDRV_FLEXCOLOR_M18C0B18 ........ 949 GUIDRV_FLEXCOLOR_M18C0B9 .......... 949 GUIDRV_FLEXCOLOR_M18C1B18 ........ 949 GUIDRV_FLEXCOLOR_M18C1B9 .......... 949 GUIDRV_FlexColor_SetFunc ................ 948 GUIDRV_FlexColor_SetInterface66712_B18
951 GUIDRV_FlexColor_SetInterface66712_B9 ..
951 GUIDRV_FlexColor_SetInterface66715_B18
951 GUIDRV_FlexColor_SetInterface66715_B9 ..
951 GUIDRV_FlexColor_SetReadFunc66709_B16
952 GUIDRV_FlexColor_SetReadFunc66712_B16
954 GUIDRV_FlexColor_SetReadFunc66712_B9 .
953 GUIDRV_FlexColor_SetReadFunc66715_B16
954 GUIDRV_FlexColor_SetReadFunc66715_B9 .
953
GUIDRV_FlexColor_SetReadFunc66720_B16 955
GUIDRV_FlexColor_SetReadFunc66772_B16 957
GUIDRV_FlexColor_SetReadFunc66772_B8 956
GUIDRV_Fujitsu_16 .................... 991992 GUIDRV_IST3008_SetBus16 ............... 959 GUIDRV_IST3088 ....................... 958959 GUIDRV_Lin ............................... 960963 GUIDRV_Page1bpp driver ............ 993995 GUIDRV_S1D13748 .................... 964966 GUIDRV_S1D13748_Config ................. 965 GUIDRV_S1D13748_SetBus_16 ........... 966 GUIDRV_S1D13781 .................... 967969 GUIDRV_S1D13781_Config ................. 968 GUIDRV_S1D13781_SetBusSPI ........... 968 GUIDRV_S1D15G00 .................... 970972 GUIDRV_S1D15G00_Config ................ 971 GUIDRV_S1D15G00_SetBus8 .............. 971 GUIDRV_SLin ............................. 973976 GUIDRV_SLin_Config ......................... 974 GUIDRV_SLin_SetBus8 ....................... 975 GUIDRV_SLin_SetS1D13700 ............... 975 GUIDRV_SLin_SetSSD1848 ................. 975 GUIDRV_SLin_SetT6963 ..................... 976 GUIDRV_SLin_SetUC1617 ................... 976 GUIDRV_SPage .......................... 977982 GUIDRV_SPage_Config ....................... 980 GUIDRV_SPage_Set1510 .................... 981 GUIDRV_SPage_Set1512 .................... 981 GUIDRV_SPage_SetBus8 .................... 980 GUIDRV_SPage_SetST7591 ................ 981 GUIDRV_SPage_SetUC1611 ................ 981 GUIDRV_SSD1926 driver ............. 983985 GUIDRV_SSD1926_Config .................. 984 GUIDRV_SSD1926_SetBus16 .............. 984 GUITASK_SetMaxTask ...................... 1043 GUITDRV_ADS7846_Config ............... 1026 GUITDRV_ADS7846_Exec ................. 1028 GUITDRV_ADS7846_GetLastVal ......... 1028
H
Handle, of a window ........................... 332 Header widget ..................... 402, 528541
API ......................................... 529541 Configuration .................................. 529 Example ......................................... 541 Keyboard reaction ........................... 529 Notification ..................................... 529 HEADER_AddItem .............................. 530 HEADER_Create ................................ 530 HEADER_CreateAttached .................... 531 HEADER_CreateEx ...................... 531, 583 HEADER_CreateIndirect ...................... 532 HEADER_CreateUser .......................... 532 HEADER_DrawSkinFlex ................ 782, 802 HEADER_GetDefaultBkColor ................ 532 HEADER_GetDefaultBorderH ............... 532 HEADER_GetDefaultBorderV ................ 533 HEADER_GetDefaultCursor .................. 533 HEADER_GetDefaultFont ..................... 533 HEADER_GetDefaultTextColor .............. 533 HEADER_GetHeight ............................ 533 HEADER_GetItemWidth ...................... 534 HEADER_GetNumItems ...................... 534
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1067
HEADER_GetSkinFlexProps ..........782, 802 HEADER_GetUserData ........................ 534 HEADER_SetBitmap ........................... 534 HEADER_SetBitmapEx ........................ 535 HEADER_SetBkColor .......................... 535 HEADER_SetBMP ............................... 535 HEADER_SetBMPEx ............................ 536 HEADER_SetDefaultBkColor ................ 536 HEADER_SetDefaultBorderH ................ 536 HEADER_SetDefaultBorderV ................ 537 HEADER_SetDefaultCursor .................. 537 HEADER_SetDefaultFont ..................... 537 HEADER_SetDefaultSkin ..............782, 802 HEADER_SetDefaultSkinClassic .....783, 802 HEADER_SetDefaultTextColor .............. 538 HEADER_SetDragLimit ........................ 538 HEADER_SetFont ............................... 538 HEADER_SetHeight ............................ 538 HEADER_SetItemText ......................... 539 HEADER_SetItemWidth ...................... 539 HEADER_SetSkin ........................783, 802 HEADER_SetSkinClassic ...............783, 802 HEADER_SetSkinFlexProps ...........783, 802 HEADER_SetStreamedBitmap .............. 539 HEADER_SetStreamedBitmapEx .......... 539 HEADER_SetTextAlign ........................ 540 HEADER_SetTextColor ........................ 540 HEADER_SetUserData ........................ 541 HEADER_SKINFLEX_PROPS ................. 801 HEADER_SKINPROPS ......................... 801 Hello world program .............................42 Hexadecimal values ........................... 101 Hiding windows ................................. 333 High-resolution coordinates ... 889, 891892 History ............................................. 252
I
I/O pins, connection to ....................... 927 Icon view widget ........................ 542555
API ................................................ 543 Configuration .................................. 542 Example ......................................... 555 Keyboard reaction ........................... 543 Notification ..................................... 543 ICONVIEW widget Predefined IDs ................................ 543 Iconview widget ................................ 402 ICONVIEW_AddBitmapItem ................. 544 ICONVIEW_AddStreamedBitmapItem ... 545 ICONVIEW_ALIGN_DEFAULT ................ 542 ICONVIEW_BKCOLOR0_DEFAULT ......... 542 ICONVIEW_BKCOLOR1_DEFAULT ......... 542 ICONVIEW_CreateEx .......................... 545 ICONVIEW_CreateIndirect .................. 546 ICONVIEW_CreateUser ....................... 546 ICONVIEW_DeleteItem ....................... 546 ICONVIEW_EnableStreamAuto ............. 546 ICONVIEW_FONT_DEFAULT ................. 542 ICONVIEW_FRAMEX_DEFAULT ............. 542 ICONVIEW_FRAMEY_DEFAULT ............. 542 ICONVIEW_GetItemText ..................... 546 ICONVIEW_GetItemUserData .............. 547 ICONVIEW_GetNumItems ................... 547 ICONVIEW_GetSel ............................. 547 ICONVIEW_GetUserData ..................... 548 ICONVIEW_InsertBitmapItem .............. 548
ICONVIEW_InsertStreamedBitmapItem .548 ICONVIEW_SetBitmapItem ..................549 ICONVIEW_SetBkColor .......................549 ICONVIEW_SetFont ............................550 ICONVIEW_SetFrame .........................550 ICONVIEW_SetItemText ......................551 ICONVIEW_SetItemUserData ...............551 ICONVIEW_SetSel ..............................551 ICONVIEW_SetSpace ..........................552 ICONVIEW_SetStreamedBitmapItem ....552 ICONVIEW_SetTextAlign .....................553 ICONVIEW_SetTextColor .....................554 ICONVIEW_SetUserData .....................554 ICONVIEW_SPACEX_DEFAULT ..............542 ICONVIEW_SPACEY_DEFAULT ..............542 ICONVIEW_TEXTCOLOR0_DEFAULT ......542 ICONVIEW_TEXTCOLOR1_DEFAULT ......542 IMAGE widget
API .........................................556558 Predefined IDs ................................556 Image widget ............................ 402, 556 Configuration ..................................556 IMAGE_CreateEx ................................556 IMAGE_CreateIndirect ........................557 IMAGE_CreateUser .............................557 IMAGE_SetBitmap ..............................557 IMAGE_SetBMP ..................................557 IMAGE_SetBMPEx ..............................558 IMAGE_SetDTA ..................................557 IMAGE_SetDTAEx ...............................558 IMAGE_SetGIF ...................................557 IMAGE_SetGIFEx ...............................558 IMAGE_SetJPEG .................................557 IMAGE_SetJPEGEx .............................558 IMAGE_SetPNG ..................................557 IMAGE_SetPNGEx ..............................558 Indirect interface ........................926929 Initializing emWin ............................... 40 Input devices ....................................855 Keyboard .................................869873 Mouse .....................................858860 Input focus .......................................738 Interrupt service routines ..... 320322, 866 Invalidation, of windows .....................333 ISO 8859 ..........................................249 ISO 8859-1 ........................ 195, 216, 218
J
Joystick example ................................868 JPEG
API .........................................156160 Compression methods ......................155 Conversion to C file ..........................155 Displaying ......................................155 Memory usage ................................156 Progressive .....................................156 JPEG file support .........................155160
K
Kanji ................................................248 Katakana ..........................................248 Kernel interface API .....................326328 Kernel interface routines ..............320322 Keyboard Input ...........................869873 Keyboard support ........................869873
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1068
Index
L
Language Support ...................... 903920 LCD
caching in memory ............................ 30 configuration of .............................. 265 connecting to microcontroller ......... 3233 without LCD controller ....................... 33 LCD controller connected to port/buffer .................... 32 memory-mapped .............................. 32 support for ....................................... 32 LCD driver customization of ............................... 32 LCD layer API ......................... 10081016 LCD_CACHE ............995, 1001, 1003, 1006 LCD_ControlCache ............................1016 LCD_ENDIAN_BIG ............................. 962 LCD_FIRSTCOM ................................ 995 LCD_FIRSTPIXEL0 ............................1006 LCD_FIRSTSEG0 ............................... 995 LCD_GetBitsPerPixel .........................1009 LCD_GetBitsPerPixelEx ......................1009 LCD_GetNumColors ..........................1009 LCD_GetNumColorsEx .......................1009 LCD_GetNumLayers ........................... 854 LCD_GetVXSize ................................1010 LCD_GetVXSizeEx ............................1010 LCD_GetVYSize ................................1010 LCD_GetVYSizeEx .............................1010 LCD_GetXMag ..................................1010 LCD_GetXMagEx ..............................1010 LCD_GetXSize ..................................1011 LCD_GetXSizeEx ..............................1011 LCD_GetYMag ..................................1010 LCD_GetYMagEx ..............................1010 LCD_GetYSize ..................................1011 LCD_GetYSizeEx ..............................1011 LCD_L0_ControlCache ........................ 994 LCD_NUM_DUMMY_READS ................. 988 LCD_READ_A0 .................. 932, 995, 1000 LCD_READ_A1 .................. 932, 995, 1000 LCD_READM_A1 ....................... 989, 1006 LCD_REG01 ...................................... 988 LCD_SERIAL_ID ................................ 988 LCD_SetDevFunc ..............................1012 LCD_SetMaxNumColors .....................1013 LCD_SetSizeEx ................................1014 LCD_SetVRAMAddrEx ........................1014 LCD_SetVSizeEx ....................... 837, 1015 LCD_SUPPORT_CACHECONTROL ......... 995 LCD_USE_PARALLEL_16 ..................... 989 LCD_USE_SERIAL_3PIN ..................... 989 LCD_WRITE ...................................... 933 LCD_WRITE_A0 932, 989, 995, 1000, 1003,
1006 LCD_WRITE_A1 933, 989, 995, 1000, 1003,
1006 LCD_WRITE_BUFFER_SIZE ................. 989 LCD_WRITEM .................................... 933 LCD_WRITEM_A0 .............................. 989 LCD_WRITEM_A1 933, 989, 995, 1000, 1003,
.............................................1006 LCD_X_Config ..................................1043 LCD_X_DisplayDriver ................ 937, 1044 LCD_X_INITCONTROLLER ................... 937 LCD_X_OFF ...................................... 938
UM03001 User & Reference Guide for emWin V5.20
LCD_X_ON ....................................... 938 LCD_X_SETLUTENTRY ........................ 938 LCD_X_SETORG ................................ 938 LCD_X_SETVRAMADDR ...................... 937 LCDConf.h .......................................... 32 Library, creating .................................. 37 Lines, drawing ............................ 129130 Linking source files .............................. 37 List box widget ........................... 559576
API ......................................... 560576 Configuration .................................. 559 Examples ....................................... 576 Keyboard reaction ........................... 559 Notification ..................................... 559 LISTBOX widget Predefined IDs ................................ 559 Listbox widget ................................... 402 LISTBOX_AddString ........................... 561 LISTBOX_BKCOLOR0_DEFAULT ............ 559 LISTBOX_BKCOLOR1_DEFAULT ............ 559 LISTBOX_BKCOLOR2_DEFAULT ............ 559 LISTBOX_Create ................................ 561 LISTBOX_CreateAsChild ..................... 562 LISTBOX_CreateEx ..................... 562563 LISTBOX_CreateUser ......................... 563 LISTBOX_DecSel ............................... 563 LISTBOX_DeleteItem ......................... 563 LISTBOX_FONT_DEFAULT ................... 559 LISTBOX_GetDefaultBkColor ............... 563 LISTBOX_GetDefaultFont .................... 564 LISTBOX_GetDefaultScrollStepH .......... 564 LISTBOX_GetDefaultTextAlign ............. 564 LISTBOX_GetDefaultTextColor ............. 564 LISTBOX_GetFont .............................. 565 LISTBOX_GetItemDisabled .................. 565 LISTBOX_GetItemSel ......................... 565 LISTBOX_GetItemText ........................ 566 LISTBOX_GetMulti ............................. 566 LISTBOX_GetNumItems ..................... 566 LISTBOX_GetScrollStepH .................... 566 LISTBOX_GetSel ................................ 567 LISTBOX_GetTextAlign ....................... 567 LISTBOX_GetUserData ....................... 567 LISTBOX_IncSel ................................ 567 LISTBOX_InsertString ........................ 568 LISTBOX_InvalidateItem .................... 568 LISTBOX_OwnerDraw ......................... 568 LISTBOX_SetAutoScrollH .................... 569 LISTBOX_SetAutoscrollV ..................... 569 LISTBOX_SetBkColor ......................... 569 LISTBOX_SetDefaultBkColor ............... 570 LISTBOX_SetDefaultFont .................... 570 LISTBOX_SetDefaultScrollStepH .......... 570 LISTBOX_SetDefaultTextAlign .............. 570 LISTBOX_SetDefaultTextColor ............. 571 LISTBOX_SetFont .............................. 571 LISTBOX_SetItemDisabled .................. 571 LISTBOX_SetItemSel ......................... 572 LISTBOX_SetItemSpacing ................... 572 LISTBOX_SetMulti ............................. 572 LISTBOX_SetOwnerDraw .................... 573 LISTBOX_SetScrollbarColor ................. 574 LISTBOX_SetScrollbarWidth ................ 574 LISTBOX_SetScrollStepH .................... 574 LISTBOX_SetSel ................................ 575 LISTBOX_SetString ............................ 575 LISTBOX_SetTextAlign ........................ 575
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1069
LISTBOX_SetTextColor ....................... 576 LISTBOX_SetUserData ....................... 576 LISTBOX_TEXTCOLOR0_DEFAULT ......... 559 LISTBOX_TEXTCOLOR1_DEFAULT ......... 559 LISTBOX_TEXTCOLOR2_DEFAULT ......... 559 LISTVIEW widget
Predefined IDs ................................ 578 Listview widget .................... 402, 577677
API ................................................ 579 Configuration .................................. 578 Example ......................................... 601 Keyboard reaction ........................... 579 Notification ..................................... 578 LISTVIEW_AddColumn ....................... 580 LISTVIEW_AddRow ............................ 581 LISTVIEW_CompareDec ...................... 581 LISTVIEW_CompareText ..................... 581 LISTVIEW_Create .............................. 582 LISTVIEW_CreateAttached .................. 582 LISTVIEW_CreateIndirect ................... 583 LISTVIEW_CreateUser ........................ 583 LISTVIEW_DecSel .............................. 583 LISTVIEW_DeleteColumn .................... 584 LISTVIEW_DeleteRow ......................... 584 LISTVIEW_DisableRow ....................... 584 LISTVIEW_DisableSort ....................... 585 LISTVIEW_EnableRow ........................ 585 LISTVIEW_EnableSort ........................ 585 LISTVIEW_GetBkColor ........................ 586 LISTVIEW_GetFont ............................ 586 LISTVIEW_GetHeader ......................... 586 LISTVIEW_GetItemText ...................... 587 LISTVIEW_GetNumColumns ................ 587 LISTVIEW_GetNumRows ..................... 587 LISTVIEW_GetSel .............................. 588 LISTVIEW_GetSelUnsorted .................. 588 LISTVIEW_GetTextColor ..................... 588 LISTVIEW_GetUserData ...................... 589 LISTVIEW_GetUserDataRow ................ 589 LISTVIEW_IncSel ............................... 589 LISTVIEW_InsertRow ......................... 589 LISTVIEW_SetAutoScrollH ................... 590 LISTVIEW_SetAutoScrollV ................... 590 LISTVIEW_SetBkColor ........................ 590 LISTVIEW_SetColumnWidth ................ 591 LISTVIEW_SetCompareFunc ................ 591 LISTVIEW_SetDefaultBkColor .............. 592 LISTVIEW_SetDefaultFont ................... 593 LISTVIEW_SetDefaultGridColor ............ 593 LISTVIEW_SetDefaultTextColor ............ 593 LISTVIEW_SetFixed ........................... 593 LISTVIEW_SetFont ............................. 594 LISTVIEW_SetGridVis ......................... 594 LISTVIEW_SetHeaderHeight ................ 594 LISTVIEW_SetItemBitmap .................. 595 LISTVIEW_SetItemBkColor ................. 595 LISTVIEW_SetItemText ...................... 596 LISTVIEW_SetItemTextColor ............... 596 LISTVIEW_SetLBorder ........................ 597 LISTVIEW_SetRBorder ........................ 597 LISTVIEW_SetRowHeight .................... 598 LISTVIEW_SetSel .............................. 598 LISTVIEW_SetSelUnsorted .................. 598 LISTVIEW_SetSort ............................. 599 LISTVIEW_SetTextAlign ...................... 599 LISTVIEW_SetTextColor ...................... 600 LISTVIEW_SetUserData ...................... 600
UM03001 User & Reference Guide for emWin V5.20
LISTVIEW_SetUserDataRow ................600 LISTVIEW_SetWrapMode ....................601 LISTWHEEL widget
Predefined IDs ................................602 Listwheel widget ........................ 402, 602
API .........................................603615 Configuration ..................................602 Keyboard reaction ............................603 Notification .....................................602 LISTWHEEL_AddString ........................603 LISTWHEEL_CreateEx .........................604 LISTWHEEL_CreateIndirect .................604 LISTWHEEL_CreateUser ......................604 LISTWHEEL_GetFont ..........................605 LISTWHEEL_GetItemText ....................605 LISTWHEEL_GetLBorder ......................605 LISTWHEEL_GetLineHeight ..................605 LISTWHEEL_GetNumItems ..................606 LISTWHEEL_GetPos ............................606 LISTWHEEL_GetRBorder .....................606 LISTWHEEL_GetSel ............................607 LISTWHEEL_GetSnapPosition ...............607 LISTWHEEL_GetTextAlign ....................607 LISTWHEEL_GetUserData ....................608 LISTWHEEL_MoveToPos ......................608 LISTWHEEL_OwnerDraw .....................608 LISTWHEEL_SetBkColor ......................609 LISTWHEEL_SetFont ...........................609 LISTWHEEL_SetLBorder ......................610 LISTWHEEL_SetLineHeight ..................610 LISTWHEEL_SetOwnerDraw .................611 LISTWHEEL_SetPos ............................611 LISTWHEEL_SetRBorder ......................612 LISTWHEEL_SetSel ............................612 LISTWHEEL_SetSnapPosition ...............613 LISTWHEEL_SetText ...........................613 LISTWHEEL_SetTextAlign ....................614 LISTWHEEL_SetTextColor ....................614 LISTWHEEL_SetUserData ....................615 LISTWHEEL_SetVelocity ......................615 Logging ............................................252 Lookup table (LUT) ....................276, 1008
M
Magnification .....................................251 Magnified format ................................251 Measurement device object ..........311313 Memory Devices
Shipping .........................................287 Memory devices ..........................287400
API .........................................292317 Auto device ..............................308311 banding ...................................307308 Basic usage ....................................291 Color depth .....................................288 Configuration ..................................291 Disabling ........................................291 disabling of .....................................392 Illustration ......................................288 Memory requirements ......................289 Multi layer/display configuration ........291 Multiple layers .................................289 Performance ...................................290 Window manager .............................289 with window manager ......................392 Memory, reducing consumption of 178, 180
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1070
Index
Menu widget ....................... 402, 616633 API ........................................ 619633 Configuration ................................. 618 Data structures ............................... 618 Example ........................................ 633 Keyboard reaction ........................... 619 Messages ....................................... 617
MENU_AddItem ................................. 620 MENU_Attach .................................... 620 MENU_CreateEx ................................ 621 MENU_CreateIndirect ......................... 622 MENU_CreateUser ............................. 622 MENU_DeleteItem ............................. 622 MENU_DisableItem ............................ 622 MENU_EnableItem ............................. 623 MENU_GetDefaultBkColor ................... 623 MENU_GetDefaultBorderSize ............... 624 MENU_GetDefaultEffect ...................... 624 MENU_GetDefaultFont ........................ 624 MENU_GetDefaultTextColor ................. 625 MENU_GetItem ................................. 625 MENU_GetItemText ........................... 625 MENU_GetNumItems ......................... 626 MENU_GetOwner ............................... 626 MENU_GetUserData ........................... 626 MENU_IF_DISABLED .......................... 618 MENU_IF_SEPARATOR ........................ 618 MENU_InsertItem .............................. 626 MENU_ITEM_DATA ............................. 618 MENU_MSG_DATA .................... 617, 1044 MENU_ON_INITMENU ........................ 617 MENU_ON_ITEMACTIVATE .................. 617 MENU_ON_ITEMPRESSED ................... 617 MENU_ON_ITEMSELECT ..................... 617 MENU_Popup .................................... 627 MENU_SetBkColor ............................. 627 MENU_SetBorderSize ......................... 628 MENU_SetDefaultBkColor ................... 629 MENU_SetDefaultBorderSize ............... 629 MENU_SetDefaultEffect ...................... 630 MENU_SetDefaultFont ........................ 630 MENU_SetDefaultTextColor ................. 630 MENU_SetFont .................................. 631 MENU_SetItem ................................. 631 MENU_SetOwner ............................... 631 MENU_SetSel .................................... 632 MENU_SetTextColor ........................... 632 MENU_SetUserData ........................... 633 Merge .............................................. 258 Merging ........................................... 255 MESSAGEBOX ................................... 763 MESSAGEBOX_Create ........................ 764 Messages, sent by callback routines ..... 340 Modifying ......................................... 254 Monospaced fonts (see Fonts) Mouse ................................................ 31 Mouse API
Generic ......................................... 858 PS2 ............................................... 859 Mouse driver .............................. 858860 PS2 ............................................... 859 Mouse support ........................... 858860 Move operations ................................ 250 Multi layer API ........................................ 851854 MULTIEDIT widget Predefined IDs ................................ 635
UM03001 User & Reference Guide for emWin V5.20
Multiedit widget ................... 403, 634645 API ......................................... 635645 Configuration .................................. 634 Example ......................................... 645 Keyboard reaction ........................... 635 Notification ..................................... 635
MULTIEDIT_AddKey ........................... 636 MULTIEDIT_AddText ........................... 636 MULTIEDIT_Create ............................. 637 MULTIEDIT_CreateEx ......................... 637 MULTIEDIT_CreateIndirect .................. 638 MULTIEDIT_CreateUser ...................... 638 MULTIEDIT_EnableBlink ...................... 638 MULTIEDIT_GetCursorCharPos ............. 638 MULTIEDIT_GetCursorPixelPos ............. 639 MULTIEDIT_GetPrompt ....................... 639 MULTIEDIT_GetText ........................... 639 MULTIEDIT_GetTextSize ..................... 640 MULTIEDIT_GetUserData .................... 640 MULTIEDIT_SetAutoScrollH ................. 640 MULTIEDIT_SetAutoScrollV ................. 640 MULTIEDIT_SetBkColor ...................... 641 MULTIEDIT_SetBufferSize ................... 641 MULTIEDIT_SetCursorOffset ................ 641 MULTIEDIT_SetFont ........................... 642 MULTIEDIT_SetInsertMode .................. 642 MULTIEDIT_SetMaxNumChars ............. 642 MULTIEDIT_SetPasswordMode ............. 642 MULTIEDIT_SetPrompt ....................... 643 MULTIEDIT_SetReadOnly .................... 643 MULTIEDIT_SetText ........................... 643 MULTIEDIT_SetTextAlign ..................... 644 MULTIEDIT_SetTextColor .................... 644 MULTIEDIT_SetUserData .................... 644 MULTIEDIT_SetWrapNone ................... 645 MULTIEDIT_SetWrapWord ................... 644 MULTIPAGE widget
Predefined IDs ................................ 647 Multipage widget ................. 403, 646659
API ......................................... 647659 Configuration .................................. 647 Example ......................................... 659 Keyboard reaction ........................... 647 Notification ..................................... 647 MULTIPAGE_AddPage ......................... 648 MULTIPAGE_CreateEx ......................... 649 MULTIPAGE_CreateIndirect ................. 649 MULTIPAGE_CreateUser ...................... 649 MULTIPAGE_DeletePage ...................... 649 MULTIPAGE_DisablePage .................... 650 MULTIPAGE_EnablePage ..................... 650 MULTIPAGE_GetDefaultAlign ............... 651 MULTIPAGE_GetDefaultBkColor ............ 651 MULTIPAGE_GetDefaultFont ................ 652 MULTIPAGE_GetDefaultTextColor ......... 652 MULTIPAGE_GetSelection .................... 652 MULTIPAGE_GetUserData ................... 653 MULTIPAGE_GetWindow ..................... 653 MULTIPAGE_IsPageEnabled ................. 653 MULTIPAGE_SelectPage ...................... 653 MULTIPAGE_SetAlign .......................... 654 MULTIPAGE_SetBkColor ...................... 654 MULTIPAGE_SetDefaultAlign ................ 655 MULTIPAGE_SetDefaultBkColor ............ 655 MULTIPAGE_SetDefaultFont ................. 655 MULTIPAGE_SetDefaultTextColor .......... 656 MULTIPAGE_SetFont .......................... 656
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1071
MULTIPAGE_SetRotation ..................... 657 MULTIPAGE_SetText ........................... 657 MULTIPAGE_SetTextColor .................... 658 MULTIPAGE_SetUserData .................... 659 Multiple buffer support ................ 825833 Multiple layer support .................. 843854 Multitask environments ........ 320323, 403
multiple tasks call emWin ... 320, 322323 one task calls emWin ................ 320321
N
Non readable displays ........................ 934 Non-blocking dialog .................... 738739 NORMAL drawing mode ...................... 107 Normal text ........................................85 Numerical value macro .........................40
O
Optional software ................................39 Output mode ..................................... 247
P
Palettes (see Color palettes) Parent window ................................... 332 Pen size ............................................ 109 Performance .......................... 10331037 Pixels .................................................32 PNG
API ......................................... 170173 PNG file support ......................... 170173 Pointer input device
API ................................................ 856 Data structure ................................ 856 Pointer input devices Mouse ..................................... 858860 Polygons, drawing ....................... 133137 PROGBAR widget Predefined IDs ................................ 660 Progbar widget .................................. 403 PROGBAR_Create .............................. 661 PROGBAR_CreateAsChild .................... 661 PROGBAR_CreateEx ........................... 661 PROGBAR_CreateIndirect .................... 662 PROGBAR_CreateUser ........................ 662 PROGBAR_DEFAULT_BARCOLOR0 ........ 660 PROGBAR_DEFAULT_BARCOLOR1 ........ 660 PROGBAR_DEFAULT_FONT .................. 660 PROGBAR_DEFAULT_TEXTCOLOR0 ....... 660 PROGBAR_DEFAULT_TEXTCOLOR1 ....... 660 PROGBAR_DrawSkinFlex ..............782, 805 PROGBAR_GetSkinFlexProps ........782, 805 PROGBAR_GetUserData ...................... 662 PROGBAR_SetBarColor ....................... 662 PROGBAR_SetDefaultSkin ............782, 805 PROGBAR_SetDefaultSkinClassic ...783, 805 PROGBAR_SetFont ............................. 663 PROGBAR_SetMinMax ........................ 663 PROGBAR_SetSkin ......................783, 805 PROGBAR_SetSkinClassic .............783, 805 PROGBAR_SetSkinFlexProps .........783, 805 PROGBAR_SetText ............................. 663 PROGBAR_SetTextAlign ...................... 664 PROGBAR_SetTextColor ...................... 664 PROGBAR_SetTextPos ........................ 664 PROGBAR_SetUserData ...................... 665
PROGBAR_SetValue ............................665 PROGBAR_SKINFLEX_INFO .................806 PROGBAR_SKINFLEX_L .......................806 PROGBAR_SKINFLEX_PROPS ...............804 PROGBAR_SKINFLEX_R ......................806 Progress bar widget .....................660665
API .........................................660665 Configuration ..................................660 Examples .......................................665 Keyboard reaction ............................660 Proportional fonts (see Fonts)
R
Radio button widget ....................666677 API .........................................667677 Configuration ..................................666 Example .........................................677 Keyboard reaction ............................667 Notification .....................................667
RADIO widget Predefined IDs ................................667
RADIO_Create ...................................668 RADIO_CreateEx ................................668 RADIO_CreateIndirect ........................669 RADIO_CreateUser .............................669 RADIO_Dec .......................................669 RADIO_DrawSkinFlex .........................782 RADIO_GetDefaultFont .......................670 RADIO_GetDefaultTextColor ................670 RADIO_GetSkinFlexProps ....................782 RADIO_GetText .................................670 RADIO_GetUserData ..........................670 RADIO_GetValue ................................671 RADIO_Inc ........................................671 RADIO_SetBkColor .............................672 RADIO_SetDefaultFocusColor ...............672 RADIO_SetDefaultFont ........................672 RADIO_SetDefaultImage .....................673 RADIO_SetDefaultSkin ........................782 RADIO_SetDefaultSkinClassic ..............783 RADIO_SetDefaultTextColor .................673 RADIO_SetFocusColor .........................674 RADIO_SetFont .................................674 RADIO_SetGroupID ............................675 RADIO_SetImage ...............................675 RADIO_SetSkin .................................783 RADIO_SetSkinClassic ........................783 RADIO_SetSkinFlexProps ............ 783, 809 RADIO_SetText ..................................676 RADIO_SetTextColor ...........................676 RADIO_SetUserData ...........................677 RADIO_SetValue ................................677 RADIO_SKINFLEX_PROPS ...................808 RADIO_SKINPROPS_CHECKED .............809 RADIO_SKINPROPS_UNCHECKED .........809 Radiobutton widget ............................403 Readpattern ......................................259 Redrawing mechanism ........................403 Resource semaphore ..........................326 Resource table, for dialogs ..................739 Resource usage ...................... 10331037 Reverse text ....................................... 85 RLE compression, of bitmaps 182, 187, 193 Run-time configuration .......................929
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1072
Index
S
Sample programs ................................ 41 Saveas ............................................. 259 Script box ........................................ 249 Scroll bar widget ........................ 678687
API ........................................ 679686 Configuration ................................. 678 Example ........................................ 686 Keyboard reaction ........................... 678 Notification .................................... 678 SCROLLBAR widget Predefined IDs ................................ 678 Scrollbar widget ................................ 403 SCROLLBAR_AddValue ....................... 679 SCROLLBAR_COLOR_ARROW_DEFAULT 678 SCROLLBAR_COLOR_SHAFT_DEFAULT .. 678 SCROLLBAR_COLOR_THUMB_DEFAULT . 678 SCROLLBAR_Create ........................... 680 SCROLLBAR_CreateAttached ............... 680 SCROLLBAR_CreateEx ........................ 681 SCROLLBAR_CreateIndirect ................ 682 SCROLLBAR_CreateUser ..................... 682 SCROLLBAR_Dec ............................... 682 SCROLLBAR_DrawSkinFlex ................. 782 SCROLLBAR_GetDefaultWidth ............. 682 SCROLLBAR_GetNumItems ................. 682 SCROLLBAR_GetPageSize ................... 683 SCROLLBAR_GetSkinFlexProps ............ 782 SCROLLBAR_GetThumbSizeMin ........... 683 SCROLLBAR_GetUserData .................. 683 SCROLLBAR_GetValue ........................ 683 SCROLLBAR_Inc ................................ 683 SCROLLBAR_SetColor ........................ 684 SCROLLBAR_SetDefaultColor .............. 684 SCROLLBAR_SetDefaultSkin ............... 782 SCROLLBAR_SetDefaultSkinClassic ...... 783 SCROLLBAR_SetDefaultWidth ............. 684 SCROLLBAR_SetNumItems ................. 685 SCROLLBAR_SetPageSize ................... 685 SCROLLBAR_SetSkin ......................... 783 SCROLLBAR_SetSkinClassic ................ 783 SCROLLBAR_SetSkinFlexProps ..... 783, 813 SCROLLBAR_SetState ........................ 685 SCROLLBAR_SetThumbSizeMin ........... 686 SCROLLBAR_SetUserData ................... 686 SCROLLBAR_SetValue ........................ 686 SCROLLBAR_SetWidth ....................... 686 SCROLLBAR_SKINFLEX_INFO ....... 814815 SCROLLBAR_SKINFLEX_PROPS ........... 812 SCROLLBAR_SKINPROPS_PRESSED ..... 813 SCROLLBAR_SKINPROPS_UNPRESSED . 813 SCROLLBAR_THUMB_SIZE_MIN_DEFAULT ..
678 Selection switch macro ......................... 40 Set of characters ............................... 256 Shift JIS
creating fonts ................................. 920 SHIFT JIS 8/16 Bit ............................. 248 Shift operations ................................ 250 Showing windows .............................. 333 Sibling window .................................. 332 SIF format ........................................ 252 SIM_GUI_CreateLCDInfoWindow() ......... 65 SIM_GUI_CreateLCDWindow ................. 66 SIM_GUI_Enable ................................. 66 SIM_GUI_Exit ..................................... 66
UM03001 User & Reference Guide for emWin V5.20
SIM_GUI_Init ...................................... 66 SIM_GUI_SetCallback .......................... 51 SIM_GUI_SetCompositeColor ................ 52 SIM_GUI_SetCompositeSize .................. 52 SIM_GUI_SetLCDColorBlack .................. 53 SIM_GUI_SetLCDColorWhite ................. 53 SIM_GUI_SetLCDPos ............................ 54 SIM_GUI_SetLCDWindowHook ............... 67 SIM_GUI_SetMag ................................ 54 SIM_GUI_SetTransColor ....................... 54 SIM_GUI_ShowDevice .......................... 51 SIM_GUI_UseCustomBitmaps ................ 55 SIM_HARDKEY_GetNum ....................... 57 SIM_HARDKEY_GetState ...................... 58 SIM_HARDKEY_SetCallback .................. 58 SIM_HARDKEY_SetMode ................. 56, 59 SIM_HARDKEY_SetState ....................... 59 SIM_SetTransColor .............................. 49 Simulation ............................... 31, 4367
API, Device .................................5155 API, GUI .....................................6567 API, Hardkey ...............................5759 Hardkey ......................................5659 Integration ..................................6067 Simulator directory structure for ........................ 46 usage of with emWin source ..........4647 usage of with emWin trial version ........ 44 Single task system ...................... 320321 Size operations .................................. 250 Skinning .................................... 775824 DrawSkinFlex .................................. 782 GetSkinFlexProps ............................ 782 SetDefaultSkin ................................ 782 SetDefaultSkinClassic ...................... 783 SetSkin .......................................... 783 SetSkinClassic ................................ 783 SetSkinFlexProps ............................ 783 SLIDER widget Predefined IDs ................................ 688 Slider widget ....................... 403, 688694 API ......................................... 689694 Configuration .................................. 688 Example .................................. 694, 704 Keyboard reaction ........................... 688 Notification ..................................... 688 SLIDER_BKCOLOR0_DEFAULT ............. 688 SLIDER_COLOR0_DEFAULT ................. 688 SLIDER_Create ................................. 689 SLIDER_CreateEx .............................. 689 SLIDER_CreateIndirect ....................... 690 SLIDER_CreateUser ........................... 690 SLIDER_Dec ..................................... 690 SLIDER_DrawSkinFlex ........................ 782 SLIDER_FOCUSCOLOR_DEFAULT ......... 688 SLIDER_GetSkinFlexProps .................. 782 SLIDER_GetUserData ......................... 690 SLIDER_GetValue .............................. 691 SLIDER_Inc ...................................... 691 SLIDER_SetBkColor ........................... 691 SLIDER_SetDefaultFocusColor ............. 692 SLIDER_SetDefaultSkin ...................... 782 SLIDER_SetDefaultSkinClassic ............. 783 SLIDER_SetFocusColor ....................... 692 SLIDER_SetNumTicks ......................... 692 SLIDER_SetRange ............................. 693 SLIDER_SetSkin ................................ 783
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1073
SLIDER_SetSkinClassic ....................... 783 SLIDER_SetSkinFlexProps ................... 783 SLIDER_SetUserData ......................... 693 SLIDER_SetValue ............................... 693 SLIDER_SetWidth .............................. 694 SLIDER_SKINFLEX_INFO .................... 820 SLIDER_SKINFLEX_PROPS .................. 817 SLIDER_SKINPROPS_PRESSED ............ 818 SLIDER_SKINPROPS_UNPRESSED ........ 818 Smoothed edges ................................ 257 Source files, linking ..............................37 SPINBOX widget ................................ 695
Predefined IDs ................................ 697 Spinbox widget .................................. 403
API ................................................ 697 Configuration .................................. 696 Keyboard reaction ........................... 697 Notification ..................................... 697 SPINBOX_CI_ENABLED ......... 699701, 703 SPINBOX_CreateEx ............................ 697 SPINBOX_CreateIndirect ..................... 698 SPINBOX_CreateUser ......................... 698 SPINBOX_DEFAULT_BUTTON_BKCOLOR0 696 SPINBOX_DEFAULT_BUTTON_BKCOLOR1 696 SPINBOX_DEFAULT_BUTTON_BKCOLOR2 696 SPINBOX_DEFAULT_BUTTON_SIZE ....... 696 SPINBOX_DEFAULT_EDGE ................... 696 SPINBOX_DEFAULT_EDIT_BKCOLOR0 ... 696 SPINBOX_DEFAULT_EDIT_BKCOLOR1 ... 696 SPINBOX_DEFAULT_STEP ................... 696 SPINBOX_DrawSkinFlex ...............782, 822 SPINBOX_EDGE_CENTER .................... 702 SPINBOX_EDGE_LEFT .................696, 702 SPINBOX_EDGE_RIGHT ...............696, 702 SPINBOX_EnableBlink ........................ 698 SPINBOX_GetBkColor ......................... 698 SPINBOX_GetButtonBkColor ................ 699 SPINBOX_GetDefaultButtonSize ........... 699 SPINBOX_GetEditHandle ..................... 699 SPINBOX_GetSkinFlexProps .........782, 822 SPINBOX_GetUserData ....................... 699 SPINBOX_GetValue ............................ 700 SPINBOX_SetBkColor ......................... 700 SPINBOX_SetButtonSize ..................... 701 SPINBOX_SetDefaultButtonSize ........... 701 SPINBOX_SetDefaultSkin .............782, 822 SPINBOX_SetDefaultSkinClassic ...783, 822 SPINBOX_SetEdge ............................. 702 SPINBOX_SetFont .............................. 702 SPINBOX_SetRange ........................... 702 SPINBOX_SetSkin .......................783, 822 SPINBOX_SetSkinClassic .............783, 822 SPINBOX_SetSkinFlexProps ..........783, 822 SPINBOX_SetTextColor ....................... 703 SPINBOX_SetUserData ....................... 703 SPINBOX_SetValue ............................ 703 SPINBOX_SKINFLEX_PI_DISABLED 823824 SPINBOX_SKINFLEX_PI_ENABLED 823824 SPINBOX_SKINFLEX_PI_FOCUSSED 823824 SPINBOX_SKINFLEX_PI_PRESSED 823824 SPINBOX_SKINFLEX_PROPS ................ 822 SPINBOX_SKINPROPS_DISABLED ........ 822 SPINBOX_SKINPROPS_ENABLED ......... 822 SPINBOX_SKINPROPS_FOCUSSED ....... 822 SPINBOX_SKINPROPS_PRESSED ......... 822 SPINBOX_TIMER_PERIOD ................... 696 SPINBOX_TIMER_PERIOD_START ........ 696
Sprintf ............................................... 91 Sprites ......................................875881
API .........................................876881 Standard fonts ...................................195 String output routines .......................... 31 Subdirectories, of GUI ......................... 36 Superloop ..................................320321 Support ................................. 10511056 Syntax, conventions used ..................... 11 System Independent Font ...................253
T
Template driver ............................... 1007 Text ............................................. 7590
alignment ................................... 8788 API ............................................ 7790 modes ........................................ 8586 positioning .............................76, 8990 TEXT widget Predefined IDs ................................705 Text widget ........................ 403, 705711 API .........................................705711 Configuration ..................................705 Examples .......................................711 Keyboard reaction ............................705 TEXT_Create .....................................706 TEXT_CreateAsChild ...........................706 TEXT_CreateEx ..................................707 TEXT_CreateIndirect ...........................707 TEXT_CreateUser ...............................708 TEXT_DEFAULT_BK_COLOR .................705 TEXT_DEFAULT_TEXT_COLOR ..............705 TEXT_DEFAULT_WRAPMODE ................705 TEXT_FONT_DEFAULT .........................705 TEXT_GetDefaultFont .........................708 TEXT_GetNumLines ............................708 TEXT_GetText ....................................708 TEXT_GetUserData .............................708 TEXT_SetBkColor ...............................708 TEXT_SetDefaultFont ..........................709 TEXT_SetDefaultTextColor ...................709 TEXT_SetDefaultWrapMode .................709 TEXT_SetFont ....................................710 TEXT_SetText ....................................710 TEXT_SetTextAlign .............................710 TEXT_SetTextColor .............................710 TEXT_SetUserData .............................711 TEXT_SetWrapMode ...........................711 Tick ....................................... 10291030 Timing and execution API ..................................... 10301031 Timing-related functions .......... 10291031 Toggle behavior, of hardkeys ............ 56, 59 Top window .......................................333 Touch drivers ................................... 1025 Touch screen API ................................................860 API, analog .....................................866 Runtime calibration ..........................864 Touch screen driver ............................860 Analog ...........................................861 Analog, config .................................867 Touch-screen ...................................... 31 Transparency .....................................333 Transparent reversed text .................... 85 Transparent text ................................. 85
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1074
Index
TREEVIEW widget Predefined IDs ................................ 714
Treeview widget .................. 403, 712734 API ........................................ 715733 API, common .......................... 716728 API, item related ...................... 728733 Configuration ................................. 714 Example ........................................ 733 Keyboard reaction ........................... 715 Notification .................................... 714 Terms ............................................ 713
TREEVIEW_AttachItem ....................... 716 TREEVIEW_CreateEx .......................... 716 TREEVIEW_CreateIndirect .................. 717 TREEVIEW_CreateUser ....................... 717 TREEVIEW_DecSel ............................. 717 TREEVIEW_GetDefaultBkColor ............. 718 TREEVIEW_GetDefaultFont ................. 718 TREEVIEW_GetDefaultLineColor .......... 718 TREEVIEW_GetDefaultTextColor .......... 719 TREEVIEW_GetItem ........................... 719 TREEVIEW_GetSel ............................. 720 TREEVIEW_GetUserData .................... 720 TREEVIEW_IncSel ............................. 720 TREEVIEW_InsertItem ....................... 721 TREEVIEW_ITEM_Collapse .................. 728 TREEVIEW_ITEM_CollapseAll .............. 729 TREEVIEW_ITEM_Create .................... 729 TREEVIEW_ITEM_Delete ..................... 730 TREEVIEW_ITEM_Detach .................... 730 TREEVIEW_ITEM_Expand ................... 730 TREEVIEW_ITEM_ExpandAll ................ 731 TREEVIEW_ITEM_GetInfo ................... 731 TREEVIEW_ITEM_GetText ................... 731 TREEVIEW_ITEM_GetUserData ............ 732 TREEVIEW_ITEM_SetImage ................ 732 TREEVIEW_ITEM_SetText ................... 733 TREEVIEW_ITEM_SetUserData ............ 733 TREEVIEW_SetAutoScrollH ................. 721 TREEVIEW_SetAutoScrollV .................. 722 TREEVIEW_SetBitmapOffset ............... 722 TREEVIEW_SetBkColor ....................... 723 TREEVIEW_SetDefaultBkColor ............. 723 TREEVIEW_SetDefaultFont ................. 723 TREEVIEW_SetDefaultLineColor ........... 723 TREEVIEW_SetDefaultTextColor ........... 724 TREEVIEW_SetFont ........................... 724 TREEVIEW_SetHasLines ..................... 724 TREEVIEW_SetImage ......................... 725 TREEVIEW_SetIndent ........................ 725 TREEVIEW_SetLineColor ..................... 726 TREEVIEW_SetOwnerDraw ................. 726 TREEVIEW_SetSel ............................. 726 TREEVIEW_SetSelMode ...................... 727 TREEVIEW_SetTextColor ..................... 727 TREEVIEW_SetTextIndent ................... 728 TREEVIEW_SetUserData ..................... 728 Trial version, of emWin ......................... 44 Tutorial .............................................. 41
U
uC/OS ............................................. 319 kernel interface routines for ............. 329
Unicode .................................... 195, 218 API reference ................................. 906 displaying characters in ................... 905
Unicode 16 Bit ............................ 245, 248 UTF-8 strings .................................... 905
V
Validation, of windows ........................ 333 Value output routines ........................... 31 Values
API ........................................... 92102 Binary ........................................... 100 Decimal ......................................9396 emWin version number .................... 102 Floating point ..............................9799 Hexadecimal ................................... 101 Values, displaying ................................ 91 Vectorized symbols ............................ 133 Version number ................................. 102 Viewer ..........................................6974 Viewing mode ................................... 251 Virtual display ..................................... 30 Virtual screen support ................. 835842 Visual C++ ................................... 44, 47 directory structure for ........................ 46 VNC Server ............................ 1017, 1024 API ......................................10211024 VNC Support .......................... 1017, 1024
W
Western Latin character set (see ISO 8859-1) WIDGET_DRAW_ITEM_FUNC ........ 410, 783 WIDGET_GetDefaultEffect ................... 409 WIDGET_ITEM_CREATE ...................... 781 WIDGET_ITEM_DRAW ........................ 411 WIDGET_ITEM_DRAW_ARROW ............ 781 WIDGET_ITEM_DRAW_BACKGROUND .. 781 WIDGET_ITEM_DRAW_BITMAP ............ 781 WIDGET_ITEM_DRAW_BUTTON ........... 781 WIDGET_ITEM_DRAW_BUTTON_L ........ 781 WIDGET_ITEM_DRAW_BUTTON_R ....... 781 WIDGET_ITEM_DRAW_FOCUS ............. 781 WIDGET_ITEM_DRAW_FRAME ............. 781 WIDGET_ITEM_DRAW_INFO ............... 779 WIDGET_ITEM_DRAW_OVERLAP .......... 781 WIDGET_ITEM_DRAW_SEP ................. 781 WIDGET_ITEM_DRAW_SHAFT ............. 781 WIDGET_ITEM_DRAW_SHAFT_L .......... 781 WIDGET_ITEM_DRAW_SHAFT_R .......... 781 WIDGET_ITEM_DRAW_TEXT ............... 781 WIDGET_ITEM_DRAW_THUMB ............ 781 WIDGET_ITEM_DRAW_TICKS .............. 781 WIDGET_ITEM_GET_BORDERSIZE_B ... 781 WIDGET_ITEM_GET_BORDERSIZE_L .... 781 WIDGET_ITEM_GET_BORDERSIZE_R ... 781 WIDGET_ITEM_GET_BORDERSIZE_T .... 781 WIDGET_ITEM_GET_BUTTONSIZE ....... 781 WIDGET_ITEM_GET_XSIZE .......... 411, 781 WIDGET_ITEM_GET_YSIZE .......... 411, 781 WIDGET_SetDefaultEffect ................... 409 WIDGET_SetEffect ............................. 410 WIDGET_USE_FLEX_SKIN .................. 405 WIDGET_USE_PARENT_EFFECT ........... 405 WIDGET_USE_SCHEME_LARGE ........... 405 WIDGET_USE_SCHEME_MEDIUM ......... 405 WIDGET_USE_SCHEME_SMALL ........... 405 Widgets .......................31, 401736, 1029
Available widgets ............................ 402 Callback ......................................... 406
UM03001 User & Reference Guide for emWin V5.20
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Index
1075
Common routines ............................ 406 CreateIndirect ................................. 407 CreateUser ..................................... 408 defining behavior of ......................... 741 Dynamic memory usage ................... 404 GetUserData ................................... 408 Handle ....................................401, 404 in dialogs ....................................... 737 Initialization ............................ 740741 initialization of ................................ 738 Member functions ............................ 403 SetUserData ................................... 408 User drawn ..................................... 410 Using ............................................. 403 WM routines ................................... 406 Window coordinates ........................... 333 Window Manager Terms ............................................ 332 Window manager ..........31, 331401, 1030 API ......................................... 352398 Window objects (see Widgets) Window widget ........................... 735820 API ................................................ 735 Configuration .................................. 735 Keyboard reaction ........................... 735 WINDOW_BKCOLOR_DEFAULT ............. 735 WINDOW_CreateEx ............................ 735 WINDOW_CreateIndirect .................... 736 WINDOW_CreateUser ......................... 736 WINDOW_GetUserData ...................... 736 WINDOW_SetBkColor ......................... 736 WINDOW_SetDefaultBkColor ............... 736 WINDOW_SetUserData ....................... 736 Windows ................................... 331400 clearing ............................................90 properties of ................................... 332 terms associated with ............... 332333 WM_Activate ..................................... 355 WM_AttachWindow ............................ 355 WM_AttachWindowAt ......................... 355 WM_BringToBottom ............................ 356 WM_BringToTop ................................. 356 WM_BroadcastMessage ...................... 356 WM_CF_ANCHOR_BOTTOM ................. 357 WM_CF_ANCHOR_LEFT ...................... 357 WM_CF_ANCHOR_RIGHT .................... 357 WM_CF_ANCHOR_TOP ........................ 357 WM_CF_BGND ................................... 357 WM_CF_CONST_OUTLINE ................... 357 WM_CF_FGND ................................... 358 WM_CF_HASTRANS ............................ 358 WM_CF_HIDE .................................... 358 WM_CF_LATE_CLIP ............................ 358 WM_CF_MEMDEV ............................... 358 WM_CF_MEMDEV_ON_REDRAW ........... 358 WM_CF_SHOW .................................. 358 WM_CF_STAYONTOP .......................... 358 WM_ClrHasTrans ................................ 356 WM_CREATE .............................. 341342 WM_CreateTimer ............................... 393 WM_CreateWindow ............................ 357 WM_CreateWindowAsChild .................. 358 WM_Deactivate ................................. 359 WM_DefaultProc ................................ 359 WM_DELETE .............................. 341342 WM_DeleteTimer ............................... 393 WM_DeleteWindow ............................ 360
UM03001 User & Reference Guide for emWin V5.20
WM_DetachWindow ............................360 WM_DisableMemdev ...........................392 WM_DisableWindow ...........................360 WM_EnableMemdev ...........................392 WM_EnableWindow ............................360 WM_Exec ..........................361, 403, 1030 WM_Exec1 ........................................361 WM_ForEachDesc ...............................361 WM_GET_ACCEPT_FOCUS ...................341 WM_GET_ID ...............................341342 WM_GetActiveWindow ........................363 WM_GetCallback ................................362 WM_GetClientRect ..............................363 WM_GetClientRectEx ..........................363 WM_GetClientWindow .........................395 WM_GetDesktopWindow .....................363 WM_GetDesktopWindowEx ..................364 WM_GetDialogItem ............................364 WM_GetFirstChild ...............................364 WM_GetFocussedWindow ....................365 WM_GetHasTrans ...............................365 WM_GetId .........................................395 WM_GetInsideRect .............................395 WM_GetInsideRectEx ..........................396 WM_GetInvalidRect ............................365 WM_GetNextSibling ............................365 WM_GetOrgX ....................................366 WM_GetOrgY .....................................366 WM_GetParent ...................................366 WM_GetPrevSibling ............................366 WM_GetScrollPosH .............................396 WM_GetScrollPosV .............................396 WM_GetScrollState ............................396 WM_GetStayOnTop .............................367 WM_GetTimerId .................................394 WM_GetUserData ...............................367 WM_GetWindowOrgX ..........................367 WM_GetWindowOrgY ..........................367 WM_GetWindowRect ...........................368 WM_GetWindowRectEx .......................368 WM_GetWindowSizeX .........................368 WM_GetWindowSizeY .........................368 WM_HasCaptured ..............................368 WM_HasFocus ...................................369 WM_HideWindow ...............................369 WM_INIT_DIALOG ........ 341342, 738, 740 WM_InvalidateArea ............................369 WM_InvalidateRect .............................370 WM_InvalidateWindow ........................370 WM_IsCompletelyCovered ...................370 WM_IsCompletelyVisible .....................371 WM_IsEnabled ...................................371 WM_IsVisible .....................................371 WM_IsWindow ...................................372 WM_KEY ....................................341342 WM_MakeModal .................................372 WM_MENU ........................................617 WM_MESSAGE ...................................340 WM_MOTION ............................. 341, 346 WM_MOTION_Enable ..........................385 WM_MOTION_SetDeceleration .............385 WM_MOTION_SetDefaultPeriod ............385 WM_MOTION_SetMotion .....................386 WM_MOTION_SetMoveable .................386 WM_MOTION_SetMovement ................386 WM_MOTION_SetSpeed ......................388 WM_MOUSEOVER ...................... 341, 346
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
1076
Index
WM_MOUSEOVER_END ............... 341, 346 WM_MOVE ................................ 341, 343 WM_MoveChildTo .............................. 372 WM_MoveTo ..................................... 372 WM_MoveWindow .............................. 373 WM_MULTIBUF_Enable ....................... 833 WM_NOTIFICATION_CHILD_DELETED .341
342, ...................................... 751 WM_NOTIFICATION_CLICKED 341, 413, 429,
.. 445, 459, 529, 543, 559, 578, 602, 635, . 647, 667, 678, 688, 697, 714, 745 WM_NOTIFICATION_LOST_FOCUS ....... 341 WM_NOTIFICATION_MOVED_OUT 341, 413, 429, . 445, 459, 529, 543, 559, 578, 602, ..........635, 647, 667, 697, 714 WM_NOTIFICATION_RELEASED ... 341, 413, 429, . 445, 459, 529, 543, 559, 578, 602, . 635, 647, 667, 678, 688, 697, 714, ...................................... 745 WM_NOTIFICATION_SCROLL_CHANGED 445, ..................543, 559, 578, 635, 745 WM_NOTIFICATION_SCROLLBAR_ADDED ... 341, ...................................... 678 WM_NOTIFICATION_SEL_CHANGED .... 342, 445, .. 543, 559, 578, 602, 745, 751 WM_NOTIFICATION_VALUE_CHANGED 341 342, . 429, 459, 635, 647, 667, 678, 688, ........................ 697, 714, 751 WM_NOTIFY_PARENT .... 341, 343, 404, 738 WM_NOTIFY_VIS_CHANGED ........ 341, 343 WM_NotifyParent ............................... 373 WM_PAINT ................................ 341, 344 WM_Paint ......................................... 373 WM_PaintWindowAndDescs ................. 373 WM_PID_STATE_CHANGED .......... 341, 347 WM_POST_PAINT ....................... 341, 344 WM_PRE_PAINT ......................... 341, 344 WM_ReleaseCapture .......................... 374 WM_ResizeWindow ............................ 374 WM_RestartTimer .............................. 394 WM_Screen2hWin ............................. 374 WM_Screen2hWinEx .......................... 374 WM_SelectWindow ............................ 375 WM_SendMessage ............................. 375 WM_SendMessageNoPara ................... 376 WM_SendToParent ............................. 376 WM_SET_FOCUS ........................ 341, 344 WM_SET_ID .............................. 341, 344 WM_SetCallback ............................... 376 WM_SetCapture ................................ 376 WM_SetCaptureMove ......................... 377 WM_SetCreateFlags ........................... 378 WM_SetDesktopColor ......................... 378 WM_SetDesktopColorEx ..................... 378 WM_SetFocus ................................... 379 WM_SetHasTrans .............................. 379 WM_SetId ........................................ 379 WM_SetpfPollPID ............................... 380 WM_SetScrollPosH ............................. 397 WM_SetScrollPosV ............................. 397 WM_SetScrollState ............................ 397 WM_SetSize ..................................... 380 WM_SetStayOnTop ............................ 381 WM_SetTransState ............................ 381 WM_SetUserClipRect .......................... 382 WM_SetUserData .............................. 382
UM03001 User & Reference Guide for emWin V5.20
WM_SetWindowPos ............................ 380 WM_SetXSize .................................... 380 WM_SetYSize .................................... 381 WM_ShowWindow ............................. 383 WM_SIZE .................................. 341, 345 WM_SUPPORT_NOTIFY_VIS_CHANGED . 351 WM_SUPPORT_TRANSPARENCY ........... 351 WM_TIMER ................................ 341, 345 WM_TOOLTIP_AddTool ........................ 389 WM_TOOLTIP_Create ......................... 389 WM_TOOLTIP_Delete ......................... 389 WM_TOOLTIP_SetDefaultColor ............. 390 WM_TOOLTIP_SetDefaultFont .............. 390 WM_TOOLTIP_SetDefaultPeriod ........... 391 WM_TOUCH ............................... 341, 347 WM_TOUCH_CHILD ..................... 341, 348 WM_Update ...................................... 383 WM_UpdateWindowAndDescs .............. 383 WM_USER ................................. 342, 350 WM_ValidateRect ............................... 384 WM_ValidateWindow .......................... 384
X
X-axis ................................................ 32 XOR drawing mode ............................ 107 XOR text ............................................ 85
Y
Y-axis ................................................ 32
Z
Z-position ......................................... 333
© 1997 - 2013 SEGGER Microcontroller GmbH & Co. KG
Acrobat Distiller 7.0 (Windows)