PdfTk::PtlAnnotFileAttachment Class Reference

PDFのファイル添付注釈を表現したクラスです。 More...

#include <PtlAnnotFileAttachment.h>

Inheritance diagram for PdfTk::PtlAnnotFileAttachment:

Collaboration diagram for PdfTk::PtlAnnotFileAttachment:

Public Types
enum	ICON_TYPE {   ICON_GRAPH = 1, ICON_PAPERCLIP = 2, ICON_PUSHPIN = 3, ICON_TAG = 4,   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
	PtlAnnotFileAttachment ()
	コンストラクタ More...
	PtlAnnotFileAttachment (const PtlAnnotFileAttachment &obj)
	コピーコンストラクタ alias copy More...
	‾PtlAnnotFileAttachment ()
	デストラクタ
PtlAnnotFileAttachment &	operator= (const PtlAnnotFileAttachment &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...
PtlParamString	getFileName () const
	添付ファイル名を取得。 More...
void	setFileName (const PtlParamString &filename)
	添付ファイル名を設定。 More...
void	readFile (PtlParamStream &inParam)
	添付するファイルの読み込み。 More...
void	writeFile (PtlParamStream &outParam)
	添付ファイルの書き出し。 More...
Public Member Functions inherited from PdfTk::PtlAnnotMarkup
	PtlAnnotMarkup (ANNOT_TYPE type)
	コンストラクタ More...
	PtlAnnotMarkup (const PtlAnnotMarkup &obj)
	コピーコンストラクタ alias copy More...
virtual	‾PtlAnnotMarkup ()
	デストラクタ
PtlAnnotMarkup &	operator= (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...
PtlAnnotPopup &	getAnnotPopup ()
	ポップアップ注釈を取得。 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 ()
	デストラクタ
PtlAnnot &	operator= (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 PtlColor &	getColor ()
	色を取得。 More...
void	setColor (const PtlColorDeviceRGB &color)
	色を設定。 More...
const PtlColor &	getInteriorColor ()
	内部色を取得。 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

enum PdfTk::PtlAnnotFileAttachment::ICON_TYPE

アイコンのタイプ

Enumerator
ICON_GRAPH	グラフ
ICON_PAPERCLIP	ペーパークリップ
ICON_PUSHPIN	プッシュピン
ICON_TAG	タグ
ICON_CUSTOM	カスタムアイコン
ICON_UNKNOWN	未知のアイコン

Constructor & Destructor Documentation

PtlAnnotFileAttachment() [1/2]

PdfTk::PtlAnnotFileAttachment::PtlAnnotFileAttachment

(

)

コンストラクタ

Exceptions

PtlException

PtlAnnotFileAttachment() [2/2]

PdfTk::PtlAnnotFileAttachment::PtlAnnotFileAttachment

(

const PtlAnnotFileAttachment &

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

getFileName()

PtlParamString PdfTk::PtlAnnotFileAttachment::getFileName

(

)

const

添付ファイル名を取得。

Returns

添付ファイル名

Exceptions

PtlException

getIconName()

PtlParamString PdfTk::PtlAnnotFileAttachment::getIconName

(

)

const

アイコン名を取得。

Returns

アイコン名。

Exceptions

PtlException

getIconType()

ICON_TYPE PdfTk::PtlAnnotFileAttachment::getIconType

(

)

const

アイコンタイプを取得。

Returns

アイコンタイプ。

Exceptions

PtlException

operator=()

PtlAnnotFileAttachment& PdfTk::PtlAnnotFileAttachment::operator=

(

const PtlAnnotFileAttachment &

obj

)

コピーオペレータ alias copy

Parameters

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

readFile()

void PdfTk::PtlAnnotFileAttachment::readFile

(

PtlParamStream &

inParam

)

添付するファイルの読み込み。

Parameters

inParam

入力指定パラメータ。

Exceptions

PtlException

setFileName()

void PdfTk::PtlAnnotFileAttachment::setFileName

(

const PtlParamString &

filename

)

添付ファイル名を設定。

Adobe製品では拡張子付きのファイル名を設定しておかないと添付ファイルを取り出せないようです。

Parameters

filename

添付ファイル名 注意：filenameにはファイル名のみを指定し、パスを含めないでください。

Exceptions

PtlException

setIconName()

void PdfTk::PtlAnnotFileAttachment::setIconName

(

const PtlParamString &

name

)

アイコン名を設定。

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

Parameters

name

アイコン名。

Exceptions

PtlException

setIconType()

void PdfTk::PtlAnnotFileAttachment::setIconType

(

ICON_TYPE

type

)

アイコンタイプを設定。

Parameters

type

アイコンタイプ。

Exceptions

PtlException

setPage()

void PdfTk::PtlAnnotFileAttachment::setPage

(

const PtlPage &

page

)

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

Parameters

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

Exceptions

PtlException

writeFile()

void PdfTk::PtlAnnotFileAttachment::writeFile

(

PtlParamStream &

outParam

)

添付ファイルの書き出し。

Parameters

outParam

出力指定パラメータ。

Exceptions

PtlException