PdfTk::PtlSearchTextResults Class Reference

PrlPtlPDFDocument/PtlPageのsearchText関数で取得されるテキスト検索結果のコンテナを表現するクラスです。
More...

#include <PtlSearchTextResults.h>

Public Member Functions
int	getHandle () const
	PtlSearchTextResults ()
	コンストラクタ More...
	PtlSearchTextResults (const PtlSearchTextResults &obj)
	コピーコンストラクタ alias copy More...
	‾PtlSearchTextResults ()
	デストラクタ
PtlSearchTextResults &	operator= (const PtlSearchTextResults &obj)
	コピーオペレータ alias copy More...
bool	isEmpty () const
	空かどうかを取得。 More...
int	getCount () const
	テキスト検索結果数を取得。 More...
PtlSearchTextResult &	get (int index)
	テキスト検索結果を取得。 More...

Detailed Description

PrlPtlPDFDocument/PtlPageのsearchText関数で取得されるテキスト検索結果のコンテナを表現するクラスです。

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

Constructor & Destructor Documentation

PtlSearchTextResults() [1/2]

PdfTk::PtlSearchTextResults::PtlSearchTextResults

(

)

コンストラクタ

Exceptions

PtlException

PtlSearchTextResults() [2/2]

PdfTk::PtlSearchTextResults::PtlSearchTextResults

(

const PtlSearchTextResults &

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

get()

PtlSearchTextResult& PdfTk::PtlSearchTextResults::get

(

int

index

)

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

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

Parameters

index

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

Returns

検索結果(PtlSearchTextResult)。

Exceptions

PtlException

getCount()

int PdfTk::PtlSearchTextResults::getCount

(

)

const

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

Returns

検索結果数。

Exceptions

PtlException

isEmpty()

bool PdfTk::PtlSearchTextResults::isEmpty

(

)

const

空かどうかを取得。

Returns

true: 空、false: 空ではない。

Exceptions

PtlException

operator=()

PtlSearchTextResults& PdfTk::PtlSearchTextResults::operator=

(

const PtlSearchTextResults &

obj

)

コピーオペレータ alias copy

Parameters

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