Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlParamSearchText クラス

#include <PtlParamSearchText.h>

PdfTk::PtlParamSearchText の継承関係図

公開型

enum  TEXT_TYPE { TEXT_RAW = 1 , TEXT_SORT = 2 }

公開メンバ関数

int getHandle () const
 PtlParamSearchText ()
 コンストラクタ
 PtlParamSearchText (const PtlParamSearchText &obj)
 コピーコンストラクタ
 ~PtlParamSearchText ()
 デストラクタ
PtlParamSearchTextoperator= (const PtlParamSearchText &obj)
 コピーオペレータ
void appendText (const PtlParamString &text)
 検索するテキストを追加。
void appendTextRegEx (const PtlParamString &text)
 検索する正規表現を追加。
void setCompareCase (bool compareCase)
 大文字と小文字を区別するかを設定。
void setIgnoreActualText (bool ignoreActualText)
 ActualTextを無視するかを設定。
void setTextType (TEXT_TYPE type)
 検索するテキストのタイプを設定。
void setOverlapAsLine (float overlap)
 文字と文字がどれだけ重なっていると同じ行とみなすかを設定。

限定公開変数類

int m_dataParamSearchText

詳解

コンテント内のテキストを検索する為のパラメータを表現したクラスです。
すべてのテキスト検索のパラメータを表現したクラスのベースクラスです。

PtlParamSearchText.h20 行目に定義があります。

列挙型メンバ詳解

◆ TEXT_TYPE

テキスト検索タイプ。

列挙値
TEXT_RAW 

取得したコンテント内のテキストをそのまま検索。

TEXT_SORT 

取得したコンテント内のテキストを座標でソートして検索。ソートはテキストの回転が0,90,180,270度のみ。

PtlParamSearchText.h26 行目に定義があります。

構築子と解体子

◆ PtlParamSearchText() [1/2]

PdfTk::PtlParamSearchText::PtlParamSearchText ( )

コンストラクタ

例外
PtlException

◆ PtlParamSearchText() [2/2]

PdfTk::PtlParamSearchText::PtlParamSearchText ( const PtlParamSearchText & obj)

コピーコンストラクタ

引数
objコピー元オブジェクト。
例外
PtlException

関数詳解

◆ appendText()

void PdfTk::PtlParamSearchText::appendText ( const PtlParamString & text)

検索するテキストを追加。

半角,全角に関わらず検索したい場合は、両方とも追加してください。
(例) MSとMS,*と*
似たような文字でもユニコードが違えば検索されないの注意してください。
(例) U+FF51(全角チルダ)とU+301C(波ダッシュ)
リガチャが存在していてもリガチャとして検索できませんので注意してください。
(例) リガチャであるU+FB01はU+FB01として検索できません。U+0066+U+0069の"fi"でしかヒットしません。

引数
text検索するテキスト。
例外
PtlException

◆ appendTextRegEx()

void PdfTk::PtlParamSearchText::appendTextRegEx ( const PtlParamString & text)

検索する正規表現を追加。

正規表現で検索する場合はappendTextではなくこの関数を使用してください。

引数
text正規表現。
例外
PtlException

◆ operator=()

PtlParamSearchText & PdfTk::PtlParamSearchText::operator= ( const PtlParamSearchText & obj)

コピーオペレータ

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

◆ setCompareCase()

void PdfTk::PtlParamSearchText::setCompareCase ( bool compareCase)

大文字と小文字を区別するかを設定。

大文字と小文字を区別するかを設定します。
※ 設定しない場合はデフォルト値としてfalseが設定されます。

引数
compareCase[in] 大文字と小文字を区別する場合はtrueを指定します。

◆ setIgnoreActualText()

void PdfTk::PtlParamSearchText::setIgnoreActualText ( bool ignoreActualText)

ActualTextを無視するかを設定。

ActualTextを無視するかを設定します。
※ 設定しない場合はデフォルト値としてfalseが設定されます。

ActualTextの具体例

/Span<</ActualText<FEFF9DD7>>> BDC % ActualTextでU+9DD7が指定されている
-1.8 13.571 Td
<1DDE>Tj % この文字はU+9D0E
EMC

文字がU+9D0EとなっていてもActualTextの設定がありU+9DD7となっていたらU+9DD7でヒットします。
setIgnoreActualTextでtrueを設定するとU+9D0Eでヒットします。

※ 注意事項
PDFにはActualTextが2箇所で使われています。
1つはコンテントのマーク付きコンテントで設定されているActualText。こちらは文字の置き換え用途で使われます。ActualTextの具体例で示したもの。
もう1つはタグの要素に付けられているActualText。こちらは画像などにつけて読み上げの時に読み上げられる名前です。
この関数で言うActualTextは前者です。

引数
ignoreActualText[in] ActualTextを無視する場合はtrueを指定します。

◆ setOverlapAsLine()

void PdfTk::PtlParamSearchText::setOverlapAsLine ( float overlap)

文字と文字がどれだけ重なっていると同じ行とみなすかを設定。

横書きで文字と文字の座標が縦方向にどれだけ重なっていると同じ行とみなすかの割合を設定します。
※ 設定しない場合はデフォルト値として0.7が設定されます。7割が重なっていると同じ行とみなされます。
この設定はsetTextTypeでTEXT_SORTが設定された場合のみ有効です。

引数
overlap[in] 文字の重なり具合を割合でセットします。

◆ setTextType()

void PdfTk::PtlParamSearchText::setTextType ( TEXT_TYPE type)

検索するテキストのタイプを設定。

検索したテキストのタイプを設定します。
※ 設定しない場合はデフォルト値としてTEXT_RAWが設定されます。
TEXT_SORTを設定した場合、リガチャは検索できません。

引数
type[in] 検索するテキストのタイプを指定します。

メンバ詳解

◆ m_dataParamSearchText

int PdfTk::PtlParamSearchText::m_dataParamSearchText
protected

PtlParamSearchText.h32 行目に定義があります。