PdfTk::PtlSearchTextResultDetails クラス

#include <PtlSearchTextResultDetails.h>

公開メンバ関数
int	getHandle () const
	PtlSearchTextResultDetails ()
	コンストラクタ
	PtlSearchTextResultDetails (const PtlSearchTextResultDetails &obj)
	コピーコンストラクタ alias copy
	~PtlSearchTextResultDetails ()
	デストラクタ
PtlSearchTextResultDetails &	operator= (const PtlSearchTextResultDetails &obj)
	コピーオペレータ alias copy
int	getCount () const
	テキスト検索結果の詳細数を取得。
PtlSearchTextResultDetail &	get (int index)
	テキスト検索結果の詳細を取得。

詳解

テキスト検索結果の詳細のコンテナを表現するクラスです。

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

PtlSearchTextResultDetails.h の 50 行目に定義があります。

構築子と解体子

PtlSearchTextResultDetails() [1/2]

PdfTk::PtlSearchTextResultDetails::PtlSearchTextResultDetails

(

)

コンストラクタ

例外

PtlException

PtlSearchTextResultDetails() [2/2]

PdfTk::PtlSearchTextResultDetails::PtlSearchTextResultDetails

(

const PtlSearchTextResultDetails &

obj

)

コピーコンストラクタ alias copy

引数

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

例外

PtlException

関数詳解

get()

PtlSearchTextResultDetail & PdfTk::PtlSearchTextResultDetails::get

(

int

index

)

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

指定した番号の検索結果の詳細を取得します。

引数

index

Index番号。0が先頭。 indexが負や検索結果数以上の場合は、例外が発生します。

戻り値

検索結果の詳細(PtlSearchTextResultDetail)。

例外

PtlException

getCount()

int PdfTk::PtlSearchTextResultDetails::getCount

(

)

const

テキスト検索結果の詳細数を取得。

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

戻り値

検索結果の詳細数。

例外

PtlException

operator=()

PtlSearchTextResultDetails & PdfTk::PtlSearchTextResultDetails::operator=

(

const PtlSearchTextResultDetails &

obj

)

コピーオペレータ alias copy

引数

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