PDFTool  6.0
Public Member Functions | List of all members
PdfTk::PtlAnnotTextMarkup Class Reference

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

#include <PtlAnnotTextMarkup.h>

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

Public Member Functions

 PtlAnnotTextMarkup (int type)
 コンストラクタ More...
 
 PtlAnnotTextMarkup (ANNOT_TYPE type)
 コンストラクタ More...
 
 PtlAnnotTextMarkup (const PtlAnnotTextMarkup &obj)
 コピーコンストラクタ alias copy More...
 
virtual ‾PtlAnnotTextMarkup ()
 デストラクタ
 
PtlAnnotTextMarkupoperator= (const PtlAnnotTextMarkup &obj)
 コピーオペレータ alias copy More...
 
PtlQuadPointsgetQuadPoints ()
 テキストを囲むQuadPointのコンテナを取得。 More...
 
void setVerticalDirection (bool vert)
 テキストを縦書き方向に囲むかどうかを設定。 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...
 

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

◆ PtlAnnotTextMarkup() [1/3]

PdfTk::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( int  type)

コンストラクタ

Parameters
typeタイプ(ANNOT_TYPE)
Exceptions
PtlException

◆ PtlAnnotTextMarkup() [2/3]

PdfTk::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( ANNOT_TYPE  type)

コンストラクタ

Parameters
typeタイプ
Exceptions
PtlException

◆ PtlAnnotTextMarkup() [3/3]

PdfTk::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( const PtlAnnotTextMarkup obj)

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

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

Member Function Documentation

◆ getQuadPoints()

PtlQuadPoints& PdfTk::PtlAnnotTextMarkup::getQuadPoints ( )

テキストを囲むQuadPointのコンテナを取得。

※ 注意事項
PtlAnnotTextMarkupはPtlQuadPointsにQuadPointを追加したら自動的に矩形座標は設定されますので
基底クラスPtlAnnotのsetRect関数で矩形座標を設定しないでください。

Returns
テキストを囲むQuadPointのコンテナ。
Exceptions
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setVerticalDirection()

void PdfTk::PtlAnnotTextMarkup::setVerticalDirection ( bool  vert)

テキストを縦書き方向に囲むかどうかを設定。

設定しない場合はデフォルト値としてfalse(横方向に囲む)が使用されます。
この設定はハイライト注釈の場合、外観の膨らみの位置に影響します。

Parameters
vertテキストを縦方向に囲むかどうか。trueなら縦方向に配置。
Exceptions
PtlException