DOcr类 参考

类 DOcr 继承关系图:

Public 成员函数
	DOcr (QObject *parent=nullptr)
QStringList	installedPluginNames ()
	获取已安装的插件名称列表，不包含默认插件
bool	loadDefaultPlugin ()
	加载默认插件，默认插件内嵌在 dtkocr 中，可以直接使用
bool	loadPlugin (const QString &pluginName)
	通过插件名加载已安装的插件
bool	pluginReady () const
	获取插件加载状态
QList< HardwareID >	hardwareSupportList () const
	获取插件支持的硬件列表，执行此函数前需要确保插件已就绪
bool	setUseHardware (const QList< QPair< HardwareID, int > > &hardwareUsed)
	设置允许插件使用的设备，可以一次指定多个设备，执行此函数前需要确保插件已就绪
bool	setUseMaxThreadsCount (int n)
	设置允许插件最多可以开几个线程，执行此函数前需要确保插件已就绪
QStringList	authKeys () const
	获取插件的鉴权参数关键字，此项一般用于需要额外授权才能使用的插件，执行此函数前需要确保插件已就绪
bool	setAuth (const QStringList &params)
	设置鉴权参数，执行此函数前需要确保插件已就绪
QStringList	imageFileSupportFormats () const
	获取支持读取的图片文件类型，执行此函数前需要确保插件已就绪
bool	setImageFile (const QString &filePath)
	设置图片文件路径，让插件从文件读取图片，图片的类型需要包含于 DOcr::imageFileSupportFormats 的返回值内，执行此函数前需要确保插件已就绪
bool	setImage (const QImage &image)
	设置需要识别的图片，执行此函数前需要确保插件已就绪
QImage	imageCached () const
	获取之前设置成功的图片数据，执行此函数前需要确保插件已就绪
QString	pluginExpandParam (const QString &key) const
	获取插件的自定义拓展参数设置情况，执行此函数前需要确保插件已就绪
bool	setPluginExpandParam (const QString &key, const QString &value)
	设置插件的自定义拓展参数，执行此函数前需要确保插件已就绪
bool	analyze ()
	执行识别操作，识别操作一般耗时较长，程序流程会在此阻塞较长时间，执行此函数前需要确保插件已就绪
bool	breakAnalyze ()
	设置中断当前识别操作，执行此函数前需要确保插件已就绪
bool	isRunning () const
	获取是否正在进行识别操作，此接口的调用位置一般和 DOcr::analyze 函数不在同一个线程内，执行此函数前需要确保插件已就绪
QStringList	languageSupport () const
	获取插件支持的语种列表，执行此函数前需要确保插件已就绪
bool	setLanguage (const QString &language)
	设置识别的语种，语种需要在包含于 DOcr::languageSupport 函数的返回值中，执行此函数前需要确保插件已就绪
QList< TextBox >	textBoxes () const
	获取识别到的文本框，执行此函数前需要确保插件已就绪
QList< TextBox >	charBoxes (int index) const
	获取识别到的文本框中的单个字的字符框，执行此函数前需要确保插件已就绪
QString	simpleResult () const
	获取格式简单的整体识别结果，执行此函数前需要确保插件已就绪
QString	resultFromBox (int index) const
	获取指定文本框内的识别结果，执行此函数前需要确保插件已就绪

Protected 属性
QScopedPointer< DOcrPrivate >	d_ptr

成员函数说明

analyze()

bool DOcr::analyze

(

)

执行识别操作，识别操作一般耗时较长，程序流程会在此阻塞较长时间，执行此函数前需要确保插件已就绪

返回

本次的识别结果是否有效

authKeys()

QStringList DOcr::authKeys

(

)

const

获取插件的鉴权参数关键字，此项一般用于需要额外授权才能使用的插件，执行此函数前需要确保插件已就绪

返回

插件的鉴权参数关键字，如果为空则表示使用插件不需要鉴权

breakAnalyze()

bool DOcr::breakAnalyze

(

)

设置中断当前识别操作，执行此函数前需要确保插件已就绪

返回

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

charBoxes()

QList< Dtk::Ocr::TextBox > DOcr::charBoxes

(

int

index

)

const

获取识别到的文本框中的单个字的字符框，执行此函数前需要确保插件已就绪

参数

[in]

index

文本框索引

返回

识别到的字符框列表

hardwareSupportList()

QList< Dtk::Ocr::HardwareID > DOcr::hardwareSupportList

(

)

const

获取插件支持的硬件列表，执行此函数前需要确保插件已就绪

返回

插件支持的硬件列表

imageCached()

QImage DOcr::imageCached

(

)

const

获取之前设置成功的图片数据，执行此函数前需要确保插件已就绪

返回

图片数据

imageFileSupportFormats()

QStringList DOcr::imageFileSupportFormats

(

)

const

获取支持读取的图片文件类型，执行此函数前需要确保插件已就绪

返回

支持的图片类型，如果为空则表示插件不支持从文件读取图片

installedPluginNames()

QStringList DOcr::installedPluginNames

(

)

获取已安装的插件名称列表，不包含默认插件

返回

已安装的插件名称列表

isRunning()

bool DOcr::isRunning

(

)

const

获取是否正在进行识别操作，此接口的调用位置一般和 DOcr::analyze 函数不在同一个线程内，执行此函数前需要确保插件已就绪

返回

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

languageSupport()

QStringList DOcr::languageSupport

(

)

const

获取插件支持的语种列表，执行此函数前需要确保插件已就绪

返回

插件支持的语种列表

loadDefaultPlugin()

bool DOcr::loadDefaultPlugin

(

)

加载默认插件，默认插件内嵌在 dtkocr 中，可以直接使用

返回

是否加载成功，true为加载成功，false为加载失败

loadPlugin()

bool DOcr::loadPlugin

(

const QString &

pluginName

)

通过插件名加载已安装的插件

参数

[in]

pluginName

插件名称，需要包含于 DOcr::installedPluginNames 函数的返回值中

返回

是否加载成功，true为加载成功，false为加载失败

pluginExpandParam()

QString DOcr::pluginExpandParam

(

const QString &

key

)

const

获取插件的自定义拓展参数设置情况，执行此函数前需要确保插件已就绪

参数

[in]

key

拓展参数关键字

返回

已设置的值

pluginReady()

bool DOcr::pluginReady

(

)

const

获取插件加载状态

返回

插件是否已就绪，true为已就绪，false为还未就绪

resultFromBox()

QString DOcr::resultFromBox

(

int

index

)

const

获取指定文本框内的识别结果，执行此函数前需要确保插件已就绪

参数

[in]

index

文本框索引

返回

指定文本框内的识别结果

setAuth()

bool DOcr::setAuth

(

const QStringList &

params

)

设置鉴权参数，执行此函数前需要确保插件已就绪

参数

[in]

params

鉴权参数列表，顺序需要和 DOcr::authKeys 函数返回的关键字顺序一一对应

返回

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

setImage()

bool DOcr::setImage

(

const QImage &

image

)

设置需要识别的图片，执行此函数前需要确保插件已就绪

参数

[in]

image

需要识别的图片

返回

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

setImageFile()

bool DOcr::setImageFile

(

const QString &

filePath

)

设置图片文件路径，让插件从文件读取图片，图片的类型需要包含于 DOcr::imageFileSupportFormats 的返回值内，执行此函数前需要确保插件已就绪

参数

[in]

filePath

图片文件路径

返回

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

setLanguage()

bool DOcr::setLanguage

(

const QString &

language

)

设置识别的语种，语种需要在包含于 DOcr::languageSupport 函数的返回值中，执行此函数前需要确保插件已就绪

参数

[in]

language

语种

返回

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

setPluginExpandParam()

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

设置插件的自定义拓展参数，执行此函数前需要确保插件已就绪

参数

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

返回

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

setUseHardware()

bool DOcr::setUseHardware

(

const QList< QPair< HardwareID, int > > &

hardwareUsed

)

设置允许插件使用的设备，可以一次指定多个设备，执行此函数前需要确保插件已就绪

参数

[in]

hardwareUsed

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

返回

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

setUseMaxThreadsCount()

bool DOcr::setUseMaxThreadsCount

(

int

n

)

设置允许插件最多可以开几个线程，执行此函数前需要确保插件已就绪

参数

[in]

n

可以开的线程数量

返回

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

simpleResult()

QString DOcr::simpleResult

(

)

const

获取格式简单的整体识别结果，执行此函数前需要确保插件已就绪

返回

整体识别结果

textBoxes()

QList< Dtk::Ocr::TextBox > DOcr::textBoxes

(

)

const

获取识别到的文本框，执行此函数前需要确保插件已就绪

返回

识别到的文本框列表

---

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

• include/dtkocr/docr.h
• docs/dtkocr/docr.zh_CN.dox