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

PDFのスタンプ注釈を表現したクラスです。 More...

#include <PtlAnnotStamp.h>

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

Public Types

enum  ICON_TYPE {
  ICON_APPROVED = 1, ICON_AS_IS = 2, ICON_CONFIDENTIAL = 3, ICON_DEPARTMENTAL = 4,
  ICON_DRAFT = 5, ICON_EXPERIMENTAL = 6, ICON_EXPIRED = 7, ICON_FINAL = 8,
  ICON_FOR_COMMENT = 9, ICON_FOR_PUBLIC_RELEASE = 10, ICON_NOT_APPROVED = 11, ICON_NOT_FOR_PUBLIC_RELEASE = 12,
  ICON_SOLD = 13, ICON_TOP_SECRET = 14, ICON_SB_APPROVED = 15, ICON_SB_COMPLETED = 16,
  ICON_SB_CONFIDENTIAL = 17, ICON_SB_DRAFT = 18, ICON_SB_FINAL = 19, ICON_SB_FOR_COMMENT = 20,
  ICON_SB_FOR_PUBLIC_RELEASE = 21, ICON_SB_INFORMATIONONLY = 22, ICON_SB_NOT_APPROVED = 23, ICON_SB_NOT_FOR_PUBLIC_RELEASE = 24,
  ICON_SB_PRELIMINARYRESULTS = 25, ICON_SB_VOID = 26, ICON_CUSTOM = 99, ICON_UNKNOWN = 100
}
 アイコンのタイプ More...
 
- Public Types inherited from 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
}
 注釈のタイプ More...
 
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
}
 注釈フラグ。 More...
 
enum  BORDER_STYLE {
  BORDER_SOLID = 1, BORDER_DASHED = 2, BORDER_BEVELED = 3, BORDER_INSET = 4,
  BORDER_UNDERLINE = 5
}
 境界線スタイル More...
 
enum  BORDER_LINE_WIDTH { BORDER_WIDTH_NONE = 0, BORDER_WIDTH_THIN = 1, BORDER_WIDTH_MIDDLE = 2, BORDER_WIDTH_THICK = 3 }
 境界線幅 More...
 

Public Member Functions

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

Detailed Description

PDFのスタンプ注釈を表現したクラスです。

Member Enumeration Documentation

◆ ICON_TYPE

アイコンのタイプ

Enumerator
ICON_APPROVED 

承認済

ICON_AS_IS 

未変更

ICON_CONFIDENTIAL 

親展

ICON_DEPARTMENTAL 

内部用

ICON_DRAFT 

草稿

ICON_EXPERIMENTAL 

試用

ICON_EXPIRED 

失効

ICON_FINAL 

最終

ICON_FOR_COMMENT 

推敲待

ICON_FOR_PUBLIC_RELEASE 

公開用

ICON_NOT_APPROVED 

却下

ICON_NOT_FOR_PUBLIC_RELEASE 

非公開

ICON_SOLD 

売却済

ICON_TOP_SECRET 

極秘

ICON_SB_APPROVED 

(標準)承認済

ICON_SB_COMPLETED 

(標準)完了

ICON_SB_CONFIDENTIAL 

(標準)極秘

ICON_SB_DRAFT 

(標準)草稿

ICON_SB_FINAL 

(標準)最終

ICON_SB_FOR_COMMENT 

(標準)評価用

ICON_SB_FOR_PUBLIC_RELEASE 

(標準)公開用

ICON_SB_INFORMATIONONLY 

(標準)参照用

ICON_SB_NOT_APPROVED 

(標準)却下

ICON_SB_NOT_FOR_PUBLIC_RELEASE 

(標準)非公開

ICON_SB_PRELIMINARYRESULTS 

(標準)試用結果

ICON_SB_VOID 

(標準)無効

ICON_CUSTOM 

カスタムアイコン

ICON_UNKNOWN 

未知のアイコン

Constructor & Destructor Documentation

◆ PtlAnnotStamp() [1/2]

PdfTk::PtlAnnotStamp::PtlAnnotStamp ( )

コンストラクタ

Exceptions
PtlException

◆ PtlAnnotStamp() [2/2]

PdfTk::PtlAnnotStamp::PtlAnnotStamp ( const PtlAnnotStamp obj)

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

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

Member Function Documentation

◆ getIconName()

PtlParamString PdfTk::PtlAnnotStamp::getIconName ( ) const

アイコン名を取得。

Returns
アイコン名。
Exceptions
PtlException

◆ getIconType()

ICON_TYPE PdfTk::PtlAnnotStamp::getIconType ( ) const

アイコンタイプを取得。

Returns
アイコンタイプ。
Exceptions
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setIconName()

void PdfTk::PtlAnnotStamp::setIconName ( const PtlParamString name)

アイコン名を設定。

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

Parameters
nameアイコン名。
Exceptions
PtlException

◆ setIconType()

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

アイコンタイプを設定。

Parameters
typeアイコンタイプ。
Exceptions
PtlException

◆ setPage()

void PdfTk::PtlAnnotStamp::setPage ( const PtlPage page)

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

Parameters
pageカスタムアイコンに使用するPDF文書のページ。
Exceptions
PtlException