PDFTool 7.0
PdfTk::PtlParamSearchTextAndHighlight Class Reference

テキスト検索してハイライト注釈をつけるパラメータを表現したクラスです。
More...

#include <PtlParamSearchTextAndHighlight.h>

Inheritance diagram for PdfTk::PtlParamSearchTextAndHighlight:
Collaboration diagram for PdfTk::PtlParamSearchTextAndHighlight:

Public Member Functions

 PtlParamSearchTextAndHighlight ()
 コンストラクタ
 PtlParamSearchTextAndHighlight (const PtlParamSearchTextAndHighlight &obj)
 コピーコンストラクタ
 ‾PtlParamSearchTextAndHighlight ()
 デストラクタ
PtlParamSearchTextAndHighlightoperator= (const PtlParamSearchTextAndHighlight &obj)
 コピーオペレータ
void setColor (const PtlColor &color)
 Highlight注釈の色を設定。
void setOpacity (float opacity)
 Highlight注釈色の不透明度を設定。
Public Member Functions inherited from PdfTk::PtlParamSearchText
int getHandle () const
 PtlParamSearchText ()
 コンストラクタ
 PtlParamSearchText (const PtlParamSearchText &obj)
 コピーコンストラクタ
 ‾PtlParamSearchText ()
 デストラクタ
PtlParamSearchTextoperator= (const PtlParamSearchText &obj)
 コピーオペレータ
void appendText (const PtlParamString &text)
 検索するテキストを追加。
void setCompareCase (bool compareCase)
 大文字と小文字を区別するかを設定。
void setIgnoreActualText (bool ignoreActualText)
 ActualTextを無視するかを設定。
void setTextType (TEXT_TYPE type)
 検索するテキストのタイプを設定。
void setOverlapAsLine (float overlap)
 文字と文字がどれだけ重なっていると同じ行とみなすかを設定。

Additional Inherited Members

Public Types inherited from PdfTk::PtlParamSearchText
enum  TEXT_TYPE { TEXT_RAW = 1 , TEXT_SORT = 2 }
 テキスト検索タイプ。 More...
Protected Attributes inherited from PdfTk::PtlParamSearchText
int m_dataParamSearchText

Detailed Description

テキスト検索してハイライト注釈をつけるパラメータを表現したクラスです。

テキスト検索した上でヒットしたテキストの上にハイライト注釈をつけます。

Constructor & Destructor Documentation

◆ PtlParamSearchTextAndHighlight() [1/2]

PdfTk::PtlParamSearchTextAndHighlight::PtlParamSearchTextAndHighlight ( )

コンストラクタ

Exceptions
PtlException

◆ PtlParamSearchTextAndHighlight() [2/2]

PdfTk::PtlParamSearchTextAndHighlight::PtlParamSearchTextAndHighlight ( const PtlParamSearchTextAndHighlight & obj)

コピーコンストラクタ

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

Member Function Documentation

◆ operator=()

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

コピーオペレータ

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

◆ setColor()

void PdfTk::PtlParamSearchTextAndHighlight::setColor ( const PtlColor & color)

Highlight注釈の色を設定。

※ 設定しない場合はデフォルト値として黄色が設定されます。

Parameters
colorHighlight注釈/マスクの色指定。
Exceptions
PtlException

◆ setOpacity()

void PdfTk::PtlParamSearchTextAndHighlight::setOpacity ( float opacity)

Highlight注釈色の不透明度を設定。

※ 設定しない場合はデフォルト値として1.0が設定されます。

Parameters
opacity0.0 〜 1.0。0.0が透明、1.0が不透明。
Exceptions
PtlException