PdfTkNet::PtlSearchTextResults Class Reference

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

#include <NetSearchTextResults.h>

Inheritance diagram for PdfTkNet::PtlSearchTextResults:

Collaboration diagram for PdfTkNet::PtlSearchTextResults:

Public Member Functions
PdfTk::PtlSearchTextResults *	getNative ()
	PtlSearchTextResults ()
	コンストラクタ
	PtlSearchTextResults (PtlSearchTextResults^ obj)
	コピーコンストラクタ alias copy
	‾PtlSearchTextResults ()
	デストラクタ
	!PtlSearchTextResults ()
	ファイナライザ。
PtlSearchTextResults	operator= (PtlSearchTextResults^ obj)
	コピーオペレータ alias copy
bool	isEmpty ()
	空かどうかを取得。
int	getCount ()
	テキスト検索結果数を取得。
PtlSearchTextResult	get (int index)
	テキスト検索結果を取得。

Protected Attributes
PdfTk::PtlSearchTextResults *	m_native

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]

PdfTkNet::PtlSearchTextResults::PtlSearchTextResults

(

)

コンストラクタ

Exceptions

PtlException

PtlSearchTextResults() [2/2]

PdfTkNet::PtlSearchTextResults::PtlSearchTextResults

(

PtlSearchTextResults^

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

get()

PtlSearchTextResult PdfTkNet::PtlSearchTextResults::get

(

int

index

)

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

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

Parameters

index

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

Returns

検索結果(PtlSearchTextResult)。

Exceptions

PtlException

getCount()

int PdfTkNet::PtlSearchTextResults::getCount

(

)

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

Returns

検索結果数。

Exceptions

PtlException

isEmpty()

bool PdfTkNet::PtlSearchTextResults::isEmpty

(

)

空かどうかを取得。

Returns

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

Exceptions

PtlException

operator=()

PtlSearchTextResults PdfTkNet::PtlSearchTextResults::operator=

(

PtlSearchTextResults^

obj

)

コピーオペレータ alias copy

Parameters

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