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

カスタムプロパティのコンテナを表現するクラスです。 More...

#include <PtlCustomProperties.h>

Public Member Functions

int getHandle () const
 
 PtlCustomProperties ()
 コンストラクタ More...
 
 PtlCustomProperties (const PtlCustomProperties &obj)
 コピーコンストラクタ alias copy More...
 
 ‾PtlCustomProperties ()
 デストラクタ
 
PtlCustomPropertiesoperator= (const PtlCustomProperties &obj)
 コピーオペレータ alias copy More...
 
bool isEmpty () const
 空かどうかを取得。 More...
 
int getCount () const
 カスタムプロパティ数を取得。 More...
 
PtlCustomProperty get (int index)
 カスタムプロパティを取得。 More...
 
void append (const PtlCustomProperty &custProp)
 カスタムプロパティを追加。 More...
 
void remove (int index)
 カスタムプロパティを削除。 More...
 
void removeAll ()
 カスタムプロパティを全て削除。 More...
 

Detailed Description

カスタムプロパティのコンテナを表現するクラスです。

Constructor & Destructor Documentation

◆ PtlCustomProperties() [1/2]

PdfTk::PtlCustomProperties::PtlCustomProperties ( )

コンストラクタ

Exceptions
PtlException

◆ PtlCustomProperties() [2/2]

PdfTk::PtlCustomProperties::PtlCustomProperties ( const PtlCustomProperties obj)

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

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

Member Function Documentation

◆ append()

void PdfTk::PtlCustomProperties::append ( const PtlCustomProperty custProp)

カスタムプロパティを追加。

最後に、カスタムプロパティを追加します。

Parameters
custPropカスタムプロパティ
Exceptions
PtlException

◆ get()

PtlCustomProperty PdfTk::PtlCustomProperties::get ( int  index)

カスタムプロパティを取得。

指定した番号のカスタムプロパティを取得します。

Parameters
indexIndex番号。0が先頭。
indexが負やカスタムプロパティ数以上の場合は、例外が発生します。
Returns
PtlCustomProperty。
Exceptions
PtlException

◆ getCount()

int PdfTk::PtlCustomProperties::getCount ( ) const

カスタムプロパティ数を取得。

Returns
カスタムプロパティ数。
Exceptions
PtlException

◆ isEmpty()

bool PdfTk::PtlCustomProperties::isEmpty ( ) const

空かどうかを取得。

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

◆ operator=()

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

コピーオペレータ alias copy

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

◆ remove()

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

カスタムプロパティを削除。

指定した番号のカスタムプロパティを削除します。

Parameters
index削除するIndex番号。0が先頭。
indexが負やカスタムプロパティ数以上の場合は、例外が発生します。
Exceptions
PtlException

◆ removeAll()

void PdfTk::PtlCustomProperties::removeAll ( )

カスタムプロパティを全て削除。

Exceptions
PtlException