Debian Codegraph @

docs/src/dguiapplicationhelper.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @file dguiapplicationhelper.h
4
5 @class Dtk::Gui::DGuiApplicationHelper
6 @ingroup dtkgui
7 @brief DGuiApplicationHelper类提供了一个gui应用程序的应用帮助类,可提供widget和declarative的
8 公共gui功能,例如调色板、字体、主题等功能。
9 @details
10
11 @enum Dtk::Gui::DGuiApplicationHelper::SizeMode
12 @brief 控件大小模式枚举包含 dtk支持的控件大小模式种类.
13 | **值** | **含义** |
14 |:-----------:|:---------------------:|
15 | NormalMode | 普通模式,为默认模式 |
16 | CompactMode | 紧凑模式 |
17
18 @fn void DGuiApplicationHelper::newProcessInstance(qint64 pid, const QStringList &arguments)
19 @brief 通知新进程的信息。
20 @details
21 单例程序情况下,尝试启动新的程序实例将触发此信号,以便获取所传入的参数列表等信息,来进行进一步处理。
22
23 @param pid 进程 ID.
24 @param arguments 启动进程时所传入的参数列表.
25
26 @fn DGuiApplicationHelper::SizeMode DGuiApplicationHelper::sizeMode() const
27 @brief 当前应用的控件大小模式。
28 @details
29 - 若应用没有设置控件大小模式,则跟随系统的控件大小模式
30 - 用户也可以设置环境变量 D_DTK_SIZEMODE 来影响应用的大小模式的支持,`D_DTK_SIZEMODE=1`为指定为普通模式,
31 当应用没有显示设置控件大小模式,则会采用普通模式。
32 - 优先级为 `DGuiApplicationHelper::setSizeMode` > `D_DTK_SIZEMODE` > `System's SizeMode`。
33
34 @fn void DGuiApplicationHelper::setSizeMode(const DGuiApplicationHelper::SizeMode sizeMode)
35 @brief 设置应用控件大小模式,应用使用的为此模式,不再响应系统的控件大小模式。
36 @param sizeMode 需要设置的控件大小模式.
37
38 @fn void DGuiApplicationHelper::resetSizeMode()
39 @brief 重置设置应用控件大小模式,跟随系统的控件大小模式。
40
41 @fn static inline bool DGuiApplicationHelper::isCompactMode()
42 @brief 当前控件大小模式是否为紧凑模式。
43
44 @fn void DGuiApplicationHelper::applicationPaletteChanged()
45 @brief 通知调色板对象的改变。
46 @sa windowPalette()
47
48 @fn void DGuiApplicationHelper::sizeModeChanged(DGuiApplicationHelper::SizeMode sizeMode)
49 @brief 通知控件大小模式发生改变。
50
51 @fn static QStringList DGuiApplicationHelper::userManualPaths(const QString &appName)
52 @brief 获取帮助手册已存在目录
53 @param appName 目标应用名称
54 @detail 目录深度具体到appName层级,例:一个典型的目录路径为:/usr/share/deepin-manual/manual-assets/application/appName
55 */