#include <PtlAnnotFreeText.h>

PdfTk::PtlAnnotFreeText の継承関係図

[凡例]

PdfTk::PtlAnnotFreeText 連携図

[凡例]

公開型
enum	LINE_ENDING_STYLE { STYLE_NONE = 0 , STYLE_SQUARE = 1 , STYLE_CIRCLE = 2 , STYLE_DIAMOND = 3 , STYLE_OPEN_ARROW = 4 , STYLE_CLOSED_ARROW = 5 , STYLE_BUTT = 6 , STYLE_R_OPEN_ARROW = 7 , STYLE_R_CLOSED_ARROW = 8 , STYLE_SLASH = 9 }
基底クラス 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 }

公開メンバ関数
	PtlAnnotFreeText ()
	コンストラクタ
	PtlAnnotFreeText (const PtlAnnotFreeText &obj)
	コピーコンストラクタ alias copy
	~PtlAnnotFreeText ()
	デストラクタ
PtlAnnotFreeText &	operator= (const PtlAnnotFreeText &obj)
	コピーオペレータ alias copy
void	setTextBoxRect (const PtlRect &rectMM)
	テキストボックスの矩形座標を設定。
void	setTextBox (const PtlTextBoxAnnot &textBox)
	テキストボックスを設定。
bool	hasCallout () const
	コールアウトを持っているかどうかを取得。
PtlPoints &	getCalloutPoints ()
	コールアウトの頂点POINTのコンテナを取得。
LINE_ENDING_STYLE	getLineEndingStyle ()
	線端スタイルを取得。
void	setLineEndingStyle (LINE_ENDING_STYLE style)
	線端スタイルを設定。
基底クラス 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のフリーテキスト注釈を表現したクラスです。

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

列挙型メンバ詳解

◆ LINE_ENDING_STYLE

enum PdfTk::PtlAnnotFreeText::LINE_ENDING_STYLE

線端のスタイル

列挙値
STYLE_NONE	なし
STYLE_SQUARE	四角
STYLE_CIRCLE	丸
STYLE_DIAMOND	ダイアモンド
STYLE_OPEN_ARROW	矢印
STYLE_CLOSED_ARROW	矢印(三角形)
STYLE_BUTT	線に垂直な短線
STYLE_R_OPEN_ARROW	矢印(逆向き)
STYLE_R_CLOSED_ARROW	矢印(逆三角形)
STYLE_SLASH	線に30傾いた短線

PtlAnnotFreeText.h の 93 行目に定義があります。

構築子と解体子

◆ PtlAnnotFreeText() [1/2]

PdfTk::PtlAnnotFreeText::PtlAnnotFreeText ( )

コンストラクタ

例外

PtlException

◆ PtlAnnotFreeText() [2/2]

PdfTk::PtlAnnotFreeText::PtlAnnotFreeText ( const PtlAnnotFreeText & obj )

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

引数

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

例外

PtlException

関数詳解

◆ getCalloutPoints()

PtlPoints & PdfTk::PtlAnnotFreeText::getCalloutPoints ( )

コールアウトの頂点POINTのコンテナを取得。

折れ曲がり線は開始点/折れ曲がり点/終了点の3座標
直線は開始点/終了点の2座標
終了点がテキストボックスに接する点です。

戻り値: 頂点Pointのコンテナ。

例外

PtlException

◆ getLineEndingStyle()

LINE_ENDING_STYLE PdfTk::PtlAnnotFreeText::getLineEndingStyle ( )

線端スタイルを取得。

戻り値: 線端スタイル。

例外

PtlException

◆ hasCallout()

bool PdfTk::PtlAnnotFreeText::hasCallout ( ) const

コールアウトを持っているかどうかを取得。

戻り値: true: コールアウト付き。false: コールアウト付きでない。

例外

PtlException

◆ operator=()

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

コピーオペレータ alias copy

引数

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

例外

PtlException

◆ setLineEndingStyle()

void PdfTk::PtlAnnotFreeText::setLineEndingStyle ( LINE_ENDING_STYLE style )

線端スタイルを設定。

※ 注意事項
コールアウトの頂点POINTを設定後に線端スタイルを設定すること

引数

style 線端スタイル。

例外

PtlException

◆ setTextBox()

void PdfTk::PtlAnnotFreeText::setTextBox ( const PtlTextBoxAnnot & textBox )

テキストボックスを設定。

引数

textBox テキストボックス。

例外

PtlException

◆ setTextBoxRect()

void PdfTk::PtlAnnotFreeText::setTextBoxRect ( const PtlRect & rectMM )

テキストボックスの矩形座標を設定。

座標の単位はmmで原点(0,0)は左下となりますので注意してください。
※ 注意事項
PtlAnnotFreeTextはsetTextBoxRectでテキストボックスの矩形を設定したら自動的に注釈の矩形座標は設定されますので
基底クラスPtlAnnotのsetRect関数で矩形座標を設定しないでください。

引数

rectMM 矩形座標

例外

PtlException

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ LINE_ENDING_STYLE

構築子と解体子

◆ PtlAnnotFreeText() [1/2]

◆ PtlAnnotFreeText() [2/2]

関数詳解

◆ getCalloutPoints()

◆ getLineEndingStyle()

◆ hasCallout()

◆ operator=()

◆ setLineEndingStyle()

◆ setTextBox()

◆ setTextBoxRect()