Skip to content

Commit

Permalink
doc: update docs for dfontcombobox
Browse files Browse the repository at this point in the history
更新dfontcombobox的文档

Log: update docs

Issue: linuxdeepin/dtk#94
  • Loading branch information
LEpoii authored and xzl01 committed Aug 2, 2023
1 parent 06f6556 commit 772ca04
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 23 deletions.
44 changes: 40 additions & 4 deletions docs/widgets/dfontcombobox.zh_CN.dox
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,47 @@
@~chinese
@file dfontcombobox.h
@ingroup button
@class
@brief
@details
@class Dtk::Widget::DFontComboBox
@brief 继承自 DComboBox类 字体选择下拉列表
@details DFontComboBox类 继承自 DComboBox类 提供了进行系统字体选择的下拉列表

TODO: 添加类简介、示例代码、示例截图和函数使用说明等
@image html DFontComboBox.png

@fn DFontComboBox::DFontComboBox(QWidget *parent)
@brief DFontComboBox 构造函数
@param[in] parent 父构件对象

@fn void DFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script)
@brief 与 QFontComboBox::setWritingSystem 功能相同, 设置字体选择器所使用的书写系统
@param[in] script QFontDatabase::WritingSystem 类对象, Qt支持的书写系统

@fn QFontDatabase::WritingSystem DFontComboBox::writingSystem() const
@brief 与 QFontComboBox::writingSystem 功能相同, 返回字体选择器所使用的书写系统
@return 字体选择器所选用的书写系统

@fn void DFontComboBox::setFontFilters(QFontComboBox::FontFilters filters)
@brief 与 QFontComboBox::setFontFilters 功能相同, 设置字体选择器可以显示的字体
@param[in] script QFontComboBox::FontFilters 类对象, Qt支持的字体类型

@fn QFontComboBox::FontFilters DFontComboBox::fontFilters() const
@brief 与 QFontComboBox::fontFilters 功能相同, 返回字体选择器可以显示的字体
@return 字体选择器所选用的字体

@fn QFont DFontComboBox::currentFont() const
@brief 与 QFontComboBox::currentFont 功能相同, 返回当前选择字体
@return 当前选择字体

@fn QSize DFontComboBox::sizeHint() const
@brief 与 QFontComboBox::sizeHint 功能相同, 返回字体选择器的推荐大小
@return 推荐大小

@fn void DFontComboBox::setCurrentFont(const QFont &f)
@brief 与 QFontComboBox::setCurrentFont 功能相同, 设置当前选择字体
@param[in] QFont类型, 要选择的字体

@fn bool DFontComboBox::event(QEvent *e)
@brief 与 QFontComboBox::event 功能相同, 返回 DComboBox::event(e)的布尔值
@return DComboBox::event(e)

*/

51 changes: 32 additions & 19 deletions src/widgets/dfontcombobox.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class DFontComboBoxPrivate : public DComboBoxPrivate

virtual ~DFontComboBoxPrivate() override;

// DFontComboBox的具体实现采用QFontComboBox的实现
// The specific implementation of DFontComboBox adopts the implementation of QFontComboBox
QFontComboBox* impl;
};

Expand All @@ -40,17 +40,22 @@ DFontComboBoxPrivate::~DFontComboBoxPrivate()
}

/*!
* \~chinese \class DFontComboBox
* \~chinese \brief DFontComboBox 字体选择下拉列表
* \~chinese \li DFontComboBox 提供了系统字体选择功能
*
* \~chinese \note\row 代码示例
* \~chinese \note\row DFontComboBox *fontComboBox = new DFontComboBox();
*/

@~english
@class DFontComboBox
@brief The DFontComboBox class provides combobox for selecting font
The DFontComboBox class provides functions to select system font
@code
#code example
DFontComboBox *fontComboBox = new DFontComboBox();
@endcode
@image html DFontComboBox.png
/*!
* \chinese \brief DFontComboBox 构造函数
* \chinese \param parent参数被发送到 DComboBox 构造函数
@~english
@brief DFontComboBox constructor.
@param[in] parent is passed to DComboBox constructor
*/
DFontComboBox::DFontComboBox(QWidget *parent)
: DComboBox(*new DFontComboBoxPrivate(this), parent)
Expand All @@ -69,7 +74,8 @@ DFontComboBox::~DFontComboBox()
}

/*!
* \~chinese \brief 与QFontComboBox::setWritingSystem相同
@~english
@brief same as QFontComboBox::setWritingSystem
*/
void DFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script)
{
Expand All @@ -78,7 +84,8 @@ void DFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script)
}

/*!
* \~chinese \brief 与QFontComboBox::writingSystem相同
@~english
@brief same as QFontComboBox::writingSystem
*/
QFontDatabase::WritingSystem DFontComboBox::writingSystem() const
{
Expand All @@ -87,7 +94,8 @@ QFontDatabase::WritingSystem DFontComboBox::writingSystem() const
}

/*!
* \~chinese \brief 与QFontComboBox::setFontFilters相同
@~english
@brief same as QFontComboBox::setFontFilters
*/
void DFontComboBox::setFontFilters(QFontComboBox::FontFilters filters)
{
Expand All @@ -96,7 +104,8 @@ void DFontComboBox::setFontFilters(QFontComboBox::FontFilters filters)
}

/*!
* \~chinese \brief 与QFontComboBox::fontFilters相同
@~english
@brief same as QFontComboBox::fontFilters
*/
QFontComboBox::FontFilters DFontComboBox::fontFilters() const
{
Expand All @@ -105,7 +114,8 @@ QFontComboBox::FontFilters DFontComboBox::fontFilters() const
}

/*!
* \~chinese \brief 与QFontComboBox::currentFont相同
@~english
@brief same as QFontComboBox::currentFont
*/
QFont DFontComboBox::currentFont() const
{
Expand All @@ -114,7 +124,8 @@ QFont DFontComboBox::currentFont() const
}

/*!
* \~chinese \brief 与QFontComboBox::sizeHint相同
@~english
@brief same as QFontComboBox::sizeHint
*/
QSize DFontComboBox::sizeHint() const
{
Expand All @@ -123,7 +134,8 @@ QSize DFontComboBox::sizeHint() const
}

/*!
* \~chinese \brief 与QFontComboBox::setCurrentFont相同
@~english
@brief same as QFontComboBox::setCurrentFont
*/
void DFontComboBox::setCurrentFont(const QFont &f)
{
Expand All @@ -132,7 +144,8 @@ void DFontComboBox::setCurrentFont(const QFont &f)
}

/*!
* \~chinese \brief 与QFontComboBox::event相同
@~english
@brief same as QFontComboBox::event
*/
bool DFontComboBox::event(QEvent *e)
{
Expand Down

0 comments on commit 772ca04

Please sign in to comment.