Redspark: Initial Page

2025-03-31T15:38:46Z

Initial Page

New page

This module provides classes and utilities for making GUI (Graphical User Interface) apps, like the desktop demo.

== Classes ==
{| class="wikitable"
|-
! Name !! Description
|-
| [[gui.Image9Slice|Image9Slice]] || An image wrapper with margins that are not stretched, and a middle that is stretched when drawn to any size.
|-
| [[gui.Scrollbar|Scrollbar]] || Base class for other scrollbar classes.
|-
| [[gui.ScrollbarH| ScrollbarH]] || Horizontal Scrollbar
|-
| [[gui.ScrollbarV|ScrollbarV]] || Vertical Scrollbar
|-
| [[gui.Window|Window]] || Window class inherits from the [[events.EventSprite]] class
|-
| [[gui.Menubar|Menubar]] || Represents a group of Menus drawn horizontally as a single unit.
|-
| [[gui.Menu|Menu]] || Represents a group of MenuItems as a menu or submenu.
|-
| [[gui.MenuItem|MenuItem]] || Represents a single item within a menu.
|-
| [[gui.InputField|InputField]] || Numeric input field.
|}

== Functions ==
{| class="wikitable"
|-
! Name !! Description
|-
| [[gui.clearScratch|clearScratch(width=256, height=256, color="#FFFFFF")]] || Clear our off-screen "scratch" display, used for drawing or compositing things to create an image or sprite).
|-
| [[gui.drawMenuItem|drawMenuItem(g, menuText, left, bottom, width=100, highlighted=false, disabled=false)]] || Draw a single menu item.
|-
| [[gui.drawMenuItem|drawMenuItem(g, menuText, left, bottom, width=100, highlighted=false, disabled=false)]] || A helper function for drawMenuItem.
|-
| [[gui.calcMenuItemWidth|calcMenuItemWidth(menuText)]] || Calculates the menu item text width in pixels plus padding.
|-
| [[gui.calcMenuItemWidth| drawMenuBottom(g, left, menuBottom, width=100)]] || Draws the bottom of the menu. Note that the third parameter is the bottom of the bottommost menu item; we actually draw below that (border and shadow).
|-
| [[gui.setupDisplays|setupDisplays]] || Setups up the display layers.
|}

== Properties ==
{| class="wikitable"
|-
! Name !! Description
|-
| gfxSource || An image template used to draw certain GUI controls. See /sys/data/desktop/desktopGfx.png for an example.
|-
| smallFont || A bmfFont. If /usr/fonts/minimicro-pro-12.bmf does not exist, then /sys/fonts/minimicro-pro-12.bmf is used.
|-
| medFont || A bmfFont. If /usr/fonts/minimicro-pro-16.bmf does not exist, then /sys/fonts/minimicro-pro-16.bmf is used.
|-
| largeFont || A bmfFont. If /usr/fonts/minimicro-pro-20.bmf does not exist, then /sys/fonts/minimicro-pro-20.bmf is used.
|-
| images || A map of various control images pulled from the gfxSource image.
|}

== Constants ==

=== Window.dragMode ===
{| class="wikitable"
|-
! Name !! Description
|-
| kDragMove || Moving the window
|-
| kDragResize || Stretching the window
|-
| kDragSelect || Selecting stuff within the window
|}

=== Window.partHit ===
{| class="wikitable"
|-
! Name !! Description
|-
| kPartTitle || Title bar
|-
| kPartFrame || Frame
|-
| kPartResize || Resize grip box
|-
| kPartContent || Content area
|}

=== Drawing ===
{| class="wikitable"
|-
! Name !! Description
|-
| kScrollbarSize || Default thickness for any scrollbar
|-
| kMenuBarHeight || Height of the menu bar at top of screen
|-
| kMenuItemHeight || Height of one item in a menu
|}

=== Misc. ===
{| class="wikitable"
|-
! Name !! Description
|-
| selectionColor || Color string
|-
| scrollWheelSpeed || Distance to scroll when mouse wheel is turned
|}

[[Category:Mini Micro]]
[[Category:Sys Modules]]

GUI - Revision history

Redspark: Initial Page