一个全新的Qt Property Tree: ncsproptree
文章目录
介绍
NcsPropTree(以下简称ncsppt) 是一个全新的展示属性、编辑属性的树状控件. 它的目标是比QtPropertyTreeBrower更好用, 更方便扩展.
ncs的意思是 Numerical Computation System, 本控件原本是为数值计算系统开发的,但是通用性非常好.
项目地址 : https://gitee.com/xieyyao/ncsproptree
运行截图如下:
软件架构
NcsPropTree主要借用std::function 而不是工厂模式来实现属性与编辑器的自动配合.
NcsPropMgr
对象
负责管理NcsProp(属性),并还完成如下核心功能:
- 为每个属性创建合适的编辑器.
- [todo] 为每个属性创建合适的装饰器,用来展示属性的值.
NcsPropTree
对象
NcsPropTree则是用来监听NcsPropMgr的动作,并将其中的所有属性展示在树中, 并完成如下操作
- 当属性编辑完毕、失去焦点的时候,展示其值
- 当属性有编辑需求的时候,以内嵌方式(in-place)或者弹出方式(popup)来展示编辑器. 如果想做成弹出的, 编辑器只要是个按钮就行, 这样点击的时候弹出编辑框.
NcsPropTree 通过map来管理property type和editor function之间的映射关系, 或者是property对象本身和某种editor function之间的映射关系. 因此,每当NcsPropTree创建一个类型的属性时,按照如下方式去创建编辑器:
- 查找这个NcsProp对应的编辑器工厂(
EditorFn
) - 查找这个类型对应的编辑器工厂
NcsProp
对象
NcsProp对象在操作属性值方面,基本是只读的。要改变属性的值,通过NcsPropMgr::setValue()
来完成.
NcsProp::setValue() 只不过是个语法糖,内部还是调用的 Mgr的写接口.
拓展NcsPropTree
NcsPropTree可以在如下方面进行轻松扩展:
- 增加新的属性类别
- 新增独特的编辑器
新增类型
拓新类型时候,需要派生NcsPropMgr
, 然后在其中定义新的属性类型,重写setValue()
函数、addProperty()
函数,然后新的Mgr类型就能管理新类型了.
虽然Mgr不关心新类型的具体实现, 但是如果有必要,还是需要继承NcsProp,形成自己独特的类型实现, 典型的可以参见NcsColorProp
的实现.
新增编辑器并绑定
编辑器的例子可以参见NpLineEdit
,
- 可以为某个单独的NcsProp绑定一种编辑器,只需要通过
NcsPropMgr::setPropEditorFactory()
来绑定. - 可以为某个单独的类型绑定一种编辑器,只需要通过
NcsPropMgr::setTypeEditorFactory()
来绑定.
内嵌编辑器的例子参见class NpLineEdit
, 弹出式的例子参见ncsstringlistedit::NcsStringListEdit
的实现.
新增值装饰器并绑定
本功能有待实现,但是原理和新增编辑器相同.
与qtpropertytreeebrower不同的是,在NcsPropTree中,扩展将会更加轻松. 只需要ncspropmgr.h和ncspropedit.h 两个头文件即可以完成扩展.
安装教程
本模块可以直接放入工程中使用,也可以编译成DLL使用.
要编译成dll, 参见ncsppt_export.h中的说明.
使用说明
- 创建NcsPropMgr对象
- 利用NcsPropMgr::addProperty()添加各种类型的属性, 并得到属性对象的指针.
- 创建NcsPropTree对象,并将NcsPropMgr指针作为构造参数传入.
- 可以将这颗树嵌入其他widget或者单独弹出都可以.
注意: NcsPropMgr不支持遍历, 所以需要自己记下属性对象的指针.
示例代码参见 tst_ncsproptree.cpp::ncsproptree_demo()
鸣谢
-
感谢xmake团队提供帮助,本项目得以顺利用xmake来编译。
xmake是国产优秀的跨平台/交叉平台编译管理系统软件,生态位等同于cmake,但是由于采用成熟编程语言lua,可读性、开发便捷性和规范性都远超cmake.
xmake 地址 : xmake.io
-
感谢Qt业余交流群内各路神仙提供参考意见.