継承図

協調図

解説

タブコントロール（SFZTabControl）は、 複数のタブページ（SFZTabPage）をタブ形式のユーザーインターフェースで管理する機能を提供します。

タブコントロールへのタブページの挿入は、 タブページの親レスポンダをタブコントロールに設定することにより行います。

タブページの表示切り替えは、タブコントロールのタブのフォーカス移動によって行います。

SFZTabControl のレイアウト

タブページの追加

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

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

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

領域の設定

SFYResponder::SetRealBound 関数を呼び出してタブコントロールの実領域を設定します。

	注意
	内部処理により、 タブコントロールの仮想領域は、 常に実領域に一致します。

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

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

タブページの仮想領域は、 タブコントロールにすべてのタブページを追加し終えてから一度だけ 明示的に 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 関数を使用してください。

タブページの削除

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

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

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

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

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

５つのタブページを持つタブコントロールを生成するためのコード

Void UserAppClass::Main(Void)
{
    SFBShellSmp         shell = SFBShell::GetInstance();
    SFBImageSmp         image;
    SFCError            error(SFERR_NO_ERROR);

    // ウインドウを生成する
    SFZWindowSmp window = SFZWindow::NewInstance();
    window->SetParent(GetThis());                  // UserAppClass を親にする
    window->SetRealBound(GetLocalBound());         // UserAppClass のローカル領域を実領域にする
    window->SetState(true, true, true, true);      // 可視・活性・操作可能・フォーカス状態

    // [必須] タブコントロールを生成する 
    SFZTabControlSmp tab = SFZTabControl::NewInstance(&error);

    // [必須] 親を設定する 
    tab->SetParent(window);

    // [必須] 実領域を設定する 
    tab->SetRealBound(window->GetLocalBound());

    // [任意] タブの背景色 (薄緑色) を設定する 
    tab->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

    // [必須] 可視・活性・操作可能・フォーカス状態に設定する 
    tab->SetState(true, true, true, true);

    // [必須] タブページを生成する 
    SFZTabPageSmp pageA = SFZTabPage::NewInstance(&error);
    SFZTabPageSmp pageB = SFZTabPage::NewInstance(&error);
    SFZTabPageSmp pageC = SFZTabPage::NewInstance(&error);
    SFZTabPageSmp pageD = SFZTabPage::NewInstance(&error);
    SFZTabPageSmp pageE = SFZTabPage::NewInstance(&error);

    // [必須] タブページの親をタブコントロールに設定する 
    // ( 親を設定した順番でタブには表示される )
    pageA->SetParent(tab);
    pageB->SetParent(tab);
    pageC->SetParent(tab);
    pageD->SetParent(tab);
    pageE->SetParent(tab);

    // [任意] タブページタイトル文字列を設定する 
    pageA->SetTitle("A");
    pageB->SetTitle("B");
    pageC->SetTitle("C");
    pageD->SetTitle("D");
    pageE->SetTitle("E");

    // [任意] タブページタイトル画像を設定する 
    image = shell->LoadResImage(SAMPLETAB_RES_FILE, IDI_OBJECT_5001);
    pageA->SetImage(image);
    image = shell->LoadResImage(SAMPLETAB_RES_FILE, IDI_OBJECT_5002);
    pageB->SetImage(image);
    image = shell->LoadResImage(SAMPLETAB_RES_FILE, IDI_OBJECT_5003);
    pageD->SetImage(image);
    image = shell->LoadResImage(SAMPLETAB_RES_FILE, IDI_OBJECT_5004);
    pageE->SetImage(image);

    // [任意] タブページのヒントテキストを設定する 
    pageA->SetHint("ボタン A を表示します。");
    pageB->SetHint("タブに表示されません。");
    pageC->SetHint("選択できません。");
    pageD->SetHint("ボタン D を表示します。");
    pageE->SetHint("ボタン E を表示します。");

    // [必須] 各タブページの状態を設定する 
    // (タブページ B は表示されず、タブページ C は選択不可になる)
    pageA->SetState(true, true, true, false);       // 操作可能
    pageB->SetState(true, false, false, false);     // 非活性
    pageC->SetState(false, false, false, false);    // 非可視
    pageD->SetState(true, true, true, false);       // 操作可能
    pageE->SetState(true, true, true, false);       // 操作可能

    // [任意] タブページ内のアイテムを設定する 
    SFZTextButtonControlSmp buttonA = SFZTextButtonControl::NewInstance();
    SFZTextButtonControlSmp buttonD = SFZTextButtonControl::NewInstance();
    SFZTextButtonControlSmp buttonE = SFZTextButtonControl::NewInstance();
    buttonA->SetParent(pageA);
    buttonD->SetParent(pageD);
    buttonE->SetParent(pageE);
    buttonA->SetText("ボタン A");
    buttonD->SetText("ボタン D");
    buttonE->SetText("ボタン E");
    buttonA->SetRealBound(SFXRectangle(70, 0, 100, 25));
    buttonD->SetRealBound(SFXRectangle(70, 150, 100, 25));
    buttonE->SetRealBound(SFXRectangle(70, 250, 100, 25));
    buttonA->SetState(true, true, true, true);
    buttonD->SetState(true, true, true, true);
    buttonE->SetState(true, true, true, true);

    // [任意] タブコントロール領域に同時に 4 つのタブページが表示されるように設定する 
    tab->SetFieldValue(4);

    // [任意] ボーダーを描画する 
    tab->SetDrawBorder(true);

    // [任意] スクロールバーの幅を設定する 
    tab->SetScrollBarWidth(7);

    // [任意] パディング値を設定する (必ず0以上) 
    tab->SetPadding(4);

    // [推奨] タブページ pageD を選択する (pageD を最前面に移動させ表示する) 
    tab->FocusPage(3); 

    // 選択されているタブが現在表示されているタブページに一致しなくなる可能性があるため、
    // 下記の方法により pageD を最前面に移動させてはいけない(禁止事項)
    // × pageD->ToFront();

    // ■□■  タブページの仮想領域設定  ■□■
    // ※1. タブページの内容（子レスポンダ）がタブコントロールのコンテント領域外に配置される場合は、
    //      SFYTabControl::AdjustPages 関数を呼び出してタブページの仮想領域を設定する必要がある 
    // ※2. この例では、タブページの内容がすべてタブコントロールのコンテント領域内に収まっているので、
    //      SFYTabControl::AdjustPages 関数を呼び出す必要はない 

    return;
}

実行結果:

コントロール値の役割と制限について

最小値は、常に 0 です。

現在値は、選択されているタブページのインデックスを表します。 タブページが存在しない場合は -1 になります。 タブページの選択は、 SFYControl::SetCurrentValue 関数ではなく SFYTabControl::FocusPage 関数を使用します。

最大値は、タブコントロールのタブページ数を表します（※この機能は将来的に廃止される予定です）。 タブページ数の取得には、SFYTabControl::GetPageCount 関数を使用してください。

フィールド値は、タブの数を表します。 必ず 1 以上の値を設定する必要があります。

トップ値は、一番左側のタブに対応するタブページのインデックスを表します。

仕様上の制限

タブコントロールの子レスポンダに、 SFZTabPage クラスかそれを継承するクラス以外のレスポンダを登録した時の動作は未定義です。

SFYControl::SetMinimumValue, SFYControl::SetMaximumValue, SFYControl::SetCurrentValue で最小値、最大値、現在値を変更してはいけません。

参照

タブコントロールとタブページ [SFZTabControl] | SFYControl | SFYTabControl | SFZTabPage | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | SFYTabControl::AdjustPages | SFYTabControl::FocusPage | 実領域 | 仮想領域

メンバ

解説

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

内部実装

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

/*protected */SFZTabControl::SFZTabControl(Void) static_throws
{
    static SFXBevelColor::AtomRecConst          bevel[] = {
        {{{{0x00, 0x9F, 0x9F, 0x9F}}}, {{{0x00, 0xDD, 0xDD, 0xDD}}}, {{{0x00, 0x6C, 0x6C, 0x6C}}}}
    };
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0xBF, 0xF3}}},           // light blue : arrow
        {{{0x00, 0x11, 0x22, 0xBB}}}            // blue : edge
    };
    static SFXEventRange::AtomRecConst          range[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,       SFP16_STYLE_ALIGN,       SFP16_STYLE_ALIGN},
        { SFEVT_RESPONDER_OWNER,  SFEVT_RESPONDER_OWNER,    SFP16_OWNER_REGISTER,    SFP16_OWNER_REGISTER},
        { SFEVT_RESPONDER_OWNER,  SFEVT_RESPONDER_OWNER,  SFP16_OWNER_UNREGISTER,  SFP16_OWNER_UNREGISTER},
    };
    SFYHandler::RuleRec                         rule[lengthof(range)];

    if (static_try()) {
        SetType(CODE_TYPE);
        rule[0].spp = XANDLER_FUNCTION(OnStyle);
        rule[0].reference = this;
        rule[1].spp = XANDLER_FUNCTION(OnChildInsert);
        rule[1].reference = this;
        rule[2].spp = XANDLER_FUNCTION(OnChildRemove);
        rule[2].reference = this;
        static_throw(RegisterHandler(atomic_cast(range), rule, lengthof(range)));
        if (static_try()) {
            _color.tabBevel.Set(bevel[0]);
            _color.hintBevel.Set(bevel[0]);
            _color.arrow.Set(rgb[0]);
            _color.edge.Set(rgb[1]);
            _font = AEE_FONT_NORMAL;
            _hintHeight = 2 + SFXGraphics::GetFontHeight(_font);
            _tabHeight = TAB_BASE_HEIGHT + SFXGraphics::GetFontHeight(_font);
            _padding = DEFAULT_PADDING;
            _border = false;
            _edgeEnable = true;
        }
    }
}// SFZTabControl::SFZTabControl //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZTabControl, OnStyle, invoker, reason)
{
    unused(invoker);
    unused(reason);

    Relocate();
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZTabControl, OnStyle, invoker, reason) //

/*private */XANDLER_IMPLEMENT_VOIDOWNER(SFZTabControl, OnChildInsert, invoker, reason, responder)
{
    SFZTabPageSmp                               page;
    unused(invoker);
    unused(reason);

    if (static_pointer_cast<SFYResponder>(GetScrollBarControl()) != responder) {
        page = static_pointer_cast<SFZTabPage>(SFYResponderSmp(responder));
        if (static_try()) {
            static_throw(page->RegisterHandler(
                SFXEventRange(SFEVT_RESPONDER_STYLE, SFEVT_RESPONDER_STYLE, SFP16_BEGIN, SFP16_END),
                XANDLER_INTERNAL(OnPageStyle)
            ));
        }
    }
    return;
}// XANDLER_IMPLEMENT_VOIDOWNER(SFZTabControl, OnChildInsert) //

/*private */XANDLER_IMPLEMENT_VOIDOWNER(SFZTabControl, OnChildRemove, invoker, reason, responder)
{
    SFZTabPageSmp                               page;
    unused(invoker);
    unused(reason);

    if (static_pointer_cast<SFYResponder>(GetScrollBarControl()) != responder) {
        page = static_pointer_cast<SFZTabPage>(SFYResponderSmp(responder));
        page->UnregisterHandler(
            SFXEventRange(SFEVT_RESPONDER_STYLE, SFEVT_RESPONDER_STYLE, SFP16_BEGIN, SFP16_END),
            XANDLER_INTERNAL(OnPageStyle)
        );
    }
    return;
}// XANDLER_IMPLEMENT_VOIDOWNER(SFZTabControl, OnChildRemove) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZTabControl, OnPageStyle, invoker, reason)
{
    unused(invoker); unused(reason);
    Invalidate();
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZTabControl, OnPageStyle) //

参照

SFYResponder::SetType | SFZTabControl::CodeEnum | SFZTabControl::SetTabBevelColor | SFZTabControl::SetHintBevelColor | SFZTabControl::SetArrowColor | SFZTabControl::SetFocusTabTopEdgeColor | SFZTabControl::SetFont | SFZTabControl::SetTabHeight | SFZTabControl::SetHintHeight | SFZTabControl::SetPadding | SFZTabControl::SetDrawBorder | SFZTabControl::SetFocusTabTopEdgeEnable | SFXBevelColor | SFXRGBColor | タイプ

解説

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

内部実装

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

/*protected virtual */SFZTabControl::~SFZTabControl(Void)
{
}// SFZTabControl::~SFZTabControl //

戻り値

タブの左右にある矢印（三角形）の色。

解説

この関数は、 タブの左右にある矢印（三角形）の色を取得します。

参照

SFZTabControl::SetArrowColor | SFXRGBColor

戻り値

フォーカスタブの上境界線の色。

解説

この関数は、フォーカスタブの上境界線の色を取得します。

	注意
	フォーカスタブとは、タブコントロールでフォーカスを持つ（現在選択中の状態にある）タブのことです。 このタブに対応するタブページはフォーカス状態にあります。 有効フラグの値が true、かつ、タブコントロールのフォーカス状態が ON であるときに限り フォーカスタブの上境界線は描画されます。 なお、フォーカスタブの上境界線に関する有効フラグと色は、 SFZTabControl::SetFocusTabTopEdgeEnable / SFZTabControl::SetFocusTabTopEdgeColor 関数で設定します。

参照

SFZTabControl::SetFocusTabTopEdgeColor | SFZTabControl::SetFocusTabTopEdgeEnable | SFXRGBColor

戻り値

フォーカスタブの上境界線に関する有効フラグの値。

解説

この関数は、フォーカスタブの上境界線に関する有効フラグの値を取得します。

	注意
	フォーカスタブとは、タブコントロールでフォーカスを持つ（現在選択中の状態にある）タブのことです。 このタブに対応するタブページはフォーカス状態にあります。 有効フラグの値が true、かつ、タブコントロールのフォーカス状態が ON であるときに限り フォーカスタブの上境界線は描画されます。 なお、フォーカスタブの上境界線に関する有効フラグと色は、 SFZTabControl::SetFocusTabTopEdgeEnable / SFZTabControl::SetFocusTabTopEdgeColor 関数で設定します。

参照

SFZTabControl::SetFocusTabTopEdgeEnable | SFZTabControl::SetFocusTabTopEdgeColor

戻り値

タブページのタイトルテキストとヒントテキストを描画するフォント。

解説

この関数は、タブページのタイトルテキストとヒントテキストを描画するフォントを取得します。

参照

SFZTabControl::SetFont | BREW API AEEFont

戻り値

ヒント領域のベベルカラー。

解説

この関数は、 ヒント領域のベベルカラーを取得します。

	注意
	ヒント領域とは、 SFZTabPage::SetHint 関数で設定する、 タブページのヒントテキストを描画する領域です。

参照

SFZTabControl::SetHintBevelColor | SFZTabPage::SetHint | SFXBevelColor

戻り値

ヒント領域の高さ。[単位:ピクセル]

解説

この関数は、ヒント領域の高さを取得します。[単位:ピクセル]

	注意
	ヒント領域とは、 SFZTabPage::SetHint 関数で設定する、 タブページのヒントテキストを描画する領域です。

参照

SFZTabControl::SetHintHeight | SFZTabPage::SetHint

戻り値

パディングサイズ。[単位:ピクセル]

解説

この関数は、パディングサイズを取得します。[単位:ピクセル]

	注意
	パディングサイズとは、隣接する 2 つのタブとタブの間の空白サイズのことです。 なお、この空白領域は、 SFYWidget::SetBackgroundColor 関数で設定する、 タブコントロールの背景色で塗り潰されます。

参照

SFZTabControl::SetPadding | SFYWidget::SetBackgroundColor

戻り値

指定されたインデックスのタブページ。

解説

この関数は、指定されたインデックスのタブページを取得します。

指定されたインデックスのタブページが存在しない場合は、 SFZTabPageSmp::EmptyInstance() を返します。

参照

SFYTabControl::GetIndex | SFXResponderPointer::EmptyInstance

戻り値

活性状態にあるタブページに対応するタブ領域のベベルカラー。

解説

この関数は、タブ領域のベベルカラーを取得します。

	注意
	このベベルカラーは、活性状態のタブページに対応するタブ領域の色です。 可視かつ非活性状態のタブページに対応するタブ領域の色は、 このベベルカラーに基づいて自動計算されます。

	注意
	タブ領域とは、 SFZTabPage::SetTitle / SFZTabPage::SetImage 関数で設定する、 タブページのタイトルテキスト・画像を描画する領域です。

参照

SFZTabControl::SetTabBevelColor | SFZTabPage::SetTitle | SFZTabPage::SetImage | SFXBevelColor | SFXRGBColor

戻り値

対応するタブページのタイトルを描画するためのタブ領域の高さ。[単位:ピクセル]

解説

この関数は、タブ領域の高さを取得します。[単位:ピクセル]

	注意
	タブ領域とは、 SFZTabPage::SetTitle / SFZTabPage::SetImage 関数で設定する、 タブページのタイトルテキスト・画像を描画する領域です。

参照

SFZTabControl::SetTabHeight | SFZTabPage::SetTitle | SFZTabPage::SetImage

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] を受信したときに呼び出されます。

実領域の変更時に追加の処理を行いたい場合は、 この関数をオーバーライドします。

デフォルトの実装では、タブコントロールのすべてのコンポーネントの位置とサイズを再計算し、スクロールバーも再計算します。 また仮想領域を実領域に一致させます。そして再描画領域に登録します。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベント]
	SFYResponder::SetRealBound 関数は、この関数内の処理により実領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundReal 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の実領域が設定されています。

	実領域が変化した時の処理
	SFYWidget::HandleBoundReal 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 実領域の変更処理は、最初に SFYWidget::HandleBoundReal 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundReal 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZTabControl::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    Relocate();
    Invalidate();
    return;
}// SFZTabControl::HandleBoundReal //

/*private */Void SFZTabControl::Relocate()
{
    SFXRectangle                                lx;
    SFXRectangle                                content;
    SFYScrollBarControlSmp                      bar;

    lx.Set(GetLocalBound());
    _rcHint.Set(SFXGrid::ZeroInstance(), SFXSize(lx.GetWidth(), _hintHeight));
    _rcTabs.Set(_rcHint.GetLeftBottom(), SFXSize(lx.GetWidth(), _tabHeight));
    _rcBody.Set(lx).SetTop(_rcTabs.GetBottom());
    content.Set(_rcBody);
    if (_border) {
        content.Deflate(TAB_BORDER_WIDTH, 0, TAB_BORDER_WIDTH, TAB_BORDER_WIDTH);
    }
    if ((bar = GetScrollBarControl()) != null) {
        if (bar->GetStateVisible()) {
            content.SubWidth(GetScrollBarWidth());
            bar->SetRealBound(SFXRectangle(content.GetRight(), content.GetY(), GetScrollBarWidth(), content.GetHeight()));
        }
    }
    SetContentBound(content);
    return;
}// SFZTabControl::Relocate //

参照

SFYResponder::SetRealBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、仮想領域を実領域に一致させます。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZTabControl::HandleBoundVirtual(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFZTabControl::HandleBoundVirtual //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、 描画イベント [SFXEvent(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, graphics)] を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装は、タブコントロールを描画します。

レスポンダの描画手順

SFYResponder::Invalidate 関数を使用して再描画領域を登録します。 イベントループの最後、 アプリ開始/レジュームまたは優先的イベントハンドラ終了のタイミング、 あるいは、コールバックなどのイベントループの外で、 自動的に、あるいは、明示的に SFYResponder::Render 関数を呼び出します。 描画エンジンが起動されます。 再描画が必要なレスポンダだけが描画イベントを受信します。 SFYWidget クラスを継承するレスポンダが描画イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した描画ハンドラの処理により、 SFYWidget::HandleRenderRequest 仮想関数が呼び出されます。 その後、描画ハンドラが登録した順に呼び出されます。 実際にレスポンダが描画されます。 Tip 描画ハンドラの宣言と登録の手間を省けるので、 通常は SFYWidget::HandleRenderRequest 仮想関数だけを利用してレスポンダを描画します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZTabControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawAllTab(graphics);
    if (_border) {
        DrawBorder(graphics);
    }
    return;
}// SFZTabControl::HandleRenderRequest //

/*private */Void SFZTabControl::DrawAllTab(SFXGraphicsPtr graphics) const
{
    SFXRectangle                                rAllTab;
    SFXRectangle                                rBase;
    SFXRectangle                                rLeft;
    SFXRectangle                                rRight;
    SFXRectangle                                r1;
    SInt32                                      visPageNum;
    SInt16                                      oneTabWidth;
    SInt16                                      arrow;

    if (_hintHeight > 0) {
        SFXBevelColor                           cHint;

        cHint.Set(_color.hintBevel);
        if (!GetStateActive(true)) {
            (cHint.GetBase().GetBrightness() > 0x7F) ? cHint.SubRGB(OFFSET_INACTIVE) : cHint.AddRGB(OFFSET_INACTIVE);
        }
        graphics->FillBevelRectangle(_rcHint, cHint);
    }
    rAllTab.Set(_rcTabs);
    rAllTab.SubHeight(TAB_BASE_HEIGHT);
    rBase.Set(_rcTabs);
    rBase.SetTop(rAllTab.GetBottom());
    graphics->FillBevelRectangle(rBase, _color.tabBevel);
    if (GetFieldValue() > 0) {
        if ((visPageNum = GetPageCount(true, false, false)) > GetFieldValue()) {
            arrow = SFXGraphics::MeasureSingleText(_font, "<");
            rLeft.Set(rAllTab);
            rLeft.SetWidth(arrow);
            rRight.Set(rLeft);
            rRight.AddX(rAllTab.GetWidth() - rLeft.GetWidth());
            rAllTab.Deflate(arrow, 0);
            if (GetTabLoop() || GetTopValue() > FirstIndexOf(true, false, false)) {
                DrawLeftTriangle(graphics, rLeft);
            }
            if (GetTabLoop() || GetBottomValue() < LastIndexOf(true, false, false)) {
                DrawRightTriangle(graphics, rRight);
            }
        }
        oneTabWidth = static_cast<SInt16>((rAllTab.GetWidth() - (GetFieldValue() + 1) * _padding) / GetFieldValue());
        r1.Set(rAllTab);
        r1.SetWidth(oneTabWidth);
        if (visPageNum > 0) {
            SFXRectangle                            cx;
            SInt32                                  i;
            SInt32                                  k;
            SInt32                                  offsetNum;

            if (visPageNum >= GetFieldValue()) {
                offsetNum = GetFieldValue() - 1;
            }
            else {
                offsetNum = visPageNum - 1;
            }
            r1.AddX(static_cast<SInt16>(offsetNum * (oneTabWidth + _padding)));
            for (i = 0, k = GetBottomValue(); i < GetFieldValue(); ++i) {
                if (k >= 0 && k >= GetTopValue()) {
                    if (k != GetCurrentValue()) {
                        DrawOneTab(graphics, r1, k);
                    }
                    else {
                        cx.Set(r1);
                    }
                    r1.SubX(oneTabWidth + _padding);
                    k = PrevIndexOf(k, true, false, false);
                }
                else {
                    break;
                }
            }
            if (GetTopValue() <= GetCurrentValue() && GetCurrentValue() <= GetBottomValue()) {
                DrawOneTab(graphics, cx, GetCurrentValue());
            }
        }
        else {
            DrawOneTab(graphics, r1, -1);
        }
    }
    return;
}// SFZTabControl::DrawAllTab //

/*private */Void SFZTabControl::DrawOneTab(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle, SInt32 index) const
{
    SFXRectangle                                rOne;
    SFXTriangle                                 triPiece;
    SFXBevelColor                               cBevel;
    SFZTabPageSmp                               page;
    UInt08                                      diffBevel;
    Bool                                        visible;
    Bool                                        active;

    page = GetPage(index);
    if (page != null || index == -1) {
        if (page != null) {
            visible = page->GetStateVisible();
            active = page->GetStateActive();
        }
        else {
            visible = true;
            active = false;
        }
        rOne.Set(rectangle);
        cBevel.Set(_color.tabBevel);
        diffBevel = 0;
        if (index != GetCurrentValue()) {
            diffBevel = OFFSET_SELECT;
        }
        if (!active) {
            diffBevel = OFFSET_INACTIVE;
        }
        (cBevel.GetBase().GetBrightness() > 0x7F) ? cBevel.SubRGB(diffBevel) : cBevel.AddRGB(diffBevel);
        if (index == GetCurrentValue()) {
            rOne.AddHeight(1);
        }
        triPiece.Set(rOne.GetRightTop().GetLeftTop(), rOne.GetRightBottom().GetLeftTop(), (rOne.GetRightBottom().AddX(_padding * 2)).GetLeftTop());
        graphics->FillTriangle(triPiece, cBevel.GetBase());
        graphics->DrawLine(SFXLine(triPiece.GetFirst(), triPiece.GetThird()), cBevel.GetDark());
        graphics->FillBevel(rOne, cBevel, true, true, _padding == 0, false);
        if (index == GetCurrentValue()) {
            if (GetStateFocus(true) && GetFocusTabTopEdgeEnable()) {
                graphics->DrawLine(SFXLine(rOne.GetEdgeTop()).Offset(0, 1).AddStartX(1).SubEndX(1), _color.edge);
            }
            rOne.AddHeight(TAB_BASE_HEIGHT - 1);
        }
        if (index != -1 && page != null) {
            SFXRectangle                                rImage;
            SFXRectangle                                rText;
            SFXWideStringConstRef                       title(page->GetTitle());
            SFBImageSmp                                 image(page->GetImage());
            SFXWideStringConstRef                       hint(page->GetHint());
            SFXRGBColor                                 cText;

            cText.Set(page->GetTextColor());
            if (!page->GetStateActive(true)) {
                (cText.GetBrightness() > 0x7F) ? cText.SubRGB(OFFSET_INACTIVE) : cText.AddRGB(OFFSET_INACTIVE);
            }
            rText.Set(rOne);
            if (image != null) {
                AEEImageInfo                        info;
                SInt16                              dx;
                SInt16                              dy;

                rImage.Set(rOne.GetOrigin(), SFXSize(rOne.GetHeight(), rOne.GetHeight()));
                if (title.IsEmpty()) {
                    rImage.AddX((rOne.GetWidth() - rImage.GetWidth()) / 2);
                }
                else {
                    rText.AddLeft(rImage.GetWidth());
                }
                image->GetInfo(&info);
                if (info.cx > 0 && info.cy > 0) {
                    dx = (rImage.GetWidth() - info.cx) / 2;
                    dy = (rImage.GetHeight() - info.cy) / 2;
                    rImage.SetSize(info.cx, info.cy);
                    graphics->DrawImage(image, rImage.GetOrigin() + SFXGrid(dx, dy));
                }
            }
            graphics->SetFont(_font);
            rText.AddY(graphics->GetFontDescent() / 2);
            graphics->DrawSingleText(title, rText, cText, IDF_ALIGN_CENTER);
            if (index == GetCurrentValue() && _hintHeight > 0) {
                rText.Set(_rcHint);
                graphics->SetFont(_font);
                rText.AddY(graphics->GetFontDescent() / 2);
                graphics->DrawSingleText(hint, rText, cText, IDF_ALIGN_CENTER);
            }
        }
    }
    return;
}// SFZTabControl::DrawOneTab //

/*private */ Void  SFZTabControl::DrawLeftTriangle(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXRGBColor                                 color(_color.arrow);
    SInt16                                      w(rectangle.GetWidth() / 4);
    SInt16                                      h(w * 2);
    SInt16                                      x(rectangle.GetX() + (rectangle.GetWidth() - w) / 2);
    SInt16                                      y(rectangle.GetY() + (rectangle.GetHeight() - h) / 2);

    if (!GetStateFocus(true)) {
        (color.GetBrightness() > 0x7F) ? color.SubRGB(OFFSET_FOCUS) : color.SubRGB(OFFSET_FOCUS);
    }
    graphics->FillTriangle(SFXTriangle(x + w, y, x, y + h / 2, x + w, y + h), color);
    return;
}// SFZTabControl::DrawLeftTriangle //

/*private */Void  SFZTabControl::DrawRightTriangle(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXRGBColor                                 color(_color.arrow);
    SInt16                                      w(rectangle.GetWidth() / 4);
    SInt16                                      h(w * 2);
    SInt16                                      x(rectangle.GetX() + (rectangle.GetWidth() - w) / 2);
    SInt16                                      y(rectangle.GetY() + (rectangle.GetHeight() - h) / 2);

    if (!GetStateFocus(true)) {
        (color.GetBrightness() > 0x7F) ? color.SubRGB(OFFSET_FOCUS) : color.SubRGB(OFFSET_FOCUS);
    }
    graphics->FillTriangle(SFXTriangle(x + w, y + h / 2, x, y, x, y + h), color);
    return;

}// SFZTabControl::DrawRightTriangle //

/*private */Void SFZTabControl::DrawBorder(SFXGraphicsPtr graphics) const
{
    SFXRGBColor                                 light;
    SFXRGBColor                                 dark;
    SFXLine                                     left;
    SFXLine                                     bottom;
    SFXLine                                     right;

    left.Set(_rcBody.GetEdgeLeft());
    left.SubStartY(1);
    graphics->DrawLine(left, _color.tabBevel.GetLight());
    left.Offset(1, 0);
    left.SubEndY(1);
    graphics->DrawLine(left, _color.tabBevel.GetBase());
    left.Offset(1, 0);
    left.SubEndY(1);
    graphics->DrawLine(left, _color.tabBevel.GetDark());
    bottom.Set(_rcBody.GetEdgeBottom());
    graphics->DrawLine(bottom, _color.tabBevel.GetDark());
    bottom.Offset(0, -1);
    bottom.AddStartX(1);
    bottom.SubEndX(1);
    graphics->DrawLine(bottom, _color.tabBevel.GetBase());
    bottom.Offset(0, -1);
    bottom.AddStartX(1);
    bottom.SubEndX(1);
    graphics->DrawLine(bottom, _color.tabBevel.GetLight());
    right.Set(_rcBody.GetEdgeRight());
    right.SubStartY(1);
    graphics->DrawLine(right, _color.tabBevel.GetDark());
    right.Offset(-1, 0);
    right.SubEndY(1);
    graphics->DrawLine(right, _color.tabBevel.GetBase());
    right.Offset(-1, 0);
    right.SubEndY(1);
    graphics->DrawLine(right, _color.tabBevel.GetLight());
    return;
}// SFZTabControl::DrawBorder //

参照

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理

引数

戻り値

解説

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

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

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

使用例

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

// タブコントロールのインスタンスを生成する
SFZTabControlSmp _tab;
SFCError error;

if ((_tab = SFZTabControl::NewInstance(&error)) != null) {
    // ...
}

解説

この関数は、タブの左右にある矢印（三角形）の色を設定します。

デフォルト値: SFXRGBColor(0x00, 0xBF, 0xF3, 0x00)

	タブコントロールの再描画
	タブの左右にある矢印（三角形）の色が変更されると、 タブコントロールはスタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFZTabControl::GetArrowColor | SFXRGBColor

解説

この関数は、タブコントロールの境界線に関する有効フラグを設定します。

デフォルト値: false

タブコントロールの境界線を描画する場合は true、描画しない場合は false を設定します。

	注意
	タブコントロールの境界線を描画するかどうかを設定することにより、タブコントロールのコンテント領域が変化します。 このため、タブコントロールに挿入されているタブページの実領域と仮想領域の変更を行う必要がありますが、 この処理は内部で呼び出される SFYTabControl::SetContentBound 関数により自動的に行われますので、 開発者は考慮する必要はありません。

参照

SFYTabControl::SetContentBound

解説

この関数は、フォーカスタブの上境界線の色を設定します。

デフォルト値: SFXRGBColor(0x11, 0x22, 0xBB, 0x00)

	注意
	フォーカスタブとは、タブコントロールでフォーカスを持つ（現在選択中の状態にある）タブのことです。 このタブに対応するタブページはフォーカス状態にあります。 有効フラグの値が true、かつ、タブコントロールのフォーカス状態が ON であるときに限り フォーカスタブの上境界線は描画されます。 なお、フォーカスタブの上境界線に関する有効フラグと色は、 SFZTabControl::SetFocusTabTopEdgeEnable / SFZTabControl::SetFocusTabTopEdgeColor 関数で設定します。

	タブコントロールの再描画
	フォーカスタブの上境界線の色が変更されると、 タブコントロールはスタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFZTabControl::GetFocusTabTopEdgeColor | SFZTabControl::SetFocusTabTopEdgeEnable | SFXRGBColor

解説

この関数は、フォーカスタブの上境界線に関する有効フラグを設定します。

デフォルト値: true

	注意
	フォーカスタブとは、タブコントロールでフォーカスを持つ（現在選択中の状態にある）タブのことです。 このタブに対応するタブページはフォーカス状態にあります。 有効フラグの値が true、かつ、タブコントロールのフォーカス状態が ON であるときに限り フォーカスタブの上境界線は描画されます。 なお、フォーカスタブの上境界線に関する有効フラグと色は、 SFZTabControl::SetFocusTabTopEdgeEnable / SFZTabControl::SetFocusTabTopEdgeColor 関数で設定します。

参照

SFZTabControl::GetFocusTabTopEdgeEnable | SFZTabControl::SetFocusTabTopEdgeColor

解説

この関数は、タブページのタイトルテキストとヒントテキストを描画するフォントを設定します。

デフォルト値: AEE_FONT_NORMAL

	タブコントロールの再描画
	フォントが変更されると、 タブコントロールはスタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_FONT, 0)] を受信します。

参照

SFZTabControl::GetFont | SFXEvent | スタイルイベント [SFEVT_RESPONDER_STYLE]

解説

この関数は、ヒント領域のベベルカラーを設定します。

デフォルト値: SFXBevelColor(SFXRGBColor(0x9F, 0x9F, 0x9F, 0x00), SFXRGBColor(0xDD, 0xDD, 0xDD, 0x00), SFXRGBColor(0x6C, 0x6C, 0x6C, 0x00))

	注意
	ヒント領域とは、 SFZTabPage::SetHint 関数で設定する、 タブページのヒントテキストを描画する領域です。

	タブコントロールの再描画
	ヒント領域のベベルカラーが変更されると、 タブコントロールはスタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFZTabControl::GetHintBevelColor | SFZTabPage::SetHint | SFXBevelColor | SFXRGBColor

解説

この関数は、ヒント領域の高さを設定します。[単位:ピクセル]

デフォルト値:（AEE_FONT_NORMAL フォントの高さ）+ 2 ピクセル

ヒントテキストを表示しない場合は、0 を設定します。

	注意
	ヒント領域とは、 SFZTabPage::SetHint 関数で設定する、 タブページのヒントテキストを描画する領域です。

	注意
	ヒント領域の高さを変更することにより、タブコントロールのコンテント領域が変化します。 このため、タブコントロールに挿入されているタブページの実領域と仮想領域の変更を行う必要がありますが、 この処理は内部で呼び出される SFYTabControl::SetContentBound 関数により自動的に行われますので、 開発者は考慮する必要はありません。

参照

SFZTabControl::GetHintHeight | SFZTabPage::SetHint | SFYTabControl::SetContentBound

解説

この関数は、パディングサイズを設定します。[単位:ピクセル]

デフォルト値: 4 ピクセル

	注意
	パディングサイズとは、隣接する 2 つのタブとタブの間の空白サイズのことです。 なお、この空白領域は、 SFYWidget::SetBackgroundColor 関数で設定する、 タブコントロールの背景色で塗り潰されます。

参照

SFZTabControl::GetPadding | SFYWidget::SetBackgroundColor

解説

この関数は、タブ領域のベベルカラーを設定します。

デフォルト値: SFXBevelColor(SFXRGBColor(0x9F, 0x9F, 0x9F, 0x00), SFXRGBColor(0xDD, 0xDD, 0xDD, 0x00), SFXRGBColor(0x6C, 0x6C, 0x6C, 0x00))

	注意
	このベベルカラーは、活性状態のタブページに対応するタブ領域の色です。 可視かつ非活性状態のタブページに対応するタブ領域の色は、 このベベルカラーに基づいて自動計算されます。

	注意
	タブ領域とは、 SFZTabPage::SetTitle / SFZTabPage::SetImage 関数で設定する、 タブページのタイトルテキスト・画像を描画する領域です。

	タブコントロールの再描画
	タブ領域のベベルカラーが変更されると、 タブコントロールはスタイルイベント [SFXEvent(SFEVT_RESPONDER_STYLE, SFP16_STYLE_COLOR, 0)] を受信します。

参照

SFZTabControl::GetTabBevelColor | SFZTabPage::SetTitle | SFZTabPage::SetImage | SFXBevelColor | SFXRGBColor

解説

この関数は、タブ領域の高さを設定します。[単位:ピクセル]

デフォルト値:（AEE_FONT_NORMAL フォントの高さ）+ 3 ピクセル

	注意
	タブ領域とは、 SFZTabPage::SetTitle / SFZTabPage::SetImage 関数で設定する、 タブページのタイトルテキスト・画像を描画する領域です。

	注意
	タブ領域の高さを変更することにより、タブコントロールのコンテント領域が変化します。 このため、タブコントロールに挿入されているタブページの実領域と仮想領域の変更を行う必要がありますが、 この処理は内部で呼び出される SFYTabControl::SetContentBound 関数により自動的に行われますので、 開発者は考慮する必要はありません。

参照

SFZTabControl::GetTabHeight | SFZTabPage::SetTitle | SFZTabPage::SetImage | SFYTabControl::SetContentBound

参照

SFYResponder::GetType | SFYResponder::SetType