该类用于检测自动化标记是否存在. 更多...

类 Dtk::Widget::DAccessibilityChecker 继承关系图:

Public 类型
enum	OutputFormat { AssertFormat , FullFormat }
	日志格式枚举.

enum	Role { Widget , ViewItem }
	检测的角色. 更多...

Public 成员函数
	DAccessibilityChecker (QObject *parent=nullptr)
	默认构造.

void	setOutputFormat (OutputFormat format)

OutputFormat	outputFormat () const

bool	check ()
	检测自动化标记名称.

void	start (int msec=3000)
	定时检测控件的标记名称.

Protected 成员函数
virtual bool	isIgnore (Role role, const QWidget *w)

属性
OutputFormat	outputFormat
	日志输出格式.

详细描述

该类用于检测自动化标记是否存在.

\inmodule dtkwidget

这是一个用于检测控件自动化标记是否完整添加的类，推荐该类在Debug模式下工作。可以使用 QT_DEBUG 或 QT_NO_DEBUG 宏指定当前是否为debug模式。断言输出模式下，程序在遇到控件不存在自动化标记名称时断言退出，并提示出具体控件和路径；全输出模式下，程序会输出全部的日志信息，且程序不会退出。除此之外，start() 函数会每隔3秒执行 check() 函数，如发现有控件不存在自动化标记名称，程序会直接退出并提示对应控件信息。一般的使用方法如下代码所示：

MainWindow w;
#ifdef QT_DEBUG
DAccessibilityChecker checker;
checker.start();
#endif
w.show();

或

MainWindow w;
#ifdef QT_DEBUG
DAccessibilityChecker checker;
checker.setOutputFormat(DAccessibilityChecker::FullFormat);
checker.check();
#endif
w.show();

如果检测出某一类不存在自动化标记，会存在类似如下的提示

Check Widget [QWidget] has no accessible name.
Widget Detail:
    Class Name: QWidget, Object Name: CentralWidget    Widget Path: MainWindow ——► QWidget

其中，可以从控件信息中获取到类名（ClassName）、对象名(ObjectName，如果存在)、对象路径（到顶层窗口的完整的父子关系）。

警告: 目前该类只用于检测自动化标记的名称。

注解: 对象名（setObjectName）设置过的类，能够更容易找到是否添加了自动化标记名称

成员枚举类型说明

◆ Role

enum Dtk::Widget::DAccessibilityChecker::Role

检测的角色.

检测角色目前分为两种。

构造及析构函数说明

◆ DAccessibilityChecker()

Dtk::Widget::DAccessibilityChecker::DAccessibilityChecker ( QObject * parent = nullptr )

explicit

默认构造.

默认构造

parent 父类指针

成员函数说明

◆ check()

bool Dtk::Widget::DAccessibilityChecker::check ( )

检测自动化标记名称.

该函数用于检测自动化检测的名称，目前支持检测的类型为 QWidget QStandardItem。

返回: 所有控件都存在自动化标记名称，返回true，否则返回false。

注解: 建议该函数在debug模式下执行，release模式下会影响程序运行

参见: start()

◆ start()

void Dtk::Widget::DAccessibilityChecker::start ( int msec = 3000 )

定时检测控件的标记名称.

调用此函数会定时执行自动化标记检测，如果发现某控件的自动化标记存在缺失，则程序退出并提示出控件的相关信息。 msec 定时开启的时间，默认为3秒.

参见: check()

属性说明

◆ outputFormat

Dtk::Widget::DAccessibilityChecker::outputFormat

readwrite

日志输出格式.

可以通过设置日志输出格式来控制输出的检查日志是断言日志还是全日志。默认情况下，这个属性是断言日志。

参见: DAccessibilityChecker::OutputFormat

该类的文档由以下文件生成:

include/util/daccessibilitychecker.h
src/util/daccessibilitychecker.cpp

Public 类型

Public 成员函数

Protected 成员函数

属性