Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::ofd::TextSearch类 参考
类 foxit::ofd::TextSearch 继承关系图:

## Public 成员函数
| TextSearch (OFDPackage package, const String &keyword)
| 带参数的构造函数。 更多...
| TextSearch (OFDPage page, const String &keyword)
| 带参数的构造函数。 更多...
| TextSearch (const TextSearch &other)
| 构造函数，通过另一个文本搜索对象。 更多...
| ~TextSearch ()
| 析构函数。
TextSearchResultInfo | GetResult (int index)
| 获取指定索引的搜索结果信息。 更多...
foxit::PointF | GetResultCenter (int index)
| 获取指定索引的搜索结果中心点。 更多...
foxit::PointF | GetResultCenterInPage (int page_index, int index)
| 获取指定页面索引的搜索结果中心点。 更多...
TextSearchCharInfo | GetResultCharInfo (int index, int char_info_index)
| 获取指定索引的搜索结果字符信息。 更多...
int | GetResultCount ()
| 获取搜索结果数量。 更多...
int | GetResultCountInPage (int page_index)
| 获取指定页面索引的搜索结果数量。 更多...
FX_RECT | GetResultRect (int index, int rect_index)
| 获取指定索引的搜索结果矩形框。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const TextSearch &other) const
| 不相等操作符。 更多...
TextSearch & | operator= (const TextSearch &other)
| 赋值操作符。 更多...
bool | operator== (const TextSearch &other) const
| 相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示OFD文本搜索相关的方法。

## 构造及析构函数说明

## ◆ TextSearch() [1/3]

foxit::ofd::TextSearch::TextSearch | ( | OFDPackage | package,
|  | const String & | keyword
| ) |  |
| explicit

带参数的构造函数。

参数

  [in] | package | OFD包对象。
  [in] | keyword | 搜索关键字。

## ◆ TextSearch() [2/3]

foxit::ofd::TextSearch::TextSearch | ( | OFDPage | page,
|  | const String & | keyword
| ) |  |
| explicit

带参数的构造函数。

参数

  [in] | page | OFD页面对象。
  [in] | keyword | 搜索关键字。

## ◆ TextSearch() [3/3]

foxit::ofd::TextSearch::TextSearch | ( | const TextSearch & | other | ) |

构造函数，通过另一个文本搜索对象。

参数

  [in] | other | 另一个文本搜索对象。

## 成员函数说明

## ◆ GetResult()

TextSearchResultInfo foxit::ofd::TextSearch::GetResult | ( | int | index | ) |

获取指定索引的搜索结果信息。

参数

  [in] | index | 搜索结果索引号。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::TextSearch::GetResultCount 返回。

返回
  指定索引的搜索结果信息。

## ◆ GetResultCenter()

foxit::PointF foxit::ofd::TextSearch::GetResultCenter | ( | int | index | ) |

获取指定索引的搜索结果中心点。

参数

  [in] | index | 搜索结果索引号。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::TextSearch::GetResultCount 返回。

返回
  指定索引的搜索结果中心点。

## ◆ GetResultCenterInPage()

foxit::PointF foxit::ofd::TextSearch::GetResultCenterInPage | ( | int | page_index,
|  | int | index
| ) |  |

获取指定页面索引的搜索结果中心点。

参数

  [in] | page_index | 页面索引号。
  [in] | index | 搜索结果索引号。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::TextSearch::GetResultCountInPage 返回。

返回
  指定页面索引的搜索结果中心点。

## ◆ GetResultCharInfo()

TextSearchCharInfo foxit::ofd::TextSearch::GetResultCharInfo | ( | int | index,
|  | int | char_info_index
| ) |  |

获取指定索引的搜索结果字符信息。

参数

  [in] | index | 搜索结果索引号。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::TextSearch::GetResultCount 返回。
  [in] | char_info_index | 字符信息索引号。有效范围：从0到(char_info_size-1)。 char_info_size 由函数 foxit::ofd::TextSearchResultInfo::char_info_size 返回。

返回
  指定索引的搜索结果字符信息。

## ◆ GetResultCount()

int foxit::ofd::TextSearch::GetResultCount | ( |  | ) |

获取搜索结果数量。

返回
  搜索结果数量。

## ◆ GetResultCountInPage()

int foxit::ofd::TextSearch::GetResultCountInPage | ( | int | page_index | ) |

获取指定页面索引的搜索结果数量。

参数

  [in] | page_index | 页面索引号。

返回
  指定页面索引的搜索结果数量。

## ◆ GetResultRect()

FX_RECT foxit::ofd::TextSearch::GetResultRect | ( | int | index,
|  | int | rect_index
| ) |  |

获取指定索引的搜索结果矩形框。

参数

  [in] | index | 搜索结果索引号。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::TextSearch::GetResultCount 返回。
  [in] | rect_index | 矩形框索引号。有效范围：从0到(rect_size-1)。 rect_size 由函数 foxit::ofd::TextSearchResultInfo::rect_size 返回。

返回
  指定索引的搜索结果矩形框。

## ◆ IsEmpty()

bool foxit::ofd::TextSearch::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ operator !=()

bool foxit::ofd::TextSearch::operator != | ( | const TextSearch & | other | ) | const

不相等操作符。

参数

  [in] | other | 另一个文本搜索对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

TextSearch& foxit::ofd::TextSearch::operator= | ( | const TextSearch & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个文本搜索对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ operator==()

bool foxit::ofd::TextSearch::operator== | ( | const TextSearch & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个文本搜索对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等。