| 1 |
@page dsettings dsettings--dtk设置工具组件 |
| 2 |
|
| 3 |
# DSettings |
| 4 |
|
| 5 |
## DSettings:dtk设置组件 |
| 6 |
|
| 7 |
[dsettings.h 详细文档](dsettings_8h.html) |
| 8 |
|
| 9 |
项目目录结构如下: |
| 10 |
|
| 11 |
```bash |
| 12 |
├── CMakeLists.txt |
| 13 |
├── data |
| 14 |
│ └── settings.json |
| 15 |
├── data.qrc |
| 16 |
└── main.cpp |
| 17 |
``` |
| 18 |
|
| 19 |
CMakeLists.txt: |
| 20 |
|
| 21 |
```cmake |
| 22 |
cmake_minimum_required(VERSION 3.1.0) # 指定cmake最低版本 |
| 23 |
|
| 24 |
project(dsetting-example VERSION 1.0.0 LANGUAGES CXX)# 指定项目名称, 版本, 语言 cxx就是c++ |
| 25 |
|
| 26 |
set(CMAKE_CXX_STANDARD 11) # 指定c++标准 |
| 27 |
set(CMAKE_CXX_STANDARD_REQUIRED ON) # 指定c++标准要求,至少为11以上 |
| 28 |
|
| 29 |
set(CMAKE_AUTORCC ON) # support qt resource file # 支持qt资源文件 |
| 30 |
|
| 31 |
set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # 支持 clangd |
| 32 |
|
| 33 |
if (CMAKE_VERSION VERSION_LESS "3.7.0") # 如果cmake版本小于3.7.0 |
| 34 |
set(CMAKE_INCLUDE_CURRENT_DIR ON) # 设置包含当前目录 |
| 35 |
endif() |
| 36 |
|
| 37 |
find_package(DtkCore REQUIRED) # 寻找Dtk组件Core |
| 38 |
|
| 39 |
add_executable(${PROJECT_NAME} # 生成可执行文件 |
| 40 |
main.cpp |
| 41 |
data.qrc |
| 42 |
) |
| 43 |
|
| 44 |
target_link_libraries(${PROJECT_NAME} PRIVATE # 添加需要链接的共享库 |
| 45 |
Dtk::Core |
| 46 |
) |
| 47 |
``` |
| 48 |
|
| 49 |
settings.json: |
| 50 |
|
| 51 |
```json |
| 52 |
{ |
| 53 |
"groups": [{ |
| 54 |
"key": "base", |
| 55 |
"name": "Basic settings", |
| 56 |
"groups": [{ |
| 57 |
"key": "open_action", |
| 58 |
"name": "Open Action", |
| 59 |
"options": [{ |
| 60 |
"key": "alway_open_on_new", |
| 61 |
"type": "checkbox", |
| 62 |
"text": "Always Open On New Windows", |
| 63 |
"default": true |
| 64 |
}, |
| 65 |
{ |
| 66 |
"key": "open_file_action", |
| 67 |
"name": "Open File:", |
| 68 |
"type": "combobox", |
| 69 |
"default": "" |
| 70 |
} |
| 71 |
] |
| 72 |
}, |
| 73 |
{ |
| 74 |
"key": "new_tab_windows", |
| 75 |
"name": "New Tab & Window", |
| 76 |
"options": [{ |
| 77 |
"key": "new_window_path", |
| 78 |
"name": "New Window Open:", |
| 79 |
"type": "combobox", |
| 80 |
"default": "" |
| 81 |
}, |
| 82 |
{ |
| 83 |
"key": "new_tab_path", |
| 84 |
"name": "New Tab Open:", |
| 85 |
"type": "combobox", |
| 86 |
"default": "" |
| 87 |
} |
| 88 |
] |
| 89 |
} |
| 90 |
] |
| 91 |
}] |
| 92 |
} |
| 93 |
``` |
| 94 |
|
| 95 |
data.qrc |
| 96 |
|
| 97 |
```xml |
| 98 |
<RCC> |
| 99 |
<qresource prefix="/"> |
| 100 |
<file>data/settings.json</file> |
| 101 |
</qresource> |
| 102 |
</RCC> |
| 103 |
``` |
| 104 |
|
| 105 |
main.cpp |
| 106 |
|
| 107 |
```cpp |
| 108 |
#include <QCoreApplication> |
| 109 |
#include <DSettings> |
| 110 |
#include <qsettingbackend.h> |
| 111 |
#include <DSettingsGroup> |
| 112 |
#include <DSettingsOption> |
| 113 |
#include <QTemporaryFile> |
| 114 |
#include <QDebug> |
| 115 |
|
| 116 |
DCORE_USE_NAMESPACE |
| 117 |
|
| 118 |
int main(int argc, char *argv[]) |
| 119 |
{ |
| 120 |
QCoreApplication a(argc, argv); |
| 121 |
|
| 122 |
// 初始化一个存储后端 |
| 123 |
QTemporaryFile tmpFile; |
| 124 |
tmpFile.open(); |
| 125 |
QPointer<QSettingBackend> backend = new QSettingBackend(tmpFile.fileName()); |
| 126 |
|
| 127 |
// 从json中初始化配置 |
| 128 |
QPointer<DSettings> settings = DSettings::fromJsonFile(":/data/settings.json"); |
| 129 |
settings->setBackend(backend); |
| 130 |
|
| 131 |
// 读取配置 |
| 132 |
// 该组中包含一个base的root组,两个子组: open_action/new_tab_windows,每个子组有包含若干选项。 |
| 133 |
// 对于"New Window Open:"这个配置,其完整的访问id为base.new_tab_windows.new_window_path。 |
| 134 |
QPointer<DSettingsOption> opt = settings->option("base.new_tab_windows.new_window_path"); |
| 135 |
qDebug() << opt->value(); |
| 136 |
|
| 137 |
// 修改配置 |
| 138 |
opt->setValue("Test"); |
| 139 |
qDebug() << opt->value(); |
| 140 |
|
| 141 |
// 获取所有keys |
| 142 |
QStringList keys = settings->keys(); |
| 143 |
qDebug() << keys; |
| 144 |
|
| 145 |
// base.open_action对应的组 |
| 146 |
QPointer<DSettingsGroup> group = settings->group("base.open_action"); |
| 147 |
qDebug() << group->key(); |
| 148 |
|
| 149 |
return a.exec(); |
| 150 |
} |
| 151 |
``` |
| 152 |
|
| 153 |
编译运行: |
| 154 |
|
| 155 |
```bash |
| 156 |
cmake -Bbuild |
| 157 |
cmake --build build |
| 158 |
./build/dsetting-example |
| 159 |
``` |
| 160 |
|
| 161 |
运行结果如下图: |
| 162 |
|
| 163 |
 |
| 164 |
|
| 165 |
@defgroup dsettings |
| 166 |
@brief dtk设置组件 |