SFOTableCellVisitor

テーブルセルを訪問する Visitor クラスです。

#include <SFOTableCellVisitor.h.hpp>

class SFOTableCellVisitor : public SFORefObject;

SFMTYPEDEFREFOBJECT(SFOTableCellVisitor)

継承図

協調図

解説

SFOTableCellReactor クラスは、テーブルセルを訪問して何らかのアクションを行うためのクラスです。

このクラスは、階層プロパティ（SFXHierarchyProperty）を備えています。

	注意
	このクラスは、テーブルセルリアクター（`SFOTableCellReactor`）の基底クラスになります。

参照

SFXHierarchyProperty | SFOTableCellReactor

メンバ

コンストラクタ/デストラクタ
SFOTableCellVisitor( `Void` ) SFOTableCellVisitor クラスのコンストラクタです。
~SFOTableCellVisitor( `Void` ) SFOTableCellVisitor クラスのデストラクタです。

パブリック関数
`ValueRec`	GetProperty( `UInt32` key , `BoolPtr` found = null , `Bool` recursive = true ) 属性キーに対応する属性値を取得します。
`Bool`	HasProperty( `UInt32` key , `Bool` recursive = true ) 指定された属性キーに対応する属性値が設定されているかどうかを判定します。
`SFCError`	SetProperty( `UInt32` key , `ValueRec` value ) 属性キーに対応する属性値を設定します。

プロテクト関数
`Void`	SetParent( `SFXHierarchyPropertyConstPtr` parent ) 親プロパティを設定します。
static `SFORefObjectSmp`	Factory( `SFORefObjectPtr` object , `SFCErrorPtr` exception ) (SFORefObject から継承) NewInstance 関数の実装を補助します。
`SFCError`	Initialize( `Void` ) (SFORefObject から継承) 初期化を行います。

SFOTableCellVisitor::SFOTableCellVisitor

SFOTableCellVisitor クラスのコンストラクタです。

[ protected, explicit ]
SFOTableCellVisitor(Void);

解説

このコンストラクタは、何も行いません。

SFOTableCellVisitor::~SFOTableCellVisitor

SFOTableCellVisitor クラスのデストラクタです。

[ protected, virtual ]
~SFOTableCellVisitor(Void);

解説

このデストラクタは、何も行いません。

SFOTableCellVisitor::GetProperty

属性キーに対応する属性値を取得します。

[ public, const ]
ValueRec GetProperty(
    UInt32 key              // 検索する属性キー
    BoolPtr found = null    // null 以外の BoolPtr 値を指定すると、属性キーの有無が返る
    Bool recursive = true   // 親プロパティを再帰的に検索するかどうか
);

戻り値

指定された属性キーに対応する属性値（SFXHierarchyProperty::ValueRec）。

解説

この関数は、指定された属性キーに対応する属性値を取得します。

属性キーが見つからなかった場合、null 値が返ります。

	SFXHierarchyProperty::ValueRec の null 値
	`SFXHierarchyProperty::ValueRec` は最大 4 バイトの共用体で、null 値はその全てのビットが 0 になります。従って、型が SFXRGBColor の場合は SFXRGBColor(0x00, 0x00, 0x00, 0x00) で黒色、Bool の場合は false となります。

found 引数を null 以外の BoolPtr 値を指定すると、属性キーの有無が返ります。属性キーの有無を判定するだけなら SFOTableCellVisitor::HasProperty 関数も利用可能です。

recursive 引数に true を指定すると、このクラスのプロパティに属性キーが存在しない場合は、親プロパティが検索対象になり、。最初にヒットした最下層クラスのプロパティの属性値が返ります。

親プロパティ

	親プロパティ
このクラスのプロパティの親プロパティは、 `SFOTableViewColumn` クラスのプロパティです。 `SFOTableViewColumn` クラスのプロパティの親プロパティは、 `SFZTableView` クラスのプロパティです。このクラスのプロパティに属性キーが存在しない場合は、 `SFOTableViewColumn` クラスのプロパティが検索対象となり、 `SFOTableViewColumn` クラスのプロパティにも属性キーが存在しない場合は、 `SFZTableView` クラスのプロパティが検索対象となります。属性キーが見つかった場合、検索はその時点で終了します。

このクラスのプロパティの親プロパティは、 SFOTableViewColumn クラスのプロパティです。 SFOTableViewColumn クラスのプロパティの親プロパティは、 SFZTableView クラスのプロパティです。

このクラスのプロパティに属性キーが存在しない場合は、 SFOTableViewColumn クラスのプロパティが検索対象となり、 SFOTableViewColumn クラスのプロパティにも属性キーが存在しない場合は、 SFZTableView クラスのプロパティが検索対象となります。

属性キーが見つかった場合、検索はその時点で終了します。

	注意
	属性についての詳細は、 `SFXHierarchyProperty` クラスの解説を参照してください。

参照

SFOTableCellVisitor::HasProperty

指定された属性キーに対応する属性値が設定されているかどうかを判定します。

[ public, const ]
Bool HasProperty(
    UInt32 key              // 検索する属性キー
    Bool recursive = true   // 親プロパティを再帰的に検索するかどうか
);

戻り値

キーが見つかったとき: true
そうでないとき: false

解説

この関数は、指定された属性キーに対応する属性値が設定されているかどうかを判定します。

親プロパティ

	親プロパティ
このクラスのプロパティの親プロパティは、 `SFOTableViewColumn` クラスのプロパティです。 `SFOTableViewColumn` クラスのプロパティの親プロパティは、 `SFZTableView` クラスのプロパティです。このクラスのプロパティに属性キーが存在しない場合は、 `SFOTableViewColumn` クラスのプロパティが検索対象となり、 `SFOTableViewColumn` クラスのプロパティにも属性キーが存在しない場合は、 `SFZTableView` クラスのプロパティが検索対象となります。属性キーが見つかった場合、検索はその時点で終了します。

属性キーが見つかった場合、検索はその時点で終了します。

	注意
	属性キーの有無の判定と属性値の取得を同時に行う場合は、 `SFOTableCellVisitor::GetProperty` 関数を使用することを推奨します。この場合、検索の回数が半分になり、パフォーマンスは向上します。

参照

SFOTableCellVisitor::GetProperty | SFOTableCellVisitor::SetProperty | SFXHierarchyProperty | SFOTableViewColumn

SFOTableCellVisitor::SetParent

親プロパティを設定します。

[ protected, const ]
Void SetParent(
    SFXHierarchyPropertyConstPtr parent   // 親プロパティ
);

解説

この関数は、親プロパティを設定します。

この関数は、 SFOTableCellReactor クラスで使用されます。

通常、このクラスの親プロパティは SFOTableViewColumn クラスのプロパティです。

	注意
	属性についての詳細は、 `SFXHierarchyProperty` クラスの解説を参照してください。

参照

SFOTableCellReactor | SFOTableViewColumn

SFOTableCellVisitor::SetProperty

属性キーに対応する属性値を設定します。

[ public ]
SFCError SetProperty(
    UInt32 key       // 設定する属性キー
    ValueRec value   // 設定する属性値
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMOERY

解説

この関数は、指定された属性キーに対応する属性値を設定します。

使用例

以下は、セルのテキストを編集可能にするコードです。

SFOTableCellReactorSmp rtor;

rtor = SFOTableCellTextReactor::NewInstance();
rtor->SetProperty(SFLPROP_EDITABLE, true);

参照

SFOTableCellVisitor::GetProperty | SFOTableCellVisitor::HasProperty | SFXHierarchyProperty::ValueRec | SFXHierarchyProperty | SFOTableCellTextReactor