Public 成员函数
virtual QList< Dtk::Ocr::HardwareID >	hardwareSupportList ()=0
	获取支持的硬件列表

virtual bool	setUseHardware (const QList< QPair< Dtk::Ocr::HardwareID, int > > &hardwareUsed)
	设置允许使用的设备，可以一次指定多个设备

virtual bool	setUseMaxThreadsCount (int n)
	设置最多可以开几个线程

virtual QStringList	authKeys ()
	获取鉴权参数关键字，此项一般用于需要额外授权才能使用的场景，例如需要联网才能使用或需要CDKEY的场景

virtual bool	setAuth (const QStringList &params)
	设置鉴权参数

virtual QStringList	imageFileSupportFormats () const
	获取支持读取的图片文件类型

virtual bool	setImageFile (const QString &filePath)
	设置图片文件路径，让插件从文件读取图片，图片的类型包含于自身实现的 `imageFileSupportFormats` 函数的返回值内，插件应当自身做好读取结果的校验

virtual bool	setImage (const QImage &image)
	设置需要识别的图片，此处传入的图片不保证就是插件所需的格式，插件应当做好格式校验并转换到所需的格式

virtual QImage	imageCached () const =0
	获取之前设置成功的图片数据，插件应当在执行 `setImageFile` 或 `setImage` 成功后对图片进行一次深拷贝，以此来实现此函数

virtual QString	pluginExpandParam (const QString &key) const
	获取自定义拓展参数设置情况，此函数用于一些较为高级或复杂的设置项，例如限制显存占用等操作，使用此接口需要向你的用户准备额外的说明书或操作手册，为了保持插件的简单和兼容性，不推荐使用此接口来实现功能

virtual bool	setPluginExpandParam (const QString &key, const QString &value)
	设置自定义拓展参数，此函数用于一些较为高级或复杂的设置项，例如限制显存占用等操作，使用此接口需要向你的用户准备额外的说明书或操作手册，为了保持插件的简单和兼容性，不推荐使用此接口来实现功能

virtual bool	analyze ()=0
	执行识别操作，建议在执行此接口的时候阻塞线程，同时注意激活和取消 `isRunning` 函数的效果

virtual bool	breakAnalyze ()
	设置中断当前识别操作

virtual bool	isRunning () const =0
	获取是否正在进行识别操作，此接口的调用位置一般和`analyze` 函数不在同一个线程内，实现的时候需要注意线程安全

virtual QStringList	languageSupport () const =0
	获取支持的语种列表，建议使用和 `ISO-639` 标准兼容的字符串

virtual bool	setLanguage (const QString &language)=0
	设置识别的语种，语种和 `languageSupport` 函数的返回值对应，插件自身需要做好判断工作

virtual QList< Dtk::Ocr::TextBox >	textBoxes () const
	获取识别到的文本框

virtual QList< Dtk::Ocr::TextBox >	charBoxes (int index) const
	获取识别到的文本框中的单个字的字符框

virtual QString	simpleResult () const =0
	获取格式简单的整体识别结果，建议以换行符为每个文本框结果的分界线

virtual QString	resultFromBox (int index) const
	获取指定文本框内的识别结果

成员函数说明

◆ analyze()

bool DOcrPluginInterface::analyze ( )

pure virtual

执行识别操作，建议在执行此接口的时候阻塞线程，同时注意激活和取消 isRunning 函数的效果

返回: 本次的识别结果是否有效

◆ authKeys()

QStringList DOcrPluginInterface::authKeys ( )

virtual

获取鉴权参数关键字，此项一般用于需要额外授权才能使用的场景，例如需要联网才能使用或需要CDKEY的场景

返回: 鉴权参数关键字

◆ breakAnalyze()

bool DOcrPluginInterface::breakAnalyze ( )

virtual

设置中断当前识别操作

返回: 是否设置成功，true为设置成功，false为设置失败

◆ charBoxes()

QList< Dtk::Ocr::TextBox > DOcrPluginInterface::charBoxes ( int index ) const

virtual

获取识别到的文本框中的单个字的字符框

参数

[in] index 文本框索引

返回: 识别到的字符框列表

◆ hardwareSupportList()

QList< Dtk::Ocr::HardwareID > DOcrPluginInterface::hardwareSupportList ( )

pure virtual

获取支持的硬件列表

返回: 支持的硬件列表

◆ imageCached()

QImage DOcrPluginInterface::imageCached ( ) const

pure virtual

获取之前设置成功的图片数据，插件应当在执行 setImageFile 或 setImage 成功后对图片进行一次深拷贝，以此来实现此函数

返回: 图片数据

◆ imageFileSupportFormats()

QStringList DOcrPluginInterface::imageFileSupportFormats ( ) const

virtual

获取支持读取的图片文件类型

返回: 支持的图片类型

◆ isRunning()

bool DOcrPluginInterface::isRunning ( ) const

pure virtual

获取是否正在进行识别操作，此接口的调用位置一般和analyze 函数不在同一个线程内，实现的时候需要注意线程安全

返回: 是否正在进行识别操作，true为识别还在进行中，false为没有在进行识别

◆ languageSupport()

QStringList DOcrPluginInterface::languageSupport ( ) const

pure virtual

获取支持的语种列表，建议使用和 ISO-639 标准兼容的字符串

返回: 支持的语种列表

◆ pluginExpandParam()

QString DOcrPluginInterface::pluginExpandParam ( const QString & key ) const

virtual

获取自定义拓展参数设置情况，此函数用于一些较为高级或复杂的设置项，例如限制显存占用等操作，使用此接口需要向你的用户准备额外的说明书或操作手册，为了保持插件的简单和兼容性，不推荐使用此接口来实现功能

参数

[in] key 拓展参数关键字

返回: 已设置的值

◆ resultFromBox()

QString DOcrPluginInterface::resultFromBox ( int index ) const

virtual

获取指定文本框内的识别结果

参数

[in] index 文本框索引

返回: 指定文本框内的识别结果

◆ setAuth()

bool DOcrPluginInterface::setAuth ( const QStringList & params )

virtual

设置鉴权参数

参数

[in] params 鉴权参数列表，顺序和自身实现的 authKeys 函数返回的关键字顺序一一对应

返回: 是否设置成功，true为设置成功，false为设置失败

◆ setImage()

bool DOcrPluginInterface::setImage ( const QImage & image )

virtual

设置需要识别的图片，此处传入的图片不保证就是插件所需的格式，插件应当做好格式校验并转换到所需的格式

参数

[in] image 需要识别的图片

返回: 是否设置成功，true为设置成功，false为设置失败

◆ setImageFile()

bool DOcrPluginInterface::setImageFile ( const QString & filePath )

virtual

设置图片文件路径，让插件从文件读取图片，图片的类型包含于自身实现的 imageFileSupportFormats 函数的返回值内，插件应当自身做好读取结果的校验

参数

[in] filePath 图片文件路径

返回: 是否设置成功，true为设置成功，false为设置失败

◆ setLanguage()

bool DOcrPluginInterface::setLanguage ( const QString & language )

pure virtual

设置识别的语种，语种和 languageSupport 函数的返回值对应，插件自身需要做好判断工作

参数

[in] language 语种

返回: 是否设置成功，true为设置成功，false为设置失败

◆ setPluginExpandParam()

bool DOcrPluginInterface::setPluginExpandParam	(	const QString &	key,
		const QString &	value
	)

virtual

设置自定义拓展参数，此函数用于一些较为高级或复杂的设置项，例如限制显存占用等操作，使用此接口需要向你的用户准备额外的说明书或操作手册，为了保持插件的简单和兼容性，不推荐使用此接口来实现功能

参数

[in]	key	拓展参数关键字
[in]	value	key所对应的设置值

返回: 是否设置成功，true为设置成功，false为设置失败

◆ setUseHardware()

bool DOcrPluginInterface::setUseHardware ( const QList< QPair< Dtk::Ocr::HardwareID, int > > & hardwareUsed )

virtual

设置允许使用的设备，可以一次指定多个设备

参数

[in] hardwareUsed 可以使用的设备的种类和它对应的设备编号列表

返回: 是否设置成功，true为设置成功，false为设置失败

◆ setUseMaxThreadsCount()

bool DOcrPluginInterface::setUseMaxThreadsCount ( int n )

virtual

设置最多可以开几个线程

参数

[in] n 可以开的线程数量

返回: 是否设置成功，true为设置成功，false为设置失败

◆ simpleResult()

QString DOcrPluginInterface::simpleResult ( ) const

pure virtual

获取格式简单的整体识别结果，建议以换行符为每个文本框结果的分界线

返回: 整体识别结果

◆ textBoxes()

QList< Dtk::Ocr::TextBox > DOcrPluginInterface::textBoxes ( ) const

virtual

获取识别到的文本框

返回: 识别到的文本框列表

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

include/dtkocr/docrplugininterface.h
docs/dtkocr/docrplugininterface.zh_CN.dox

Public 成员函数

成员函数说明

◆ analyze()

◆ authKeys()

◆ breakAnalyze()

◆ charBoxes()

◆ hardwareSupportList()

◆ imageCached()

◆ imageFileSupportFormats()

◆ isRunning()

◆ languageSupport()

◆ pluginExpandParam()

◆ resultFromBox()

◆ setAuth()

◆ setImage()

◆ setImageFile()

◆ setLanguage()

◆ setPluginExpandParam()

◆ setUseHardware()

◆ setUseMaxThreadsCount()

◆ simpleResult()

◆ textBoxes()