PDFTool 7.0
Public Types | Public Member Functions | List of all members
PdfTk::PtlParamSearchTextAndSetMask Class Reference

テキスト検索してマスク処理するパラメータを表現したクラスです。
More...

#include <PtlParamSearchTextAndSetMask.h>

Inheritance diagram for PdfTk::PtlParamSearchTextAndSetMask:
Inheritance graph
[legend]
Collaboration diagram for PdfTk::PtlParamSearchTextAndSetMask:
Collaboration graph
[legend]

Public Types

enum  REMOVE_ELEMENT {
  REMOVE_TEXT = 0x00000001 , REMOVE_IMAGE = 0x00000002 , REMOVE_PATH = 0x00000004 , REMOVE_SHADING = 0x00000008 ,
  REMOVE_ALL = 0x0FFFFFFF
}
 追加する削除エレメントの種類。 More...
Public Types inherited from PdfTk::PtlParamSearchText
enum  TEXT_TYPE { TEXT_RAW = 1 , TEXT_SORT = 2 }
 テキスト検索タイプ。 More...

Public Member Functions

 PtlParamSearchTextAndSetMask ()
 コンストラクタ
 PtlParamSearchTextAndSetMask (const PtlParamSearchTextAndSetMask &obj)
 コピーコンストラクタ
 ‾PtlParamSearchTextAndSetMask ()
 デストラクタ
PtlParamSearchTextAndSetMask & operator= (const PtlParamSearchTextAndSetMask &obj)
 コピーオペレータ
void setColor (const PtlColor &color)
 マスクの色設定。
void setOpacity (float opacity)
 マスク色の不透明度を設定。
void setRemoveElement (int remove)
 マスクの削除対象とするエレメントを追加。
Public Member Functions inherited from PdfTk::PtlParamSearchText
int getHandle () const
 PtlParamSearchText ()
 コンストラクタ
 PtlParamSearchText (const PtlParamSearchText &obj)
 コピーコンストラクタ
 ‾PtlParamSearchText ()
 デストラクタ
PtlParamSearchText & operator= (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

Protected Attributes inherited from PdfTk::PtlParamSearchText
int m_dataParamSearchText

Detailed Description

テキスト検索してマスク処理するパラメータを表現したクラスです。

テキスト検索した上でヒットしたテキストをマスク処理します。

Member Enumeration Documentation

◆ REMOVE_ELEMENT

enum PdfTk::PtlParamSearchTextAndSetMask::REMOVE_ELEMENT

追加する削除エレメントの種類。

Enumerator
REMOVE_TEXT 

ヒットしたテキスト以外も削除対象とする。

REMOVE_IMAGE 

画像を削除対象とする。

REMOVE_PATH 

パスを削除対象とする。

REMOVE_SHADING 

シェイディングを削除対象とする。

REMOVE_ALL 

全を削除対象とする。

Constructor & Destructor Documentation

◆ PtlParamSearchTextAndSetMask() [1/2]

PdfTk::PtlParamSearchTextAndSetMask::PtlParamSearchTextAndSetMask ( )

コンストラクタ

Exceptions
PtlException

◆ PtlParamSearchTextAndSetMask() [2/2]

PdfTk::PtlParamSearchTextAndSetMask::PtlParamSearchTextAndSetMask ( const PtlParamSearchTextAndSetMask & obj)

コピーコンストラクタ

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

Member Function Documentation

◆ operator=()

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

コピーオペレータ

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

◆ setColor()

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

マスクの色設定。

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

Parameters
colorマスクの色指定。
Exceptions
PtlException

◆ setOpacity()

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

マスク色の不透明度を設定。

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

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

◆ setRemoveElement()

void PdfTk::PtlParamSearchTextAndSetMask::setRemoveElement ( int remove)

マスクの削除対象とするエレメントを追加。

マスク処理ではテキスト検索した上でヒットしたテキストを削除するのが基本動作ですが、
この関数を用いることによりヒットしたテキストの領域にある他のエレメントを削除対象とすることができます。
※ 設定しない場合はヒットしたテキストのみが削除対象となります。

Parameters
remove追加する削除対象のエレメント。REMOVE_XXXのフラグを論理和で指定します。
Exceptions
PtlException
Generated by doxygen 1.14.0