PDFTool  7.0
Public Member Functions | List of all members
PdfTk::PtlAnnots Class Reference

注釈のコンテナを表現するクラスです。 More...

#include <PtlAnnots.h>

Public Member Functions

int getHandle () const
 
 PtlAnnots ()
 コンストラクタ More...
 
 PtlAnnots (const PtlAnnots &obj)
 コピーコンストラクタ alias copy More...
 
 ‾PtlAnnots ()
 デストラクタ
 
PtlAnnotsoperator= (const PtlAnnots &obj)
 コピーオペレータ alias copy More...
 
bool isEmpty ()
 空かどうかを取得。 More...
 
int getCount ()
 注釈数を取得。 More...
 
PtlAnnotget (int index)
 注釈を取得。 More...
 
void append (PtlAnnot &annot)
 注釈を追加。 More...
 
void remove (int index)
 注釈を削除。 More...
 
void removeAll ()
 全ての注釈を削除。 More...
 

Detailed Description

注釈のコンテナを表現するクラスです。

Constructor & Destructor Documentation

◆ PtlAnnots() [1/2]

PdfTk::PtlAnnots::PtlAnnots ( )

コンストラクタ

Exceptions
PtlException

◆ PtlAnnots() [2/2]

PdfTk::PtlAnnots::PtlAnnots ( const PtlAnnots obj)

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

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

Member Function Documentation

◆ append()

void PdfTk::PtlAnnots::append ( PtlAnnot annot)

注釈を追加。

注釈を追加します。

Parameters
annot注釈

◆ get()

PtlAnnot& PdfTk::PtlAnnots::get ( int  index)

注釈を取得。

指定位置にある注釈を取得します。
ポップアップ注釈はマークアップ注釈(PtlAnnotMarkup)のサブクラスから取得します。

Parameters
index位置。0が先頭。
indexが負や注釈数以上の場合、例外が発生します。
Returns
注釈
Exceptions
PtlException

◆ getCount()

int PdfTk::PtlAnnots::getCount ( )

注釈数を取得。

Returns
注釈数
Exceptions
PtlException

◆ isEmpty()

bool PdfTk::PtlAnnots::isEmpty ( )

空かどうかを取得。

Returns
true: 空、false: 空ではない。
Exceptions
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ remove()

void PdfTk::PtlAnnots::remove ( int  index)

注釈を削除。

指定位置の注釈を削除し、後続の注釈を前につめます。
注釈を取得している状態で当関数を使用しても動作は保障されません。

Parameters
index位置。0が先頭。
indexが負や注釈数以上の場合、例外が発生します。
Exceptions
PtlException

◆ removeAll()

void PdfTk::PtlAnnots::removeAll ( )

全ての注釈を削除。

注釈を取得している状態で当関数を使用しても動作は保障されません。

Exceptions
PtlException