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,配置项目,包含 StellarX.h,运行第一个窗口。

02

理解基础结构

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

03

使用常用控件

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

04

学习布局与重绘

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

05

阅读示例 Demo

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

Find What You Need

按目标选择文档

想运行示例、查控件、看更新或读源码,可以从这里快速进入。

我想快速跑起来

看环境配置、项目引入、第一个窗口示例。

快速开始

我想查某个控件

按控件查构造函数、常用方法、使用示例。

API 指南

我想看界面效果

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

示例 Demo

我想了解版本变化

查看当前版本、更新内容、兼容性说明和后续规划。

更新日志

我想读源码

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

GitHub 仓库

我想参与项目

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

GitHub Issues

Concept Map

核心结构速览

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

StellarX.h

框架的主包含头文件。一般情况下,用户只需要包含它,就可以使用 StellarX 的主要能力。

Window

窗口与事件循环

负责窗口创建、背景绘制、控件托管、事件循环和 resize 收口。

Control

控件基础

所有控件的基础类,提供位置、尺寸、可见性、dirty 标记和布局基础。

Canvas

容器与嵌套

用于管理子控件、分发事件、组织复杂界面和承载嵌套布局。

Widgets

常用控件

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

Advanced

布局与重绘

锚点布局、尺寸策略、背景快照、托管重绘和 overlay 补画是后续进阶重点。

Current Version

当前推荐版本:v3.1.0

v3.1.0 重点围绕布局系统、几何语义和托管重绘链路继续稳定化。 第一次接触 StellarX,建议直接从当前推荐版本开始。

Feedback

反馈与联系

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

GitHub Issues

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

提交 Issue