| 1 |
/*! |
| 2 |
@~chinese |
| 3 |
@file include/util/ddesktopservices.h |
| 4 |
@ingroup DesktopServices |
| 5 |
@brief Dtk 提供常见桌面服务的方法工具类 |
| 6 |
|
| 7 |
@namespace Dtk::Gui::DDesktopServices ddesktopservices.h |
| 8 |
@details 用于提供一些接口,包括在文件管理器中显示目录,显示文件,显示文件属性,移入回收站,播放系统音效等。 |
| 9 |
|
| 10 |
@enum Dtk::Gui::DDesktopServices::SystemSoundEffect |
| 11 |
@brief 系统音效的枚举 |
| 12 |
@var Dtk::Gui::DDesktopServices::SSE_Notifications |
| 13 |
@brief 显示通知的音效 |
| 14 |
@var Dtk::Gui::DDesktopServices::SEE_Screenshot |
| 15 |
@brief 截屏的音效 |
| 16 |
@var Dtk::Gui::DDesktopServices::SSE_EmptyTrash |
| 17 |
@brief 清空回收站的音效 |
| 18 |
@var Dtk::Gui::DDesktopServices::SSE_SendFileComplete |
| 19 |
@brief 完成发送文件(到桌面)的音效 |
| 20 |
@var Dtk::Gui::DDesktopServices::SSE_BootUp |
| 21 |
@brief 开机的音效 |
| 22 |
@var Dtk::Gui::DDesktopServices::SSE_Shutdown |
| 23 |
@brief 关机的音效 |
| 24 |
@var Dtk::Gui::DDesktopServices::SSE_Logout |
| 25 |
@brief 注销的音效 |
| 26 |
@var Dtk::Gui::DDesktopServices::SSE_WakeUp |
| 27 |
@brief 唤醒的音效 |
| 28 |
@var Dtk::Gui::DDesktopServices::SSE_VolumeChange |
| 29 |
@brief 音量调节的音效 |
| 30 |
@var Dtk::Gui::DDesktopServices::SSE_LowBattery |
| 31 |
@brief 低电量的音效 |
| 32 |
@var Dtk::Gui::DDesktopServices::SSE_PlugIn |
| 33 |
@brief 电源接入的音效 |
| 34 |
@var Dtk::Gui::DDesktopServices::SSE_PlugOut |
| 35 |
@brief 电源移除的音效 |
| 36 |
@var Dtk::Gui::DDesktopServices::SSE_DeviceAdded |
| 37 |
@brief 移动设备接入的音效 |
| 38 |
@var Dtk::Gui::DDesktopServices::SSE_DeviceRemoved |
| 39 |
@brief 移动设备移除的音效 |
| 40 |
@var Dtk::Gui::DDesktopServices::SSE_Error |
| 41 |
@brief 错误提示的音效 |
| 42 |
|
| 43 |
@fn Dtk::Gui::DDesktopServices::showFolder(const QString &localFilePath, const QString &startupId = QString()) |
| 44 |
@details 通过文件管理器显示目录 |
| 45 |
@param[in] localFilePath 要显示的目录路径 |
| 46 |
@param[in] startupId 本次启动的id, 默认为空 |
| 47 |
@return 调用成功返回 true, 否则返回 false |
| 48 |
|
| 49 |
@fn Dtk::Gui::DDesktopServices::showFolders(const QList<QString> &localFilePaths, const QString &startupId = QString()) |
| 50 |
@details 通过文件管理器显示多个目录 |
| 51 |
@param[in] localFilePaths 要显示的目录路径列表 |
| 52 |
@param[in] startupId 本次启动的id, 默认为空 |
| 53 |
@return 调用成功返回 true, 否则返回 false |
| 54 |
|
| 55 |
@fn Dtk::Gui::DDesktopServices::showFolder(const QUrl &url, const QString &startupId = QString()) |
| 56 |
@details 通过文件管理器显示目录 |
| 57 |
@param[in] url 要显示的目录 QUrl 形式路径 |
| 58 |
@param[in] startupId 本次启动的id, 默认为空 |
| 59 |
@return 调用成功返回 true, 否则返回 false |
| 60 |
|
| 61 |
@fn Dtk::Gui::DDesktopServices::showFolders(const QList<QUrl> &urls, const QString &startupId = QString()) |
| 62 |
@details 通过文件管理器显示多个目录 |
| 63 |
@param[in] urls 要显示的目录路径 url 列表 |
| 64 |
@param[in] startupId 本次启动的id, 默认为空 |
| 65 |
@return 调用成功返回 true, 否则返回 false |
| 66 |
|
| 67 |
@fn Dtk::Gui::DDesktopServices::showFileItemProperty(const QString &localFilePath, const QString &startupId = QString()) |
| 68 |
@details 通过文件管理器显示文件的属性 |
| 69 |
@param[in] localFilePath 要显示的文件路径 |
| 70 |
@param[in] startupId 本次启动的id, 默认为空 |
| 71 |
@return 调用成功返回 true, 否则返回 false |
| 72 |
|
| 73 |
@fn Dtk::Gui::DDesktopServices::showFileItemProperties(const QList<QString> &localFilePaths, const QString &startupId = QString()) |
| 74 |
@details 通过文件管理器显示多个文件的属性 |
| 75 |
@param[in] localFilePaths 要显示的文件路径列表 |
| 76 |
@param[in] startupId 本次启动的id, 默认为空 |
| 77 |
@return 调用成功返回 true, 否则返回 false |
| 78 |
|
| 79 |
@fn Dtk::Gui::DDesktopServices::showFileItemProperty(const QUrl &url, const QString &startupId = QString()) |
| 80 |
@details 通过文件管理器显示文件的属性 |
| 81 |
@param[in] url 要显示的文件 QUrl 形式路径 |
| 82 |
@param[in] startupId 本次启动的id, 默认为空 |
| 83 |
@return 调用成功返回 true, 否则返回 false |
| 84 |
|
| 85 |
@fn Dtk::Gui::DDesktopServices::showFileItemProperties(const QList<QUrl> &urls, const QString &startupId = QString()) |
| 86 |
@details 通过文件管理器显示多个文件的属性 |
| 87 |
@param[in] urls 要显示的目录路径 url 列表 |
| 88 |
@param[in] startupId 本次启动的id, 默认为空 |
| 89 |
@return 调用成功返回 true, 否则返回 false |
| 90 |
|
| 91 |
@fn Dtk::Gui::DDesktopServices::showFileItem(const QString &localFilePath, const QString &startupId = QString()) |
| 92 |
@details 通过文件管理器在父目录中显示并选中文件(目录) |
| 93 |
@param[in] localFilePath 要显示(选中)的文件(目录)路径 |
| 94 |
@param[in] startupId 本次启动的id, 默认为空 |
| 95 |
@return 调用成功返回 true, 否则返回 false |
| 96 |
|
| 97 |
@fn Dtk::Gui::DDesktopServices::showFileItems(const QList<QString> &localFilePaths, const QString &startupId = QString()) |
| 98 |
@details 通过文件管理器父目录中显示并选中多个文件(目录) |
| 99 |
@param[in] localFilePaths 要显示(选中)的文件(目录)路径列表 |
| 100 |
@param[in] startupId 本次启动的id, 默认为空 |
| 101 |
@return 调用成功返回 true, 否则返回 false |
| 102 |
|
| 103 |
@fn Dtk::Gui::DDesktopServices::showFileItem(const QUrl &url, const QString &startupId = QString()) |
| 104 |
@details 通过文件管理器在父目录中显示并选中文件(目录) |
| 105 |
@param[in] url 要显示(选中)的文件(目录)QUrl 形式路径 |
| 106 |
@param[in] startupId 本次启动的id, 默认为空 |
| 107 |
@return 调用成功返回 true, 否则返回 false |
| 108 |
|
| 109 |
@fn Dtk::Gui::DDesktopServices::showFileItems(const QList<QUrl> &urls, const QString &startupId = QString()) |
| 110 |
@details 通过文件管理器父目录中显示并选中多个文件(目录) |
| 111 |
@param[in] urls 要显示选中)的文件(目录)路径 url 列表 |
| 112 |
@param[in] startupId 本次启动的id, 默认为空 |
| 113 |
@return 调用成功返回 true, 否则返回 false |
| 114 |
|
| 115 |
@fn Dtk::Gui::DDesktopServices::trash(const QString &localFilePath) |
| 116 |
@details 通过文件管理器将文件移入回收站 |
| 117 |
@param[in] localFilePath 要移入回收站的文件路径 |
| 118 |
@return 调用成功返回 true, 否则返回 false |
| 119 |
|
| 120 |
@fn Dtk::Gui::DDesktopServices::trash(const QList<QString> &localFilePaths) |
| 121 |
@details 通过文件管理器将多个文件移入回收站 |
| 122 |
@param[in] localFilePaths 要移入回收站的文件路径列表 |
| 123 |
@return 调用成功返回 true, 否则返回 false |
| 124 |
|
| 125 |
@fn Dtk::Gui::DDesktopServices::trash(const QUrl &url) |
| 126 |
@details 通过文件管理器将文件移入回收站 |
| 127 |
@param[in] url 要移入回收站的文件 url 路径 |
| 128 |
@return 调用成功返回 true, 否则返回 false |
| 129 |
|
| 130 |
@fn Dtk::Gui::DDesktopServices::trash(const QList<QUrl> &urls) |
| 131 |
@details 通过文件管理器将多个文件移入回收站 |
| 132 |
@param[in] urls 要移入回收站的文件路径 url 列表 |
| 133 |
@return 调用成功返回 true, 否则返回 false |
| 134 |
|
| 135 |
@fn Dtk::Gui::DDesktopServices::playSystemSoundEffect(const SystemSoundEffect &effect) |
| 136 |
@details 播放系统音效。如果系统音效被禁用或者要播放音效被禁用将播放失败 |
| 137 |
@param[in] effect 要播放的音效,见枚举 Dtk::Gui::DDesktopServices::SystemSoundEffect |
| 138 |
@return 调用成功返回 true, 否则返回 false |
| 139 |
|
| 140 |
@fn Dtk::Gui::DDesktopServices::playSystemSoundEffect(const QString &name) |
| 141 |
@details 根据音效名播放系统音效。如果系统音效被禁用或者要播放音效被禁用将播放失败 |
| 142 |
@param[in] name 要播放的音效名称,见 Dtk::Gui::DDesktopServices::getNameByEffectType |
| 143 |
@return 调用成功返回 true, 否则返回 false |
| 144 |
|
| 145 |
@fn Dtk::Gui::DDesktopServices::previewSystemSoundEffect(const SystemSoundEffect &effect) |
| 146 |
@details 系统音效预览。 |
| 147 |
@param[in] effect 要播放的音效,见枚举 Dtk::Gui::DDesktopServices::SystemSoundEffect |
| 148 |
@return 调用成功返回 true, 否则返回 false |
| 149 |
|
| 150 |
@fn Dtk::Gui::DDesktopServices::previewSystemSoundEffect(const QString &name) |
| 151 |
@details 根据音效名预览系统音效。 |
| 152 |
@param[in] name 要播放的音效名称,见 Dtk::Gui::DDesktopServices::getNameByEffectType |
| 153 |
@return 调用成功返回 true, 否则返回 false |
| 154 |
|
| 155 |
@fn Dtk::Gui::DDesktopServices::getNameByEffectType(const SystemSoundEffect &effect) |
| 156 |
@details 根据音效名预览系统音效。 |
| 157 |
@param[in] effect 要获取名称的音效,见枚举 Dtk::Gui::DDesktopServices::SystemSoundEffect |
| 158 |
@return QString effect 对应的音效名称 |
| 159 |
|
| 160 |
@fn Dtk::Gui::DDesktopServices::errorMessage() |
| 161 |
@details 文件管理器相关调用出错时可以通过此接口获取错误信息 |
| 162 |
@return 错误信息 |
| 163 |
|
| 164 |
*/ |