2
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 (SEG-
GER) 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.
© 2020 SEGGER Microcontroller GmbH, Monheim am Rhein / 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
Ecolab-Allee 5
D-40789 Monheim am Rhein
Germany
Tel. +49 2173-99312-0
Fax. +49 2173-99312-28
E-mail:
support@segger.com
*
Internet: www.segger.com
*
By sending us an email your (personal) data will automatically be processed. For further information please refer to our
privacy policy which is available at https://www.segger.com/legal/privacy-policy/.
emWin User Guide & Reference Manual © 2020 SEGGER Microcontroller GmbH
3
Manual versions
This manual describes the current software version. If you find an error in the manual or a
problem in the software, please inform us and we will try to assist you as soon as possible.
Contact us for further information on topics or functions that are not yet documented.
Print date: June 2, 2020
Software Revision Date By Description
6.14 0 200602 FO
Structure of chapters reworked.
Chapter ’Introduction to emWin’ updated.
• Added “Complete emWin system” diagram.
• Example section enhanced.
• Added information about AppWizard.
Chapter ’Getting Started’ updated.
• Prep.bat, CC.bat and Lib.bat examples updated to GCC/Cortex-M4.
Chapter ’Simulation’ updated.
• Hardkey bitmap examples updated.
Chapter ’Fonts’ updated.
• New function GUI_GetTrailingBlankRows() added.
• New function GUI_GetLeadingBlankRows() added.
Chapter ’The Window Manager (WM)’ updated.
• WM_GetUserData() now returns 0 if the given handle is NULL.
Chapter ’Widgets’ updated.
• New KEYBOARD widget added.
• New function KEYBOARD_CreateUser() added.
• New function KEYBOARD_CreateIndirect() added.
• New function KEYBOARD_ExportLayout() added.
• New function KEYBOARD_ExportPatternFile() added.
• New function KEYBOARD_SetLayout() added.
• New function KEYBOARD_SetStreamedLayout() added.
• New function KEYBOARD_SetColor() added.
• New function KEYBOARD_SetFont() added.
• New function KEYBOARD_SetPeriod() added.
• New function EDIT_EnableAutoScroll() added.
6.12 1 200417 FO
Chapter ’Displaying bitmap files’ updated.
• Added member Progressive to struct GUI_JPEG_INFO to tell whether
or not the JPEG image is progressive.
Chapter ’Antialiasing’ updated.
• New function GUI_AA_FillEllipseXL() added.
6.12 0 200408 FO
Chapter ’2-D Graphic Library’ updated.
• New function GUI_QR_CreateFramed() added.
Chapter ’Widgets (Window objects)’ updated.
• New GAUGE widget added.
• New function GAUGE_CreateIndirect() added.
• New function GAUGE_CreateUser() added.
• New function GAUGE_GetValue() added.
• New function GAUGE_SetAlign() added.
• New function GAUGE_SetBkColor() added.
• New function GAUGE_SetColor() added.
• New function GAUGE_SetOffset() added.
• New function GAUGE_SetRadius() added.
• New function GAUGE_SetRange() added.
• New function GAUGE_SetRoundedEnd() added.
• New function GAUGE_SetRoundedValue() added.
• New function GAUGE_SetValue() added.
• New function GAUGE_SetValueRange() added.
• New function GAUGE_SetWidth() added.
• New QRCODE widget added.
• New function QRCODE_CreateIndirect() added.
• New function QRCODE_CreateUser() added.
• New function QRCODE_SetEccLevel() added.
• New function QRCODE_SetNumModules() added.
• New function QRCODE_SetPixelSize() added.
• New function QRCODE_SetText() added.
• New function QRCODE_SetWiFiText() added.
6.10 4 200318 FO
Chapter ’AppWizard’ updated.
• New function APPW_GetFont() added.
Chapter ’Widgets’ updated.
• New function RADIO_GetImage() added.
• New function LISTVIEW_GetLBorder() added.
• New function LISTVIEW_GetRBorder() added.
emWin User Guide & Reference Manual © 2020 SEGGER Microcontroller GmbH
4
Software Revision Date By Description
• New function LISTVIEW_GetTextAlign() added.
• New function LISTVIEW_RowIsDisabled() added.
• New function IMAGE_SetTiled() added.
• New function IMAGE_GetImageSize() added.
• New function GRAPH_SetGridOffY() added.
• New function CHECKBOX_GetDefaultAlign() added.
• New function CHECKBOX_SetDefaultAlign() added.
• New function CALENDAR_ShowDate() added.
• New function CALENDAR_GetWeekday() added.
Chapter ’Language Support’ updated.
• Updated section ’Thai language support’.
• New function GUI_UC_EnableThai() added.
6.10 3 200313 FO
Chapter ’Displaying Text’ updated.
• Added parameter to GUI_GetCharFromPos() to save character index.
Chapter ’Fonts’ updated.
• New function GUI_GetStringDistXEx() added.
Chapter ’Movies’ updated.
• New function GUI_MOVIE_GetInfoH() added.
• New function GUI_MOVIE_GetNumFrames() added.
Fixed a bug with GUI_DrawBitmapEx() where transparency wasn’t drawn
correctly.
Chapter ’Widgets’ updated.
• Added the functionality of HOME and END keys to EDIT widget.
• Added automatic horizontal text scrolling to EDIT widget.
• New function TEXT_GetRotation() added.
• New function TEXT_SetRotation() added.
• New function TEXT_SetDefaultRotation() added.
• New function TEXT_GetDefaultRotation() added.
• New function TEXT_GetTextOffset() added.
• New function TEXT_SetTextOffset() added.
6.10 2 200218 FO
Chapter ’Simulation’ updated.
• Screenshots updated.
• SIM_GUI_SetCompositeSize() and SIM_GUI_ShowDevice() enhanced.
• Added ’Data structures’ section to Device simulation API.
• Added ’Defines’ section to Device simulation API.
Chapter ’Viewer’ updated.
• Screenshots updated.
Chapter ’AppWizard’ updated.
• Screenshots updated.
Chapter ’emWinSPY’ updated.
• Screenshots updated.
Chapter ’Displaying text’ updated.
• Added ’Defines’ section to Text API.
• Added ’Enumerations’ section to Text API.
Chapter ’2-D Graphic Library’ updated.
• New function GUI_DrawRoundedRectEx() added.
• New function GUI_DrawRoundedFrameEx() added.
• Added ’Data structures’ section to Graphic API.
• Added ’Defines’ section to Graphic API.
Chapter ’Displaying bitmap files’ updated.
• Added ’Data structures’ section to JPEG API.
• Added ’Data structures’ section to GIF API.
Chapter ’Bitmap Converter’ updated.
• Screenshots updated.
Chapter ’Language Support’ updated.
• References to BiDi removed even if emWin is compiled with GUI_SUP-
PORT_BIDI. Calling of GUI_UC_EnableBIDI() now is mandatory.
Chapter ’Fonts’ updated.
• Added ’Data structures’ section to Font API.
• Added ’Defines’ section to Font API.
Chapter ’Font Converter’ updated.
• Screenshots updated.
Chapter ’Movies’ updated.
• Screenshot updated.
• Added ’Data structures’ section to Movie API.
• Added ’Defines’ section to Movie API.
Chapter ’Animations’ updated.
• Added section ’Using a delete callback function’.
• Added ’Data structures’ section to Animation API.
• Added ’Defines’ section to Animation API.
Chapter ’Colors’ updated.
• Screenshot updated.
emWin User Guide & Reference Manual © 2020 SEGGER Microcontroller GmbH
5
Software Revision Date By Description
Chapter ’Memory Devices’
• Added ’Defines’ section to Memory Device API.
Chapter ’The Window Manager (WM)’ updated.
• Added ’Data structures’ section to WM API.
• Added ’Defines’ section to WM API.
Chapter ’Widgets (window objects)’ updated.
• Added ’Defines’ section to BUTTON API.
• Added ’Defines’ section to CHECKBOX API.
• Added ’Defines’ section to DROPDOWN API.
• Added ’Defines’ section to EDIT API.
• Added ’Defines’ section to FRAMEWIN API.
• Added ’Defines’ section to GRAPH API.
• New function GRAPH_DATA_XY_Clear() added.
• New function GRAPH_DATA_XY_GetLineVis() added.
• New function GRAPH_DATA_XY_GetPointVis() added.
• New function GRAPH_DATA_XY_SetLineVis() added.
• New function GRAPH_DATA_XY_SetPointVis() added.
• New function HEADER_DeleteItem() added.
• New function HEADER_GetSel() added.
• New function HEADER_SetFixed() added.
• New function HEADER_SetScrollPos() added.
• Added ’Defines’ section to ICONVIEW API.
• Added ’Defines’ section to IMAGE API.
• Added ’Defines’ section to LISTBOX API.
• Added ’Defines’ section to LISTVIEW API.
• Added ’Defines’ section to LISTWHEEL API.
• Added ’Data structures’ section to MENU API.
• Added ’Defines’ section to MENU API.
• Added ’Defines’ section to MULTIEDIT API.
• Added ’Defines’ section to MULTIPAGE API.
• Added ’Defines’ section to RADIO API.
• New function RADIO_GetNumItems() added.
• New function RADIO_GetSpacing() added.
• New function RADIO_SetSpacing() added.
• Added ’Defines’ section to SCROLLBAR API.
• Added ’Defines’ section to SLIDER API.
• Added ’Defines’ section to SPINBOX API.
• Added ’Defines’ section to SWIPELIST API.
• Added ’Defines’ section to SWITCH API.
Chapter ’Dialogs’ updated.
• Added ’Data structures’ section to CALENDAR API.
• Added ’Defines’ section to CALENDAR API.
• Added ’Defines’ section to CHOOSECOLOR API.
• Added ’Data structures’ section to CHOOSEFILE API.
• Added ’Defines’ section to CHOOSEFILE API.
Chapter ’MultiLayer / MultiDisplay support’ updated.
• Added ’Data structures’ section to MultiLayer API.
Chapter ’MultiTouch support (MT)’ updated.
• Added ’Data structures’ section to Basic buffer access API.
• Added ’Defines’ section to Basic buffer access API.
Chapter ’Cursors’ updated.
• Added ’Data structures’ section to Cursor API.
Chapter ’VNC Server’ updated.
• Added ’Data structures’ section to VNC Server API.
Chapter ’Indexes’ updated.
• Added ’Types’ index for data structures.
6.10 1 200203 JE
Chapter ’Display Drivers’
• GUIDRV_SPage supports Sitronix ST7571, GUIDRV_SPage_Set1510()
6.10 0 200106 FO
New chapter ’AppWizard’
• New function APPW_SetVarData() added.
• New function APPW_GetVarData() added.
Chapter ’Displaying Text’
• New function GUI_GetCharFromPos() added.
Chapter ’2-D Graphic Library’
• New function GUI_BARCODE_Draw() added.
• New function GUI_BARCODE_GetXSize() added.
• New function GUI_DrawGradientVEx() added.
• New function GUI_DrawGradientHEx() added.
• New function GUI_DrawGradientMVEx() added.
• New function GUI_DrawGradientMHEx() added.
• New function GUI_DrawGradientRoundedVEx() added.
• New function GUI_DrawGradientRoundedHEx() added.
emWin User Guide & Reference Manual © 2020 SEGGER Microcontroller GmbH
