RTT-GUI

This project is forked from RT-Thread Package -- GUI Engine (an open source embedded GUI framework) and heavily refactored.

Beside programmatically UI design, a JSON like, text based UI configuration is also available. Following is an example.

APP: {
  PARAM: {
    // name, handler
    "FileBrowser", NULL,
  },

  MWIN: {
    PARAM: {
      // title, handler
      "FileBrowser", NULL,
    },

    FILELIST: {
      PARAM: {
        // size, handler, dir
        DEFAULT, on_file, "/",
      },
    },
  },

  WIN: {
    PARAM: {
      // title, size, handler, on_close handler
      "FileWin", DEFAULT, NULL, on_close,
    },
    ID: 0,

    BOX: {
      PARAM: {
        // orient, border size
        // orient: 1, HORIZONTAL; 2, VERTICAL
        1, 0,
      },
      ID: 1,
    },

    PICTURE: {
      PARAM: {
        // size, handler, path, align, auto-resize
        // align: 0x00, LEFT / TOP; 0x01, CENTER_HORIZONTAL; 0x02, RIGHT; 0x08, CENTER_VERTICAL; 0x04, BOTTOM
        // resize: 0, False; 1, True
        NULL, NULL, NULL, 0x01, 1,
      },
      // RTGUI_ALIGN_STRETCH | RTGUI_ALIGN_EXPAND
      ALIGN: 0x30,
      ID: 2,
    },
  },
}

Examples

• PicShow

  • Picture slideshow program
  • Read *.jpg and *.bmp files from SD card location /pic
  • The interval is 5 seconds
  • Widgets used: window, box (sizer), picture, label, progress (bar) and button

• PicShowDesign

  • Similar to "PicShow" but using text based design
  • The design is read from a file at SD card location /design/PicShow.gui
  • Please copy the design file to SD card before run the example

• FileBrowser

  • File brower program
  • Show the content of SD card
  • Preview is available for *.jpg and *.bmp files
  • Widgets used: window, box (sizer), filelist and picture

• FileBrowserDesign

  • Similar to "FileBrowser" but using text based design
  • The design is stored in a constant variable

Dependence

• RT-Thread Library

  • Enable GUI, "CONFIG_USING_GUI" in "rtconfig.h"
  • Enable LCD driver, e.g. "CONFIG_USING_ILI" in "rtconfig.h"
  • Enable touch screen driver, e.g. "CONFIG_USING_FT6206" in "rtconfig.h"
  • Enable SD driver, "CONFIG_USING_SPISD" in "rtconfig.h"

• ChaN's TJpgDec

  • This is a tiny JPEG decoder developed by ChaN
  • To enable, set "CONFIG_USING_IMAGE_JPEG" in "guiconfig.h"

• Lode Vandevenne's LodePNG

  • PNG decoder developed by Lode Vandevenne
  • To enable, set "CONFIG_USING_IMAGE_PNG" in "guiconfig.h"
  • Encoder is disabled
  • No dependency or linkage to zlib or libpng required
  • Made for C (ISO C90) and has C++ wrapper

Available Widgets

Widget	Super Class	Remark
Widget	Object	The base class
Container	Widget	A container (as parent) contains other widgets (as children)
Box (Sizer)	Object	Attached to container to define the layout of its children
Window	Container
Title (Bar)	Widget	The title bar of window widget
Label	Widget
Button	Label
Progress (Bar)	Widget
List	Widget
File List	List
Picture	Widget	A widget to show image

Available Image Formats

Format	Dependence	Remark
XPM		RTT-GUI internal image format
BMP		Support format: 1bpp (bit per pixel), 2bpp (not tested yet), 4bpp, 8bpp, 16bpp (RGB565) and 24bpp (RGB888) Support scale ratio: 0 (no change) to 1/1024
JPEG	ChaN's TJpgDec	Support scale ratio: 0 (no change), 1/2, 1/4 and 1/8
PNG	Lode Vandevenne's LodePNG

Available Fonts

Format	Remark
ASCII12
ASCII16
HZ12	Simplified Chinese
HZ16	Simplified Chinese

The HZ12 and HZ16 are too huge to load to memory, so please load them from SD card instead by: Enable "CONFIG_USING_FONT_FILE" in "guiconfig.h" and copy hz12.fnt and hz16.fnt to SD \font directory.

May do the same for ASCII12 and ASCII16 to save memory.

License

Component	License
RTT-GUI	GNU Lesser General Public License v2.1
RT-Thread core	Apache License 2.0
TJpgDec	BSD like License
LodePNG	zlib License