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

#include <PtlAnnotText.h>

PdfTk::PtlAnnotText の継承関係図
PdfTk::PtlAnnotText 連携図

公開型

enum  ICON_TYPE {
  ICON_COMMENT = 1 , ICON_HELP = 2 , ICON_INSERT = 3 , ICON_KEY = 4 ,
  ICON_NEWPARAGRAPH = 5 , ICON_NOTE = 6 , ICON_PARAGRAPH = 7 , ICON_CUSTOM = 99 ,
  ICON_UNKNOWN = 100
}
基底クラス PdfTk::PtlAnnot に属する継承公開型
enum  ANNOT_TYPE {
  TYPE_TEXT = 1 , TYPE_LINK = 2 , TYPE_FREE_TEXT = 3 , TYPE_LINE = 4 ,
  TYPE_SQUARE = 5 , TYPE_CIRCLE = 6 , TYPE_POLYGON = 7 , TYPE_POLYLINE = 8 ,
  TYPE_HIGHLIGHT = 9 , TYPE_UNDERLINE = 10 , TYPE_SQUIGGLY = 11 , TYPE_STRIKEOUT = 12 ,
  TYPE_STAMP = 13 , TYPE_CARET = 14 , TYPE_INK = 15 , TYPE_POPUP = 16 ,
  TYPE_FILE_ATTACHMENT = 17 , TYPE_SOUND = 18 , TYPE_MOVIE = 19 , TYPE_WIDGET = 20 ,
  TYPE_SCREEN = 21 , TYPE_PRINTER_MARK = 22 , TYPE_TRAP_NETWORK = 23 , TYPE_WATERMARK = 24 ,
  TYPE_3D = 25 , TYPE_REDACT = 26 , TYPE_PROJECTION = 27 , TYPE_RICHMEDIA = 28 ,
  TYPE_UNKNOWN = 100
}
enum  ANNOT_FLAGS {
  FLAG_INVISIBLE = 0x00000001 , FLAG_HIDDEN = 0x00000002 , FLAG_PRINT = 0x00000004 , FLAG_NOZOOM = 0x00000008 ,
  FLAG_NOROTATE = 0x00000010 , FLAG_NOVIEW = 0x00000020 , FLAG_READONLY = 0x00000040 , FLAG_LOCKED = 0x00000080 ,
  FLAG_TOGGLE_NOVIEW = 0x00000100 , FLAG_LOCKED_CONTENTS = 0x00000200
}
enum  BORDER_STYLE {
  BORDER_SOLID = 1 , BORDER_DASHED = 2 , BORDER_BEVELED = 3 , BORDER_INSET = 4 ,
  BORDER_UNDERLINE = 5
}
enum  BORDER_LINE_WIDTH { BORDER_WIDTH_NONE = 0 , BORDER_WIDTH_THIN = 1 , BORDER_WIDTH_MIDDLE = 2 , BORDER_WIDTH_THICK = 3 }

公開メンバ関数

 PtlAnnotText ()
 コンストラクタ
 PtlAnnotText (const PtlAnnotText &obj)
 コピーコンストラクタ alias copy
 ~PtlAnnotText ()
 デストラクタ
PtlAnnotTextoperator= (const PtlAnnotText &obj)
 コピーオペレータ alias copy
ICON_TYPE getIconType () const
 アイコンタイプを取得。
void setIconType (ICON_TYPE type)
 アイコンタイプを設定。
const PtlParamStringgetIconName ()
 アイコン名を取得。
void setIconName (const PtlParamString &name)
 アイコン名を設定。
void setPage (const PtlPage &page)
 カスタムアイコンに使用するPDF文書ページを設定。
基底クラス PdfTk::PtlAnnotMarkup に属する継承公開メンバ関数
 PtlAnnotMarkup (ANNOT_TYPE type)
 コンストラクタ
 PtlAnnotMarkup (const PtlAnnotMarkup &obj)
 コピーコンストラクタ alias copy
virtual ~PtlAnnotMarkup ()
 デストラクタ
PtlAnnotMarkupoperator= (const PtlAnnotMarkup &obj)
 コピーオペレータ alias copy
const PtlParamStringgetMarkUpTitle ()
 ポップアップウィンドウのタイトル文字列を取得。
void setMarkUpTitle (const PtlParamString &title)
 ポップアップウィンドウのタイトル文字列を設定。
const PtlParamStringgetMarkUpSubj ()
 サブジェクトの短い説明を取得。
void setMarkUpSubj (const PtlParamString &subj)
 サブジェクトの短い説明を設定。
PtlDate getMarkUpDate () const
 注釈生成日時を取得。
void setMarkUpDate (const PtlDate &date)
 注釈生成日時を設定。
float getMarkUpCA () const
 不透明度を取得。
void setMarkUpCA (float ca)
 不透明度を設定。
bool hasAnnotPopup () const
 ポップアップ注釈を持つか否かを取得。
PtlAnnotPopupgetAnnotPopup ()
 ポップアップ注釈を取得。
void setAnnotPopUp (PtlAnnotPopup &popup)
 ポップアップ注釈を設定。
基底クラス PdfTk::PtlAnnot に属する継承公開メンバ関数
int getHandle () const
 PtlAnnot (ANNOT_TYPE type)
 コンストラクタ
 PtlAnnot (const PtlAnnot &obj)
 コピーコンストラクタ alias copy
virtual ~PtlAnnot ()
 デストラクタ
PtlAnnotoperator= (const PtlAnnot &obj)
 コピーオペレータ alias copy
ANNOT_TYPE getType () const
 注釈タイプを取得。
bool isMarkup () const
 マークアップ注釈か否かを取得。
PtlRect getRect ()
 矩形座標を取得。
void setRect (const PtlRect &rectMM)
 矩形座標を設定。
const PtlParamStringgetTextContents ()
 内容を取得。
void setTextContents (const PtlParamString &contents)
 内容を設定。
PtlDate getDate ()
 日時を取得。
void setDate (const PtlDate &date)
 日時を設定。
int getAnnotFlags ()
 注釈フラグを取得。
void setAnnotFlags (int flag)
 注釈フラグを設定。
const PtlColorgetColor ()
 色を取得。
void setColor (const PtlColorDeviceRGB &color)
 色を設定。
const PtlColorgetInteriorColor ()
 内部色を取得。
void setInteriorColor (const PtlColor &color)
 内部色を設定。
BORDER_STYLE getBorderStyle ()
 境界線スタイルを取得。
void setBorderStyle (BORDER_STYLE style)
 境界線スタイルを設定。
BORDER_LINE_WIDTH getBorderWidth ()
 境界線幅をBORDER_LINE_WIDTHで取得。
void setBorderWidth (BORDER_LINE_WIDTH width)
 境界線幅をBORDER_LINE_WIDTHで設定。
float getBorderWidthNative ()
 注釈に設定してある境界線幅を直接取得。
void setBorderWidthNative (float width)
 注釈の境界線幅を数値で直接設定。
const PtlParamStringgetAnnotationName ()
 注釈名を取得。

詳解

PDFのテキスト注釈を表現したクラスです。

PtlAnnotText.h19 行目に定義があります。

列挙型メンバ詳解

◆ ICON_TYPE

アイコンのタイプ

列挙値
ICON_COMMENT 

コメント

ICON_HELP 

ヘルプ

ICON_INSERT 

テキスト挿入

ICON_KEY 

キー

ICON_NEWPARAGRAPH 

新規段落

ICON_NOTE 

ノート

ICON_PARAGRAPH 

段落

ICON_CUSTOM 

カスタムアイコン

ICON_UNKNOWN 

未知のアイコン

PtlAnnotText.h25 行目に定義があります。

構築子と解体子

◆ PtlAnnotText() [1/2]

PdfTk::PtlAnnotText::PtlAnnotText ( )

コンストラクタ

例外
PtlException

◆ PtlAnnotText() [2/2]

PdfTk::PtlAnnotText::PtlAnnotText ( const PtlAnnotText & obj)

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

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

関数詳解

◆ getIconName()

const PtlParamString & PdfTk::PtlAnnotText::getIconName ( )

アイコン名を取得。

戻り値
アイコン名。
例外
PtlException

◆ getIconType()

ICON_TYPE PdfTk::PtlAnnotText::getIconType ( ) const

アイコンタイプを取得。

戻り値
アイコンタイプ。
例外
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setIconName()

void PdfTk::PtlAnnotText::setIconName ( const PtlParamString & name)

アイコン名を設定。

アイコンタイプとしてICON_CUSTOMを設定した場合にのみ有効となります。
ICON_CUSTOM以外のアイコンタイプでアイコン名を設定すると動作は不定です。

引数
nameアイコン名。
例外
PtlException

◆ setIconType()

void PdfTk::PtlAnnotText::setIconType ( ICON_TYPE type)

アイコンタイプを設定。

引数
typeアイコンタイプ。
例外
PtlException

◆ setPage()

void PdfTk::PtlAnnotText::setPage ( const PtlPage & page)

カスタムアイコンに使用するPDF文書ページを設定。

引数
pageカスタムアイコンに使用するPDF文書のページ。
例外
PtlException