| CRM64Pro GDK v0.17.0 A free cross-platform game development kit built on top of SDL 3.0

Loading...
Searching...
No Matches
GUI
GUI modules

## Description

GUI Manager for panels, consoles and debug windows [v26.05.0].

### Overview

The GUI module provides the engine-managed runtime GUI layer through the GUI Manager. It handles three object families: Panels (widget containers), Consoles (interactive command-line overlays) and Debug Windows (runtime variable monitors). Panels can optionally arrange their child widgets using horizontal or vertical flow layout while preserving their behavioral type (modeless, modal or ephemeral). GUI objects are attached to screens, support multi-screen configurations, and can be saved and loaded through the CDC GUI format. Widget lifecycle is split into visibility (show() / hide()) and interactivity (enable() / disable()), so controls can remain visible while disabled.
See Widget module for skin properties, feature flags, callbacks, state machine and update protocol.

### Key features

- Panel system: Widget containers with modeless, modal and ephemeral (TTL) behavior
- Panel flow layouts: Optional horizontal and vertical flow layout with configurable spacing, padding, justify and alignment
- Console: In-game command-line interface with history, built-in commands and TAB auto-complete
- Debug window: Runtime watch windows for Sint32 and float variables with configurable refresh interval
- Widget set: Label, Image, Frame, Button, CheckBox, Progress, Slider, TextEdit, NumberEdit, List, ComboBox
- Theming: Built-in Default, Dark and Flat themes; custom themes created at runtime via createTheme()
- Tooltips: Delayed hover tooltips with fade-in, per-widget TTL, cursor-follow and themed visuals
- Multi-screen routing: GUI objects attach to specific screens; events are filtered by windowID
- Separated widget lifecycle: Visibility and enabled state are managed independently
- Inspection and persistence: Enumerate widgets, inspect metadata, save and load GUI state through CDC

### GUI object types

Panel | Container for widgets. Supports modeless, modal and time-to-live (TTL) ephemeral behavior. Panels are ref-counted: loading a panel whose name already exists returns the existing panel and increments its reference count. Optional flow layout for automatic child arrangement.
Console | Command-line interface with prompt, UTF-8 cursor navigation, command history, TAB auto-complete and custom command registration. Captures SDL text input focus while allowing other GUI interactions. Read-only mode available.
DebugWindow | Variable watch window for monitoring Sint32* and float* pointers in real-time. Configurable refresh interval. add/removeWatch fail gracefully when the window is disabled.

### Render order

Render pass order, from bottom to top:

1. Panels | Rendered back-to-front by focus vector (vPanelID). Open ComboBox popups are rendered in a second panel pass above normal panel widgets.
2. Tooltip | Manager-owned overlay drawn above panels but below DebugWindows and Consoles. Uses the active theme shared tooltip style, optionally overridden per widget.
3. DebugWindows | Rendered on top of panels and tooltips. Drag-drop capable.
4. Consoles | Always on top of panels, tooltips and debug windows.

### Update priority

Input/update priority is processed from topmost interactive overlays down to panels:

1. DebugWindows | Checked first so overlay activity can block drag/drop and lower GUI layers.
2. Consoles | Checked before panels so text input focus and overlay activity can prevent panel interaction underneath.
3. Panels | Front panel receives events first. Modal panels can block lower panels.
4. Tooltip State | Resolved after object updates so tooltip ownership uses the final hover/focus state for the frame.

### Panel flow layout

Panels can automatically arrange their child widgets using a one-dimensional flow layout. The layout is selected via setLayout() and configured with setLayoutSpacing(), setLayoutPadding(), setLayoutJustify() and setLayoutAlign(). The layout re-runs (reflow()) whenever the internal dirty flag is raised: on widget creation, widget removal, widget resize, widget show/hide, panel show, and explicit invalidateLayout() calls. Widget positions under a flow layout are set by calling Widget::setPosition() with absolute pixel coordinates computed by the reflow pass.

PL_NONE | No layout. Widgets are positioned manually. Default.
PL_HFLOW | Horizontal flow. Widgets are placed left-to-right. Main axis is X, cross axis is Y.
PL_VFLOW | Vertical flow. Widgets are placed top-to-bottom. Main axis is Y, cross axis is X.

Layout justify options (eLayoutJustify) - main axis distribution

LJ_START | Widgets packed to the start of the main axis (after padding). Default.
LJ_CENTER | Widgets centered along the main axis. If total widget size exceeds the inner dimension the cursor may go negative; widgets are silently clamped by WF_ENCLOSE.
LJ_END | Widgets packed to the end of the main axis. Same overflow clamp caveat as LJ_CENTER.
LJ_SPACE | Spacing is distributed evenly between widgets. With a single visible widget, spacing is the configured iLayoutSpacing value.

Layout align options (eLayoutAlign) - cross axis positioning

LA_START | Widgets aligned to the start of the cross axis (after cross padding).
LA_CENTER | Widgets centered along the cross axis. Default.
LA_END | Widgets aligned to the end of the cross axis.
LA_STRETCH | Widget cross-axis size is expanded to fill the available inner cross dimension. setSize() is called on each widget during reflow.

Note
  Showing or hiding a widget automatically invalidates the parent panel layout. Use Panel::invalidateLayout() only for caller-controlled edge cases where no widget creation, removal, resize or visibility change occurs.

### Console features

Command registration | addCmdHandler() registers user commands with a name, help text and callback. The command name must be unique and cannot be "help".
Built-in commands | 'help', 'con', 'dw' and 'cur' are always available. Parameters for auto-complete are registered internally via setCmdParams().
Command history | Up/Down arrow keys recall and cycle previously executed commands.
TAB auto-complete | Single match: completes immediately. Multiple matches: prints list and expands to the common prefix. Repeated TAB cycles through matches.
Input focus | Captures SDL_EVENT_TEXT_INPUT, blocking it from reaching panels below. Read-only mode disables text input and command execution while keeping the console visible.
Clipboard | Ctrl+C copies the current prompt line. Ctrl+V pastes at the current cursor position.

### DebugWindow features

Variable watch | addWatch() accepts a display name, an optional Sint32* and an optional float*. At least one pointer must be non-null. Watch names must be unique.
Refresh interval | setRefreshInterval() configures the update period in milliseconds. Default is 500 ms. The timer is driven by an explicit init flag (bRefreshTimerInit) rather than a zero-sentinel to avoid edge cases at startup.
Named watches | Each watch has a display name shown before its values. Format: "name integer float" or "name integer" or "name float" depending on which pointers are set.
Disabled guard | addWatch() and removeWatch() return -1 immediately when the DebugWindow base widget is in GS_DISABLED state.

### Manager types

Panel | Shared-name management: loading a CDC block whose panel name already exists returns the existing panel and increments its reference count. close() decrements the count and destroys the panel only when it reaches zero.
Console | Standard manager: names must be unique. The first console created (GUICONSOLE_SIGNATURE) is the default console and cannot be closed or disabled.
DebugWindow | Standard manager: names must be unique.

### Tooltip behavior

Tooltips are driven by widget text assigned through Widget::setTooltip(). The GUI manager shows them after GUI_TOOLTIP_DELAY_MS (1000 ms) of stable hover, with a fade-in over GUI_TOOLTIP_FADEIN_MS (500 ms). Tooltip visuals use the active theme's shared tooltip style, unless the hovered widget overrides tooltip background, border or font locally. The tooltip is positioned near the cursor with GUI_TOOLTIP_OFFSET_X / GUI_TOOLTIP_OFFSET_Y and clamped to the screen bounds. Per-widget TTL is read from Widget::getTooltipTTL(); the widget default is WIDGET_TOOLTIP_DEFAULT_TTL_MS = 0, meaning the tooltip stays visible while the hover is valid. GUI_TOOLTIP_TTL_MS is only the manager's bootstrap/fallback value used before a concrete widget owner is latched. After a tooltip expires, it will not show again for the same widget until the pointer leaves and re-hovers. Tooltip display is dismissed early by keyboard input, text input events, mouse button press or mouse wheel while a tooltip is visible. Mouse button release is intentionally ignored because the press already represents the user intent to dismiss.

### Themes

GUI themes define procedural widget styling per widget type and widget state. Built-in themes are available immediately through GUIMgr::getThemeDefault(), GUIMgr::getThemeDark() and GUIMgr::getThemeFlat(). Theme resolution order for any skin property: widget override, then panel theme override, then global theme, then built-in Default theme. A typical workflow is:

GUIMgr& gui = Main::Instance().IGUIMgr();
gui.setGlobalTheme(gui.getThemeDark());
CRM64Pro::GUIMgr::setGlobalTheme
Sint32 setGlobalTheme(Sint32 idTheme)
Set the active global theme.
Definition GUI.cpp:1682
CRM64Pro::Main::IGUIMgr
GUIMgr & IGUIMgr()
Get reference to GUI Manager.
Definition CoreMain.cpp:976
CRM64Pro::Main::Instance
static Main & Instance()
Access the Main singleton.
Definition CoreMain.cpp:429

To customize a theme:

Sint32 idTheme = gui.createTheme("MyTheme");
GUITheme* pTheme = gui.getTheme(idTheme);
if(pTheme)
{
pTheme->setSkinBackgroundColor(WT_BUTTON, WS_NORMAL, 32, 96, 160);
pTheme->setSkinFontName(WT_BUTTON, WS_NORMAL, "@c64/font/Arial12White");
}
CRM64Pro::WS_NORMAL
@ WS_NORMAL
Normal widget state.
Definition CRM64Pro.h:5330
CRM64Pro::WT_BUTTON
@ WT_BUTTON
Standard button widget.
Definition CRM64Pro.h:5344

Custom themes created via createTheme() are pre-filled from the Default theme. Theme entries are inspected through GUITheme::getSkin() and modified through the explicit GUITheme::setSkin...() methods. Built-in fonts should use the full "@c64/font/..." name in GUIThemeSkin::sFontName to avoid name collisions with user-loaded fonts. Theme font resolution first checks FontMgr::getBuiltin(), then FontMgr::get() by name.

### Best practices

- Use GUI objects from the main thread only; there is no internal synchronization
- Set a global theme through GUIMgr::setGlobalTheme(), then override individual panels or widgets only when needed. This minimizes per-widget skin data in CDC files
- Widget show()/hide(), creation, removal and resize automatically invalidate parent flow layouts; use Panel::invalidateLayout() only for caller-controlled edge cases
- Use widget tooltips for hover help text and panel TTL (ephemeral panels) for temporary HUD notifications
- Register custom console commands during initialization for in-game debugging; use addCmdHandler() with setCmdParams() to enable TAB auto-complete for your command parameters
- Use DebugWindow during development to monitor critical game variables; remove or hide it in release builds
- Attach GUI objects to the correct screen in multi-screen configurations; events are filtered by windowID and objects on a hidden screen receive the crafted focus-lost event
- Access the manager exclusively through Main::IGUIMgr()

Note
  The GUI Manager is a singleton, automatically created once Main is instantiated. You can get a reference to it using Main::IGUIMgr().
  The GUI Manager is automatically released when Main::Terminate() is called. Any resource still loaded at that point is released, avoiding leaks.

## Classes
class | CRM64Pro::Panel
| Panel Object class. More...
class | CRM64Pro::Console
| Console Object class. More...
class | CRM64Pro::DebugWindow
| DebugWindow Object class. More...
class | CRM64Pro::GUIMgr
| GUI Manager class. More...

## Macros
#define | GUI_PANEL 0x42000000
#define | GUI_CONSOLE 0x44000000
#define | GUI_DEBUGWINDOW 0x48000000

## Enumerations
enum | CRM64Pro::ePanelType { CRM64Pro::PT_RETRIEVE = -1 , CRM64Pro::PT_MODELESS = 0 , CRM64Pro::PT_MODAL = 1 , CRM64Pro::PT_EPHEMERAL = 2 }
| Panel Type. More...
enum | CRM64Pro::ePanelSizeMode { CRM64Pro::PSM_MANUAL = 0 , CRM64Pro::PSM_SCREEN = 1 }
| Panel size mode. More...
enum | CRM64Pro::ePanelLayout : Uint32 { CRM64Pro::PL_NONE = 0 , CRM64Pro::PL_HFLOW = 1 , CRM64Pro::PL_VFLOW = 2 }
| Panel layout flags. More...
enum | CRM64Pro::eLayoutJustify
| Flow layout distribution along the main axis.
enum | CRM64Pro::eLayoutAlign
| Flow layout alignment on the cross axis.

## Functions
bool | CRM64Pro::GUIMgr::info (Sint32 iMode=0) override
| Request GUI Manager information.
Sint32 | CRM64Pro::GUIMgr::create (const string &sName, Uint32 iType=GUI_PANEL) override
| Creates a new GUI object.
bool | CRM64Pro::GUIMgr::close (Sint32 idGUI) override
| Close and destroy a GUI object.
Sint32 | CRM64Pro::GUIMgr::getCount () const override
| Get number of loaded objects.
Sint32 | CRM64Pro::GUIMgr::setName (Sint32 idGUI, const string &sName) override
| Change the object name.
Panel * | CRM64Pro::GUIMgr::getPanel (Sint32 idGUI=0)
| Get a pointer to a Panel using its handler.
Sint32 | CRM64Pro::GUIMgr::getPanelFocus () const
| Get the GUI Panel id with the focus.
Sint32 | CRM64Pro::GUIMgr::setPanelFocus (Sint32 idGUI)
| Set the focus on the given GUI Panel id.
Console * | CRM64Pro::GUIMgr::getConsole (Sint32 idGUI=GUI_CONSOLE)
| Get a pointer to a Console using its handler.
DebugWindow * | CRM64Pro::GUIMgr::getDebugWindow (Sint32 idGUI=0)
| Get a pointer to a DebugWindow using its handler.
Sint32 | CRM64Pro::GUIMgr::load (const string &sCDCFile, const string &sName)
| Load a panel and its widgets stored in a CDC file.
Sint32 | CRM64Pro::GUIMgr::load (const Sint32 idCDC, const string &sName)
| Load a panel and its widgets stored in a CDC file.
Sint32 | CRM64Pro::GUIMgr::remove (Sint32 idCDC, const string &sName)
| Remove a panel and its widgets stored in a CDC file.
Sint32 | CRM64Pro::GUIMgr::getIconInfo () const
| Get the built-in info icon.
Sint32 | CRM64Pro::GUIMgr::getIconWarning () const
| Get the built-in warning icon.
Sint32 | CRM64Pro::GUIMgr::getIconQuestion () const
| Get the built-in question icon.
Sint32 | CRM64Pro::GUIMgr::getIconError () const
| Get the built-in error icon.
Sint32 | CRM64Pro::GUIMgr::createTheme (const string &sName)
| Create a new custom theme initialized from the built-in Default theme.
GUITheme * | CRM64Pro::GUIMgr::getTheme (Sint32 idTheme)
| Get a theme by id.
Sint32 | CRM64Pro::GUIMgr::setGlobalTheme (Sint32 idTheme)
| Set the active global theme.
Sint32 | CRM64Pro::GUIMgr::getGlobalTheme () const
| Get the active global theme id.
bool | CRM64Pro::GUIMgr::closeTheme (Sint32 idTheme)
| Close and destroy a custom theme.
Sint32 | CRM64Pro::GUIMgr::getThemeDefault () const
| Get the built-in Default theme id.
Sint32 | CRM64Pro::GUIMgr::getThemeDark () const
| Get the built-in Dark theme id.
Sint32 | CRM64Pro::GUIMgr::getThemeFlat () const
| Get the built-in Flat theme id.
bool | CRM64Pro::Console::info (Sint32 iMode=0) override
| Request Console information.
const string & | CRM64Pro::Console::getName () const override
| Get the name.
Uint32 | CRM64Pro::Console::getID () const override
| Get the ID.
Widget & | CRM64Pro::Console::baseWidget ()
| Get the reference to base Widget for this object.
Sint32 | CRM64Pro::Console::attachTo (Sint32 idScreen)
| Attach this console to a screen.
Sint32 | CRM64Pro::Console::getScreen () const
| Return the screen id where this console is attached to.
Sint32 | CRM64Pro::Console::print (const char *format,...)
| Print a formatted message to the console.
Sint32 | CRM64Pro::Console::vPrint (const char *format, va_list args)
| Print a formatted message to the console.
Sint32 | CRM64Pro::Console::addCmdHandler (const string &sCommandName, const string &sCommandHelp, Sint32(*cmdFunc)(vector< string > *, Console *pCon))
| Add a new command handler to the console.
Sint32 | CRM64Pro::Console::executeCmd (const string &sCmd)
| Execute a command on this console.
Sint32 | CRM64Pro::Console::setReadOnly (bool bEnable=true)
| Enable or disable read-only mode for the console prompt.
bool | CRM64Pro::Console::isReadOnly () const
| Check whether the console prompt is in read-only mode.
bool | CRM64Pro::DebugWindow::info (Sint32 iMode=0) override
| Request DebugWindow information.
const string & | CRM64Pro::DebugWindow::getName () const override
| Get the name.
Uint32 | CRM64Pro::DebugWindow::getID () const override
| Get the ID.
Widget & | CRM64Pro::DebugWindow::baseWidget ()
| Get the reference to base Widget for this object.
Sint32 | CRM64Pro::DebugWindow::addWatch (const string &sName, Sint32 *iIntegerVar, float *fFloatVar=nullptr)
| Add a watch.
Sint32 | CRM64Pro::DebugWindow::removeWatch (const string &sName)
| Remove a watch.
Sint32 | CRM64Pro::DebugWindow::attachTo (Sint32 idScreen)
| Attach this debugwindow to a screen.
Sint32 | CRM64Pro::DebugWindow::getScreen () const
| Return the screen id where this debugwindow is attached to.
Sint32 | CRM64Pro::DebugWindow::setRefreshInterval (Sint32 iRefresh)
| Set the refresh interval.
Sint32 | CRM64Pro::DebugWindow::getRefreshInterval () const
| Get the refresh interval.
bool | CRM64Pro::Panel::info (Sint32 iMode=0) override
| Request Panel information.
const string & | CRM64Pro::Panel::getName () const override
| Get the name.
Uint32 | CRM64Pro::Panel::getID () const override
| Get the ID.
Widget & | CRM64Pro::Panel::baseWidget ()
| Get the reference to base Widget for this object.
Sint32 | CRM64Pro::Panel::setTitle (const string &sText, const Position &posX=Position(PH_CENTER), const Position &posY=Position(PH_CENTER))
| Set the panel title text.
Sint32 | CRM64Pro::Panel::getTitle (string &sText) const
| Get the panel title text.
Sint32 | CRM64Pro::Panel::attachTo (Sint32 idScreen)
| Attach this panel to a screen.
Sint32 | CRM64Pro::Panel::setScreenDesired (Sint32 iScreenDesired)
| Set the desired screen index persisted for this panel.
Sint32 | CRM64Pro::Panel::getScreen () const
| Return the screen id where this panel is attached to.
Sint32 | CRM64Pro::Panel::getScreenDesired () const
| Return the desired screen index persisted for this panel.
Sint32 | CRM64Pro::Panel::setTheme (Sint32 idTheme)
| Set the panel theme.
Sint32 | CRM64Pro::Panel::getTheme () const
| Get the panel theme.
Widget * | CRM64Pro::Panel::createWidgetByType (const string &sName, eWidgetType eWT, Sint32 iWID)
| Create a widget by runtime type.
eWidgetType | CRM64Pro::Panel::getWidgetType (Sint32 iWID) const
| Return the type of a widget using its ID.
Widget * | CRM64Pro::Panel::getWidgetByID (Sint32 iWID)
| Get a pointer to a Widget using its ID.
Sint32 | CRM64Pro::Panel::setWidgetName (Sint32 iWID, const string &sName)
| Rename an owned widget.
WidgetLabel * | CRM64Pro::Panel::createLabel (const string &sName, Sint32 iWID)
| Create a Label widget and return its typed pointer.
WidgetImage * | CRM64Pro::Panel::createImage (const string &sName, Sint32 iWID)
| Create an Image widget and return its typed pointer.
WidgetFrame * | CRM64Pro::Panel::createFrame (const string &sName, Sint32 iWID)
| Create a Frame widget and return its typed pointer.
WidgetButton * | CRM64Pro::Panel::createButton (const string &sName, Sint32 iWID)
| Create a Button widget and return its typed pointer.
WidgetCheckBox * | CRM64Pro::Panel::createCheckBox (const string &sName, Sint32 iWID)
| Create a CheckBox widget and return its typed pointer.
WidgetProgress * | CRM64Pro::Panel::createProgress (const string &sName, Sint32 iWID)
| Create a Progress widget and return its typed pointer.
WidgetSlider * | CRM64Pro::Panel::createSlider (const string &sName, Sint32 iWID, eSliderAxis eAxis=SA_HORIZONTAL)
| Create a Slider widget and return its typed pointer.
WidgetTextEdit * | CRM64Pro::Panel::createTextEdit (const string &sName, Sint32 iWID)
| Create a TextEdit widget and return its typed pointer.
WidgetList * | CRM64Pro::Panel::createList (const string &sName, Sint32 iWID)
| Create a List widget and return its typed pointer.
WidgetComboBox * | CRM64Pro::Panel::createComboBox (const string &sName, Sint32 iWID)
| Create a ComboBox widget and return its typed pointer.
WidgetNumberEdit * | CRM64Pro::Panel::createNumberEdit (const string &sName, Sint32 iWID)
| Create a NumberEdit widget and return its typed pointer.
WidgetLabel * | CRM64Pro::Panel::getLabel (Sint32 iWID)
| Get a typed Label widget using its ID.
WidgetImage * | CRM64Pro::Panel::getImage (Sint32 iWID)
| Get a typed Image widget using its ID.
WidgetFrame * | CRM64Pro::Panel::getFrame (Sint32 iWID)
| Get a typed Frame widget using its ID.
WidgetButton * | CRM64Pro::Panel::getButton (Sint32 iWID)
| Get a typed Button widget using its ID.
WidgetCheckBox * | CRM64Pro::Panel::getCheckBox (Sint32 iWID)
| Get a typed CheckBox widget using its ID.
WidgetProgress * | CRM64Pro::Panel::getProgress (Sint32 iWID)
| Get a typed Progress widget using its ID.
WidgetSlider * | CRM64Pro::Panel::getSlider (Sint32 iWID)
| Get a typed Slider widget using its ID.
WidgetTextEdit * | CRM64Pro::Panel::getTextEdit (Sint32 iWID)
| Get a typed TextEdit widget using its ID.
WidgetList * | CRM64Pro::Panel::getList (Sint32 iWID)
| Get a typed List widget using its ID.
WidgetComboBox * | CRM64Pro::Panel::getComboBox (Sint32 iWID)
| Get a typed ComboBox widget using its ID.
WidgetNumberEdit * | CRM64Pro::Panel::getNumberEdit (Sint32 iWID)
| Get a typed NumberEdit widget using its ID.
void | CRM64Pro::Panel::getWidgetInfoList (vector< sWidgetInfo > &vOut) const
| Fill widget metadata of this panel.
Sint32 | CRM64Pro::Panel::closeWidget (Sint32 iWID)
| Close and destroy a Widget.
Sint32 | CRM64Pro::Panel::setPanelType (ePanelType ePT, Sint32 iTime=0)
| Set the panel type.
ePanelType | CRM64Pro::Panel::getPanelType () const
| Get the panel type.
Sint32 | CRM64Pro::Panel::getPanelTTL () const
| Get the panel time to live.
Sint32 | CRM64Pro::Panel::setSizeMode (ePanelSizeMode ePSM)
| Set the panel size mode.
ePanelSizeMode | CRM64Pro::Panel::getSizeMode () const
| Get the panel size mode.
Sint32 | CRM64Pro::Panel::setLayout (ePanelLayout ePL)
| Set the panel child layout mode.
ePanelLayout | CRM64Pro::Panel::getLayout () const
| Get the panel child layout mode.
Sint32 | CRM64Pro::Panel::setLayoutSpacing (Sint32 iSpacing)
| Set spacing between child widgets in flow layouts.
Sint32 | CRM64Pro::Panel::setLayoutPadding (Sint32 iTop, Sint32 iRight, Sint32 iBottom, Sint32 iLeft)
| Set padding inside the panel base widget for flow layouts.
Sint32 | CRM64Pro::Panel::setLayoutJustify (eLayoutJustify eJustify)
| Set flow-layout distribution along the main axis.
eLayoutJustify | CRM64Pro::Panel::getLayoutJustify () const
| Get flow-layout distribution along the main axis.
Sint32 | CRM64Pro::Panel::setLayoutAlign (eLayoutAlign eAlign)
| Set flow-layout alignment along the cross axis.
eLayoutAlign | CRM64Pro::Panel::getLayoutAlign () const
| Get flow-layout alignment along the cross axis.
void | CRM64Pro::Panel::invalidateLayout ()
| Mark the flow layout dirty so child positions are recomputed on the next update/render pass.
Sint32 | CRM64Pro::Panel::save (const string &sCDCFile)
| Save the panel and all its widgets to a CDC file.
Sint32 | CRM64Pro::Panel::save (const Sint32 idCDC)
| Save the panel and all its widgets to a CDC file.

## Macro Definition Documentation

## ◆ GUI_PANEL

#define GUI_PANEL 0x42000000

GUI Object: Panel.

## ◆ GUI_CONSOLE

#define GUI_CONSOLE 0x44000000

GUI Object: Console.

## ◆ GUI_DEBUGWINDOW

#define GUI_DEBUGWINDOW 0x48000000

GUI Object: DebugWindow.

## Enumeration Type Documentation

## ◆ ePanelType

enum CRM64Pro::ePanelType

Panel Type.

Enumerator
PT_RETRIEVE | Legacy internal sentinel. Use Panel::getPanelType() in public code.
PT_MODELESS | Modeless panel. When it gets the focus, it does not block the input for others panels.
PT_MODAL | Modal panel. When it gets the focus, it blocks the input for others panels on the same screen.
PT_EPHEMERAL | Ephemeral and modeless panel. Its lasts the given time duration.

## ◆ ePanelSizeMode

enum CRM64Pro::ePanelSizeMode

Panel size mode.

Enumerator
PSM_MANUAL | Panel uses its stored base widget size.
PSM_SCREEN | Panel base widget size tracks the attached screen size at runtime.

## ◆ ePanelLayout

enum CRM64Pro::ePanelLayout : Uint32

Panel layout flags.

Enumerator
PL_NONE | Manual child positioning.
PL_HFLOW | Arrange visible child widgets left to right.
PL_VFLOW | Arrange visible child widgets top to bottom.

## Function Documentation

## ◆ info() [1/4]

bool CRM64Pro::GUIMgr::info | ( | Sint32 | iMode = 0 | ) |
| override

Request GUI Manager information.

Writes information to the default log.

Parameters

  iMode | -1 for manager information only. 0 (default) for manager information plus all GUI objects. A positive GUI id for manager information plus that specific GUI object.

Returns
  true on success, or false on failure.

## ◆ create()

Sint32 CRM64Pro::GUIMgr::create | ( | const string & | sName,
|  | Uint32 | iType = GUI_PANEL )
| override

Creates a new GUI object.

Parameters

  sName | The name for the GUI object (e.g. 'myPanel'). Must be unique and max 64 characters (truncated if longer).
  iType | GUI Object type (GUI_PANEL, GUI_CONSOLE or GUI_DEBUGWINDOW) OR'ed with version (10 = v1.0, only version supported). Default is GUI_PANEL with v1.0.

Returns
  greater than 0 on success (the GUI id) or a negative error code on failure.

Note
  All GUI Objects are attached to the default screen by default but can be changed via attachTo() methods. Created objects have baseWidget enabled but hidden (C64_STATUS_HIDDEN).

## ◆ close()

bool CRM64Pro::GUIMgr::close | ( | Sint32 | idGUI | ) |
| override

Close and destroy a GUI object.

Parameters

  idGUI | 0 for closing all GUI objects or a specific GUI id. The default console cannot be removed. Shared Panel ids are not removed until the last owner calls this method.

Returns
  true if at least one GUI object was closed or a shared Panel reference was released, or false if nothing changed.

Note
  Unclosed objects are automatically closed when the GDK terminates.

## ◆ getCount()

Sint32 CRM64Pro::GUIMgr::getCount | ( |  | ) | const
| override

Get number of loaded objects.

Returns
  the number of log objects.

## ◆ setName()

Sint32 CRM64Pro::GUIMgr::setName | ( | Sint32 | idGUI,
|  | const string & | sName )
| override

Change the object name.

Parameters

  idGUI | GUI id. Can be a Panel, Console or DebugWindow.
  sName | The name to give to the object (e.g. 'myPanel'). Must be unique and max 64 characters (truncated if longer).

Returns
  0 on success, or a negative error code on failure.

## ◆ getPanel()

Panel * CRM64Pro::GUIMgr::getPanel | ( | Sint32 | idGUI = 0 | ) |

Get a pointer to a Panel using its handler.

Parameters

  idGUI | Panel GUI id.

Returns
  nullptr the Panel was not found.
  A pointer to the Panel object.

## ◆ getPanelFocus()

Sint32 CRM64Pro::GUIMgr::getPanelFocus | ( |  | ) | const

Get the GUI Panel id with the focus.

Returns
  greater than 0 on success(the GUI Panel id) or a negative error code on failure.

## ◆ setPanelFocus()

Sint32 CRM64Pro::GUIMgr::setPanelFocus | ( | Sint32 | idGUI | ) |

Set the focus on the given GUI Panel id.

Parameters

  idGUI | the GUI Panel id. In order to get the focus, the panel must be shown.

Returns
  0 on success, or a negative error code on failure.

## ◆ getConsole()

Console * CRM64Pro::GUIMgr::getConsole | ( | Sint32 | idGUI = GUI_CONSOLE | ) |

Get a pointer to a Console using its handler.

By default it returns the default console.

Parameters

  idGUI | Console GUI id. With GUI_CONSOLE (default value), it returns the default console.

Returns
  nullptr the Console was not found.
  A pointer to the Console object.

## ◆ getDebugWindow()

DebugWindow * CRM64Pro::GUIMgr::getDebugWindow | ( | Sint32 | idGUI = 0 | ) |

Get a pointer to a DebugWindow using its handler.

Parameters

  idGUI | DebugWindow GUI id.

Returns
  nullptr the DebugWindow was not found.
  A pointer to the DebugWindow object.

## ◆ load() [1/2]

Sint32 CRM64Pro::GUIMgr::load | ( | const string & | sCDCFile,
|  | const string & | sName )

Load a panel and its widgets stored in a CDC file.

The GUI Manager can share Panel ids based on name, checking if already loaded before creating new ones.

Parameters

  sCDCFile | string containing [directory]+filename. Directory separators '\' and '/' are supported.
  sName | string with the panel name (max 64 characters).

Note
  If the stored desired screen is not currently available, the loaded panel is attached to the default screen.
  Stored child widget entries are expected in the PanelName/WidgetName format used by panel save.

Returns
  0 or greater on success (the Panel id) or a negative error code on failure.

## ◆ load() [2/2]

Sint32 CRM64Pro::GUIMgr::load | ( | const Sint32 | idCDC,
|  | const string & | sName )

Load a panel and its widgets stored in a CDC file.

The GUI Manager has the ability of sharing Panel ids based on the name as the key, so before trying to load a new one, it checks if it is already loaded for sharing it.

Parameters

  idCDC | CDC id.
  sName | string with the panel name (maximum size of 64 characters).

Note
  Stored child widget entries are expected in the PanelName/WidgetName format used by panel save.

Returns
  0 or greater on success(the Panel id) or a negative error code on failure.

## ◆ remove()

Sint32 CRM64Pro::GUIMgr::remove | ( | Sint32 | idCDC,
|  | const string & | sName )

Remove a panel and its widgets stored in a CDC file.

Parameters

  idCDC | CDC id.
  sName | string with the panel name (max 64 characters).

Returns
  0 on success, or a negative error code on failure.

Note
  This permanently removes the panel block and all associated widget blocks from the archive.

## ◆ getIconInfo()

Sint32 CRM64Pro::GUIMgr::getIconInfo | ( |  | ) | const

Get the built-in info icon.

Returns
  greater than 0 on success(the image id) or a negative error code on failure.

## ◆ getIconWarning()

Sint32 CRM64Pro::GUIMgr::getIconWarning | ( |  | ) | const

Get the built-in warning icon.

Returns
  greater than 0 on success(the image id) or a negative error code on failure.

## ◆ getIconQuestion()

Sint32 CRM64Pro::GUIMgr::getIconQuestion | ( |  | ) | const

Get the built-in question icon.

Returns
  greater than 0 on success(the image id) or a negative error code on failure.

## ◆ getIconError()

Sint32 CRM64Pro::GUIMgr::getIconError | ( |  | ) | const

Get the built-in error icon.

Returns
  greater than 0 on success(the image id) or a negative error code on failure.

## ◆ createTheme()

Sint32 CRM64Pro::GUIMgr::createTheme | ( | const string & | sName | ) |

Create a new custom theme initialized from the built-in Default theme.

Parameters

  sName | Theme name. Must be unique and max 64 characters (truncated if longer).

Returns
  A positive theme id on success, or a negative error code on failure.

## ◆ getTheme() [1/2]

GUITheme * CRM64Pro::GUIMgr::getTheme | ( | Sint32 | idTheme | ) |

Get a theme by id.

Parameters

  idTheme | Theme id.

Returns
  nullptr when the theme was not found, or a pointer to the theme on success.

## ◆ setGlobalTheme()

Sint32 CRM64Pro::GUIMgr::setGlobalTheme | ( | Sint32 | idTheme | ) |

Set the active global theme.

Parameters

  idTheme | Theme id. Use -1 to restore the built-in Default theme.

Returns
  0 on success, or a negative error code on failure.
  GUIMgr& gui = Main::Instance().IGUIMgr();
  gui.setGlobalTheme(gui.getThemeDark());
  CRM64Pro::GUIMgr::getThemeDark
  Sint32 getThemeDark() const
  Get the built-in Dark theme id.
  Definition GUI.cpp:1730

## ◆ getGlobalTheme()

Sint32 CRM64Pro::GUIMgr::getGlobalTheme | ( |  | ) | const

Get the active global theme id.

Returns
  The current global theme id.

## ◆ closeTheme()

bool CRM64Pro::GUIMgr::closeTheme | ( | Sint32 | idTheme | ) |

Close and destroy a custom theme.

Parameters

  idTheme | Theme id.

Returns
  true on success, or false when nothing changed.

Note
  Built-in themes cannot be closed.

## ◆ getThemeDefault()

Sint32 CRM64Pro::GUIMgr::getThemeDefault | ( |  | ) | const

Get the built-in Default theme id.

Returns
  The built-in Default theme id.

## ◆ getThemeDark()

Sint32 CRM64Pro::GUIMgr::getThemeDark | ( |  | ) | const

Get the built-in Dark theme id.

Returns
  The built-in Dark theme id.

## ◆ getThemeFlat()

Sint32 CRM64Pro::GUIMgr::getThemeFlat | ( |  | ) | const

Get the built-in Flat theme id.

Returns
  The built-in Flat theme id.

## ◆ info() [2/4]

bool CRM64Pro::Console::info | ( | Sint32 | iMode = 0 | ) |
| override

Request Console information.

Writes information to the default log.

Parameters

  iMode | currently ignored. The method always prints full console information, including the command list and base widget state.

Returns
  true on success, or false on failure.

## ◆ getName() [1/3]

const string & CRM64Pro::Console::getName | ( |  | ) | const
| override

Get the name.

Returns
  The object name.

## ◆ getID() [1/3]

Uint32 CRM64Pro::Console::getID | ( |  | ) | const
| override

Get the ID.

Returns
  Object ID.

## ◆ baseWidget() [1/3]

Widget & CRM64Pro::Console::baseWidget | ( |  | ) |

Get the reference to base Widget for this object.

Returns
  a reference to the base Widget.

## ◆ attachTo() [1/3]

Sint32 CRM64Pro::Console::attachTo | ( | Sint32 | idScreen | ) |

Attach this console to a screen.

Parameters

  idScreen | a valid screen handle. Default is the default screen (0).

Returns
  0 on success, or a negative error code on failure.

## ◆ getScreen() [1/3]

Sint32 CRM64Pro::Console::getScreen | ( |  | ) | const

Return the screen id where this console is attached to.

Returns
  the screen id.

## ◆ print()

Sint32 CRM64Pro::Console::print | ( | const char * | format,
|  |  | ... )

Print a formatted message to the console.

Parameters

  format | format control, same as printf() function.
  ... | optional arguments, same as printf() function.

Returns
  0 on success, or a negative error code on failure.

Note
  If the baseWidget is disabled (C64_STATUS_DISABLED), this method does nothing.

## ◆ vPrint()

Sint32 CRM64Pro::Console::vPrint | ( | const char * | format,
|  | va_list | args )

Print a formatted message to the console.

Parameters

  format | format control, same as printf() function.
  args | pointer to list of arguments, same as vprintf() function.

Returns
  0 on success, or a negative error code on failure.

Note
  If the baseWidget is disabled (C64_STATUS_DISABLED), this method does nothing.

## ◆ addCmdHandler()

Sint32 CRM64Pro::Console::addCmdHandler | ( | const string & | sCommandName,
|  | const string & | sCommandHelp,
|  | Sint32(* | cmdFunc )(vector< string > *, Console *pCon) )

Add a new command handler to the console.

Parameters

  sCommandName | string with the command name (must be unique). Reserved commands: 'con' (Console control), 'dw' (Debug Window control), 'help' (List all commands).
  sCommandHelp | string with a brief command description.
  cmdFunc | pointer to the function handler. The vector<string>* parameter contains the tokenized command and Console* is the calling console. Must return 0 on success or negative on error.

Returns
  0 on success, or a negative error code on failure.

## ◆ executeCmd()

Sint32 CRM64Pro::Console::executeCmd | ( | const string & | sCmd | ) |

Execute a command on this console.

Parameters

  sCmd | string with the command plus arguments to be executed by this console.

Returns
  0 on success, or a negative error code on failure.

Note
  If the baseWidget is disabled (C64_STATUS_DISABLED), this method does nothing.

## ◆ setReadOnly()

Sint32 CRM64Pro::Console::setReadOnly | ( | bool | bEnable = true | ) |

Enable or disable read-only mode for the console prompt.

In read-only mode the console remains visible and can still print output, but prompt editing and command execution are blocked.

Parameters

  bEnable | true to enable read-only mode, false to allow prompt input again.

Returns
  0 on success, or a negative error code on failure.

## ◆ isReadOnly()

bool CRM64Pro::Console::isReadOnly | ( |  | ) | const

Check whether the console prompt is in read-only mode.

Returns
  true when the console prompt is read-only, or false otherwise.

## ◆ info() [3/4]

bool CRM64Pro::DebugWindow::info | ( | Sint32 | iMode = 0 | ) |
| override

Request DebugWindow information.

Writes information to the default log.

Parameters

  iMode | currently ignored. The method always prints full debug-window information, including watch count, refresh interval and base widget state.

Returns
  true on success, or false on failure.

## ◆ getName() [2/3]

const string & CRM64Pro::DebugWindow::getName | ( |  | ) | const
| override

Get the name.

Returns
  The object name.

## ◆ getID() [2/3]

Uint32 CRM64Pro::DebugWindow::getID | ( |  | ) | const
| override

Get the ID.

Returns
  Object ID.

## ◆ baseWidget() [2/3]

Widget & CRM64Pro::DebugWindow::baseWidget | ( |  | ) |

Get the reference to base Widget for this object.

Returns
  a reference to the base Widget.

## ◆ addWatch()

Sint32 CRM64Pro::DebugWindow::addWatch | ( | const string & | sName,
|  | Sint32 * | iIntegerVar,
|  | float * | fFloatVar = nullptr )

Add a watch.

Parameters

  sName | watch name. Must be unique.
  iIntegerVar | a pointer to an integer variable to be associated to this watch. nullptr for doing nothing.
  fFloatVar | a pointer to a float variable to be associated to this watch. nullptr for doing nothing.

Returns
  0 on sucess or a negative error code on failure.

Note
  If the baseWidget is disabled (C64_STATUS_DISABLED), this method does nothing.
  Watched pointers are stored as raw pointers and dereferenced during refresh. The caller must guarantee that the pointed storage remains valid for the lifetime of the watch, or until removeWatch() is called.

## ◆ removeWatch()

Sint32 CRM64Pro::DebugWindow::removeWatch | ( | const string & | sName | ) |

Remove a watch.

Parameters

  sName | watch name.

Returns
  0 on success, or a negative error code on failure.

Note
  If the baseWidget is disabled (C64_STATUS_DISABLED), this method does nothing.

## ◆ attachTo() [2/3]

Sint32 CRM64Pro::DebugWindow::attachTo | ( | Sint32 | idScreen | ) |

Attach this debugwindow to a screen.

Parameters

  idScreen | a valid screen handle. Default is the default screen (0).

Returns
  0 on success, or a negative error code on failure.

## ◆ getScreen() [2/3]

Sint32 CRM64Pro::DebugWindow::getScreen | ( |  | ) | const

Return the screen id where this debugwindow is attached to.

Returns
  the screen id.

## ◆ setRefreshInterval()

Sint32 CRM64Pro::DebugWindow::setRefreshInterval | ( | Sint32 | iRefresh | ) |

Set the refresh interval.

Parameters

  iRefresh | time interval in milliseconds for refreshing the value of the watches. By default it is set to 500ms.

Returns
  0 on success, or a negative error code on failure.

## ◆ getRefreshInterval()

Sint32 CRM64Pro::DebugWindow::getRefreshInterval | ( |  | ) | const

Get the refresh interval.

Returns
  0 or greater on success(the refresh interval) or a negative error code on failure.

## ◆ info() [4/4]

bool CRM64Pro::Panel::info | ( | Sint32 | iMode = 0 | ) |
| override

Request Panel information.

Writes information to the default log.

Parameters

  iMode | currently ignored. The method always prints full panel information, including the base widget and all owned widgets.

Returns
  true on success, or false on failure.

## ◆ getName() [3/3]

const string & CRM64Pro::Panel::getName | ( |  | ) | const
| override

Get the name.

Returns
  The object name.

## ◆ getID() [3/3]

Uint32 CRM64Pro::Panel::getID | ( |  | ) | const
| override

Get the ID.

Returns
  Object ID.

## ◆ baseWidget() [3/3]

Widget & CRM64Pro::Panel::baseWidget | ( |  | ) |

Get the reference to base Widget for this object.

Returns
  a reference to the base Widget.

Note
  Use setTitle()/getTitle() for panel title text instead of writing text through the returned Widget directly.

## ◆ setTitle()

Sint32 CRM64Pro::Panel::setTitle | ( | const string & | sText,
|  | const Position & | posX = Position(PH_CENTER),
|  | const Position & | posY = Position(PH_CENTER) )

Set the panel title text.

Parameters

  sText | Title text to show in the base widget.
  posX | Title X position. Default is PH_CENTER.
  posY | Title Y position. Default is PH_CENTER.

Returns
  0 on success, or a negative error code on failure.

## ◆ getTitle()

Sint32 CRM64Pro::Panel::getTitle | ( | string & | sText | ) | const

Get the panel title text.

Parameters

  sText | String reference receiving the current title.

Returns
  0 on success, or a negative error code on failure.

## ◆ attachTo() [3/3]

Sint32 CRM64Pro::Panel::attachTo | ( | Sint32 | idScreen | ) |

Attach this panel to a screen.

Parameters

  idScreen | a valid screen handle. Default is the default screen (0).

Returns
  0 on success, or a negative error code on failure.

## ◆ setScreenDesired()

Sint32 CRM64Pro::Panel::setScreenDesired | ( | Sint32 | iScreenDesired | ) |

Set the desired screen index persisted for this panel.

Parameters

  iScreenDesired | desired screen index. Values below 0 are clamped to 0.

Returns
  0 on success, or a negative error code on failure.

## ◆ getScreen() [3/3]

Sint32 CRM64Pro::Panel::getScreen | ( |  | ) | const

Return the screen id where this panel is attached to.

Returns
  the screen id.

## ◆ getScreenDesired()

Sint32 CRM64Pro::Panel::getScreenDesired | ( |  | ) | const

Return the desired screen index persisted for this panel.

Returns
  the desired screen index.

## ◆ setTheme()

Sint32 CRM64Pro::Panel::setTheme | ( | Sint32 | idTheme | ) |

Set the panel theme.

Parameters

  idTheme | Theme id managed by GUIMgr. Use -1 to clear the panel override and fall back to the global theme.

Returns
  0 on success, or a negative error code on failure.
  Panel* pPanel = Main::Instance().IGUIMgr().getPanel(idPanel);
  if(pPanel)
  {
  pPanel->setTheme(Main::Instance().IGUIMgr().getThemeFlat());
  }
  CRM64Pro::GUIMgr::getPanel
  Panel * getPanel(Sint32 idGUI=0)
  Get a pointer to a Panel using its handler.
  Definition GUI.cpp:1258
  CRM64Pro::Panel::setTheme
  Sint32 setTheme(Sint32 idTheme)
  Set the panel theme.
  Definition GUIPanel.cpp:876

## ◆ getTheme() [2/2]

Sint32 CRM64Pro::Panel::getTheme | ( |  | ) | const

Get the panel theme.

Returns
  The panel theme id, or -1 when the panel uses the global theme.

## ◆ createWidgetByType()

Widget * CRM64Pro::Panel::createWidgetByType | ( | const string & | sName,
|  | eWidgetType | eWT,
|  | Sint32 | iWID )

Create a widget by runtime type.

Parameters

  sName | The short runtime widget name. Must be unique inside the panel.
  eWT | Widget type. Check ::eWidgetType for further information.
  iWID | unsigned integer with the unique Widget ID.

Returns
  nullptr on failure.
  A pointer to the created Widget object on success.

Note
  This is the dynamic creation entry point intended for editor/import/runtime-driven code. For normal usage, prefer the typed creators such as createButton(), createTextEdit() or createList(). Different widget versions may exist but creation always uses the newest. Created widgets are enabled but hidden (GS_HIDDEN).
  The maximum allowed widget-name length depends on the current panel name because child widgets are persisted internally as PanelName/WidgetName inside CDC archives.

## ◆ getWidgetType()

eWidgetType CRM64Pro::Panel::getWidgetType | ( | Sint32 | iWID | ) | const

Return the type of a widget using its ID.

Parameters

  iWID | Widget id.

Returns
  The widget type, or WT_BASE if the widget was not found.

## ◆ getWidgetByID()

Widget * CRM64Pro::Panel::getWidgetByID | ( | Sint32 | iWID | ) |

Get a pointer to a Widget using its ID.

Parameters

  iWID | Widget id.

Returns
  nullptr the Widget was not found.
  A pointer to the Widget object.

Note
  This is the dynamic lookup entry point intended for editor/import/runtime-driven code. For normal usage, prefer the typed getters such as getButton(), getTextEdit() or getList().

## ◆ setWidgetName()

Sint32 CRM64Pro::Panel::setWidgetName | ( | Sint32 | iWID,
|  | const string & | sName )

Rename an owned widget.

Parameters

  iWID | Widget id. The base widget (0) is not handled by this method.
  sName | New short runtime widget name. Must be unique inside this panel.

Returns
  0 on success, or a negative error code on failure.

Note
  Use panel renaming for the base widget. This method only renames child widgets owned by the panel.
  The maximum allowed widget-name length depends on the current panel name because child widgets are persisted internally as PanelName/WidgetName inside CDC archives.

## ◆ createLabel()

WidgetLabel * CRM64Pro::Panel::createLabel | ( | const string & | sName,
|  | Sint32 | iWID )

Create a Label widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created Label widget on success.

## ◆ createImage()

WidgetImage * CRM64Pro::Panel::createImage | ( | const string & | sName,
|  | Sint32 | iWID )

Create an Image widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created Image widget on success.

## ◆ createFrame()

WidgetFrame * CRM64Pro::Panel::createFrame | ( | const string & | sName,
|  | Sint32 | iWID )

Create a Frame widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created Frame widget on success.

## ◆ createButton()

WidgetButton * CRM64Pro::Panel::createButton | ( | const string & | sName,
|  | Sint32 | iWID )

Create a Button widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created Button widget on success.

## ◆ createCheckBox()

WidgetCheckBox * CRM64Pro::Panel::createCheckBox | ( | const string & | sName,
|  | Sint32 | iWID )

Create a CheckBox widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created CheckBox widget on success.

## ◆ createProgress()

WidgetProgress * CRM64Pro::Panel::createProgress | ( | const string & | sName,
|  | Sint32 | iWID )

Create a Progress widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created Progress widget on success.

## ◆ createSlider()

WidgetSlider * CRM64Pro::Panel::createSlider | ( | const string & | sName,
|  | Sint32 | iWID,
|  | eSliderAxis | eAxis = SA_HORIZONTAL )

Create a Slider widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.
  eAxis | Slider axis. Horizontal by default.

Returns
  nullptr on failure.
  A pointer to the created Slider widget on success.

## ◆ createTextEdit()

WidgetTextEdit * CRM64Pro::Panel::createTextEdit | ( | const string & | sName,
|  | Sint32 | iWID )

Create a TextEdit widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created TextEdit widget on success.

## ◆ createList()

WidgetList * CRM64Pro::Panel::createList | ( | const string & | sName,
|  | Sint32 | iWID )

Create a List widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created List widget on success.

## ◆ createComboBox()

WidgetComboBox * CRM64Pro::Panel::createComboBox | ( | const string & | sName,
|  | Sint32 | iWID )

Create a ComboBox widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created ComboBox widget on success.

## ◆ createNumberEdit()

WidgetNumberEdit * CRM64Pro::Panel::createNumberEdit | ( | const string & | sName,
|  | Sint32 | iWID )

Create a NumberEdit widget and return its typed pointer.

Parameters

  sName | Widget name.
  iWID | Widget unique id.

Returns
  nullptr on failure.
  A pointer to the created NumberEdit widget on success.

## ◆ getLabel()

WidgetLabel * CRM64Pro::Panel::getLabel | ( | Sint32 | iWID | ) |

Get a typed Label widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a Label.
  A pointer to the Label widget on success.

## ◆ getImage()

WidgetImage * CRM64Pro::Panel::getImage | ( | Sint32 | iWID | ) |

Get a typed Image widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not an Image.
  A pointer to the Image widget on success.

## ◆ getFrame()

WidgetFrame * CRM64Pro::Panel::getFrame | ( | Sint32 | iWID | ) |

Get a typed Frame widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a Frame.
  A pointer to the Frame widget on success.

## ◆ getButton()

WidgetButton * CRM64Pro::Panel::getButton | ( | Sint32 | iWID | ) |

Get a typed Button widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a Button.
  A pointer to the Button widget on success.

## ◆ getCheckBox()

WidgetCheckBox * CRM64Pro::Panel::getCheckBox | ( | Sint32 | iWID | ) |

Get a typed CheckBox widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a CheckBox.
  A pointer to the CheckBox widget on success.

## ◆ getProgress()

WidgetProgress * CRM64Pro::Panel::getProgress | ( | Sint32 | iWID | ) |

Get a typed Progress widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a Progress widget.
  A pointer to the Progress widget on success.

## ◆ getSlider()

WidgetSlider * CRM64Pro::Panel::getSlider | ( | Sint32 | iWID | ) |

Get a typed Slider widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a Slider.
  A pointer to the Slider widget on success.

## ◆ getTextEdit()

WidgetTextEdit * CRM64Pro::Panel::getTextEdit | ( | Sint32 | iWID | ) |

Get a typed TextEdit widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a TextEdit.
  A pointer to the TextEdit widget on success.

## ◆ getList()

WidgetList * CRM64Pro::Panel::getList | ( | Sint32 | iWID | ) |

Get a typed List widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a List.
  A pointer to the List widget on success.

## ◆ getComboBox()

WidgetComboBox * CRM64Pro::Panel::getComboBox | ( | Sint32 | iWID | ) |

Get a typed ComboBox widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a ComboBox.
  A pointer to the ComboBox widget on success.

## ◆ getNumberEdit()

WidgetNumberEdit * CRM64Pro::Panel::getNumberEdit | ( | Sint32 | iWID | ) |

Get a typed NumberEdit widget using its ID.

Parameters

  iWID | Widget unique id.

Returns
  nullptr if the widget was not found or is not a NumberEdit.
  A pointer to the NumberEdit widget on success.

## ◆ getWidgetInfoList()

void CRM64Pro::Panel::getWidgetInfoList | ( | vector< sWidgetInfo > & | vOut | ) | const

Fill widget metadata of this panel.

Parameters

  vOut | Output vector receiving widget id, name and type for each widget currently owned by this panel. Existing contents are cleared before writing.

Note
  This is the preferred inspection API when code only needs metadata and not direct widget access.

## ◆ closeWidget()

Sint32 CRM64Pro::Panel::closeWidget | ( | Sint32 | iWID | ) |

Close and destroy a Widget.

Parameters

  iWID | 0 for closing all Widgets or the Widget id.

Returns
  0 on success, or a negative error code on failure.

Note
  If you forget to close a widget, it will be automatically closed once the panel is closed.

## ◆ setPanelType()

Sint32 CRM64Pro::Panel::setPanelType | ( | ePanelType | ePT,
|  | Sint32 | iTime = 0 )

Set the panel type.

Parameters

  ePT | Panel type. Check ::ePanelType for further information.
  iTime | Time to live (in milliseconds) for PT_EPHEMERAL panels. Minimum is 1000ms.

Returns
  0 on success, or a negative error code on failure.

Note
  Panel behavior type is independent from panel layout. Use setLayout() to enable automatic child arrangement.

## ◆ getPanelType()

ePanelType CRM64Pro::Panel::getPanelType | ( |  | ) | const

Get the panel type.

Returns
  Current panel type.

## ◆ getPanelTTL()

Sint32 CRM64Pro::Panel::getPanelTTL | ( |  | ) | const

Get the panel time to live.

Returns
  TTL in milliseconds for PT_EPHEMERAL panels, or 0 for other panel types.

## ◆ setSizeMode()

Sint32 CRM64Pro::Panel::setSizeMode | ( | ePanelSizeMode | ePSM | ) |

Set the panel size mode.

Parameters

  ePSM | Size mode. PSM_MANUAL keeps the stored base widget size. PSM_SCREEN tracks the attached screen size at runtime.

Returns
  0 on success, or a negative error code on failure.

Note
  Screen-sized panels preserve their manual size internally so they can switch back to manual mode without losing it.

## ◆ getSizeMode()

ePanelSizeMode CRM64Pro::Panel::getSizeMode | ( |  | ) | const

Get the panel size mode.

Returns
  Current size mode.

## ◆ setLayout()

Sint32 CRM64Pro::Panel::setLayout | ( | ePanelLayout | ePL | ) |

Set the panel child layout mode.

Parameters

  ePL | Layout flags. PL_NONE keeps manual child positioning. PL_HFLOW and PL_VFLOW are mutually exclusive.

Returns
  0 on success, or a negative error code on failure.

Note
  In flow layouts, child widget positions are owned by the panel and may be overwritten during update/render reflow.

## ◆ getLayout()

ePanelLayout CRM64Pro::Panel::getLayout | ( |  | ) | const

Get the panel child layout mode.

Returns
  Current panel layout flags.

## ◆ setLayoutSpacing()

Sint32 CRM64Pro::Panel::setLayoutSpacing | ( | Sint32 | iSpacing | ) |

Set spacing between child widgets in flow layouts.

Parameters

  iSpacing | Spacing in pixels between adjacent children. Negative values are clamped to 0.

Returns
  0 on success, or a negative error code on failure.

Note
  Returns an error when the panel layout is PL_NONE.

## ◆ setLayoutPadding()

Sint32 CRM64Pro::Panel::setLayoutPadding | ( | Sint32 | iTop,
|  | Sint32 | iRight,
|  | Sint32 | iBottom,
|  | Sint32 | iLeft )

Set padding inside the panel base widget for flow layouts.

Parameters

  iTop | Top padding.
  iRight | Right padding.
  iBottom | Bottom padding.
  iLeft | Left padding.

Returns
  0 on success, or a negative error code on failure.

Note
  Returns an error when the panel layout is PL_NONE.

## ◆ setLayoutJustify()

Sint32 CRM64Pro::Panel::setLayoutJustify | ( | eLayoutJustify | eJustify | ) |

Set flow-layout distribution along the main axis.

Parameters

  eJustify | Justification mode.

Returns
  0 on success, or a negative error code on failure.

Note
  Returns an error when the panel layout is PL_NONE.

## ◆ getLayoutJustify()

eLayoutJustify CRM64Pro::Panel::getLayoutJustify | ( |  | ) | const

Get flow-layout distribution along the main axis.

Returns
  Current justification mode.

## ◆ setLayoutAlign()

Sint32 CRM64Pro::Panel::setLayoutAlign | ( | eLayoutAlign | eAlign | ) |

Set flow-layout alignment along the cross axis.

Parameters

  eAlign | Alignment mode.

Returns
  0 on success, or a negative error code on failure.

Note
  LA_STRETCH stores each child's non-stretched size so it can be restored when leaving stretch mode.
  Calling Widget::setSize() manually while LA_STRETCH is active updates that stored restore size.
  Returns an error when the panel layout is PL_NONE.

## ◆ getLayoutAlign()

eLayoutAlign CRM64Pro::Panel::getLayoutAlign | ( |  | ) | const

Get flow-layout alignment along the cross axis.

Returns
  Current alignment mode.

## ◆ invalidateLayout()

void CRM64Pro::Panel::invalidateLayout | ( |  | ) |

Mark the flow layout dirty so child positions are recomputed on the next update/render pass.

Automatic invalidation already happens for child show(), hide() and setSize() changes. This method is provided for edge cases where caller-controlled reflow is still desirable.

## ◆ save() [1/2]

Sint32 CRM64Pro::Panel::save | ( | const string & | sCDCFile | ) |

Save the panel and all its widgets to a CDC file.

Widgets images/sprites will also be saved to the same CDC file.

Parameters

  sCDCFile | string containing [directory]+filename+[extension]. Directory separators '\' and '/' are supported.

Returns
  0 or greater on success or a negative error code on failure.

Note
  Child widgets keep their short runtime names in memory, but are persisted internally as PanelName/WidgetName inside the CDC.
  If the panel, widget or any associated image/sprite already exist, they will be overwritten.

## ◆ save() [2/2]

Sint32 CRM64Pro::Panel::save | ( | const Sint32 | idCDC | ) |

Save the panel and all its widgets to a CDC file.

Widgets images/sprites will also be saved in to the same CDC file.

Parameters

  idCDC | CDC id.

Returns
  0 or greater on success or a negative error code on failure.

Note
  Child widgets keep their short runtime names in memory, but are persisted internally as PanelName/WidgetName inside the CDC.
  If the panel, widget or any associated image/sprite already exist, they will be overwritten.