継承図

協調図

解説

■ 仕様と使い方

SFZTabPage クラスは、 タブコントロール（SFZTabControl）のひとつのタブページを表すコンテナであり、 タブコントロールと共に利用します。

このクラスは、タブコントロールのタブ領域やヒント領域、コンテント領域に情報を表示するための機能を提供します。

タブコントロールのレイアウト

タブページの追加

タブコントロールへのタブページの追加は、 タブページの SFYResponder::SetParent 関数を呼び出して親レスポンダにタブコントロールを設定することにより行います。

	注意
	タブページは、タブコントロールに追加された順に並びます。 この順序を変更するには、タブページを削除して追加しなおす必要があります。 なお、タブページのインデックスは、タブページがタブコントロールに追加された順を表します。

	注意
	コントロールは子レスポンダとしてコンテナ（SFYContainer クラスを継承するレスポンダ）を持ちませんが、 タブコントロールだけは例外的に子レスポンダとしてコンテナを持ちます。

領域の設定

タブページの実領域は、 内部処理により自動的にタブコントロールのコンテント領域に設定されます。 開発者はタブページの実領域を設定する必要はありません。

	タブコントロールのコンテント領域
	タブコントロールのコンテント領域とは、 タブコントロールの領域からヒント領域、タブ領域、ボーダー領域、スクロールバー領域を除いた矩形領域のことです。 タブページの内容が表示される領域であるので、コンテント領域と呼びます。

タブページの仮想領域は、 タブコントロールにすべてのタブページを追加し終えてから一度だけ 明示的に SFYTabControl::AdjustPages 関数を呼び出すことにより行います。 このとき、仮想領域は自動的に計算されて、 タブコントロールのコンテント領域とタブページの子レスポンダを含む最小の矩形領域に設定されます （始点は (0, 0) で、タブページの実領域の始点と同じ）。

	注意
	タブページのすべての子レスポンダがタブコントロールのコンテント領域内に配置される場合、 SFYTabControl::AdjustPages 関数の呼び出しは省略できます。

状態について

タブコントロールは、 以下のようにタブページの状態に応じて描画や、 フォーカス時の振る舞いが異なります。

	注意
	上記のラベルとは、タブコントロールのタブに表示されるタブページのタイトルラベルのことです。

	タブページの初期状態
	インスタンス生成直後、タブページの状態は「可視＋活性＋操作可能＋非フォーカス」に初期化されます。 大抵の場合は、この設定で十分なので、タブページの状態を設定する必要はありません。

タブコントロールのデザイン

タブ領域やヒント領域、ボーダー領域を表示するための関数が利用可能です。 詳しくは、SFZTabControl / SFZTabPage クラスのリファレンスを参照してください。

タブページの選択

タブコントロールには、SFYTabControl::SetFieldValue 関数で設定した数のタブが表示されます。

各タブには対応するタブページが存在し、タブには対応するタブページのタイトルテキストが表示されます （ヒント領域が設定されている場合はヒントテキストも表示されます）。 そのうちの 1 つのタブページだけがフォーカス状態になり、その内容がコンテント領域に表示されます。

SFZTabControl::SetFocusTabTopEdgeEnable 関数で上境界線を有効に設定している場合、 フォーカス状態のタブページに対応するタブの上境界線は SFZTabControl::SetFocusTabTopEdgeColor 関数で設定した色で描画されます。

特定のタブページにフォーカスを移動するには、 SFYTabControl::FocusPage 関数を呼び出します。 現在フォーカスを持つタブページのフォーカスを前後（左右）のタブページに移動するには、 SFYTabControl::FocusLeft / SFYTabControl::FocusRight 関数を呼び出します。

フォーカスの移動先であるタブページのタイトルテキストがタブコントロールのタブ領域に表示されていない場合は、 自動的にタブ領域が左右にスクロールして表示されます。

	注意
	SFYTabControl::FocusLeft / SFYTabControl::FocusRight 関数は、 SFYTabControl::SetFocusLeftKey / SFYTabControl::SetFocusRightKey 関数で設定した左右フォーカス移動キーを押下すると呼び出されます。

	注意
	選択されたタブページは、 フォーカス状態は "true"に設定され、 同じ姉妹タブページの中で最前面に配置されます。 タブコントロールの表示内容の整合性が崩れるので、 タブページに対して SFYResponder::ToFront / SFYResponder::SetStateFocus 関数を呼び出すことは禁止されています。 タブページの内容を表示する場合は、SFYTabControl::FocusPage 関数を使用してください。

タブページを生成するコード

以下は、タブページを生成するコードです。

SFZTabControlSmp _tab;   // タブコントロール
SFZTabPageSmp    _page;  // タブページ

// タブページを生成する
_page = SFZTabPage::NewInstance(&error);

// タブページの親をタブコントロールにする
_page->SetParent(_tab);

// タブページのタイトルを設定する
_page->SetTitle("My page");

// タブページの状態を「可視＋活性＋操作可能＋非フォーカス」にまとめて設定する
// ※デフォルト初期設定の状態と同じなので、次の行は省略可能
_page->SetState(true, true, true, false);

// ■□■  タブページの実領域と仮想領域の設定  ■□■
// 1. タブページの実領域は自動的に設定されるので不要
// 2. タブページの仮想領域は、タブページの子レスポンダがタブコントロールのコンテント領域外に配置される場合に
//    "SFYTabControl::AdjustPages()" を呼び出すことによって設定する（仮想領域のサイズは自動計算される）

	注意
	詳細は、SFZTabControl にあるサンプルコードを参照してください。

タブページの削除

タブコントロールからタブページを削除する方法は以下の通りです。

タブコントロールからタブページを動的に削除するコードは以下の通りです。

// CASE 1. タブページを保持する場合 (親を空にする)
page->SetParent(SFYResponder::EmptyInstance());

// CASE 2. タブページを他のタブコントロールで利用する場合（親を他のタブコントロールに設定する）
SFYTabControlSmp othertab;
page->SetParent(othertab);

// CASE 3. タブページを破棄する場合
page->Terminate();

	タブコントロール再描画の内部実装
	タブページは、タイトルテキスト・画像、ヒントテキスト、テキストの色を属性として持ちます。 属性が変更された場合、 タブページはスタイルイベント[SFEVT_RESPONDER_STYLE]を受信します。 タブコントロールは、タブページがスタイルイベントを受信すると、 再描画する必要があるので自分自身を再描画領域に登録する処理を行います。

参照

タブコントロールとタブページ [SFZTabControl] | スタイルイベント[SFEVT_RESPONDER_STYLE] | SFYContainer | SFZTabControl | SFZTabControl::SetTabBevelColor | SFZTabControl::SetArrowColor

メンバ

解説

このコンストラクタは、以下の初期化処理を行います。

内部実装

このコンストラクタの内部実装は以下の通りです。

/*public */SFZTabPage::SFZTabPage(Void) static_throws
{
    if (static_try()) {
        SetType(CODE_TYPE);
        _title = "";
        _hint  = "";
        _textColor.Set(SFXRGBColor(0x00, 0x00, 0x00, 0x00));
        SetState(true, true, true, false);
    }
}// SFZTabPage::SFZTabPage //

参照

SFYResponder::SetType | SFZTabPage::CodeEnum | SFZTabPage::SetTitle | SFZTabPage::SetHint | SFZTabPage::SetTextColor | SFYResponder::SetState | SFXRGBColor | タイプ | 状態

解説

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

内部実装

このデストラクタの内部実装は以下の通りです。

/*public virtual */SFZTabPage::~SFZTabPage(Void)
{
}// SFZTabPage::~SFZTabPage //

戻り値

ヒントテキスト。

解説

この関数は、ヒントテキストを取得します。

参照

SFZTabPage::SetHint

戻り値

タブコントロール内のタブページのタイトル画像。

解説

この関数は、タブコントロール内のタブページのタイトル画像を取得します。

参照

SFZTabPage::SetImage

戻り値

テキストの色。

解説

この関数は、タイトルテキストとヒントテキストを描画する色を取得します。

参照

SFZTabPage::SetTextColor | SFXRGBColor

戻り値

タイトルテキスト。

解説

この関数は、タイトルテキストを取得します。

参照

SFZTabPage::SetTitle

引数

戻り値

解説

この関数は、SFZTabPage クラスの新しいインスタンスを作成します。

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

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

使用例

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

// タブページのインスタンスを生成する
SFCError error;
SFZTabPageSmp _tabpage;

if ((_tabpage = SFZTabPage::NewInstance(&error)) != null) {
    // ...
}

戻り値

解説

この関数は、タブコントロールのヒント領域に表示される、 タブページのヒントテキストを設定します。

デフォルト値: ""(空文字列)

	タブコントロールとタブページの内部処理
	タブコントロール（SFZTabControl）は、 子レスポンダであるタブページ（SFZTabPage）が挿入されたときに、 スタイルイベント [SFXEventRange(SFEVT_RESPONDER_STYLE, SFEVT_RESPONDER_STYLE, SFP16_BEGIN, SFP16_END)] を処理するハンドラをタブページに登録します。 このタブページは、 ヒントテキストが設定・変更されると、 親レスポンダが設定されている（タブコントロールに挿入されている）場合に限り、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_TEXT, 0)] を受信します。

参照

SFZTabPage::GetHint | SFXEventRange | SFXEvent | スタイルイベント[SFEVT_RESPONDER_STYLE]

戻り値

解説

この関数は、タブページのタイトル画像を設定します。

	注意
	タイトル画像はタブコントロール内の該当するタブのタイトル画像として表示されます。

	タブコントロールとタブページの内部処理
	タブコントロール（SFZTabControl）は、 子レスポンダであるタブページ（SFZTabPage）が挿入されたときに、 スタイルイベント [SFXEventRange(SFEVT_RESPONDER_STYLE, SFEVT_RESPONDER_STYLE, SFP16_BEGIN, SFP16_END)] を処理するハンドラをタブページに登録します。 このタブページは、 タイトル画像が設定・変更されると、 親レスポンダが設定されている（タブコントロールに挿入されている）場合に限り、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_IMAGE, 0)] を受信します。

参照

SFZTabPage::GetImage | SFXEventRange | SFXEvent | スタイルイベント[SFEVT_RESPONDER_STYLE]

解説

この関数は、タイトルテキストとヒントテキストを描画する色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

	タブコントロールとタブページの内部処理
	タブコントロール（SFZTabControl）は、 子レスポンダであるタブページ（SFZTabPage）が挿入されたときに、 スタイルイベント [SFXEventRange(SFEVT_RESPONDER_STYLE, SFEVT_RESPONDER_STYLE, SFP16_BEGIN, SFP16_END)] を処理するハンドラをタブページに登録します。 このタブページは、 テキストの色が設定・変更されると、 親レスポンダが設定されている（タブコントロールに挿入されている）場合に限り、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFZTabPage::GetTextColor | SFXRGBColor | SFXEventRange | SFXEvent | スタイルイベント[SFEVT_RESPONDER_STYLE]

戻り値

解説

このタブページのタイトルテキストを設定します。 このタイトルテキストはタブコントロール内の該当するタブのテキストとして表示されます。

デフォルト値: ""(空文字列)

	タブコントロールとタブページの内部処理
	タブコントロール（SFZTabControl）は、 子レスポンダであるタブページ（SFZTabPage）が挿入されたときに、 スタイルイベント [SFXEventRange(SFEVT_RESPONDER_STYLE, SFEVT_RESPONDER_STYLE, SFP16_BEGIN, SFP16_END)] を処理するハンドラをタブページに登録します。 このタブページは、 タイトルテキストが設定・変更されると、 親レスポンダが設定されている（タブコントロールに挿入されている）場合に限り、 スタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_TEXT, 0)] を受信します。

参照

SFZTabPage::GetTitle | SFXEventRange | SFXEvent | スタイルイベント[SFEVT_RESPONDER_STYLE]

参照

SFYResponder::GetType | SFYResponder::SetType