PdfTk::PtlSearchTextResult クラス

#include <PtlSearchTextResult.h>

公開メンバ関数
int	getHandle () const
	PtlSearchTextResult ()
	コンストラクタ
	PtlSearchTextResult (const PtlSearchTextResult &obj)
	コピーコンストラクタ
	~PtlSearchTextResult ()
	デストラクタ
PtlSearchTextResult &	operator= (const PtlSearchTextResult &obj)
	コピーオペレータ
int	getPageNumber () const
	テキスト検索したページ番号を取得。
const PtlParamString &	getKeyword ()
	テキスト検索に使用した文字を取得。
PtlSearchTextResultDetails &	getResultDetails ()
	テキスト検索結果の詳細コンテナを取得。

詳解

PtlPDFDocument/PtlPageのsearchText関数で取得されるテキスト検索結果を表現したクラスです。

    PtlSearchTextResults
        PtlSearchTextResult
            ページ番号
            検索に使用した文字
            PtlSearchTextResultDetails
                 PtlSearchTextResultDetail
                     検索でヒットした文字
                     検索でヒットした文字を囲むQuadPoint
 
(例) "日本の夏"と"ヨーロッパの冬"で検索して3箇所ヒット
    PtlSearchTextResults
        PtlSearchTextResult
            1ページ
            "日本の夏"
            PtlSearchTextResultDetails
                PtlSearchTextResultDetail
                "日本の夏"
        PtlSearchTextResult
            1ページ
            "日本の夏"
            PtlSearchTextResultDetails
                PtlSearchTextResultDetail
                "日本の"
                PtlSearchTextResultDetail
                "夏"
        PtlSearchTextResult
            1ページ
            "ヨーロッパの冬"
            PtlSearchTextResultDetails
                PtlSearchTextResultDetail
                "ヨーロッパの冬"

PtlSearchTextResult.h の 52 行目に定義があります。

構築子と解体子

PtlSearchTextResult() [1/2]

PdfTk::PtlSearchTextResult::PtlSearchTextResult

(

)

コンストラクタ

例外

PtlException

PtlSearchTextResult() [2/2]

PdfTk::PtlSearchTextResult::PtlSearchTextResult

(

const PtlSearchTextResult &

obj

)

コピーコンストラクタ

引数

obj	コピー元オブジェクト。

例外

PtlException

関数詳解

getKeyword()

const PtlParamString & PdfTk::PtlSearchTextResult::getKeyword

(

)

テキスト検索に使用した文字を取得。

戻り値

検索に使用した文字。

例外

PtlException

getPageNumber()

int PdfTk::PtlSearchTextResult::getPageNumber

(

)

const

テキスト検索したページ番号を取得。

ページ番号は0オリジンです。

例外

PtlException

getResultDetails()

PtlSearchTextResultDetails & PdfTk::PtlSearchTextResult::getResultDetails

(

)

テキスト検索結果の詳細コンテナを取得。

検索結果の詳細コンテナを取得します。
検索した結果を1つのQuadPointで囲めることができたら詳細コンテナは1つの詳細のみ持ちますが、
複数のQuaddPointを使うことになった場合は、複数の詳細を持つことになります。
(例)
例えば、"日本の夏"を検索して、"日本の"と"夏"が別のQuadPointで囲まれた場合、
"日本の"と"夏"が別々のPtlSearchTextResultDetailに設定されることになります。
この場合、PtlSearchTextResultDetailsには2件のPtlSearchTextResultDetailが格納されています。

戻り値

検索結果の詳細コンテナ。

例外

PtlException

operator=()

PtlSearchTextResult & PdfTk::PtlSearchTextResult::operator=

(

const PtlSearchTextResult &

obj

)

コピーオペレータ

引数

obj	コピー元オブジェクト。