#include <PtlAnnotFileAttachment.h>

PdfTk::PtlAnnotFileAttachment の継承関係図

[凡例]

PdfTk::PtlAnnotFileAttachment 連携図

[凡例]

公開型
enum	ICON_TYPE { ICON_GRAPH = 1 , ICON_PAPERCLIP = 2 , ICON_PUSHPIN = 3 , ICON_TAG = 4 , 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 }

公開メンバ関数
	PtlAnnotFileAttachment ()
	コンストラクタ
	PtlAnnotFileAttachment (const PtlAnnotFileAttachment &obj)
	コピーコンストラクタ alias copy
	~PtlAnnotFileAttachment ()
	デストラクタ
PtlAnnotFileAttachment &	operator= (const PtlAnnotFileAttachment &obj)
	コピーオペレータ alias copy
ICON_TYPE	getIconType () const
	アイコンタイプを取得。
void	setIconType (ICON_TYPE type)
	アイコンタイプを設定。
const PtlParamString &	getIconName ()
	アイコン名を取得。
void	setIconName (const PtlParamString &name)
	アイコン名を設定。
void	setPage (const PtlPage &page)
	カスタムアイコンに使用するPDF文書ページを設定。
const PtlParamString &	getFileName ()
	添付ファイル名を取得。
void	setFileName (const PtlParamString &filename)
	添付ファイル名を設定。
void	readFile (PtlParamStream &inParam)
	添付するファイルの読み込み。
void	writeFile (PtlParamStream &outParam)
	添付ファイルの書き出し。
基底クラス PdfTk::PtlAnnotMarkup に属する継承公開メンバ関数
	PtlAnnotMarkup (ANNOT_TYPE type)
	コンストラクタ
	PtlAnnotMarkup (const PtlAnnotMarkup &obj)
	コピーコンストラクタ alias copy
virtual	~PtlAnnotMarkup ()
	デストラクタ
PtlAnnotMarkup &	operator= (const PtlAnnotMarkup &obj)
	コピーオペレータ alias copy
const PtlParamString &	getMarkUpTitle ()
	ポップアップウィンドウのタイトル文字列を取得。
void	setMarkUpTitle (const PtlParamString &title)
	ポップアップウィンドウのタイトル文字列を設定。
const PtlParamString &	getMarkUpSubj ()
	サブジェクトの短い説明を取得。
void	setMarkUpSubj (const PtlParamString &subj)
	サブジェクトの短い説明を設定。
PtlDate	getMarkUpDate () const
	注釈生成日時を取得。
void	setMarkUpDate (const PtlDate &date)
	注釈生成日時を設定。
float	getMarkUpCA () const
	不透明度を取得。
void	setMarkUpCA (float ca)
	不透明度を設定。
bool	hasAnnotPopup () const
	ポップアップ注釈を持つか否かを取得。
PtlAnnotPopup &	getAnnotPopup ()
	ポップアップ注釈を取得。
void	setAnnotPopUp (PtlAnnotPopup &popup)
	ポップアップ注釈を設定。
基底クラス PdfTk::PtlAnnot に属する継承公開メンバ関数
int	getHandle () const
	PtlAnnot (ANNOT_TYPE type)
	コンストラクタ
	PtlAnnot (const PtlAnnot &obj)
	コピーコンストラクタ alias copy
virtual	~PtlAnnot ()
	デストラクタ
PtlAnnot &	operator= (const PtlAnnot &obj)
	コピーオペレータ alias copy
ANNOT_TYPE	getType () const
	注釈タイプを取得。
bool	isMarkup () const
	マークアップ注釈か否かを取得。
PtlRect	getRect ()
	矩形座標を取得。
void	setRect (const PtlRect &rectMM)
	矩形座標を設定。
const PtlParamString &	getTextContents ()
	内容を取得。
void	setTextContents (const PtlParamString &contents)
	内容を設定。
PtlDate	getDate ()
	日時を取得。
void	setDate (const PtlDate &date)
	日時を設定。
int	getAnnotFlags ()
	注釈フラグを取得。
void	setAnnotFlags (int flag)
	注釈フラグを設定。
const PtlColor &	getColor ()
	色を取得。
void	setColor (const PtlColorDeviceRGB &color)
	色を設定。
const PtlColor &	getInteriorColor ()
	内部色を取得。
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 PtlParamString &	getAnnotationName ()
	注釈名を取得。

詳解

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

PtlAnnotFileAttachment.h の 20 行目に定義があります。

列挙型メンバ詳解

◆ ICON_TYPE

enum PdfTk::PtlAnnotFileAttachment::ICON_TYPE

アイコンのタイプ

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

PtlAnnotFileAttachment.h の 26 行目に定義があります。

構築子と解体子

◆ PtlAnnotFileAttachment() [1/2]

PdfTk::PtlAnnotFileAttachment::PtlAnnotFileAttachment ( )

コンストラクタ

例外

PtlException

◆ PtlAnnotFileAttachment() [2/2]

PdfTk::PtlAnnotFileAttachment::PtlAnnotFileAttachment ( const PtlAnnotFileAttachment & obj )

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

引数

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

例外

PtlException

関数詳解

◆ getFileName()

const PtlParamString & PdfTk::PtlAnnotFileAttachment::getFileName ( )

添付ファイル名を取得。

戻り値: 添付ファイル名

例外

PtlException

◆ getIconName()

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

アイコン名を取得。

戻り値: アイコン名。

例外

PtlException

◆ getIconType()

ICON_TYPE PdfTk::PtlAnnotFileAttachment::getIconType ( ) const

アイコンタイプを取得。

戻り値: アイコンタイプ。

例外

PtlException

◆ operator=()

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

コピーオペレータ alias copy

引数

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

◆ readFile()

void PdfTk::PtlAnnotFileAttachment::readFile ( PtlParamStream & inParam )

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

引数

inParam 入力指定パラメータ。

例外

PtlException

◆ setFileName()

void PdfTk::PtlAnnotFileAttachment::setFileName ( const PtlParamString & filename )

添付ファイル名を設定。

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

引数

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

例外

PtlException

◆ setIconName()

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

アイコン名を設定。

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

引数

name アイコン名。

例外

PtlException

◆ setIconType()

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

アイコンタイプを設定。

引数

type アイコンタイプ。

例外

PtlException

◆ setPage()

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

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

引数

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

例外

PtlException

◆ writeFile()

void PdfTk::PtlAnnotFileAttachment::writeFile ( PtlParamStream & outParam )

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

引数

outParam 出力指定パラメータ。

例外

PtlException

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ ICON_TYPE

構築子と解体子

◆ PtlAnnotFileAttachment() [1/2]

◆ PtlAnnotFileAttachment() [2/2]

関数詳解

◆ getFileName()

◆ getIconName()

◆ getIconType()

◆ operator=()

◆ readFile()

◆ setFileName()

◆ setIconName()

◆ setIconType()

◆ setPage()

◆ writeFile()