継承図

協調図

解説

SFOTableViewColumn クラスは、 テーブルビューの 1 つの列を表します。

このクラスは、主に以下の 4 つの機能を提供します。

参照

SFZTableView | SFOTableModelBase | SFOTableCellReactor | SFXHierarchyProperty

メンバ

解説

このコンストラクタでは、 title 引数、modelColumnIndex 引数、reactor 引数を指定することにより、 このテーブルビューカラムのタイトル名、テーブルモデルカラム、テーブルセルリアクターを設定することが可能です。

	注意
	このコンストラクタは SFOTableViewColumn::NewInstance 関数から間接的に呼び出されます。

参照

SFOTableViewColumn::NewInstance | SFOTableViewColumn::SetTitle | SFOTableViewColumn::SetModelColumnIndex | SFOTableViewColumn::SetCellReactor | SFOTableCellReactor

解説

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

解説

この関数は、 テーブルビューカラムのヘッダー部を描画します。

	注意
	階層プロパティの整列属性（SFLPROP_ALIGNMENT）、 フォント属性（SFLPROP_FONT）、前景色（SFLPROP_FOREGROUND_COLOR）を使用してヘッダー領域にタイトル名を描画します。

参照

SFXHierarchyProperty

戻り値

テーブルセルリアクター（SFOTableCellReactor）。

解説

この関数は、 テーブルビューカラムに設定されているテーブルセルリアクター（SFOTableCellReactor）を取得します。

	注意
	テーブルビューカラムへのテーブルセルリアクターの設定は、 SFOTableViewColumn::SetCellReactor 関数を利用して行います。

参照

SFOTableViewColumn::SetCellReactor | SFOTableCellReactor

戻り値

列番号。

解説

この関数は、 このテーブルビューカラムに対応するテーブルモデルカラムのインデックスを取得します。

参照

SFOTableViewColumn::SetModelColumnIndex | SFOTableModelBase

戻り値

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

解説

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

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

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

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

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

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

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

参照

SFOTableViewColumn::SetProperty | SFOTableViewColumn::HasProperty | SFXHierarchyProperty::ValueRec | SFXHierarchyProperty | SFZTableView

戻り値

列のタイトル名

解説

この関数は、 このテーブルビューカラムのタイトル名を取得します。

参照

SFOTableViewColumn::SetTitle | SFXWideString

戻り値

解説

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

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

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

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

参照

SFOTableViewColumn::SetProperty | SFOTableViewColumn::GetProperty | SFXHierarchyProperty | SFZTableView

引数

戻り値

解説

この関数は、SFOTableViewColumn インスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

title 引数、modelColumnIndex 引数、reactor 引数を指定することにより、 このテーブルビューカラムのタイトル名、テーブルモデルカラム、テーブルセルリアクターを設定することが可能です。

	内部処理
	内部でインスタンスの生成は new 演算子で行われ、その後 SFORefObject::Factory 関数に渡されます。

使用例

以下は、SFOTableViewColumn インスタンスを生成するためのコードです。

// SFOTableViewColumn のインスタンスを生成する
SFOTableViewColumnSmp vcol;
SFCError error;

if ((vcol = SFOTableViewColumn::NewInstance(&error)) == SFERR_NO_ERROR) {
    // .. (省略) ..
}

参照

SFOTableViewColumn::SetTitle | SFOTableViewColumn::SetModelColumnIndex | SFOTableViewColumn::SetCellReactor | SFOTableViewColumn | SFORefObject::Factory | SFOTableCellReactor

解説

この関数は、 このテーブルビューカラム（SFOTableViewColumn）に 指定されたテーブルセルリアクター（SFOTableCellReactor）を設定します （テーブルビューカラムにテーブルセルリアクターを関連付けます）。

テーブルセルリアクターは他のテーブルビューカラムと共有できます。 この場合、テーブルセルリアクターの属性は共有されます。

	注意
	SFOTableViewColumn::NewInstance 関数 （SFOTableViewColumn::SFOTableViewColumn コンストラクタ）を利用して設定することも可能です。

使用例

以下は、テーブルビューカラムにテーブルセルリアクターを設定するコードです。

SFOTableViewColumnSmp vcol;
SFOTableCellReactorSmp rtor;
SFCError error;

vcol = SFOTableViewColumn::NewInstance(&error);
rtor = SFOTableCellTextReactor::NewInstance(&error);
vcol->SetCellReactor(rtor);

参照

SFOTableViewColumn::GetCellReactor | SFOTableViewColumn::NewInstance | SFOTableViewColumn::SFOTableViewColumn | SFOTableCellReactor | SFOTableCellTextReactor

解説

この関数は、 このテーブルビューカラムに対応するテーブルモデルカラムのインデックスを設定します （テーブルモデルカラムとテーブルビューカラムを関連付けます）。

	注意
	SFOTableViewColumn::NewInstance 関数 （SFOTableViewColumn::SFOTableViewColumn コンストラクタ）を利用して設定することも可能です。 テーブルビューとテーブルモデルの関連付けは、 SFZTableView::SetModel 関数を利用して行います。

使用例

SFZTableViewSmp view;
SFOTableModelSmp model;
SFXTableItem<2> item;
SFOTableViewColumnSmp vcol;

view = SFZTableView::NewInstance();
model = SFOTableModel::NewInstance();

// 10 行 2 列 [文字列 | Bool 値] のテーブルモデルを作成
for (SInt32 row = 0; row < 10; row++) {
    item.data[0] = SFXAnsiString::Format("item: %d", row);
    item.data[1] = static_cast<Bool>(row % 2);
    model->InsertLast(item);
}

// テーブルビューにテーブルモデルを関連付ける
view->SetModel(model);

vcol = SFOTableViewColumn::NewInstance();
vcol->SetTitle("Toggle");
vcol->SetCellReactor(SFOTableCellToggleReactor::NewInstance());

// 第 2 列目のテーブルモデルカラム（Bool 型）と関連付け、第 1 列目のテーブルビューとする
vcol->SetModelColumnIndex(1);
view->AddColumn(vcol);

vcol = SFOTableViewColumn::NewInstance();
vcol->SetTitle("Text");
vcol->SetCellReactor(SFOTableCellTextReactor::NewInstance());

// 第 1 列目のテーブルモデルカラム（SFXAnsiString 型）と関連付け、第 2 列目のテーブルビューとする
vcol->SetModelColumnIndex(0);
view->AddColumn(vcol);

// ..(省略)..
// テーブルビューは [チェックボックス | テキスト] となる。

参照

SFOTableViewColumn::GetModelColumnIndex | SFOTableViewColumn::NewInstance | SFOTableViewColumn::SFOTableViewColumn | SFZTableView::SetModel | SFOTableModel | SFZTableView | SFXTableItem | SFOTableCellToggleReactor | SFOTableCellTextReactor

戻り値

解説

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

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

使用例

以下は、 テーブルモデルカラムの幅を固定幅にするコードです。

SFOTableViewColumnSmp vcol;

vcol = SFOTableViewColumn::NewInstance();

// テーブルモデルカラムの幅を 20 ピクセルに固定する
vcol->SetProperty(SFLPROP_FIXED_WIDTH, 20);

参照

SFOTableViewColumn::GetProperty | SFOTableViewColumn::HasProperty | SFXHierarchyProperty::ValueRec | SFXHierarchyProperty

戻り値

解説

この関数は、 このテーブルモデルカラムのタイトル名を設定します。

デフォルト値: ""[空文字列]

参照

SFOTableViewColumn::GetTitle | SFOTableViewColumn::NewInstance | SFOTableViewColumn::SFOTableViewColumn | SFXWideString