diff --git a/docs/images/DToolTip_example.png b/docs/images/DToolTip_example.png new file mode 100644 index 000000000..41efcf9e8 Binary files /dev/null and b/docs/images/DToolTip_example.png differ diff --git a/docs/widgets/dtooltip.zh_CN.dox b/docs/widgets/dtooltip.zh_CN.dox index 822113377..a016eb61c 100644 --- a/docs/widgets/dtooltip.zh_CN.dox +++ b/docs/widgets/dtooltip.zh_CN.dox @@ -2,11 +2,80 @@ @~chinese @file dtooltip.h @ingroup tooltip -@class -@brief -@details +@class Dtk::Widget::DToolTip +@brief 类似于 QToolTip 功能的类 +@details 用于在指定位置显示工具提示信息 -TODO: 添加类简介、示例代码、示例截图和函数使用说明等 +### 示例代码 +#### main.cpp +```cpp +#include +#include +#include +#include +DWIDGET_USE_NAMESPACE + +int main(int argc, char *argv[]) +{ + DApplication app(argc, argv); + DMainWindow window; + window.setMinimumSize(QSize(300, 200)); + + QWidget *centralWidget = new QWidget(&window); + QVBoxLayout *layout = new QVBoxLayout(centralWidget); + + QString Content = "这是一条提示消息"; // 设置提示信息文本，斜体，加粗，下划线，可根据所需添加 + DToolTip *tool = new DToolTip(Content, false); // bool completionClose 提示消息消失后是否销毁 + tool->setToolTipTextFormat(Qt::PlainText); // 设置纯文本格式，如有等需求可以选择RichText等格式 + tool->setToolTipShowMode(tool,DToolTip::Default); // 设置显示模式 + QPoint pos(200,200); + tool->show(pos,5000); // 设置提示消息出现的位置与时间 + layout->addWidget(tool); + + window.setCentralWidget(centralWidget); + window.show(); + + return app.exec(); +} +``` +@image html DToolTip_example.png + +@fn void DToolTip::setToolTipTextFormat(Qt::TextFormat format) +@brief 设置 ToolTip 的文本格式 +通过给定参数 format , 将 DStyle 内部中的 ToolTip 文本格式设置为指定的样式 +@param[in] format 文本格式 +@sa Qt::TextFormat + +@fn Qt::TextFormat DToolTip::toolTipTextFormat() +@brief 获取 ToolTip 文本格式 +@return 返回 DStyle 内部使用的 ToolTip 文本格式 +@sa Qt::TextFormat + +@fn void DToolTip::setToolTipShowMode(QWidget *widget, ToolTipShowMode mode) +@brief 设置 ToolTip 显示模式 +@param[in] widget 获取 ToolTip 显示模式的控件 +@param[in] mode ToolTip 显示模式 + +@fn DToolTip::ToolTipShowMode DToolTip::toolTipShowMode(const QWidget *widget) +@brief 获取 ToolTip 显示模式 +@param[in] widget 获取 ToolTip 显示模式的控件 +@return ToolTip 显示模式 + +@fn DToolTip::DToolTip(const QString &text, bool completionClose) +@brief DToolTip的构造函数 +@param[in] text 文本信息 +@param[in] completionClose 提示消息消失后是否销毁 + +@fn QSize DToolTip::sizeHint() const +@brief 获取 ToolTip 控件的推荐大小 +@return ToolTip 控件的推荐大小 +@sa QLabel::sizeHint() + +@fn void DToolTip::show(const QPoint &pos, int duration) +@brief 设置提示消息出现的位置 +@param[in] pos 提示消息位置 +@param[in] duration 提示消息存在时间，单位毫秒 */ + diff --git a/src/widgets/dtooltip.cpp b/src/widgets/dtooltip.cpp index 94143b3c6..da3a407c4 100644 --- a/src/widgets/dtooltip.cpp +++ b/src/widgets/dtooltip.cpp @@ -26,23 +26,21 @@ static Qt::TextFormat textFormat = Qt::TextFormat::AutoText; } /*! - \brief 设置 tooltip 的文本格式. - - 通过给定 \a format , 将 DStyle 内部中的 ToolTip - 文本格式设置为 \a format 指定的样式。 - - \sa Qt::TextFormat +@~english + @brief set the Tooltip text format + Set the Tooltip text format inside DStyle to the specified style by setting format. + @param[in] format text format + @sa Qt::TextFormat */ void DToolTip::setToolTipTextFormat(Qt::TextFormat format) { DToolTipStatic::textFormat = format; } /*! - \brief 获取 tooltip 文本格式. - - \return 返回 DStyle 内部使用的 ToolTip 文本格式。 - - \sa Qt::TextFormat +@~english + @brief get the Tooltip text format + @return Tooltip text format used inside DStyle + @sa Qt::TextFormat */ Qt::TextFormat DToolTip::toolTipTextFormat() { @@ -50,9 +48,10 @@ Qt::TextFormat DToolTip::toolTipTextFormat() } /*! +@~english * @brief DToolTip::setToolTipShowMode - * @param widget widget to set ToolTip show mode - * @param mode ToolTip show mode + * @param[in] widget widget to set ToolTip show mode + * @param[in] mode ToolTip show mode */ void DToolTip::setToolTipShowMode(QWidget *widget, ToolTipShowMode mode) { @@ -60,8 +59,9 @@ void DToolTip::setToolTipShowMode(QWidget *widget, ToolTipShowMode mode) } /*! +@~english * @brief DToolTip::toolTipShowMode - * @param widget widget to get ToolTip show mode + * @param[in] widget widget to get ToolTip show mode * @return ToolTip show mode */ DToolTip::ToolTipShowMode DToolTip::toolTipShowMode(const QWidget *widget) @@ -135,18 +135,18 @@ void DToolTip::setShowToolTip(QWidget *widget, bool showToolTip) } /*! - \class Dtk::Widget::DToolTip - \inmodule dtkwidget - \brief DToolTip类似于 QToolTip 功能的类. - - DToolTip提供了将 DToolTip 显示在指定位置的函数 +@~english + @class Dtk::Widget::DToolTip + @inmodule dtkwidget + @brief like QToolTip + @details DToolTip provides a function that displays DTooltip in the specified position. */ /*! - \brief DToolTip的构造函数. - - \a text 文本信息 - \a completionClose 提示消息消失后是否销毁 +@~english + @brief DToolTip constructor + @param[in] text text message + @param[in] completionClose Prompt whether the tip is destroyed after disappearing. */ DToolTip::DToolTip(const QString &text, bool completionClose) : DTipLabel(text) @@ -157,9 +157,10 @@ DToolTip::DToolTip(const QString &text, bool completionClose) } /*! - \brief DToolTip::sizeHint. +@~english + @brief DToolTip::sizeHint - \sa QLabel::sizeHint() + @sa QLabel::sizeHint() */ QSize DToolTip::sizeHint() const { @@ -172,10 +173,11 @@ QSize DToolTip::sizeHint() const } /*! - \brief DToolTip::show设置提示消息出现的位置. +@~english + @brief DToolTip::show set the location where the tip appears - \a pos 提示消息位置 - \a duration 提示消息存在时间，单位毫秒 + @param[in] pos location of tip + @param[in] duration tip existence time, unit in millisecond */ void DToolTip::show(const QPoint &pos, int duration) {