Debian Codegraph @

docs/util/ddciicon.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @file include/util/ddciicon.h
4 @ingroup dci
5 @brief DCI图标类
6
7 @class Dtk::Gui::DDciIconImage ddciicon.h
8 @details 用于获取 dci 图标某种状态的图片资源(位图数据),同时支持静态图和动态图,接口的设计类似于 QImageReader,一般通过调用 DDciIcon::image 构造此对象。与 DDciIcon 配合使用,其所支持的图片格式与 DDciIcon::pixmap 接口一致,都取决于 Qt 图片插件系统(即 QImageReader)所提供的能力。
9 @sa DDciIcon::image
10
11 @fn Dtk::Gui::DDciIconImage::DDciIconImage()
12 @details 构造一个空的对象。
13
14 @fn Dtk::Gui::DDciIconImage::DDciIconImage(const DDciIconImage &other)
15 @details 根据 other 对象构造一个新的 DDciIconImage 对象,这个新的对象将与 other 共享 DDciIconImagePrivate 对象。
16
17 @fn Dtk::Gui::DDciIconImage::operator=(const DDciIconImage &other)
18 @details 对当前对象进行赋值,这将导致此对象与 other 共享 DDciIconImagePrivate 对象。
19
20 @fn Dtk::Gui::DDciIconImage::operator=(DDciIconImage &&other)
21 @details 对当前对象进行赋值,这将导致此对象与 other 两者的 DDciIconImagePrivate 对象被交换。
22 @sa DDciIconImage::swap
23
24 @fn Dtk::Gui::DDciIconImage::swap(DDciIconImage &other)
25 @details 交换两个对象的数据,这将导致两者的 DDciIconImagePrivate 对象被交换。
26
27 @fn Dtk::Gui::DDciIconImage::operator ==(const DDciIconImage &other) const
28 @details 如果两个对象引用了相同的 DDciIconImagePrivate 数据对象,则返回 true,否则返回 false。
29
30 @fn Dtk::Gui::DDciIconImage::operator !=(const DDciIconImage &other) const
31 @details 如果两个对象引用了不同的 DDciIconImagePrivate 数据对象,则返回 true,否则返回 false。
32
33 @fn Dtk::Gui::DDciIconImage::isNull() const
34 @details 如果此对象为空,则返回 true,否则返回 false。当对象为空时,调用其它成员函数将获得一个无效的结果。
35
36 @fn Dtk::Gui::DDciIconImage::reset()
37 @details 重置数据的状态,将清理所有的内部缓存数据,并且重置所有的状态记录,与重新调用 DDciIcon::image 获取一个新的对象后的状态相同。对于动画图片而言,这会导致 DDciIconImage::atBegin 变成 true,即动画将从第一帧重新开始。
38
39 @fn Dtk::Gui::DDciIconImage::toImage(const DDciIconPalette &palette) const
40 @details 对于静态图片,将读取图片数据,并加载为 QImage 对象返回。对于动态图片,将返回当前帧的位图数据,且多次调用时不会重新加载,将返回缓存的 QImage 对象,另外需要注意的时,与 QImageReader::read 的不同,在调用此函数读取当前帧后,并不会自动跳转到下一帧,即在未调用 DDciIconImage::jumpToNextImage 时,多次调用此函数将返回同一帧。
41 @param[in] palette 如果此图片支持指定调色板,则将根据传入的 DDciIconPalette 中指定的颜色对图片进行加工。详情请参见 DSG 标准中的 DCI 图片格式设计。
42 @sa DDciIconImage::hasPalette DDciIconImage::paint
43
44 @fn Dtk::Gui::DDciIconImage::paint(QPainter *painter, const QRectF &rect, Qt::Alignment alignment, const DDciIconPalette &palette) const
45 @details 将图片的位图数据通过传入的画笔进行绘制。
46 @param[in] painter 指定画笔对象。
47 @param[in] rect 指定绘制区域,此区域相对于画笔所对应的 QPainter::paintDevice(),如果此区域的宽度比图片的宽度小,则会在绘制时将图片缩小到此区域的大小,反之则保持图片自身大小,而不会知道图片被放大。
48 @param[in] alignment 指定绘制时图片相对于 rect 所指定区域的位置,即当图片宽度小于 rect 所指定的宽度时,将根据此参数决定图片的显示位置。
49 @param[in] palette 如果此图片支持指定调色板,则将根据传入的 DDciIconPalette 中指定的颜色对图片进行加工。详情请参见 DSG 标准中的 DCI 图片格式设计。
50 @sa DDciIconImage::toImage
51
52 @fn Dtk::Gui::DDciIconImage::hasPalette() const
53 @details 如果此图片支持指定调色板,则返回 true,否则返回 false。
54
55 @fn Dtk::Gui::DDciIconImage::supportsAnimation() const
56 @details 如果此图片支持动画,则返回 true,否则返回 false。
57
58 @fn Dtk::Gui::DDciIconImage::atBegin() const
59 @details 如果此图片支持动画且动画处于第一帧,则返回 true,否则返回 false。
60
61 @fn Dtk::Gui::DDciIconImage::atEnd() const
62 @details 如果此图片支持动画且动画处于最后一帧,则返回 true,否则返回 false。
63
64 @fn Dtk::Gui::DDciIconImage::jumpToNextImage()
65 @details 将动画跳转到下一帧,如果此图片支持动画且当前不是最后一帧,则返回 true,否则返回 false。
66
67 @fn Dtk::Gui::DDciIconImage::loopCount() const
68 @details 返回动画的轮播次数,如果此图片不支持动画,则返回值无效。如果返回值为 -1,则表明此动画需要无限循环播放。
69
70 @fn Dtk::Gui::DDciIconImage::maxImageCount() const
71 @details 返回动画的最大帧数,如果当前图片有多层且每一层都支持动画,则是所有动画帧数的累加,因此多个动画的播放时间会可能会有重叠的帧,所以无法确保播放此图片时一定能显示这么多帧,动画是否结束需要以 DDciIconImage::atEnd 的返回结果为准。如果此图片不支持动画,则返回值无效。
72
73 @fn Dtk::Gui::DDciIconImage::currentImageDuration() const
74 @details 返回当前动画帧的持续时间,单位为毫秒。如果此图片不支持动画,则返回值无效。
75
76 @fn Dtk::Gui::DDciIconImage::currentImageNumber() const
77 @details 返回动画已经播放到的帧的序号,此值一定小于 DDciIconImage::maxImageCount - 1。如果此图片不支持动画,则返回值无效。
78
79 @class Dtk::Gui::DDciIcon ddciicon.h
80 @details 如果需要详细dci相关介绍以及规范文档, 可以参见[dci文件图标规范](https://github.com/linuxdeepin/deepin-specifications/blob/master/unstable/%E5%9B%BE%E6%A0%87%E6%96%87%E4%BB%B6%E8%A7%84%E8%8C%83.md)
81
82 ## DDciIcon示例
83 项目目录结构在同一目录下
84
85 ## CMakeLists.txt
86 ```cmake
87 cmake_minimum_required(VERSION 3.1.0) # 指定cmake最低版本
88
89 project(ddciicon-example VERSION 1.0.0 LANGUAGES CXX) # 指定项目名称, 版本, 语言 cxx就是c++
90
91 set(CMAKE_CXX_STANDARD 11) # 指定c++标准
92 set(CMAKE_CXX_STANDARD_REQUIRED ON) # 指定c++标准要求,至少为11以上
93
94 set(CMAKE_AUTOMOC ON) # 支持qt moc
95 set(CMAKE_AUTORCC ON) # support qt resource file # 支持qt资源文件
96
97 set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # 支持 clangd
98
99 if (CMAKE_VERSION VERSION_LESS "3.7.0") # 如果cmake版本小于3.7.0
100 set(CMAKE_INCLUDE_CURRENT_DIR ON) # 设置包含当前目录
101 endif()
102
103 find_package(Qt5 REQUIRED COMPONENTS Core) # 寻找Qt5组件Core
104 find_package(Qt5 REQUIRED COMPONENTS Gui) # 寻找Qt5组件Core
105 find_package(Qt5 REQUIRED COMPONENTS Widgets) # 寻找Qt5组件Widgets
106 find_package(DtkCore REQUIRED) # 寻找Dtk组件Core
107 find_package(Dtk REQUIRED COMPONENTS Gui) # 寻找Dtk组件Gui
108 find_package(Dtk REQUIRED COMPONENTS Widget) # 寻找Dtk组件Widget
109
110 add_executable(${PROJECT_NAME} # 生成可执行文件
111 main.cpp
112 qml.qrc
113 )
114
115 target_link_libraries(${PROJECT_NAME} PRIVATE # 添加需要链接的共享库
116 Qt5::Core
117 Qt5::Gui
118 Qt5::Widgets
119 Dtk::Core
120 dtkgui
121 dtkwidget
122 )
123 ```
124
125 ## main.cpp
126 ```cpp
127 #include <DApplication>
128 #include <DWidgetUtil>
129 #include <DIconButton>
130 #include <DDciIcon>
131 #include <QtDebug>
132 #include <QFormLayout>
133 #include <DMainWindow>
134 #include <QWidget>
135 #include <QLabel>
136 #include <QHBoxLayout>
137
138 DWIDGET_USE_NAMESPACE
139
140 int main(int argc, char *argv[])
141 {
142 DApplication a(argc, argv);
143 DMainWindow win;
144
145 QWidget w;
146 QFormLayout* layout = new QFormLayout(&w);
147
148 // fromTheme表示从图标主题中寻找资源。
149 DDciIcon dci = DDciIcon::fromTheme("select_indicator");
150
151 auto icon = dci.matchIcon(0, DDciIcon::Light, DDciIcon::Hover);
152 qDebug() << "DCI图标的实际大小" << dci.actualSize(icon);
153
154 // 定义一个函数,传入DIconButton,以及提示信息
155 auto addBtnRow = [&](DIconButton *iconBtn, const QString name){
156 iconBtn->setIconSize(QSize(32,32));
157 QHBoxLayout *hlayout = new QHBoxLayout();
158 hlayout->addWidget(iconBtn);
159 QLabel *btnLabel = new QLabel(name);
160 hlayout->addWidget(btnLabel);
161 return hlayout;
162 };
163
164 // 将DDciIcon传入DIconButton
165 DIconButton *iconBtn1 = new DIconButton(dci);
166 layout->addRow(addBtnRow(iconBtn1, "icon button"));
167
168 DIconButton *iconBtn2 = new DIconButton(dci);
169 iconBtn2->setDisabled(true);
170 layout->addRow(addBtnRow(iconBtn2, "disabled state"));
171
172 DIconButton *iconBtn3 = new DIconButton(dci);
173 iconBtn3->setDown(true);
174 layout->addRow(addBtnRow(iconBtn3, "pressed state"));
175
176 win.setCentralWidget(&w);
177 win.resize(200,100);
178 win.show();
179 Dtk::Widget::moveToCenter(&win);
180 return a.exec();
181 }
182 ```
183
184 ## qml.qrc
185 ```xml
186 <RCC>
187 <qresource prefix="/dsg/built-in-icons">
188 <file>select_indicator.dci</file>
189 </qresource>
190 </RCC>
191 ```
192
193 ## select_indicator.dci
194 下载dci-demo解压获取,这是个用qml编写的例子,使用DDciIcon更灵活
195 [dci-demo](https://github.com/linuxdeepin/deepin-specifications/blob/master/unstable/dci-demo.zip)
196
197 编译和运行程序
198 ```bash
199 cmake -B build
200 cmake --build build
201 ./build/ddciicon-example
202 ```
203
204 程序运行效果如下:
205 ![ddciicon-example](/docs/images/ddciicon-example1.jpg)
206
207 @enum Dtk::Gui::DDciIcon::Mode
208 @brief DCI图标模式
209 @details
210 | 键 | 值 |
211 |:--------:|:---:|
212 | Normal | 0 |
213 | Disabled | 1 |
214 | Hover | 2 |
215 | Pressed | 3 |
216
217
218 @enum Dtk::Gui::DDciIcon::Theme
219 @brief DCI图标主题
220 @details
221 | 键 | 值 |
222 |:-----:|:---:|
223 | Light | 0 |
224 | Dark | 1 |
225
226 @enum Dtk::Gui::DDciIcon::IconAttribute
227 @brief DCI图标属性
228 @details
229 | 键 | 值 |
230 |:-----:|:---:|
231 | HasPalette | 0x001 |
232 这个属性为了获取dci图标的图层是否包含调色板颜色调整, 比如某一个图层的图片的需要用高亮色的填充就是 HasPalette, 这个高亮色还可以调整亮度饱和度rgba等参数
233
234 @enum Dtk::Gui::DDciIcon::IconMatchedFlag
235 @brief DCI图标匹配参数
236 @var DDciIcon::None
237 @brief 空,无含义
238 @var DDciIcon::DontFallbackMode
239 @brief 在查找图片资源时,如果指定的 mode 不存在,则禁止回退,直接当作查找不到处理
240 @var DDciIcon::RegardPaddingsAsSize
241 @brief 将图层中携带的 paddings 属性算作图层大小的一部分,这会影响图片匹配时的大小判断
242
243 @fn Dtk::Gui::DDciIcon::DDciIcon()
244 @brief 构造函数
245
246 @fn Dtk::Gui::DDciIcon::DDciIcon(const DCORE_NAMESPACE::DDciFile *dciFile)
247 @brief 指定DCI文件的构造函数
248
249 @fn Dtk::Gui::DDciIcon(const QString &fileName)
250 @brief 指定DCI文件名的构造函数
251
252 @fn Dtk::Gui::DDciIcon::DDciIcon(const QByteArray &data)
253 @brief 指定DCI文件数据的构造函数
254
255 @fn Dtk::Gui::DDciIcon::DDciIcon(const DDciIcon &other)
256 @brief 拷贝构造函数,重载赋值运算符
257
258 @fn Dtk::Gui::DDciIcon::swap(DDciIcon &other)
259 @brief 交换两个DDciIcon对象
260
261 @fn bool Dtk::Gui::DDciIcon::isNull() const
262 @brief 判断DCI图标是否为空
263
264 @fn DDciIconMatchResult Dtk::Gui::DDciIcon::matchIcon(int size, Theme theme, Mode mode, IconMatchedFlags flags = None) const
265 @brief 获取DCI图标匹配元信息, 元信息仅能作为传入参数使用
266 @param[in] size 图标大小
267 @param[in] theme 图标主题
268 @param[in] mode 图标模式
269 @param[in] flags 图标匹配标志
270
271 @fn int Dtk::Gui::DDciIcon::actualSize(DDciIconMatchResult result) const
272 @brief 获取DCI图标实际大小
273 @param[in] result DCI图标匹配结果
274
275 @fn int Dtk::Gui::DDciIcon::actualSize(int size, Theme theme, Mode mode =Normal) const
276 @brief 获取DCI图标实际大小
277 @details 该函数会根据传入的参数获取DCI图标匹配结果,然后调用actualSize(DDciIconMatchResult result)函数获取DCI图标实际大小
278 @sa DDciIcon::actualSize(DDciIconMatchResult result)
279
280 @fn QList<int> Dtk::Gui::DDciIcon::availableSizes(Theme theme, Mode mode=Normal) const
281 @brief 获取DCI图标可用大小列表
282 @param[in] theme 图标主题
283 @param[in] mode 图标模式,默认为Normal
284
285 @fn bool Dtk::Gui::DDciIcon::isSupportedAttribute(DDciIconMatchResult result, IconAttribute attr)
286 @brief 判断DCI图标是否支持指定属性
287 @param[in] result DCI图标匹配结果
288 @param[in] attr 图标属性
289
290 @fn QPixmap Dtk::Gui::DDciIcon::pixmap(qreal devicePixelRatio, int iconSize, Theme theme, Mode mode = Normal,const DDciIconPalette &palette = DDciIconPalette()) const
291 @brief 获取DCI图标的QPixmap
292 @param[in] devicePixelRatio 设备像素比
293 @param[in] iconSize 图标大小
294 @param[in] theme 图标主题
295 @param[in] mode 图标模式, 默认为Normal
296 @param[in] palette 图标调色板,默认为无(空)调色板
297
298 @fn QPixmap Dtk::Gui::DDciIcon::pixmap(qreal devicePixelRatio, int iconSize, DDciIconMatchResult result, const DDciIconPalette &palette = DDciIconPalette()) const
299 @brief 获取DCI图标的QPixmap
300 @param[in] devicePixelRatio 设备像素比
301 @param[in] iconSize 图标大小
302 @param[in] result DCI图标匹配结果
303 @param[in] palette 图标调色板, 默认为无(空)调色板
304
305 @fn void Dtk::Gui::DDciIcon::paint(QPainter *painter, const QRect &rect, qreal devicePixelRatio, Theme theme, Mode mode = Normal, Qt::Alignment alignment = Qt::AlignCenter, const DDciIconPalette &palette = DDciIconPalette()) const
306 @brief 绘制DCI图标
307 @param[in] painter QPainter对象
308 @param[in] rect 绘制区域
309 @param[in] devicePixelRatio 设备像素比
310 @param[in] theme 图标主题
311 @param[in] mode 图标模式, 默认为Normal
312 @param[in] alignment 对齐方式, 默认为Qt::AlignCenter
313 @param[in] palette 图标调色板, 默认为无(空)调色板
314
315 @fn void Dtk::Gui::DDciIcon::paint(QPainter *painter, const QRect &rect, qreal devicePixelRatio, DDciIconMatchResult result, Qt::Alignment alignment = Qt::AlignCenter, const DDciIconPalette &palette = DDciIconPalette()) const
316 @brief 绘制DCI图标
317 @param[in] painter QPainter对象
318 @param[in] rect 绘制区域
319 @param[in] devicePixelRatio 设备像素比
320 @param[in] result DCI图标匹配结果
321 @param[in] alignment 对齐方式, 默认为Qt::AlignCenter
322 @param[in] palette 图标调色板, 默认为无(空)调色板
323
324 @fn Dtk::Gui::DDciIcon::image(DDciIconMatchResult result, int size, qreal devicePixelRatio) const
325 @details 构造一个 DDciIconImage 对象
326 @param[in] result 匹配到的图片结果,将根据此匹配结果查找对应的图片数据。
327 @param[in] size 期望获取到的图片大小,将根据此大小寻找最为接近的图片资源,当图片大小与传入的大小不一致时,将优先返回一个稍大的图片。
328 @param[in] devicePixelRatio 期望获取到的图片的缩放比例,将根据其寻找最为接近的图片资源,当无法找到指定比例的图片时,将优先返回一个稍大比例的图片。
329 @sa DDciIcon::matchIcon
330
331 @fn static DDciIcon Dtk::Gui::DDciIcon::fromTheme(const QString &name)
332 @brief 从dci图标主题(包括内置dci图标资源)中获取图标名字为name的图标
333 @param[in] name DCI图标名称
334
335 @fn static DDciIcon Dtk::Gui::DDciIcon::fromTheme (const QString &name, const DDciIcon &fallback)
336 @brief 从dci图标主题(包括内置dci图标资源)中获取图标名字为name的图标
337 @param[in] name DCI图标名称
338 @param[in] fallback 当图标名为 name 的图标找不到时, fallback 到 fallback 的这个dci图标
339
340 */