DearMQL5 is an institutional-grade, immediate-mode graphical user interface
(GUI) engine designed from the ground up for MetaTrader 5 (MQL5), inspired by
the ergonomics and performance of Dear ImGui.
### Core Architecture & Execution Pipeline
- Immediate-Mode Paradigm: Declarative frame-based rendering pipeline with zero
memory allocation churn during render loops and deterministic execution.
- Modular Per-Hub Canvas Surfaces (CUWindowSurface): Replaces full-screen canvas
overlays with isolated, window-bounded CCanvas bitmaps, reducing memory usage
by up to 93% (~570 KB vs 8.3 MB for 1080p) and preventing click-swallowing.
- 0-Cost Hardware Texture Drag Engine: Absolute-anchor drag mechanics update
native MT5 OBJPROP_XDISTANCE and OBJPROP_YDISTANCE properties directly on
the compositor, bypassing CPU rasterization completely (0.00% CPU usage).
- Chart Scroll Protection: Automatically suppresses chart history sliding
(CHART_MOUSE_SCROLL) during active HUD dragging and safely restores it on release.
- Two-Phase Hit-Testing: Interactive controls (buttons, sliders, toggles) receive
first-priority click focus, cleanly separating widget actions from window drags.
### Subsystems & Components
- Core State & Input (Core/):
* UInputState: Mouse/keyboard tracking, deltas, and chart scroll lock.
* UState: Retained state hash map in pure MQL5 with 64-bit FNV-1a hashing.
* UIdStack: Hierarchical identifier scoping preventing widget ID collisions.
* ULayout: Automatic cursor placement supporting SameLine, Indent, and Unindent.
* UEventQueue: Non-blocking circular UI event queue for decoupled handling.
* UTheme: Institutional OneDark/Nord dark color palette and typography metrics.
- Rendering Backends (Render/):
* URendererCanvas: Isolated per-hub surfaces with 32-bit ARGB alpha transparency.
* URendererNative: Native MT5 object pool (OBJ_RECTANGLE_LABEL) with diff caching.
* UFont: Anti-aliased font metrics and width cache.
- Complete Widget Suite (Widgets/):
* UButton: Click-on-release standard, accent, and emergency panic buttons.
* UToggle: Smooth draggable/clickable iOS-style toggle switches.
* USlider: Draggable horizontal float and integer sliders.
* UProgressBar: Adaptive progress bars with dynamic green->amber->red color ramps.
* UHeader: Collapsible section headers with immediate-mode state retention.
* ULabel & USeparator: Formatted text, colored metrics, and horizontal dividers.
- Window Management (Windows/):
* UWindow: Window container with titlebar, collapse toggle, and coordinate clipping.
* UWindowManager: Multi-window coordinator with GlobalVariable persistence across
chart timeframe changes and backward-compatible key resolution.
### Tooling, Documentation & Reference Implementation
- Examples/EA_DearMQL5_Demo.mq5: Complete reference Prop-Firm cockpit HUD.
- README.md: Comprehensive institutional English documentation for GitHub and Algo Forge.
- Docs/ARCHITECTURE.md: Technical architecture specification with Mermaid lifecycle.
52 lines
1.9 KiB
MQL5
52 lines
1.9 KiB
MQL5
//+------------------------------------------------------------------+
| |
//| UWidget.mqh |
| |
//| Copyright 2026, DearMQL5 GUI Engine |
| |
//| https://www.mql5.com |
| |
//+------------------------------------------------------------------+
| |
#property copyright "Copyright 2026, DearMQL5 GUI Engine"
| |
#property link "https://www.mql5.com"
| |
#property strict
| |
| |
#include "..\Core\UTheme.mqh"
| |
#include "..\Core\UInputState.mqh"
| |
#include "..\Core\UIdStack.mqh"
| |
#include "..\Core\ULayout.mqh"
| |
#include "..\Util\UMath.mqh"
| |
| |
/// Base helper for immediate-mode widget bounding, hit-testing and hot/active state.
| |
class UWidget
| |
{
| |
public:
| |
/// Tests interaction state for a given rectangular boundary and ID.
| |
static void Behavior(const ulong id,
| |
const int x, const int y, const int w, const int h,
| |
bool &out_hovered, bool &out_clicked, bool &out_active)
| |
{
| |
int mx = UInputState::MouseX();
| |
int my = UInputState::MouseY();
| |
| |
bool in_rect = UMath::PointInRect(mx, my, x, y, w, h);
| |
| |
// Only allow setting hot if no other widget is currently active (captured)
| |
ulong active = UInputState::GetActive();
| |
if(in_rect && (active == 0 || active == id))
| |
UInputState::SetHot(id);
| |
| |
out_hovered = (UInputState::GetHot() == id);
| |
| |
if(out_hovered && UInputState::IsMouseClicked())
| |
{
| |
UInputState::SetActive(id);
| |
UInputState::SetFocused(id);
| |
}
| |
| |
// Widget is active if currently active or was active when released in this frame
| |
out_active = (UInputState::GetActive() == id || UInputState::GetPrevActive() == id);
| |
out_clicked = (out_hovered && UInputState::IsMouseReleased() && out_active);
| |
| |
if(out_clicked)
| |
{
| |
UInputState::ReleaseActive();
| |
}
| |
}
| |
};
|