PdfTk::PtlAnnotMarkup Class Reference

PDFのマークアップ注釈を表現したクラスです。
すべてのマークアップ注釈クラスのベースクラスです。 More...

#include <PtlAnnotMarkup.h>

Inheritance diagram for PdfTk::PtlAnnotMarkup:

Collaboration diagram for PdfTk::PtlAnnotMarkup:

Public Member Functions
	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...

Additional Inherited Members
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...

Detailed Description

PDFのマークアップ注釈を表現したクラスです。
すべてのマークアップ注釈クラスのベースクラスです。

Constructor & Destructor Documentation

PtlAnnotMarkup() [1/2]

PdfTk::PtlAnnotMarkup::PtlAnnotMarkup

(

ANNOT_TYPE

type

)

コンストラクタ

Parameters

type

タイプ

Exceptions

PtlException

PtlAnnotMarkup() [2/2]

PdfTk::PtlAnnotMarkup::PtlAnnotMarkup

(

const PtlAnnotMarkup &

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

getAnnotPopup()

PtlAnnotPopup& PdfTk::PtlAnnotMarkup::getAnnotPopup

(

)

ポップアップ注釈を取得。

存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasAnnotPopup関数でポップアップ注釈の有無を確認してください。

Returns

ポップアップ注釈

Exceptions

PtlException

getMarkUpCA()

float PdfTk::PtlAnnotMarkup::getMarkUpCA

(

)

const

不透明度を取得。

Returns

不透明度。
0.0 〜 1.0。0.0が透明、1.0が不透明。

Exceptions

PtlException

getMarkUpDate()

PtlDate PdfTk::PtlAnnotMarkup::getMarkUpDate

(

)

const

注釈生成日時を取得。

Returns

注釈生成の日時オブジェクト

Exceptions

PtlException

getMarkUpSubj()

PtlParamString PdfTk::PtlAnnotMarkup::getMarkUpSubj

(

)

const

サブジェクトの短い説明を取得。

Returns

サブジェクトの短い説明

Exceptions

PtlException

getMarkUpTitle()

PtlParamString PdfTk::PtlAnnotMarkup::getMarkUpTitle

(

)

const

ポップアップウィンドウのタイトル文字列を取得。

Returns

タイトル文字列

Exceptions

PtlException

hasAnnotPopup()

bool PdfTk::PtlAnnotMarkup::hasAnnotPopup

(

)

const

ポップアップ注釈を持つか否かを取得。

Returns

true: ポップアップ注釈を持つ。false: ポップアップ注釈を持たない。

Exceptions

PtlException

operator=()

PtlAnnotMarkup& PdfTk::PtlAnnotMarkup::operator=

(

const PtlAnnotMarkup &

obj

)

コピーオペレータ alias copy

Parameters

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

Exceptions

PtlException

setAnnotPopUp()

void PdfTk::PtlAnnotMarkup::setAnnotPopUp

(

PtlAnnotPopup &

popup

)

ポップアップ注釈を設定。

Parameters

popup

ポップアップ注釈

Exceptions

PtlException

setMarkUpCA()

void PdfTk::PtlAnnotMarkup::setMarkUpCA

(

float

ca

)

不透明度を設定。

Parameters

ca	不透明度。 0.0 〜 1.0。0.0が透明、1.0が不透明。

Exceptions

PtlException

setMarkUpDate()

void PdfTk::PtlAnnotMarkup::setMarkUpDate

(

const PtlDate &

date

)

注釈生成日時を設定。

Parameters

date	注釈生成の日時オブジェクト

Exceptions

PtlException

setMarkUpSubj()

void PdfTk::PtlAnnotMarkup::setMarkUpSubj

(

const PtlParamString &

subj

)

サブジェクトの短い説明を設定。

Parameters

subj	サブジェクトの短い説明

Exceptions

PtlException

setMarkUpTitle()

void PdfTk::PtlAnnotMarkup::setMarkUpTitle

(

const PtlParamString &

title

)

ポップアップウィンドウのタイトル文字列を設定。

Parameters

title

タイトル文字列

Exceptions

PtlException