StellarX Docs

StellarX 文档中心

从安装环境、运行第一个窗口,到理解控件、所有权、布局、重绘和示例项目。

第一次使用 StellarX,可以先从快速开始进入;已经能跑起窗口后, 再继续查阅 API 指南、示例 Demo、迁移说明和更新日志。

main.cpp
#include "StellarX.h"

int main()
{
    Window win(1300, 800, NULL, RGB(255, 255, 0), "欢迎使用 StellarX 星垣-GUI");

    win.draw();

    return win.runEventLoop();
}

Start Here

你应该从哪里开始?

这里整理了常用阅读入口;具体接口、参数、控件所有权和类方法, 可以进入 API 指南查看。
01

第一次使用

先阅读快速开始,完成环境配置,选择静态库或源码集成方式,并跑起第一个窗口。

进入快速开始
02

查控件怎么用

查看 API 指南,按 Window、Button、Canvas、Table 等控件查找用法。

进入 API 指南
03

看实际效果

通过示例 Demo 了解 StellarX 能做出的界面效果、控件组合和交互方式。

查看示例

Learning Path

推荐阅读路径

从“能运行”开始,再逐步理解控件、所有权、结构变更、布局和框架内部机制。
01

快速开始

安装 EasyX,配置项目,选择预编译静态库或源码集成,运行第一个窗口。

02

理解基础结构

先搞清 Window、Control、Canvas 的关系,再学习具体控件。

03

使用常用控件

学习 Button、Label、TextBox、Table、TabControl、Dialog 和 MessageBox 的常见用法。

04

理解控件所有权

学习 ControlHandle、add/remove/clear/find 接口,以及回调期间延迟提交结构变更的规则。

05

学习布局与重绘

继续理解锚点、尺寸策略、托管重绘、窗口 resize、脏区和整场景重绘收口。

06

阅读示例 Demo

通过 KEY 测试界面和小工具示例,理解控件组合与真实使用场景。

Find What You Need

按目标选择文档

想运行示例、查控件、了解升级变化或阅读源码,可以从这里快速进入。

我想快速跑起来

查看环境配置、静态库或源码集成方式,以及第一个窗口示例。

快速开始

我想查某个控件

按控件查找构造函数、常用方法、行为边界和使用示例。

API 指南

我想看界面效果

查看登录界面、表格、Dialog、MessageBox 和 KEY 测试界面等示例。

示例 Demo

我想了解版本变化

查看 v4.0.0 更新内容、破坏性 API、兼容性说明和迁移方法。

更新日志

我想读源码

前往 GitHub 查看完整源码、示例、Issue 和 Release。

GitHub 仓库

我想参与项目

提交 Issue、补充示例、完善文档或参与后续维护。

GitHub Issues

Concept Map

核心结构速览

先了解框架由哪些部分组成,再进入 API 指南查看具体接口和行为边界。
Entry

StellarX.h

框架的公共聚合头文件。一般情况下,业务代码只需要包含它, 不应依赖聚合头内部的包含顺序。

Window

窗口与事件循环

负责窗口创建、控件托管、事件分发、消息批处理、结构变更提交和 resize 收口。

Control

控件基础与稳定身份

Control 提供几何、可见性、dirty 标记和布局基础; ControlHandle 用于在容器外保存稳定的控件身份。

Canvas

容器与嵌套

用于安全管理子控件、分发事件、组织复杂界面和承载嵌套布局, 并支持回调期间延迟提交结构变更。

Widgets

常用控件

Button、Label、TextBox、Table、TabControl、Dialog 和 MessageBox 等。

Advanced

布局、重绘与结构变更

锚点布局、尺寸策略、托管重绘、延迟结构变更事务、 Tooltip 状态和日志配置是后续进阶重点。

Current Version

当前推荐版本:v4.0.0

v4.0.0 重点解决回调期间控件树变更、运行期几何残影、文本所有权、 页签 API、日志配置和消息积压等问题。 第一次接触 StellarX,建议直接从当前版本开始。 从 v3.1.0 升级时,请重点检查 getControls()、clearAllControls()、 ControlText::lpszFace、TabControl::add() 和 SxLogger::setConfig() 等接口变化。

Feedback

反馈与联系

使用 StellarX 过程中遇到 Bug、文档问题或功能建议, 建议优先通过 GitHub Issues 反馈; 如果涉及合作、教学使用反馈或不适合公开讨论的内容, 也可以通过邮箱或即时联系方式联系。
Recommended

GitHub Issues

适合反馈 Bug、提交复现步骤、提出功能建议、讨论 API 设计或跟踪项目问题。 公开 Issue 更方便后续整理、复现和追踪,也能帮助其他遇到类似问题的使用者。

提交 Issue