継承図

協調図

解説

■ 仕様と使い方

コンボボックスコントロール(SFZComboBoxControl)は、 項目リストを表示するためのフレックスリストボックスコントロール(SFZFlexListBoxControl)を内部に保持するボタンコントロールです。

項目を追加するには、 SFZComboBoxControl::Insert / SFZComboBoxControl::InsertFirst / SFZComboBoxControl::InsertLast 関数を使います。 項目を削除するには、 SFZComboBoxControl::Remove / SFZComboBoxControl::RemoveFirst / SFZComboBoxControl::RemoveLast 関数を使います。 SFZComboBoxControl::Clear 関数を呼び出すと、すべての項目が削除されます。

フレックスリストボックスコントロール(SFZFlexListBoxControl)の部分は、 SFYButtonControl::SetOperateKey 関数で設定するコンボボックスコントロール(SFZComboBoxControl)の操作キーを押下後に離すと表示されます。

コンボボックスコントロールの領域には、 このフレックスリストボックスコントロール内で現在選択されている項目が表示されます。

フレックスリストボックスコントロールでは、 フォーカスされた項目はハイライト表示されます。 SFZFlexListBoxControl::SetScrollUpKey / SFZFlexListBoxControl::SetScrollDownKey / SFZFlexListBoxControl::SetPageUpKey / SFZFlexListBoxControl::SetPageDownKey / SFZFlexListBoxControl::SetSnapUpKey / SFZFlexListBoxControl::SetSnapDownKey 関数で設定するスクロールキーを使用して項目リストをスクロールします。

参照: 結果イベント[SFEVT_RESPONDER_RESULT]

以下はコンボボックスコントロールの仕様です。

	フレックスリストボックスコントロール
	詳細は、SFZFlexListBoxControl クラスの解説を参照してください。

コンボボックスコントロールの仕様上の制限

最小値は常に 0 です。 現在値は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)で選択されている項目のインデックスを表します。 最大値は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)の項目数を表します。 (※この機能は将来的に廃止予定です。 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)の項目数を取得するには、 SFZComboBoxControl::GetItemCount 関数を呼び出してください。) SFYControl::SetMinimumValue 関数または SFYControl::SetMaximumValue 関数を使用して最小値または最大値を変更してはいけません。

□コンボボックスコントロールの構成

デフォルトの実装では、 コンボボックスコントロールは状態に応じて以下のように描画されます。

図 345. コンボボックスコントロールの拡大図[活性状態または操作可能状態]

タイトルはタイトル表示ベベル領域の幅２ピクセル分の枠（フォーカス・フレーム）で囲まれるコンテンツ領域に描画されます。

詳細情報: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 346. コンボボックスコントロールの拡大図[非活性状態]

タイトルは SFZComboBoxControl::SetTitleColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

矢印（下三角形）は SFZComboBoxControl::SetArrowColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

詳細情報: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 347. コンボボックスコントロールの拡大図[フォーカス状態・非押下時]

詳細情報: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 348. コンボボックスコントロールの拡大図[フォーカス状態・押下時]

詳細情報: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

以下は、コンボボックスコントロールを生成するためのコードです。

// ボディ文字列だけの実装
Void UserClass::Main(Void)
{
    SFZWindowSmp            window;
    SFZComboBoxControlSmp   combo;
    SFCError                error(SFERR_NO_ERROR);

    // ウインドウを生成する
    window = SFZWindow::NewInstance(&error);
    window->SetParent(GetThis());
    window->SetRealBound(GetLocalBound());
    window->SetState(true, true, true, true);
    window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

    // [必須] コンボボックスを生成する
    combo = SFZComboBoxControl::NewInstance(&error);

    // [必須] 親をウィンドウに設定する
    combo->SetParent(window);

    // [必須] 文字列を挿入する
    for (SInt32 i = 0;  i < 5 ; ++i) {
        combo->InsertLast(SFXAnsiString::Format("Item index is %d.", i));
    }

    // [必須] 実領域を設定する (ウィンドウのローカル領域から最適な領域を計算する)
    combo->SetRealBound(combo->GetSuitableBound(window->GetLocalBound().Deflate(20, 50)).SetOrigin(20, 50));

    // [必須] 状態を設定する (true, true, true, true)
    combo->SetState(true, true, true, true);
    return;
}

// ヘッダ文字列とボディアイコン画像を含んだ実装
Void UserClass::Main2(Void) {
    SFZWindowSmp                    window;
    SFZComboBoxControlSmp           combo;
    SFZComboBoxControl::ItemRec     item;
    SFBShellSmp                     shell(SFBShell::GetInstance());
    SFBImageSmp                     normal(shell->LoadResImage("userclass.bar", IDI_OBJECT_5001));
    SFBImageSmp                     select(shell->LoadResImage("userclass.bar", IDI_OBJECT_5002));
    SFCError                        error(SFERR_NO_ERROR);

    // ウインドウを生成する
    window = SFZWindow::NewInstance(&error);
    window->SetParent(GetThis());
    window->SetRealBound(GetLocalBound());
    window->SetState(true, true, true, true);
    window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

    // [必須] コンボボックスを生成する
    combo = SFZComboBoxControl::NewInstance(&error);

    // [必須] 親をウィンドウに設定する
    combo->SetParent(window);

    // ここではアイテム構造体を利用して項目を追加する。
    // 文字列だけでも追加できるが画像を利用する場合は、
    // アイテム構造体を利用した方が簡単。[選択]

    // [選択必須] アイテム構造体に有効状態を設定する
    item.property.enable = true;

    // [選択必須] アイテム構造体にアクセスキーとコマンド ID を設定する
    //            (今回は使用しない)
    item.property.key = 0;
    item.property.id = SFZComboBoxControl::INVALID_COMMAND_ID;

    // [任意] アイテム構造体に画像を設定する
    item.normal.body.icon = normal;
    item.select.body.icon = select;

    // [必須] ５ 個の項目を追加する
    for (SInt32 i = 0;  i < 5; ++i) {

        // [選択必須] アイテム構造体に文字列を設定する
        item.normal.header.text.Set(SFXWideString::Format("%02d", i));
        item.normal.body.text.Set(SFXWideString::Format("List item %02d", i));
        item.select.body.text.Set(SFXWideString::Format("The item %02d is selected.", i));

        // 末尾に挿入
        combo->InsertLast(item);
    }

    // [必須] 実領域を設定する (ウィンドウのローカル領域から最適な領域を計算する)
    combo->SetRealBound(combo->GetSuitableBound(window->GetLocalBound().Deflate(20, 50)).SetOrigin(20, 50));

    // [必須] 状態を設定する (true, true, true, true)
    combo->SetState(true, true, true, true);
    return;
}

実行結果: (左: ボディ文字列のみ、右: ヘッダ文字列、ボディアイコン画像、ボディ文字列を含む)

	注意
	コンボボックスコントロールに内部的に保持されるフレックスリストボックスコントロールの領域は、 追加された項目とコンボボックスコントロールが配置される親レスポンダのローカル領域によって自動的に設定されます。 フレックスリストボックスコントロールを描画するには、 SFYResponder::SetRealBound 関数を使用して親レスポンダの実領域(ローカル領域)の設定が必須になります。 親レスポンダの実領域は、 SFYResponder::SetVirtualBound 関数で仮想領域を設定しない限りローカル領域と同じです。 ※ ローカル領域と仮想領域は同じ矩形領域を表します。

参照

コンボボックスコントロール[SFZComboBoxControl] | SFZFlexListBoxControl | 状態 | SFYButtonControl | SFYSingleTextWidget | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 実領域 | ローカル領域 | 仮想領域

メンバ

解説

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

	注意
	SFZComboBoxControl クラスを継承するレスポンダでは、 上記イベントが発生すると、それに対応するハンドラが呼び出されます。

内部実装

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

/*protected */SFZComboBoxControl::SFZComboBoxControl(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0x00, 0x00}}}
    };
    static SFXEventRange::AtomRecConst          range[] = {
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_FOCUS,    SFP16_STATE_FOCUS},
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_PRESS,    SFP16_STATE_PRESS},
        { SFEVT_RESPONDER_VALUE,  SFEVT_RESPONDER_VALUE,  SFP16_VALUE_CURRENT,  SFP16_VALUE_CURRENT}
    };
    static SFXEventRange::AtomRecConst          wrange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         rule[lengthof(range)];
    SFYHandler::RuleRec                         wrule[lengthof(wrange)];
    SFYHandler::RuleRec                         lrule[lengthof(lrange)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        rule[0].spp = XANDLER_FUNCTION(OnStateFocus);
        rule[0].reference = this;
        rule[1].spp = XANDLER_FUNCTION(OnStatePress);
        rule[1].reference = this;
        rule[2].spp = XANDLER_FUNCTION(OnCurrentValue);
        rule[2].reference = this;
        static_throw(RegisterHandler(atomic_cast(range), rule, lengthof(range)));
        if (static_try()) {
            if ((_widget = SFYFlexListItemWidget::NewInstance(&error)) != null) {
                wrule[0].spp = XANDLER_FUNCTION(OnWidgetStyle);
                wrule[0].reference = this;
                static_throw(_widget->RegisterHandler(atomic_cast(wrange), wrule, lengthof(wrange)));
                if (static_try()) {
                    static_throw(_widget->SetParent(GetThis()));
                    if (static_try()) {
                        _widget->SetHorizontalAlign(SFYFlexListItemWidget::NORMAL, static_cast<SFYFlexListItemWidget::HorizontalEnum>(DEFAULT_HORIZONTAL));
                        _widget->SetState(true, true, false, false);
                        if ((_listbox = SFZFlexListBoxControl::NewInstance(&error)) != null) {
                            lrule[0].spp = XANDLER_FUNCTION(OnListBoxResult);
                            lrule[0].reference = this;
                            static_throw(_listbox->RegisterHandler(atomic_cast(lrange), lrule, lengthof(lrange)));
                            if (static_try()) {
                                _color.arrow = rgb[0];
                            }
                        }
                        else {
                            static_throw(error);
                        }

                    }
                }
            }
            else {
                static_throw(error);
            }
        }
    }
}// SFZComboBoxControl::SFZComboBoxControl //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZComboBoxControl, OnStateFocus, invoker, reason, state)
{
    unused(invoker); unused(reason);
    (state) ? (_widget->StartScroll()) : (_widget->StopScroll());
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZComboBoxControl, OnStateFocus) //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZComboBoxControl, OnStatePress, invoker, reason, state)
{
    SFXRectangle                                lx;

    unused(invoker); unused(reason);
    lx.Set(_widget->GetRealBound());
    (state) ? (lx.Offset(GetPressOffset())) : (lx.Unoffset(GetPressOffset()));
    _widget->SetRealBound(lx);
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZTextButtonControl, OnStatePress) //

/*private */XANDLER_IMPLEMENT_VOIDVALUE(SFZComboBoxControl, OnCurrentValue, invoker, reason, value)
{
    SInt32                                      cur(value);
    SInt32                                      max(GetItemCount());

    unused(invoker); unused(reason);
    if (cur >= max) {
        cur = max - 1;
    }
    if (cur < 0) {
        cur = 0;
    }
    if (cur != value) {
        SetCurrentValue(cur);
    }
    else {
        CopyItemToWidget(_listbox->GetItem(value), _widget);
    }
    return;
}// XANDLER_IMPLEMENT_VOIDVALUE(SFZComboBoxControl, OnCurrentValue) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZComboBoxControl, OnWidgetStyle, invoker, reason)
{
    unused(invoker);
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZComboBoxControl, OnWidgetStyle) //

/*private */XANDLER_IMPLEMENT_VOIDRESULT(SFZComboBoxControl, OnListBoxResult, invoker, reason, result)
{
    unused(invoker); unused(result);
    _listbox->SetParent(SFYResponderSmp::EmptyInstance());
    _listbox->SetStateVisible(false);
    SetStateFocus(true);
    if (reason == SFP16_RESULT_OK) {
        SetCurrentValue(_listbox->GetCurrentValue());
        InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false);
    }
    return;
}// XANDLER_IMPLEMENT_VOIDEVENT(SFZComboBoxControl, OnListBoxResult) //

/*private */SFCError SFZComboBoxControl::CopyItemToWidget(SFZFlexListBoxControl::ItemRecConstRef item, SFYFlexListItemWidgetSmpConstRef widget)
{
    SFCError                                    error(SFERR_NO_ERROR);

    if ((error = widget->SetText(SFYFlexListItemWidget::TEXT_HEADER_NORMAL, item.normal.header.text)) == SFERR_NO_ERROR) {
        if ((error = widget->SetText(SFYFlexListItemWidget::TEXT_BODY_NORMAL, item.normal.body.text)) == SFERR_NO_ERROR) {
            if ((error = widget->SetIconImage(SFYFlexListItemWidget::ICON_BODY_NORMAL, item.normal.body.icon)) == SFERR_NO_ERROR) {
                if ((error = widget->SetIconImage(SFYFlexListItemWidget::ICON_FOOTER_NORMAL, item.normal.footer.icon)) == SFERR_NO_ERROR) {
                    if ((error = widget->SetText(SFYFlexListItemWidget::TEXT_HEADER_SELECT, item.select.header.text)) == SFERR_NO_ERROR) {
                        if ((error = widget->SetText(SFYFlexListItemWidget::TEXT_BODY_SELECT, item.select.body.text)) == SFERR_NO_ERROR) {
                            if ((error = widget->SetIconImage(SFYFlexListItemWidget::ICON_BODY_SELECT, item.select.body.icon)) == SFERR_NO_ERROR) {
                                error = widget->SetIconImage(SFYFlexListItemWidget::ICON_FOOTER_SELECT, item.select.footer.icon);
                            }
                        }
                    }
                }
            }
        }
    }
    return error;
}// SFZComboBoxControl::CopyItemToWidget //

参照

SFYResponder::SetType | SFZComboBoxControl::CodeEnum | SFZComboBoxControl::SetArrowColor | SFZComboBoxControl::SetFont | SFZComboBoxControl::SetTitleColor | SFZComboBoxControl::SetSpaceSize | SFZComboBoxControl::SetHorizontalAlign | SFZComboBoxControl::SetVerticalAlign | SFZComboBoxControl::SetScrollDirection | SFZComboBoxControl::SetScrollInterval | SFZComboBoxControl::SetScrollStep | SFZComboBoxControl::SetWaitInterval | SFZComboBoxControl::HorizontalEnum | SFZComboBoxControl::VerticalEnum | SFZComboBoxControl::DirectionEnum | SFZComboBoxControl::DefaultEnum | SFYButtonControl::SetStatePress | SFYControl::SetCurrentValue | SFZFlexListBoxControl::NewInstance | SFXRGBColor | SFXEvent | タイプ | 状態 | イベント | 状態イベント[SFEVT_RESPONDER_STATE] | 結果イベント[SFEVT_RESPONDER_RESULT] | 値イベント[SFEVT_RESPONDER_VALUE]

解説

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

内部実装

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

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

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)の末尾に項目を追加します。

	非推奨 (廃止予定 API)
	この関数はまもなく廃止されます。 この関数の代わりに、SFZComboBoxControl::InsertLast 関数を使用してください。

参照

SFZComboBoxControl::InsertLast | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZFlexListBoxControl

解説

この関数は、コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)のすべての項目を削除します。

参照

SFZComboBoxControl::InsertLast | SFZComboBoxControl::Insert | SFZComboBoxControl::InsertFirst | SFZComboBoxControl::Append | SFZComboBoxControl::Remove | SFZFlexListBoxControl

解説

この関数は、 指定された矩形領域にコンボボックスの矢印を描画します。

独自の処理を行う場合は、この関数をオーバーライドします。

	Tip
	この関数は、SFZComboBoxControl::HandleRenderRequest 関数内で呼び出されます。

内部実装

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

/*protected */Void SFZComboBoxControl::DrawTab(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SInt16                                      W(rectangle.GetWidth());
    SInt16                                      H(rectangle.GetHeight());
    SInt16                                      h(H / 4 - 1);
    SInt16                                      w(h * 2);
    SInt16                                      x(rectangle.GetX() + (W - w) / 2);
    SInt16                                      y(rectangle.GetY() + (H - h) / 2);
    SFXRGBColor                                 rgb(GetArrowColor());
    SFXTriangle                                 triangle;

    triangle.Set(x, y, x + w, y, x + w / 2, y + h);
    if (!GetStateActive(true)) {
        (rgb.GetBrightness() > 0x7F) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
    }
    graphics->FillTriangle(triangle, rgb);
    return;
}// SFZComboBoxControl::DrawTab //

参照

SFZComboBoxControl::HandleRenderRequest

戻り値

ボタンの矢印を描画する色。

解説

この関数は、矢印の色を取得します。

参照

SFZComboBoxControl::SetArrowColor | SFXRGBColor

戻り値

フォント。

解説

この関数は、フォントを取得します。

指定した文字列定数（SFZComboBoxControl::TextEnum）に対応するフォントが返されます。

文字列定数を指定しない場合はボディのフォントが返されます。

参照

SFZComboBoxControl::TextEnum | SFZComboBoxControl::SetFont | BREW API AEEFont

戻り値

タイトルの水平アライメントの値。

解説

この関数は、タイトルの水平アライメントの値を取得します。

参照

SFZComboBoxControl::SetHorizontalAlign | SFZComboBoxControl::HorizontalEnum

戻り値

コンボボックスコントロールが内部で保持するフレックスリストボックス(SFZFlexListBoxControl)について、 指定した項目に設定されたダイレクトアクセスキーが返ります。 ダイレクトアクセスキーが設定されていない場合は "0" が返ります。

参照

SFZComboBoxControl::SetItemAccessKey | SFZFlexListBoxControl | AVKType

戻り値

コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）の項目数。

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）の項目数を取得します。

参照

SFZFlexListBoxControl

戻り値

項目のアイコン定数 (SFZComboBoxControl::IconEnum) に対応するアイコン画像。

解説

この関数は、このコンボボックスコントロールが内部で保持する、 フレックスリストボックスコントロール(SFZFlexListBoxControl)内の指定された項目のアイコン定数 (SFZComboBoxControl::IconEnum) に対応するアイコン画像を取得します。

参照

SFZComboBoxControl::IconEnum | SFZComboBoxControl::SetItemIconImage | SFZFlexListBoxControl

戻り値

項目の文字列定数に対応する文字列。

文字列定数を指定しなかった場合は、ボディ文字列。

解説

この関数は、このコンボボックスコントロールが内部で保持する、 フレックスリストボックスコントロール(SFZFlexListBoxControl)内の指定された項目の文字列定数 (SFZComboBoxControl::TextEnum) に対応する文字列を取得します。

文字列定数を指定しなかった場合は、 ボディ文字列を取得します。

参照

SFZComboBoxControl::TextEnum | SFZComboBoxControl::SetItemText | SFZFlexListBoxControl

戻り値

コンボボックスコントロールで利用されるフレックスリストボックスコントロール。

解説

この関数は、 コンボボックスコントロールが保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)を取得します。

開発者は取得したフレックスリストボックスコントロールを使用して、 項目の背景色や前景色を変更することができます。

	フレックスリストボックスコントロール
	詳細は、SFZFlexListBoxControl クラスの解説を参照してください。

使用例

以下は、フレックスリストボックスコントロールを取得してグリッド線を有効にしています。

SFZComboBoxControlSmp       combo;
SFZFlexListBoxControlSmp    list;

// コンボボックスのインスタンスを作成する
if ((combo = SFZComboBoxControl::NewInstance()) != null) {
    // ・・・
}

// フレックスリストボックスを取得する
if ((list = combo->GetListBoxControl()) != null) {

    // グリッド線を有効にする
    list->SetGridLineEnable(true);
}

参照

SFZFlexListBoxControl

戻り値

コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール内の項目数。

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール内の項目数を取得します。

	非推奨 (廃止予定 API)
	この関数はまもなく廃止されます。 この関数の代わりに、SFZComboBoxControl::GetItemCount 関数を使用してください。

参照

SFZComboBoxControl::GetItemCount

戻り値

タイトルのスクロール移動方向。

解説

この関数は、タイトルのスクロール移動方向を取得します。

参照

SFZComboBoxControl::SetScrollDirection

戻り値

スクロールインターバル。[単位:ミリ秒]

解説

この関数は、タイトルのスクロールインターバルを取得します。[単位:ミリ秒]

参照

SFZComboBoxControl::SetScrollInterval

戻り値

スクロール移動量。[単位:ピクセル]

解説

この関数は、タイトルのスクロール移動量を取得します。[単位:ピクセル]

参照

SFZComboBoxControl::SetScrollStep

戻り値

タイトルの要素間スペースサイズ。[単位:ピクセル]

解説

この関数は、タイトルの要素間スペースサイズを取得します。[単位:ピクセル]

参照

SFZComboBoxControl::SetSpaceSize

戻り値

タイトルの文字色。

解説

この関数は、タイトルの文字色を取得します。

指定した文字列定数（SFZComboBoxControl::TextEnum）に対応するタイトルの文字色が返されます。

文字列定数を指定しない場合はボディの文字色が返されます。

参照

SFXRGBColor | SFZComboBoxControl::TextEnum | SFZComboBoxControl::SetTitleColor

戻り値

タイトルの垂直アライメントの値。

解説

この関数は、タイトルの垂直アライメントの値を取得します。

参照

SFZComboBoxControl::SetVerticalAlign | SFZComboBoxControl::VerticalEnum

戻り値

スクロール開始までの待ち時間。[単位:ミリ秒]

解説

この関数は、タイトルのスクロール開始までの待ち時間を取得します。[単位:ミリ秒]

参照

SFZComboBoxControl::SetWaitInterval

解説

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

引数 rectangle で指定した矩形領域に収まる範囲内で、レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素（サイズ）に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素（始点）はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

現在値の項目を基準に最適なサイズを計算します。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数にヒント領域を指定した場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundOptimize 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle にはヒント領域が初期設定されています。

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

内部実装

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

SFYFlexListItemWidgetSmp        _widget;

/*protected virtual */Void SFZComboBoxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXRectangle                                temp;

    temp.Set(*rectangle);
    rectangle->Deflate(GetShadowMargin());
    rectangle->Deflate(GetButtonMargin());
    rectangle->SetSize(_widget->GetSuitableBound(*rectangle).GetSize());
    rectangle->Inflate(GetButtonMargin());
    rectangle->Inflate(GetShadowMargin());
    rectangle->AddWidth(rectangle->GetHeight());
    if (rectangle->GetWidth() > temp.GetWidth()) {
        rectangle->SetWidth(temp.GetWidth());
    }
    return;
}// SFZComboBoxControl::HandleBoundOptimize //

参照

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

解説

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

レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素（サイズ）に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素（始点）はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

現在値の項目を基準に最適なサイズを計算します。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数に何も指定しない場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundRequest 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には実領域が初期設定されています。 Tip 実領域のデフォルト値は SFXRectangle(0, 0, 0, 0) です。

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

内部実装

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

SFYFlexListItemWidgetSmp        _widget;

/*protected virtual */Void SFZComboBoxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetShadowMargin());
    rectangle->Deflate(GetButtonMargin());
    rectangle->SetSize(_widget->GetSuitableBound().GetSize());
    rectangle->Inflate(GetButtonMargin());
    rectangle->Inflate(GetShadowMargin());
    rectangle->AddWidth(rectangle->GetHeight());
    return;
}// SFZComboBoxControl::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFXEvent | 実領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

デフォルトの実装は、 タイトル表示領域を内部で保持するウィジェット(SFYFlexListItemWidget) の実領域として設定します。

タイトルは、内部でウィジェット (SFYFlexListItemWidget) として保持されます。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントの送信
	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントは SFYResponder::SetRealBound または SFYResponder::SetVirtualBound 関数の呼び出しによって仮想領域が変化したときに発生します。

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

内部実装

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

/*protected virtual */Void SFZComboBoxControl::HandleBoundVirtual(Void)
{
    Relocate();
    if (_listbox->GetStateVisible()) {
        RelocateListBox();
    }
    return;
}// SFZComboBoxControl::HandleBoundVirtual //

/*private */Void SFZComboBoxControl::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    lx.SubRight(lx.GetHeight());
    lx.Deflate(GetShadowMargin());
    lx.Deflate(GetButtonMargin());
    if (GetStatePress()) {
        lx.Offset(GetPressOffset());
    }
    _widget->SetRealBound(lx);
    return;
}// SFZComboBoxControl::Relocate //

/*private */Void SFZComboBoxControl::RelocateListBox(Void)
{
    SFXRectangle                                rx;
    SFXRectangle                                px;
    SFXRectangle                                sx;
    SFYResponderSmp                             parent(GetParent());

    if (parent != null) {
        rx.Set(GetRealBound());
        px.Set(
            SFXRectangle(parent->GetVirtualBound()).GetLeftTop().Neg(),
            parent->GetRealBound().GetSize()
        );
        sx.Set(SFXRectangle(rx.GetX(), px.GetY(), rx.GetWidth(), px.GetHeight()));
        sx.Set(_listbox->GetSuitableBound(sx));
        sx.SetWidth(rx.GetWidth());
        if (sx.GetHeight() < px.GetHeight()) {
            sx.SetY(rx.GetBottom());
            if (sx.GetBottom() > px.GetBottom()) {
                sx.SubY(sx.GetBottom() - px.GetBottom());
            }
        }
        _listbox->SetRealBound(sx);
    }
    return;
}// SFZComboBoxControl::ReLocateListBox //

参照

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

解説

この関数は、SFYButtonControl::SetOperateKey 関数で設定した操作キーの SFEVT_KEY_RELEASE イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、 コンボボックスコントロールが内部に保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)を表示します。

内部実装

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

SFZFlexListBoxControlSmp        _listbox;

/*protected virtual */Void SFZComboBoxControl::HandleOperateKeyRelease(Void)
{
    SetStateFocus(false);
    _listbox->SetParent(GetThis()->GetParent());
    _listbox->SetState(true, true, true, true);
    _listbox->SetCurrentValue(GetCurrentValue());
    RelocateListBox();
    _listbox->ToFront();
    return;
}// SFZComboBoxControl::HandleOperateKeyRelease

/*private */Void SFZComboBoxControl::RelocateListBox(Void)
{
    SFXRectangle                                rx;
    SFXRectangle                                px;
    SFXRectangle                                sx;
    SFYResponderSmp                             parent(GetParent());

    if (parent != null) {
        rx.Set(GetRealBound());
        px.Set(
            SFXRectangle(parent->GetVirtualBound()).GetLeftTop().Neg(),
            parent->GetRealBound().GetSize()
        );
        sx.Set(SFXRectangle(rx.GetX(), px.GetY(), rx.GetWidth(), px.GetHeight()));
        sx.Set(_listbox->GetSuitableBound(sx));
        sx.SetWidth(rx.GetWidth());
        if (sx.GetHeight() < px.GetHeight()) {
            sx.SetY(rx.GetBottom());
            if (sx.GetBottom() > px.GetBottom()) {
                sx.SubY(sx.GetBottom() - px.GetBottom());
            }
        }
        _listbox->SetRealBound(sx);
    }
    return;
}// SFZComboBoxControl::ReLocateListBox //

参照

SFYButtonControl::SetOperateKey | SFZFlexListBoxControl | キーイベント[SFEVT_KEY]

解説

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

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

デフォルトの実装では、 状態に応じて以下のようなコンボボックスコントロールを描画します。 ボタン部分の描画の詳細については、SFYButtonControl::DrawButton 関数と SFYButtonControl::DrawShadow 関数の説明を参照してください。

■コンボボックスコントロールの構成

■コンボボックスコントロールの描画処理

図 349. コンボボックスコントロールの拡大図[活性状態または操作可能状態]

タイトルはタイトル表示ベベル領域の幅２ピクセル分の枠（フォーカス・フレーム）で囲まれるコンテンツ領域に描画されます。

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 350. コンボボックスコントロールの拡大図[非活性状態]

タイトルは SFZComboBoxControl::SetTitleColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

矢印（下三角形）は SFZComboBoxControl::SetArrowColor 関数で設定した色を非活性状態に合わせて補正した色で描画されます。

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 351. コンボボックスコントロールの拡大図[フォーカス状態・非押下時]

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

図 352. コンボボックスコントロールの拡大図[フォーカス状態・押下時]

詳細情報 : SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

レスポンダの描画手順

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

内部実装

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

/*protected virtual */Void SFZComboBoxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    SFXRectangle                                lx;
    SFXRectangle                                wx;

    lx.Set(DrawShadow(graphics, GetLocalBound()));
    wx.Set(lx.GetOrigin(), lx.GetWidth() - lx.GetHeight(), lx.GetHeight());
    DrawButton(graphics, wx);
    DrawButton(graphics, lx.SetLeft(wx.GetRight()));
    DrawTab(graphics, lx);
    return;
}// SFZComboBoxControl::HandleRenderRequest //

参照

SFZComboBoxControl::DrawTab | SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow | SFZComboBoxControl::SetTitleColor | SFZComboBoxControl::SetArrowColor | SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFYButtonControl::SetShadowColor | SFYButtonControl::SetOperateKey | SFZListBoxControl | SFYControl::GetCurrentValue | SFYWidget | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | 状態

戻り値

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）の指定されたインデックスの位置に指定された項目を挿入します。

インデックスが 0 以下の場合は先頭に挿入されます。

インデックスが最大値以上の場合は末尾に挿入されます。

	注意
	この関数で項目を追加した後、 項目数（SFZComboBoxControl::GetItemCount 関数の戻り値）は 1 だけ増加します。

参照

SFZComboBoxControl::InsertFirst | SFZComboBoxControl::InsertLast | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZComboBoxControl::GetItemCount | SFZComboBoxControl::ItemRec | SFZFlexListBoxControl

戻り値

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）の先頭に指定された項目を挿入します。

	注意
	この関数で項目を追加した後、 項目数（SFZComboBoxControl::GetItemCount 関数の戻り値）は 1 だけ増加します。

参照

SFZComboBoxControl::InsertLast | SFZComboBoxControl::Insert | SFZComboBoxControl::RemoveFirst | SFZComboBoxControl::Clear | SFZComboBoxControl::GetItemCount | SFZComboBoxControl::ItemRec | SFZFlexListBoxControl

戻り値

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）の末尾に指定された項目を挿入します。

	注意
	この関数で項目を追加した後、 項目数（SFZComboBoxControl::GetItemCount 関数の戻り値）は 1 だけ増加します。

参照

SFZComboBoxControl::InsertFirst | SFZComboBoxControl::Insert | SFZComboBoxControl::RemoveLast | SFZComboBoxControl::Clear | SFZComboBoxControl::GetItemCount | SFZComboBoxControl::ItemRec | SFZFlexListBoxControl

引数

戻り値

解説

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

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

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

使用例

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

// コンボボックスのインスタンスを生成する
SFCError error;
SFZComboBoxControlSmp _combobox;

if ((_combobox = SFZComboBoxControl::NewInstance(&error)) != null) {
    // ...
}

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）内の指定されたインデックスの項目を削除します。

削除する項目の位置が 0 より小さい場合、または項目数以上の場合、項目の削除は行われません。

削除開始位置が項目数以上の場合、または 削除終了位置が 0 以下の場合、項目の削除は行われません。

削除開始位置が 0 より小さい場合、削除開始位置は 0 に再設定されます。

削除終了位置が項目数より大きい場合、削除終了位置は項目数に再設定されます。

	注意
	この関数で項目を削除した後、 項目数（SFZComboBoxControl::GetItemCount 関数の戻り値）は 1 だけ減少します。

参照

SFZComboBoxControl::Clear | SFZComboBoxControl::RemoveFirst | SFZComboBoxControl::RemoveLast | SFZComboBoxControl::Insert | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

解説

この関数は、コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）内の先頭の項目を削除します。

	注意
	この関数で項目を削除した後、 項目数（SFZComboBoxControl::GetItemCount 関数の戻り値）は 1 だけ減少します。

参照

SFZComboBoxControl::Clear | SFZComboBoxControl::Remove | SFZComboBoxControl::RemoveLast | SFZComboBoxControl::InsertFirst | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

解説

この関数は、コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール （SFZFlexListBoxControl）内の末尾の項目を削除します。

	注意
	この関数で項目を削除した後、 項目数（SFZComboBoxControl::GetItemCount 関数の戻り値）は 1 だけ減少します。

参照

SFZComboBoxControl::Clear | SFZComboBoxControl::RemoveFirst | SFZComboBoxControl::Remove | SFZComboBoxControl::InsertLast | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

解説

この関数は、 ボタンの矢印(下三角形)を描画する色 (SFXRGBColor)を設定します。

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

非活性状態にあるときは、この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色で矢印(下三角形)は描画されます。

	色の明度
	色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFZComboBoxControl::GetArrowColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、 文字列定数（SFZComboBoxControl::TextEnum）に対応するフォントを設定します。

文字列定数を指定しない場合は、ボディのフォントを設定します。

参照

SFZComboBoxControl::TextEnum | SFZComboBoxControl::GetFont | BREW API AEEFont

解説

この関数は、タイトルの水平アライメントを設定します。

デフォルト値: SFZComboBoxControl::DEFAULT_HORIZONTAL

SFZComboBoxControl::DEFAULT_HORIZONTAL の値は SFZComboBoxControl::HorizontalEnum を参照してください。

参照

SFZComboBoxControl::GetHorizontalAlign | SFZComboBoxControl::HorizontalEnum

戻り値

解説

この関数は、 コンボボックスコントロールが内部で保持するフレックスリストボックスコントロール(SFZFlexListBoxControl)について、 指定された項目にダイレクトアクセスキーとその絵文字を設定します。

使用例

以下は、コンボボックスコントロールが内部で保持するフレックスリストボックスコントロールについて、 指定された項目にアクセスキーとその絵文字を設定するコードです。

// フレックスリストボックスコントロールの最初の項目に、アクセスキーとして AVK_1、その絵文字として 0xFBF6 を設定する
_combobox->SetItemAccessKey(0, AVK_1, 0xFBF6);

参照

SFZComboBoxControl::GetItemAccessKey | AVKType

戻り値

解説

この関数は、このコンボボックスコントロールが内部で保持する、 フレックスリストボックスコントロール(SFZFlexListBoxControl)内の指定された項目のアイコン定数 (SFZComboBoxControl::IconEnum) に対応するアイコン画像を設定します。

画像オブジェクトを直接、あるいは、リソースファイルから読み込むように指定します。

画像サイズの X または Y 成分が 0 以下のときや画像にアニメーションが含まれるときは、SFERR_INVALID_PARAM が返ります。

参照

SFZComboBoxControl::GetItemIconImage | SFZFlexListBoxControl | SFZComboBoxControl::IconEnum

戻り値

解説

この関数は、このコンボボックスコントロールが内部で保持する、 フレックスリストボックスコントロール(SFZFlexListBoxControl)内の指定された項目の文字列定数 (SFZComboBoxControl::TextEnum) に対応する文字列を設定します。

文字列定数（textEnum 引数）を指定しなかった場合は、 ボディ文字列を設定します。

参照

SFZComboBoxControl::GetItemText | SFZFlexListBoxControl | SFZComboBoxControl::TextEnum

解説

この関数は、タイトルのスクロール移動方向を設定します。

デフォルト値: SFZComboBoxControl::DEFAULT_DIRECTION

SFZComboBoxControl::DEFAULT_DIRECTION の値は SFZComboBoxControl::DirectionEnum を参照してください。

参照

SFZComboBoxControl::GetScrollDirection | SFZComboBoxControl::DirectionEnum

解説

この関数は、タイトルのスクロールインターバルを設定します。[単位:ミリ秒]

デフォルト値: SFZComboBoxControl::DEFAULT_SCROLL ミリ秒

SFZComboBoxControl::DEFAULT_SCROLL の値は SFZComboBoxControl::DefaultEnum を参照してください。

参照

SFZComboBoxControl::GetScrollInterval | SFZComboBoxControl::DefaultEnum

解説

この関数は、1 回のスクロールで移動するピクセル数を設定します。[単位:ピクセル]

−1（デフォルト値）を設定すると、使用しているフォントの半角空白文字 1 文字分（" "）の幅がスクロール移動量となります。

デフォルト値: SFZComboBoxControl::DEFAULT_STEP ピクセル

SFZComboBoxControl::DEFAULT_STEP の値は SFZComboBoxControl::DefaultEnum を参照してください。

参照

SFZComboBoxControl::GetScrollStep | SFZComboBoxControl::DefaultEnum

解説

この関数は、下図にあるタイトルの要素間スペースサイズを設定します。[単位:ピクセル]

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

参照

SFZComboBoxControl::GetSpaceSize

解説

この関数は、タイトルの色を設定します。

文字列定数（SFZComboBoxControl::TextEnum）に対応するタイトルを描画する色を設定します。

文字列定数を指定しない場合は、タイトルの色を設定します。

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

非活性状態にあるときは、この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色で文字列は描画されます。

色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFZComboBoxControl::TextEnum | SFZComboBoxControl::GetTitleColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、タイトルの垂直アライメントを設定します。

デフォルト値: SFZComboBoxControl::DEFAULT_VERTICAL

SFZComboBoxControl::DEFAULT_VERTICAL の値は SFZComboBoxControl::VerticalEnum を参照してください。

参照

SFZComboBoxControl::GetVerticalAlign | SFZComboBoxControl::VerticalEnum

解説

この関数は、タイトルのスクロール開始までの待ち時間を設定します。[単位:ミリ秒]

デフォルト値: SFZComboBoxControl::DEFAULT_WAIT ミリ秒

SFZComboBoxControl::DEFAULT_WAIT の値は SFZComboBoxControl::DefaultEnum を参照してください。

参照

SFZComboBoxControl::GetWaitInterval | SFZComboBoxControl::DefaultEnum

解説

この関数は、タイトルのスクロールを開始します。

仮想領域の幅がタイトルの幅よりも大きいときは何もしません。

SFEVT_APP_SUSPEND イベントと SFEVT_APP_RESUME イベントに自動的に応答しますが、 SFEVT_APP_SUSPEND イベントの受信後から SFEVT_APP_RESUME イベントの受信までの間にこの関数を呼び出したときの動作は未定です。

参照

SFZComboBoxControl::StopScroll

解説

この関数は、タイトルのスクロールを停止します。

参照

SFZComboBoxControl::StartScroll

参照

SFYResponder::GetType | SFYResponder::SetType

解説

ICON_BODY_NORMAL: 通常時のボディアイコン画像

ICON_BODY_SELECT: 選択時のボディアイコン画像 (タイトルには利用されません)

ICON_FOOTER_NORMAL: 通常時のフッタアイコン画像

ICON_FOOTER_SELECT: 選択時のフッタアイコン画像 (タイトルには利用されません)

解説

アイテム構造体を利用して、項目を挿入することができます。

参照

SFZComboBoxControl::Insert

解説

TEXT_HEADER_NORMAL: 通常時のヘッダ文字列

TEXT_HEADER_SELECT: 選択時のヘッダ文字列 (タイトルには利用されません)

TEXT_BODY_NORMAL: 通常時のボディ文字列

TEXT_BODY_SELECT: 選択時のボディ文字列 (タイトルには利用されません)