DtkWidget
DTK Widget module
载入中...
搜索中...
未找到
Public 槽 | Public 成员函数 | 所有成员列表
Dtk::Widget::DSettingsDialog类 参考

DSettingsDialog 为使用DSettings的Dtk程序提供一个通用的设置对话框，这个对话框可以通过json配置文件来自动生成 更多...

类 Dtk::Widget::DSettingsDialog 继承关系图:
Dtk::Widget::DAbstractDialog

Public 槽

void updateSettings (DTK_CORE_NAMESPACE::DSettings *settings)
 
void updateSettings (const QByteArray &translateContext, DTK_CORE_NAMESPACE::DSettings *settings)
 
void setGroupVisible (const QString &groupKey, bool visible)
 
- Public 槽 继承自 Dtk::Widget::DAbstractDialog
void moveToCenter ()
 将对话框移动至屏幕中央或其父控件的中央
 
void moveToTopRight ()
 将对话框移动至屏幕右上角或其父控件的右上角
 
void moveToCenterByRect (const QRect &rect)
 移动对话框到给定rect区域的中央。rect是移动对话框要参照的QRect区域
 
void moveToTopRightByRect (const QRect &rect)
 移动对话框到给定rect区域的右上角。rect是移动所需要参照的QRect位置。
 
void setDisplayPosition (DisplayPosition displayPosition)
 设置对话框显示位置
 

Public 成员函数

 DSettingsDialog (QWidget *parent=nullptr)
 
DSettingsWidgetFactory * widgetFactory () const
 获取当前对话框使用的控件构造工厂
 
bool groupIsVisible (const QString &groupKey) const
 
void setResetVisible (bool visible)
 DSettingsDialog::setResetV配置文件实例。isible 设置恢复默认设置按钮是否显示
 
void scrollToGroup (const QString &groupKey)
 DSettingsDialog::scrollToGroup 使对话框跳转到指定的 group 项目
 
void setIcon (const QIcon &icon)
 DSettingsDialog::setIcon 设置标题栏的图标 QIcon
 
- Public 成员函数 继承自 Dtk::Widget::DAbstractDialog
 DAbstractDialog (QWidget *parent=nullptr)
 构造一个DAbstractDialog实例
 
 DAbstractDialog (bool blurIfPossible, QWidget *parent=nullptr)
 构造一个 DAbstractDialog 实例
 
DisplayPosition displayPosition () const
 
void move (const QPoint &pos)
 将窗口移动到指定坐标
 
void move (int x, int y)
 将窗口移动到指定坐标
 
void setGeometry (const QRect &rect)
 构造一个矩形
 
void setGeometry (int x, int y, int width, int height)
 

额外继承的成员函数

- Public 类型 继承自 Dtk::Widget::DAbstractDialog
enum  DisplayPosition { Center , TopRight }
 对话框显示位置 更多...
 
enum  DisplayPostion { DisplayCenter = Center , DisplayTopRight = TopRight }
 
- 信号 继承自 Dtk::Widget::DAbstractDialog
void sizeChanged (QSize size)
 窗口大小发生改变
 
- Protected 成员函数 继承自 Dtk::Widget::DAbstractDialog
void mouseMoveEvent (QMouseEvent *event) Q_DECL_OVERRIDE
 对话框的鼠标移动事件
 
void mousePressEvent (QMouseEvent *event) Q_DECL_OVERRIDE
 对话框的鼠标点击事件
 
void mouseReleaseEvent (QMouseEvent *event) Q_DECL_OVERRIDE
 对话框的鼠标释放事件
 
void resizeEvent (QResizeEvent *event) Q_DECL_OVERRIDE
 窗口大小改变事件
 
void showEvent (QShowEvent *event) override
 窗口显示事件,如果收到过鼠标移动事件不再使用自动布局
 
 DAbstractDialog (DAbstractDialogPrivate &dd, QWidget *parent=nullptr)
 
- 属性 继承自 Dtk::Widget::DAbstractDialog
DisplayPosition displayPosition
 获取对话框显示位置
 

详细描述

DSettingsDialog 为使用DSettings的Dtk程序提供一个通用的设置对话框，这个对话框可以通过json配置文件来自动生成

示例程序

通过一个简单的示例来学会使用 DSettingsDialog ,这个示例要实现这样一个类似浏览器设置的需求 当打开新项目时的设置和打开新窗口/新标签时的设置

通过json文件来写设置的需求，如下：

settings.json

json设置了一个基础设置，分为 open_action 和 New Tab & Window 两块，两块又分别有其具体的两个设置， open_action 有一个是否总是在新窗口打开页面的设置和打开文件的设置，实现方式分别是 checkbox 和 combobox ； New Tab & Window 有一个新窗口打开的方式和新标签打开的方式两个设置，都是 combobox 实现。

其中实现控件除了checkbox、combobox还提供了lineedit, shortcut, spinbutton, buttongroup,radiogroup, slider, switchbutton,title1, title2，下文会在示例中一一展示

{
"groups": [{
"key": "base",
"name": "基础设置",
"groups": [{
"key": "setting1",
"name": "设置一",
"options": [{
"key": "checkbox_ex",
"type": "checkbox",
"text": "是否打开此选项",
"default": "true"
},
{
"key": "combobox_ex",
"type": "combobox",
"name": "请选择"
}]
},
{
"key": "setting2",
"name": "设置二",
"options": [{
"key": "lineedit_ex",
"type": "lineedit"
},
{
"key": "shortcut_ex",
"type": "shortcut"
}]
},
{
"key": "setting3",
"name": "设置三",
"options": [{
"key": "spinbutton_ex",
"type": "spinbutton"
},
{
"key": "buttongroup_ex",
"type": "buttongroup",
"items": ["yes","no"],
"default": 1
}]
},
{
"key": "setting4",
"name": "设置四",
"options": [{
"key": "slider_ex",
"type": "slider",
"max": 100,
"min": 0,
"default": 50
},
{
"key": "radiogroup_ex",
"type": "radiogroup",
"items": ["选项一","选项二"],
"default": 1
}]
},
{
"key": "setting5",
"name": "设置五",
"options": [{
"key": "switchbutton_ex",
"type": "switchbutton",
"name": "switchbutton"
},
{
"key": "title1_ex",
"type": "title1",
"text": "title1",
"default": "这是title1"
},
{
"key": "title2_ex",
"type": "title2",
"text": "title2",
"default": "这是title2"
},
{
"key": "icon-button",
"type": "icon-button"
}]
}]
}]
}

resources.qrc

json文件配置完后需要将其添加到资源文件 resources.qrc

<RCC>
<qresource prefix="/">
<file>settingsData/settings.json</file>
</qresource>
</RCC>

CMakeLists.txt

配置CMake

cmake_minimum_required(VERSION 3.1.0) # 指定cmake最低版本
project(example1 VERSION 1.0.0 LANGUAGES CXX) # 指定项目名称, 版本, 语言 cxx就是c++
set(CMAKE_CXX_STANDARD 11) # 指定c++标准
set(CMAKE_CXX_STANDARD_REQUIRED ON) # 指定c++标准要求,至少为11以上
set(target example1) # 指定目标名称
set(CMAKE_AUTOMOC ON) # support qt moc # 支持qt moc
set(CMAKE_AUTORCC ON) # support qt resource file # 支持qt资源文件
set(CMAKE_AUTOUIC ON) # support qt ui file # 支持qt ui文件(非必须)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # support clangd 支持 clangd
if (CMAKE_VERSION VERSION_LESS "3.7.0") # 如果cmake版本小于3.7.0
set(CMAKE_INCLUDE_CURRENT_DIR ON) # 设置包含当前目录
endif()
find_package(Qt5 COMPONENTS Widgets REQUIRED) # 寻找Qt5组件Widgets
find_package(Qt5 COMPONENTS Gui REQUIRED) # 寻找Qt5组件Gui
find_package(Dtk COMPONENTS Widget REQUIRED) # 寻找Dtk组件Widget
find_package(Dtk COMPONENTS Core REQUIRED) # 寻找Dtk组件Core
find_package(Dtk COMPONENTS Gui) # 寻找Dtk组件Gui
set(RESCOUCES resources.qrc) #设置资源文件变量名
add_executable(example1 # 添加可执行文件
${RESCOUCES} #添加资源文件
main.cpp
)
target_link_libraries(example1 PRIVATE
Qt5::Widgets
Qt5::Gui
dtkgui
dtkcore
dtkwidget
) # 链接库

main.cpp

代码部分

#include <DApplication>
#include <DMainWindow>
#include <DSettingsDialog>
#include <QTemporaryFile>
#include <DPushButton>
#include <QObject>
#include <DSettingsWidgetFactory>
#include <DSettingsOption>
#include <DIconButton>
#include "dtkcore_global.h"
#include <qsettingbackend.h>
DWIDGET_USE_NAMESPACE
DCORE_USE_NAMESPACE
int main(int argc, char *argv[]){
DApplication app(argc, argv);
DMainWindow win;
DPushButton *btn = new DPushButton("设置", &win); //初始化一个设置按钮
win.resize(800,600);
btn->move(0, 50);
//建立设置按钮的连接，点击按钮弹出设置页面
QObject::connect(btn, &QPushButton::clicked, &win, [&win](){
//初始化一个存储后端
QTemporaryFile tmpFile;
tmpFile.open();
QSettingBackend backend(tmpFile.fileName());
//从json中初始化配置
auto settings = DSettings::fromJsonFile(":/settingsData/settings.json");
settings->setBackend(&backend);
//初始化一个设置显示窗口
DSettingsDialog dsd(&win);
//如果自带控件不能满足需求，可自行注册控件，此处以一个Icon button为例
dsd.widgetFactory()->registerWidget("icon-button", [&win](QObject *obj){
DSettingsOption *option = qobject_cast<DSettingsOption *>(obj);
DIconButton *iconBtn = new DIconButton(DStyle::SP_DriveCDIcon);//新建一个icon button
return iconBtn;
});
dsd.updateSettings(settings); //将设置加载到设置窗口
dsd.exec(); //设置窗口显示并等待响应
});
win.show();
return app.exec();
}
Dtk::Widget::DApplication
DApplication 是 DTK 中用于替换 QCoreApplication 相关功能实现的类.
Definition dapplication.h:33
Dtk::Widget::DIconButton
按钮的图标
Definition diconbutton.h:24
Dtk::Widget::DMainWindow
The DMainWindow class provides a main application window.
Definition dmainwindow.h:20
Dtk::Widget::DSettingsDialog
DSettingsDialog 为使用DSettings的Dtk程序提供一个通用的设置对话框，这个对话框可以通过json配置文件来自动生成
Definition dsettingsdialog.h:19

运行程序，效果如下：

dsettingsdialog_example

成员函数说明

◆ scrollToGroup()

void DSettingsDialog::scrollToGroup ( const QString &  groupKey)

DSettingsDialog::scrollToGroup 使对话框跳转到指定的 group 项目

参数
[in]groupKeyDSettings 中 groupKeys 以及其子项 childGroups
注解
请在对话框 show() 以后调用

◆ setIcon()

void DSettingsDialog::setIcon ( const QIcon &  icon)

DSettingsDialog::setIcon 设置标题栏的图标 QIcon

参数
[in]icon设置的 Icon

◆ setResetVisible()

void DSettingsDialog::setResetVisible ( bool  visible)

DSettingsDialog::setResetV配置文件实例。isible 设置恢复默认设置按钮是否显示

参数
[in]visibletrue显示 false隐藏
注解
请在 updateSettings() 后调用

◆ widgetFactory()

DSettingsWidgetFactory * DSettingsDialog::widgetFactory ( ) const

获取当前对话框使用的控件构造工厂

每一个设置对话框都有自己的构造工厂实例，这些实例并不会共享数据。

返回
返回当前对话框使用的控件构造工厂
该类的文档由以下文件生成: