Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlLayer クラス

#include <PtlLayer.h>

公開メンバ関数

int getHandle () const
 PtlLayer ()
 コンストラクタ
 PtlLayer (const PtlLayer &obj)
 コピーコンストラクタ
 ~PtlLayer ()
 デストラクタ
PtlLayeroperator= (const PtlLayer &obj)
 コピーオペレータ
const PtlParamStringgetLayerName ()
 レイヤー名を取得。
void setLayerName (const PtlParamString &layername)
 レイヤー名を設定。
bool isRoot () const
 ルートレイヤーかどうかを取得。
bool hasParent ()
 親レイヤーを持つかどうかを取得。
PtlLayer getParent ()
 親レイヤーを取得。
bool hasChild ()
 子レイヤーを持つかどうかを取得。
PtlLayersgetChildren ()
 子レイヤーを取得。
bool isLocked ()
 ロックされているかどうかを取得。
void setLocked (bool lock)
 ロック状態を設定。
bool isChecked ()
 チェックされているかどうかを取得。
void setChecked (bool check)
 チェック状態を設定。ただし、ロックされている場合は失敗する。
bool isRadioGroup ()
 ラジオボタングループかどうかを取得。
bool isEdit ()
 レイヤー名以外の項目を編集できるかどうかを取得。

詳解

PDFのレイヤーを表現したクラスです。

PtlLayer.h20 行目に定義があります。

構築子と解体子

◆ PtlLayer() [1/2]

PdfTk::PtlLayer::PtlLayer ( )

コンストラクタ

例外
PtlException

◆ PtlLayer() [2/2]

PdfTk::PtlLayer::PtlLayer ( const PtlLayer & obj)

コピーコンストラクタ

引数
objコピー元オブジェクト。
例外
PtlException

関数詳解

◆ getChildren()

PtlLayers & PdfTk::PtlLayer::getChildren ( )

子レイヤーを取得。

戻り値
子レイヤー。
例外
PtlException

◆ getLayerName()

const PtlParamString & PdfTk::PtlLayer::getLayerName ( )

レイヤー名を取得。

戻り値
レイヤー名
例外
PtlException

◆ getParent()

PtlLayer PdfTk::PtlLayer::getParent ( )

親レイヤーを取得。

戻り値
親レイヤー。
例外
PtlException

◆ hasChild()

bool PdfTk::PtlLayer::hasChild ( )

子レイヤーを持つかどうかを取得。

戻り値
true: 子レイヤーを持つ。false: 子レイヤーを持たない。
例外
PtlException

◆ hasParent()

bool PdfTk::PtlLayer::hasParent ( )

親レイヤーを持つかどうかを取得。

戻り値
true: 親レイヤーを持つ。false: 親レイヤーを持たない。
例外
PtlException

◆ isChecked()

bool PdfTk::PtlLayer::isChecked ( )

チェックされているかどうかを取得。

戻り値
true: ON。false: OFF。
例外
PtlException

◆ isEdit()

bool PdfTk::PtlLayer::isEdit ( )

レイヤー名以外の項目を編集できるかどうかを取得。

戻り値
true: 編集可能。false: 編集不可。
例外
PtlException

◆ isLocked()

bool PdfTk::PtlLayer::isLocked ( )

ロックされているかどうかを取得。

戻り値
true: ロックされている。false: ロックされていない。
例外
PtlException

◆ isRadioGroup()

bool PdfTk::PtlLayer::isRadioGroup ( )

ラジオボタングループかどうかを取得。

戻り値
true: ラジオボタングループ。false: ラジオボタングループではない。
例外
PtlException

◆ isRoot()

bool PdfTk::PtlLayer::isRoot ( ) const

ルートレイヤーかどうかを取得。

戻り値
true: ルート項目である。false: ルート項目でない。
例外
PtlException

◆ operator=()

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

コピーオペレータ

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

◆ setChecked()

void PdfTk::PtlLayer::setChecked ( bool check)

チェック状態を設定。ただし、ロックされている場合は失敗する。

引数
checktrueならON。falseならOFF。
例外
PtlException

◆ setLayerName()

void PdfTk::PtlLayer::setLayerName ( const PtlParamString & layername)

レイヤー名を設定。

引数
layernameレイヤー名
例外
PtlException

◆ setLocked()

void PdfTk::PtlLayer::setLocked ( bool lock)

ロック状態を設定。

引数
locktrueならロックする。falseならロックを解除
例外
PtlException