継承図

協調図

解説

■ 仕様と使い方

SFZFlexListBoxControl は、 リストの中から項目をひとつ選択させるための SFZListBoxControl クラスよりも高機能なリストボックスコントロール用クラスです。

□フレックスリストボックスコントロールの仕様

以下のように、個々の項目は左からヘッダ部、ボディ部、フッタ部の３つのパートに分かれます。

	注意
	ヘッダ部とフッタ部の水平アライメントは、常に左寄せ、右寄せです。 ボディ部の水平アライメントは、 SFZFlexListBoxControl::SetHorizontalAlign 関数を使用して指定できます。 ボディ部はトグル状態の設定により、 選択項目について複数行文字列表示にしたり、アイコン画像と文字列の順序を入れ替えることができます。 SFZFlexListBoxControl::SetHorizontalAlign 関数を使用して指定する、 水平アライメントはボディ部の後者に位置する要素にのみ（デフォルトは文字列）適用されます。 SFZFlexListBoxControl::SetVerticalAlign 関数を使用して指定する、 垂直アライメントは全てのパートに適用されます。

□SFZFlexListBoxControl クラスと SFZListBoxControl クラスの相違点

	パフォーマンスとメモリ使用量
	SFZFlexListBoxControl クラスでは、 各項目はウィジェットクラスを使用して実装されています。 項目数に比例して内部で管理するレスポンダの数が増加するので、 SFZFlexListBoxControl インスタンスを破棄するタイミングでパフォーマンスが劣化する恐れがあります。 また、メモリ使用量に関しても、同様のことが言えます。 項目数が数百以上の場合は、 SFZListBoxControl クラスを利用することを推奨します。

□フレックスリストボックスコントロールの使い方

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

SFZFlexListBoxControl::SetScrollUpKey 関数で設定された ScrollUp キー、または SFZFlexListBoxControl::SetScrollDownKey 関数で設定された ScrollDown キーを使用して選択項目を項目単位で移動できます。

SFZFlexListBoxControl::SetPageUpKey 関数で設定された PageUp キー、または SFZFlexListBoxControl::SetPageDownKey 関数で設定された PageDown キーを使用して選択項目をページ単位で移動できます。

SFZFlexListBoxControl::SetSnapUpKey 関数で設定された SnapUp キー、または SFZFlexListBoxControl::SetSnapDownKey 関数で設定された SnapDown キーを使用して選択項目を最上位項目または最下位項目に移動できます。

選択項目が移動した場合は、 値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] が発生します。

	注意
	この値イベントは、フレックスリストボックスコントロールの内部ハンドラ内で発生します。

選択項目は、 SFZFlexListBoxControl::SetTextColor 関数で設定された選択項目の文字列の色、 SFZFlexListBoxControl::SetSelectListColor 関数で設定された背景色で描画されます。

非選択項目は、 SFZFlexListBoxControl::SetTextColor 関数で設定された非選択項目の文字列の色、 奇数番目の項目は SFZFlexListBoxControl::SetOddListColor 関数、 偶数番目の項目は SFZFlexListBoxControl::SetEvenListColor 関数で設定された背景色でそれぞれ描画されます。

SFZFlexListBoxControl::SetItemEnable 関数によって設定される有効フラグが "false" である項目は、 テキストは SFZFlexListBoxControl::SetTextColor 関数で設定された色を基にして「無効な項目」用に計算された色で描画されます。 背景も奇数番目と偶数番目に応じて SFZFlexListBoxControl::SetOddListColor と SFZFlexListBoxControl::SetEvenListColor 関数で設定された色を基にして「無効な項目」用に計算された色でそれぞれ塗り潰されます。 ただし、 選択項目の背景は、 常に SFZFlexListBoxControl::SetSelectListColor 関数で設定された色で塗り潰されます。 また、このコントロールの状態が非活性状態であるときは、 すべての項目が 有効フラグが "false" であるときと同じ処理で描画されます。

その他、 SFZFlexListBoxControl::SetItemAccessKey 関数を使用して項目にアクセスキーを設定したり、 SFZFlexListBoxControl::SetGridLineEnable 関数と SFZFlexListBoxControl::SetGridLineColor 関数を使用してグリッド線を表示することも可能です。 項目内のマージンは SFZFlexListBoxControl::SetListMargin 関数で設定します。

デフォルトの実装では、 フレックスリストボックスコントロール[SFZFlexListBoxControl]は 下記の結果イベント[SFEVT_RESPONDER_RESULT]を受信します。

開発者は、これらの結果イベントを受信するハンドラを登録できます。

フレックスリストボックスコントロールの操作キーは、SFYBoxControl::SetOperateKey 関数を使用して設定します。 デフォルトでは、セレクトキーがフレックスリストボックスコントロールの操作キーとして割り当てられています。

アクセスキーは、SFZFlexListBoxControl::SetItemAccessKey 関数を使用して設定します。

ESCAPE キーは、SFZFlexListBoxControl::SetEscapeKey 関数を使用して設定します。 デフォルトでは、クリアキーが ESCAPE キーとして割り当てられています。

	注意
	選択項目が SFZFlexListBoxControl::SetItemEnable 関数により無効化（"false" が設定）されているとき、 結果イベントは発生しません。

参照: 結果イベント[SFEVT_RESPONDER_RESULT] | SFZFlexListBoxControl::HandleOperateKey | SFZFlexListBoxControl::HandleAccessKey | SFZFlexListBoxControl::HandleEscapeKey

■フレックスリストボックスを生成するためのコード

Void UserClass::Main(Void)
{
    SFZWindowSmp                    window;
    SFZFlexListBoxControlSmp        list;
    SFZFlexListBoxControl::ItemRec  item;
    SFBShellSmp                     shell(SFBShell::GetInstance());
    SFBImageSmp                     normal(shell->LoadResImage("userclass.bar", IDI_OBJECT_5001));
    SFBImageSmp                     select(shell->LoadResImage("userclass.bar", IDI_OBJECT_5002));
    SFBImageSmp                     disable(shell->LoadResImage("userclass.bar", IDI_OBJECT_5003));
    SFCError                        error(SFERR_NO_ERROR);

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

    // [必須] リストボックスを生成する
    list = SFZFlexListBoxControl::NewInstance(&error);

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

    // [任意] 偶数番目の項目の背景色を設定する
    list->SetEvenListColor(SFXRGBColor(0xFF, 0xFF, 0xCC, 0x00));

    // [任意] 奇数番目の項目の背景色を設定する
    list->SetOddListColor(SFXRGBColor(0xFF, 0xCC, 0xFF, 0x00));

    // [任意] 通常時の水平アライメントを中央揃えにする
    list->SetHorizontalAlign(SFZFlexListBoxControl::NORMAL, SFZFlexListBoxControl::HORIZONTAL_CENTER);

    // [任意] リスト項目間のマージンを設定する
    list->SetListMargin(SFXMargin(2, 1, 2, 1));

    // [任意] グリッドライン線を無効にする (デフォルト)
    list->SetGridLineEnable(false);

    // [任意] スペースサイズを設定する
    list->SetSpaceSize(4);

    // [任意] 連続スクロールするように設定する
    list->SetScrollRepeat(true);

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

    // [任意] 選択時は複数行文字列表示にする
    list->SetToggle(SFZFlexListBoxControl::TOGGLE_MULTIPLE_BODY_TEXT);

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

    // [アイテム構造体を利用する場合は必須] アイテム構造体のプロパティを設定する
    item.property.enable = true;  // 有効フラグを true に設定する
    item.property.key = 0;        // アクセスキーを設定しない    
    item.property.id = SFZFlexListBoxControl::INVALID_COMMAND_ID; // コマンド ID を設定しない

    // [任意] アイテム構造体のボディ部属性の画像を設定する
    item.normal.body.icon = normal;
    item.select.body.icon = select;

    // [必須] ２０個の項目を追加する
    for (SInt32 i = 0;  i < 20 ; ++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));

        // ５番目の項目だけアイテム構造体のフッタ部属性のアイコン画像を設定する
        if (i == 5) {
            item.normal.footer.icon = disable;
        }
        else {
            item.normal.footer.icon = SFBImageSmp::EmptyInstance();
        }

        // 末尾に挿入する
        list->InsertLast(item);
    }

    // [任意] ５番目の項目を無効にする
    list->SetItemEnable(5, false);

    // [必須] 最適な領域を計算して実領域を設定する
    list->SetRealBound(list->GetSuitableBound(window->GetLocalBound().Deflate(10, 10)).SnapCenterMiddle(GetLocalBound().GetCenterMiddle()));

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

    // [任意] １番目の項目を選択する (※)
    list->SetCurrentValue(1);

    // (※注意)
    // フレックスリストボックスの状態を「操作可能状態」にしてから現在の選択項目を設定する
    //

    return;
}

実行結果:

参照

SFYBoxControl | SFZListBoxControl | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | 結果イベント[SFEVT_RESPONDER_RESULT] | 状態

メンバ

解説

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

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

内部実装

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

/*protected */SFZFlexListBoxControl::SFZFlexListBoxControl(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0x00, 0x00}}},           // color.normal.text
        {{{0x00, 0xFF, 0xFF, 0xFF}}}            // color.select.text
    };
    static SFXEventRange::AtomRecConst          lrange[] = {
        #if TARGET_VERSION_GE(3, 0, 0)
        {       SFEVT_KEY_PRESS,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END},
        #else
        {       SFEVT_KEY_PRESS,         SFEVT_KEY_HELD,          SFP16_BEGIN,            SFP16_END},
        #endif
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_VALUE,  SFEVT_RESPONDER_VALUE,  SFP16_VALUE_CURRENT,  SFP16_VALUE_CURRENT}
    };
    static SFXEventRange::AtomRecConst          vrange[] = {
        { SFEVT_RESPONDER_VALUE,  SFEVT_RESPONDER_VALUE,  SFP16_VALUE_CURRENT,  SFP16_VALUE_CURRENT},
        { SFEVT_RESPONDER_BOUND,  SFEVT_RESPONDER_BOUND,     SFP16_BOUND_REAL,  SFP16_BOUND_VIRTUAL}
    };
    SFYHandler::RuleRec                         lrule[lengthof(lrange)];
    SFYHandler::RuleRec                         vrule[lengthof(vrange)];
    SFYHandler::RuleRec                         brule[lengthof(brange)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        lrule[0].spp = XANDLER_FUNCTION(OnShield);
        lrule[0].reference = this;
        lrule[1].spp = XANDLER_FUNCTION(OnKey);
        lrule[1].reference = this;
        lrule[2].spp = XANDLER_FUNCTION(OnCurrentValue);
        lrule[2].reference = this;
        static_throw(RegisterHandler(atomic_cast(lrange), lrule, lengthof(lrange)));
        if (static_try()) {
            if ((_vertical = SFYVerticalFlexListControl::NewInstance(&error)) != null) {
                static_throw(_vertical->SetParent(GetThis()));
                if (static_try()) {
                    vrule[0].spp = XANDLER_FUNCTION(OnVerticalCurrentValue);
                    vrule[0].reference = this;
                    vrule[1].spp = XANDLER_FUNCTION(OnVerticalBound);
                    vrule[1].reference = this;
                    static_throw(_vertical->RegisterHandler(atomic_cast(vrange), vrule, lengthof(vrange)));
                    if (static_try()) {
                        _vertical->SetPropertyTransparent(true);
                        _vertical->SetState(true, true, true, true);
                        if ((_bar.smp = SFZScrollBarControl::NewInstance(&error)) != null) {
                            static_throw(_bar.smp->SetParent(GetThis()));
                            if (static_try()) {
                                _bar.smp->SetOrientation(SFYScrollBarControl::VERTICAL);
                                brule[0].spp = XANDLER_FUNCTION(OnBarScrollEnable);
                                brule[0].reference = this;
                                static_throw(_bar.smp->RegisterHandler(atomic_cast(brange), brule, lengthof(brange)));
                                if (static_try()) {
                                    _bar.smp->SetState(true, true, false, false);
                                    _bar.width = DEFAULT_BAR_WIDTH;
                                    _key.sup = AVK_UP;
                                    _key.sdown = AVK_DOWN;
                                    _key.pup = AVK_TXPGUP;
                                    _key.pdown = AVK_TXPGDOWN;
                                    _key.nup = AVK_TXHOME;
                                    _key.ndown = AVK_TXEND;
                                    _key.escape = AVK_CLR;
                                    _accKeyEnable = true;
                                    _itemEmpty.property.key = static_cast<AVKType>(0);
                                    _itemEmpty.property.id = INVALID_COMMAND_ID;
                                    _itemEmpty.property.enable = false;
                                    _sub.normal.header.color.Set(rgb[0]);
                                    _sub.normal.body.color.Set(rgb[0]);
                                    _sub.select.header.color.Set(rgb[1]);
                                    _sub.select.body.color.Set(rgb[1]);
                                    _sub.space = DEFAULT_SPACE;
                                    _sub.normal.horizontal = DEFAULT_HORIZONTAL;
                                    _sub.select.horizontal = DEFAULT_HORIZONTAL;
                                    _sub.normal.vertical = DEFAULT_VERTICAL;
                                    _sub.select.vertical = DEFAULT_VERTICAL;
                                    _sub.normal.header.font = AEE_FONT_NORMAL;
                                    _sub.normal.body.font = AEE_FONT_NORMAL;
                                    _sub.select.header.font = AEE_FONT_NORMAL;
                                    _sub.select.body.font = AEE_FONT_NORMAL;
                                    _sub.scroll.wait = DEFAULT_WAIT;
                                    _sub.scroll.interval = DEFAULT_SCROLL;
                                    _sub.scroll.step = DEFAULT_STEP;
                                    _sub.scroll.direction = DEFAULT_DIRECTION;
                                    _sub.toggle = 0;
                                }
                            }
                        }
                        else {
                            static_throw(error);
                        }
                    }
                }
            }
            else {
                static_throw(error);
            }
        }
    }
}// SFZFlexListBoxControl::SFZFlexListBoxControl //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZFlexListBoxControl, OnShield, invoker, event)
{
    unused(invoker);
    return (event.GetP16() == GetScrollUpKey() ||
            event.GetP16() == GetScrollDownKey() ||
            event.GetP16() == GetPageUpKey() ||
            event.GetP16() == GetPageDownKey() ||
            event.GetP16() == GetSnapUpKey() ||
            event.GetP16() == GetSnapDownKey() ||
            event.GetP16() == GetOperateKey() ||
            event.GetP16() == GetEscapeKey() ||
            (GetAccessKeyEnable() && _vertical->ContainsAccessKey(static_cast<AVKType>(event.GetP16())))
    );
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZFlexListBoxControl, OnShield) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZFlexListBoxControl, OnKey, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == GetOperateKey()) {
        HandleOperateKey();
        result = true;
    }
    else if (event.GetP16() == GetEscapeKey()) {
        HandleEscapeKey();
        result = true;
    }
    else if (event.GetP16() == GetScrollUpKey()) {
        _vertical->ScrollUp();
        result = true;
    }
    else if (event.GetP16() == GetScrollDownKey()) {
        _vertical->ScrollDown();
        result = true;
    }
    else if (event.GetP16() == GetPageUpKey()) {
        _vertical->PageUp();
        result = true;
    }
    else if (event.GetP16() == GetPageDownKey()) {
        _vertical->PageDown();
        result = true;
    }
    else if (event.GetP16() == GetSnapUpKey()) {
        _vertical->SnapUp();
        result = true;
    }
    else if (event.GetP16() == GetSnapDownKey()) {
        _vertical->SnapDown();
        result = true;
    }
    else if (GetAccessKeyEnable() && _vertical->ContainsAccessKey(static_cast<AVKType>(event.GetP16()))) {
        result = HandleAccessKey(static_cast<AVKType>(event.GetP16()));
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZFlexListBoxControl, OnKey) //

/*private */XANDLER_IMPLEMENT_VOIDVALUE(SFZFlexListBoxControl, OnCurrentValue, invoker, reason, value)
{
    unused(invoker); unused(reason);
    _vertical->SetCurrentValue(value);
    return;
}// XANDLER_IMPLEMENT_VOIDVALUE(SFZFlexListBoxControl, OnCurrentValue) //

/*private */XANDLER_IMPLEMENT_VOIDVALUE(SFZFlexListBoxControl, OnVerticalCurrentValue, 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(value);
    }
    return;
}// XANDLER_IMPLEMENT_VOIDVALUE(SFZFlexListBoxControl,, OnVerticalCurrentValue) //

/*private */XANDLER_IMPLEMENT_VOIDBOUND(SFZFlexListBoxControl, OnVerticalBound, invoker, reason, rectangle)
{
    SFXRectangle                                rx;
    SFXRectangle                                vx;
    SInt16                                      max;
    SInt16                                      cur;
    SInt16                                      page;

    unused(invoker);
    if (_bar.smp != null) {
        switch (reason) {
            case SFP16_BOUND_REAL:
                rx.Set(*rectangle);
                if (_bar.smp->GetOrientation() == SFYScrollBarControl::VERTICAL) {
                    page = rx.GetHeight();
                }
                else {
                    page = rx.GetWidth();
                }
                _bar.smp->SetPageValue(page);
                break;
            case SFP16_BOUND_VIRTUAL:
                vx.Set(*rectangle);
                if (_bar.smp->GetOrientation() == SFYScrollBarControl::VERTICAL) {
                    max = vx.GetHeight();
                    cur = -vx.GetTop();
                }
                else {
                    max = vx.GetWidth();
                    cur = -vx.GetLeft();
                }
                _bar.smp->SetMinimumValue(0);
                _bar.smp->SetMaximumValue(max);
                _bar.smp->SetCurrentValue(cur);
                break;
            default:
                break;
        }
    }
    return;
}// XANDLER_IMPLEMENT_VOIDBOUND(SFZFlexListBoxControl, OnVerticalBound) //

/*private */XANDLER_IMPLEMENT_VOIDSCROLLBAR(SFZFlexListBoxControl, OnBarScrollEnable, invoker, reason)
{
    unused(invoker); unused(reason);
    _bar.smp->SetState(_bar.smp->IsScrollable(), _bar.smp->IsScrollable(), false, false);
    Relocate();
    return;
}// XANDLER_IMPLEMENT_VOIDSCROLLBAR(SFZFlexListBoxControl, OnBarScrollEnable) //

/*protected */SFYFlexListControl::SFYFlexListControl(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xFF, 0xFF, 0xFF}}},           // color.even / color.odd   (white)
        {{{0x00, 0x11, 0x22, 0xBB}}},           // color.select             (blue)
        {{{0x00, 0x00, 0x00, 0x00}}}            // color.gridLine           (black)
    };
    static SFXMargin::AtomRecConst              margin[] = {
        {1, 1, 1, 1}
    };

    if (static_try()) {
        SetType(CODE_TYPE);
        _listMargin.Set(margin[0]);
        _repeat = false;
        _color.even.Set(rgb[0]);
        _color.odd.Set(rgb[0]);
        _color.select.Set(rgb[1]);
        _color.gridLine.Set(rgb[2]);
        _property.enable = true;
        _line = false;
    }
}// SFYFlexListControl::SFYFlexListControl //

参照

SFYResponder::SetType | SFZFlexListBoxControl::CodeEnum | SFZFlexListBoxControl::SetScrollBarWidth | SFYControl::GetCurrentValue | SFZFlexListBoxControl::SetScrollRepeat | SFZFlexListBoxControl::SetEvenListColor | SFZFlexListBoxControl::SetOddListColor | SFZFlexListBoxControl::SetSelectListColor | SFZFlexListBoxControl::SetTextColor | SFZFlexListBoxControl::SetGridLineColor | SFZFlexListBoxControl::SetListMargin | SFZFlexListBoxControl::SetGridLineEnable | SFZFlexListBoxControl::SetAccessKeyEnable | SFZFlexListBoxControl::SetFont | SFZFlexListBoxControl::SetSpaceSize | SFZFlexListBoxControl::SetToggle | SFZFlexListBoxControl::SetScrollDirection | SFZFlexListBoxControl::SetScrollInterval | SFZFlexListBoxControl::SetScrollStep | SFZFlexListBoxControl::SetWaitInterval | SFYBoxControl::SetOperateKey | SFZFlexListBoxControl::SetItemAccessKey | SFZFlexListBoxControl::HandleOperateKey | SFZFlexListBoxControl::SetEscapeKey | SFZFlexListBoxControl::HandleEscapeKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFZFlexListBoxControl::HorizontalEnum | SFZFlexListBoxControl::VerticalEnum | SFZFlexListBoxControl::DirectionEnum | SFZFlexListBoxControl::DefaultEnum | SFZFlexListBoxControl::ToggleEnum | SFXMargin | SFXRGBColor | SFXEvent | タイプ | 実領域 | イベント | キーイベント[SFEVT_KEY] | 値イベント[SFEVT_RESPONDER_VALUE] | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

このフレックスリストボックスコントロールからすべての項目を削除します。

内部実装

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

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

/*protected virtual */SFYFlexListControl::~SFYFlexListControl(Void)
{
    WidgetArray::Iterator                       itor;

    itor = _widget.GetFirstIterator();
    while (itor.HasNext()) {
        ::delete itor.GetNext();
    }
}// SFYFlexListControl::~SFYFlexListControl //

参照

SFZFlexListBoxControl::Clear

解説

この関数は、リストボックスからすべての項目を削除します。

参照

SFZFlexListBoxControl::Remove

戻り値

解説

この関数は、指定されたアクセスキーが登録されているかどうかを判定します。

参照

SFZFlexListBoxControl::SetAccessKeyEnable | AVKType

戻り値

解説

この関数は、 指定されたコマンド ID を先頭から末尾に向かって検索し、最初に見つかった位置のインデックスを取得します。

	注意
	検索開始位置を指定することで、先頭以外の位置から検索できます。

	コマンド ID
	コマンド ID とは、リスト内の項目に識別子として自由に設定できる 32ビット符号なし整数（UInt32 型）のことです。 FirstIndexOfCommandId / LastIndexOfCommandId 関数で コマンド ID を指定して項目を検索することができます。

参照

SFZFlexListBoxControl::SetItemCommandId | SFZFlexListBoxControl::LastIndexOfCommandId | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、アクセスキー有効フラグの値を取得します。

参照

SFZFlexListBoxControl::SetAccessKeyEnable

戻り値

ESCAPE キー。

解説

この関数は、SFZFlexListBoxControl::SetEscapeKey 関数によって設定された ESCAPE キーを取得します。

参照

SFZFlexListBoxControl::SetEscapeKey

戻り値

偶数番目の非選択項目の背景色。

解説

この関数は、偶数番目の非選択項目の背景色を取得します。

参照

SFZFlexListBoxControl::SetEvenListColor

戻り値

指定された文字列定数に対応するフォント。

解説

この関数は、指定された文字列定数に対応するフォントを取得します。

参照

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::SetFont | BREW API AEEFont

戻り値

グリッド線の色。

解説

この関数は、グリッド線の色を取得します。

参照

SFZFlexListBoxControl::SetGridLineColor | SFZFlexListBoxControl::SetGridLineEnable

戻り値

グリッド線有効フラグの値。

解説

この関数は、グリッド線有効フラグの値を取得します。

参照

SFZFlexListBoxControl::SetGridLineEnable | SFZFlexListBoxControl::SetGridLineColor

戻り値

水平アライメントの値。

解説

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

参照

SFZFlexListBoxControl::SetHorizontalAlign | SFZFlexListBoxControl::HorizontalEnum

戻り値

アイテム構造体（SFZFlexListBoxControl::ItemRec）。

解説

この関数は、指定された項目のアイテム構造体を取得します。

	アイテム構造体
	アイテム構造体については、SFZFlexListBoxControl::ItemRec の解説を参照してください。

参照

SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::ItemRec

戻り値

指定された項目のアクセスキー（AVKType）。

解説

この関数は、指定された項目のアクセスキーを取得します。

アクセスキーが設定されていない場合、static_cast<AVKType>(0) が返ります。

参照

SFZFlexListBoxControl::SetItemAccessKey | SFZFlexListBoxControl::ItemRec | AVKType

戻り値

指定された項目のコマンド ID。

解説

この関数は、指定された項目のコマンド ID を取得します。

	コマンド ID
	コマンド ID とは、リスト内の項目に識別子として自由に設定できる 32ビット符号なし整数（UInt32 型）のことです。 FirstIndexOfCommandId / LastIndexOfCommandId 関数で コマンド ID を指定して項目を検索することができます。

参照

SFZFlexListBoxControl::SetItemCommandId | SFZFlexListBoxControl::FirstIndexOfCommandId | SFZFlexListBoxControl::LastIndexOfCommandId | SFZFlexListBoxControl::ItemRec

戻り値

フレックスリストボックスコントロールの項目の数。

解説

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

戻り値

項目の有効フラグに設定された値（Bool 型）。

解説

この関数は、指定された項目の有効フラグの値を取得します。

参照

SFZFlexListBoxControl::SetItemEnable | SFZFlexListBoxControl::ItemRec

戻り値

指定された項目の高さ 。[単位:ピクセル]

解説

この関数は、リストボックスコントロール内の指定された項目の高さを取得します。

	注意
	SFZFlexListBoxControl::SetFont 関数で項目に設定されたフォントの高さ、 SFZFlexListBoxControl::SetItemIconImage 関数で項目に設定されたアイコン画像の高さ、 SFZFlexListBoxControl::SetListMargin 関数で設定された上下の余白からフレックスリストボックスコントロールの項目の高さを計算します。

参照

SFZFlexListBoxControl::SetFont | SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::SetListMargin

戻り値

指定された項目内の指定されたアイコン定数（SFZFlexListBoxControl::IconEnum）に対応する画像。

解説

この関数は、指定された項目内の指定されたアイコン定数（SFZFlexListBoxControl::IconEnum）に対応する画像を取得します。

参照

SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::IconEnum | SFZFlexListBoxControl::ItemRec

戻り値

指定された項目の指定された文字列定数に対応するテキスト。

解説

この関数は、指定された項目の指定された文字列定数（SFZFlexListBoxControl::TextEnum）に対応する文字列を取得します。

参照

SFZFlexListBoxControl::SetItemText | SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::ItemRec

戻り値

リスト項目内のマージン（SFXMargin）。

解説

この関数は、リスト項目のマージンを取得します。

参照

SFZFlexListBoxControl::SetListMargin

戻り値

奇数番目の非選択項目の背景色。

解説

この関数は、奇数番目の非選択項目の背景色を取得します。

参照

SFZFlexListBoxControl::SetOddListColor

戻り値

項目を下方向に 1 ページ分スクロールする PageDown キー。

解説

この関数は、項目を下方向に 1 ページ分スクロールする PageDown キーを取得します。

参照

SFZFlexListBoxControl::SetPageDownKey | AVKType

戻り値

項目を上方向に 1 ページ分スクロールする PageUp キー。

解説

この関数は、項目を上方向に 1 ページ分スクロールする PageUp キーを取得します。

参照

SFZFlexListBoxControl::SetPageUpKey | AVKType

戻り値

スクロールバーコントロール。

解説

この関数は、フレックスリストボックスで使用されるスクロールバーコントロールを取得します。

開発者は取得したスクロールバーコントロールを使用してスクロールバーの外観を変更することができます。

独自のスクロールバーコントロールを利用する場合は、SFZFlexListBoxControl::SetScrollBarControl 関数を呼び出して設定します。

使用例

以下は、スクロールバーコントロールを取得してトラック色を変更するためのコードです。

// スクロールバーコントロールを取得する
SFZFlexListBoxControlSmp    _list;
SFYScrollBarControlSmp      _bar;

_list = SFZFlexListBoxControl::NewInstance();

if ((_bar = _list->GetScrollBarControl()) != null) {
    _bar->SetTrackColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));
}

参照

SFYScrollBarControl | SFZFlexListBoxControl::SetScrollBarControl

戻り値

スクロールバーの横幅。[単位:ピクセル]

解説

この関数は、スクロールバーの横幅を取得します。[単位:ピクセル]

参照

SFZFlexListBoxControl::SetScrollBarWidth

戻り値

スクロールの移動方向（SFZFlexListBoxControl::DirectionEnum）。

解説

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

参照

SFZFlexListBoxControl::SetScrollDirection

戻り値

項目を下方向に１項目スクロールする ScrollDown キー。

解説

この関数は、項目を下方向に１項目スクロールする ScrollDown キーを取得します。

参照

SFZFlexListBoxControl::SetScrollDownKey | AVKType

戻り値

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

解説

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

参照

SFZFlexListBoxControl::SetScrollInterval

戻り値

解説

この関数は、連続スクロールフラグの値を取得します。

	注意
	連続スクロールフラグの値が true の場合、 フォーカスを持つ先頭/末尾の項目を更に上/下方向にフォーカスを移動させようとすると 末尾/先頭の項目にフォーカスが移動します。 先頭の項目から末尾の項目にフォーカスが移動した場合は、 末尾の項目が実領域の最下部の位置に来るように表示されます。 末尾の項目から先頭の項目にフォーカスが移動した場合は、 先頭の項目が実領域の最上部の位置に来るように表示されます。 なお、スクロールするだけの項目が存在しない場合は、 何も起こりません。

参照

SFZFlexListBoxControl::SetScrollRepeat

戻り値

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

解説

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

参照

SFZFlexListBoxControl::SetScrollStep

戻り値

項目を上方向に１項目スクロールする ScrollUp キー。

解説

この関数は、項目を上方向に１項目スクロールする ScrollUp キーを取得します。

参照

SFZFlexListBoxControl::SetScrollUpKey | AVKType

戻り値

選択項目の背景色。

解説

この関数は、選択項目の背景色を取得します。

参照

SFZFlexListBoxControl::SetSelectListColor

戻り値

項目を下端までスクロールする SnapDown キー。

解説

この関数は、項目を下端までスクロールする SnapDown キーを取得します。

参照

SFZFlexListBoxControl::SetSnapDownKey | AVKType

戻り値

項目を上端までスクロールする SnapUp キー。

解説

この関数は、項目を上端までスクロールする SnapUp キーを取得します。

参照

SFZFlexListBoxControl::SetSnapUpKey | AVKType

戻り値

スペースサイズ。[単位:ピクセル]

解説

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

参照

SFZFlexListBoxControl::SetSpaceSize

戻り値

文字列定数（SFZFlexListBoxControl::TextEnum）に対応する色。

解説

この関数は、指定された文字列定数（SFZFlexListBoxControl::TextEnum）に対応する色を取得します。

参照

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::SetTextColor

戻り値

トグル状態（SFZFlexListBoxControl::ToggleEnum の論理和）。

解説

この関数は、トグル状態（SFZFlexListBoxControl::ToggleEnum の論理和）を取得します。

参照

SFZFlexListBoxControl::ToggleEnum | SFZFlexListBoxControl::SetToggle

戻り値

垂直アライメント（SFZFlexListBoxControl::VerticalEnum）。

解説

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

参照

SFZFlexListBoxControl::SetVerticalAlign | SFZFlexListBoxControl::VerticalEnum

戻り値

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

解説

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

参照

SFZFlexListBoxControl::SetWaitInterval

解説

この関数は、SFZFlexListBoxControl::SetItemAccessKey 関数で設定したアクセスキーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

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

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

SFZFlexListBoxControl::SetAccessKeyEnable 関数によりコントロール全体のアクセスキー有効フラグが true に設定され、 SFZFlexListBoxControl::SetItemAccessKey 関数で設定したアクセスキーを設定した項目が SFZFlexListBoxControl::SetItemEnable 関数により項目の有効フラグが true に設定されている場合、 SFYControl::SetCurrentValue 関数を呼び出してその項目を現在の選択項目とします。 そして、結果イベント[SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 指定されたアクセスキーが設定されている項目のインデックス)]を送信します。

コントロール全体のアクセスキー有効フラグが false に設定されている場合や、 項目の有効フラグが false に設定されている場合、何も処理されません。

同じアクセスキーが複数の項目に設定されている場合は、最初の項目に設定されたものだけが有効になります。

内部実装

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

/*protected virtual */Bool SFZFlexListBoxControl::HandleAccessKey(AVKType key)
{
    Bool                                        result(false);

    for (SInt32 i = 0; i < GetItemCount(); ++ i) {
        if (GetItemAccessKey(i) == key) {
            if (GetItemEnable(i)) {
                SetCurrentValue(i);
                InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, i), false);
                result = true;
                break;
            }
        }
    }
    return result;
}// SFZFlexListBoxControl::HandleAccessKey //
}// SFYWidget::HandleBoundOptimize //

参照

SFZFlexListBoxControl::SetItemAccessKey | SFZFlexListBoxControl::SetAccessKeyEnable | SFZFlexListBoxControl::SetItemEnable SFYControl::GetCurrentValue | SFXEvent | 結果イベント | キーイベント[SFEVT_KEY]

解説

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

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

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

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

	項目の高さ
	SFZFlexListBoxControl では、 各項目の高さは異なる可能性があるため項目毎に高さを計算し、その和をとっています。 一方、SFZListBoxControl では、項目の高さはすべて同じです。

	項目のフォント、アイコンキャラクタやアイコン画像、文字列、スペースサイズ、マージン
	項目内の要素であるフォント、アイコンキャラクタやアイコン画像、文字列、マージンは、 SFZFlexListBoxControl::SetFont 関数、 SFZFlexListBoxControl::SetItem 関数、 SFZFlexListBoxControl::SetItemIconImage 関数、 SFZFlexListBoxControl::SetItemText 関数、 SFZFlexListBoxControl::SetSpaceSize 関数、 SFZFlexListBoxControl::SetListMargin 関数を使用して設定されます。 アイコンキャラクタやアイコン画像、文字列は設定されないこともあります。 設定されていない項目内の要素の長さは 0 として計算されます。

	スクロールバーの横幅
	スクロールバーの幅は、SFZFlexListBoxControl::SetScrollBarWidth 関数で設定される幅です。

	ボックス枠用のマージン
	ボックスコントロールのマージンは、SFXMargin(3, 3, 3, 3) で表される領域です。 詳細は SFYBoxControl::GetBoxMargin 関数の解説を参照してください。

	領域イベント[(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 仮想関数をオーバーライドして処理を記述します。

内部実装

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

struct ScrollBarRec {
    SFYScrollBarControlSmp              smp;
    SInt16                              width;
};

SFYVerticalFlexListControlSmp   _vertical;
ScrollBarRec                    _bar;

/*protected virtual */Void SFZFlexListBoxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXSize                                     size;

    rectangle->Deflate(GetBoxMargin());
    size.Set(_vertical->GetSuitableBound(*rectangle).GetSize());
    if (_vertical->IsOptimizeOver()) {
        rectangle->SubWidth(_bar.width);
        size.Set(_vertical->GetSuitableBound(*rectangle).GetSize());
        rectangle->SetSize(size);
        rectangle->AddWidth(_bar.width);
    }
    else {
        rectangle->SetSize(size);
    }
    rectangle->Inflate(GetBoxMargin());
    return;
}// SFZFlexListBoxControl::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFZFlexListBoxControl::SetFont | SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::SetItemText | SFZFlexListBoxControl::SetSpaceSize | SFZFlexListBoxControl::SetListMargin | SFZFlexListBoxControl::SetScrollBarWidth | SFYBoxControl::GetBoxMargin | SFXMargin | SFZListBoxControl | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]

解説

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

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

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

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

	項目の高さ
	SFZFlexListBoxControl では、 各項目の高さは異なる可能性があるため項目毎に高さを計算し、その和をとります。 一方、SFZListBoxControl では、項目の高さはすべて同じです。

	項目のフォント、アイコンキャラクタやアイコン画像、文字列、スペースサイズ、マージン
	項目内の要素であるフォント、アイコンキャラクタやアイコン画像、文字列、マージンは、 SFZFlexListBoxControl::SetFont 関数、 SFZFlexListBoxControl::SetItem 関数、 SFZFlexListBoxControl::SetItemIconImage 関数、 SFZFlexListBoxControl::SetItemText 関数、 SFZFlexListBoxControl::SetSpaceSize 関数、 SFZFlexListBoxControl::SetListMargin 関数を使用して設定されます。 アイコンキャラクタやアイコン画像、文字列は設定されないこともあります。 設定されていない項目内の要素の長さは 0 として計算されます。

	ボックス枠用のマージン
	ボックスコントロールのマージンは、SFXMargin(3, 3, 3, 3) で表される領域です。 詳細は SFYBoxControl::GetBoxMargin 関数の解説を参照してください。

	領域イベント[(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 仮想関数をオーバーライドして処理を記述します。

内部実装

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

SFYVerticalFlexListControlSmp   _vertical;

/*protected virtual */Void SFZFlexListBoxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    SFXSize                                     size;

    rectangle->Deflate(GetBoxMargin());
    size.Set(_vertical->GetSuitableBound().GetSize());
    rectangle->SetSize(size);
    rectangle->Inflate(GetBoxMargin());
    return;
}// SFZFlexListBoxControl::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFZFlexListBoxControl::SetFont | SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::SetItemText | SFZFlexListBoxControl::SetSpaceSize | SFZFlexListBoxControl::SetListMargin | SFYBoxControl::GetBoxMargin | SFXMargin | SFZListBoxControl | SFXEvent | 実領域 | 領域イベント[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]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常はこの仮想関数をオーバーライドして処理を記述します。

内部実装

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

struct ScrollBarRec {
    SFYScrollBarControlSmp              smp;
    SInt16                              width;
};

SFYVerticalFlexListControlSmp   _vertical;
ScrollBarRec                    _bar;

/*protected virtual */Void SFZFlexListBoxControl::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFZFlexListBoxControl::HandleBoundVirtual //

/*private */Void SFZFlexListBoxControl::Relocate(Void)
{
    SFYFlexListItemWidgetSmp                    widget;
    SFXRectangle                                rc(GetLocalBound());
    SFXRectangle                                vx;
    SFXRectangle                                bx;
    SInt16                                      width(0);

    if (_bar.smp != null && _bar.smp->IsScrollable()) {
        width = _bar.width;
    }
    rc.Deflate(GetBoxMargin());
    vx.Set(rc.SubWidth(width));
    rc.AddX(rc.GetWidth());
    bx.Set(rc.SetWidth(width));
    if (_bar.smp != null) {
        _bar.smp->SetRealBound(bx);
    }
    _vertical->SetRealBound(vx);
    if (GetItemEnable(GetCurrentValue())) {
        if ((widget = GetItemWidget(GetCurrentValue())) != null) {
            if (widget->GetStateActive(true)) {
                widget->StartScroll();
            }
        }
    }
    return;
}// SFZFlexListBoxControl::Relocate //

参照

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

解説

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

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

デフォルトの実装では、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0)] を送信します。

内部実装

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

/*protected virtual */Void SFZFlexListBoxControl::HandleEscapeKey(Void)
{
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0), false);
    return;
}// SFZFlexListBoxControl::HandleEscapeKey //

参照

SFZFlexListBoxControl::SetEscapeKey SFXEvent | 結果イベント[SFEVT_RESPONDER_RESULT] | キーイベント[SFEVT_KEY]

解説

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

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

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

SFZFlexListBoxControl::SetItemEnable 関数により選択された項目の有効フラグが true に設定されている場合、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, SFYControl::GetCurrentValue 関数の戻り値)] を送信します。

項目の有効フラグが false に設定されている場合、結果イベントを送信しません。

内部実装

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

/*protected virtual */Void SFZFlexListBoxControl::HandleOperateKey(Void)
{
    if (GetItemEnable(GetCurrentValue())) {
        InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetCurrentValue()), false);
    }
    return;
}// SFZFlexListBoxControl::HandleOperateKey //

参照

SFYBoxControl::SetOperateKey | SFZFlexListBoxControl::SetItemEnable | SFXEvent | 結果イベント[SFEVT_RESPONDER_RESULT] | キーイベント[SFEVT_KEY]

解説

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

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

デフォルトの実装は、フレックスリストボックスコントロールを描画します。

レスポンダの描画手順

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

内部実装

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

/*protected virtual */Void SFZFlexListBoxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawBox(graphics, GetLocalBound());
    return;
}// SFZFlexListBoxControl::HandleRenderRequest //

参照

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

戻り値

解説

この関数は、指定されたインデックスの位置に項目を挿入します。

index 引数が 0 以下の場合は先頭に挿入されます。

index 引数が項目数以上の場合は末尾に挿入されます。

	注意
	追加後の項目数が SFYControl クラスの最大値として設定されます。

	アイテム構造体
	アイテム構造体については、SFZFlexListBoxControl::ItemRec の解説を参照してください。

参照

SFZFlexListBoxControl::InsertFirst | SFZFlexListBoxControl::InsertLast | SFZFlexListBoxControl::Remove | SFYControl::SetMaximumValue | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、先頭に項目を挿入します。

	注意
	追加後の項目数が SFYControl クラスの最大値として設定されます。

	アイテム構造体
	アイテム構造体については、SFZFlexListBoxControl::ItemRec の解説を参照してください。

参照

SFZFlexListBoxControl::Insert | SFZFlexListBoxControl::InsertLast | SFZFlexListBoxControl::RemoveFirst | SFYControl::SetMaximumValue | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、末尾に項目を挿入します。

	注意
	追加後の項目数が SFYControl クラスの最大値として設定されます。

	アイテム構造体
	アイテム構造体については、SFZFlexListBoxControl::ItemRec の解説を参照してください。

参照

SFZFlexListBoxControl::InsertFirst | SFZFlexListBoxControl::InsertLast | SFZFlexListBoxControl::RemoveLast | SFYControl::SetMaximumValue | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、コマンド ID を末尾から先頭に向かって検索し、最初に見つかった位置のインデックスを取得します。

	注意
	検索開始位置を指定することで、末尾以外の位置から検索できます。

	コマンド ID
	コマンド ID とは、リスト内の項目に識別子として自由に設定できる 32ビット符号なし整数（UInt32 型）のことです。 FirstIndexOfCommandId / LastIndexOfCommandId 関数で コマンド ID を指定して項目を検索することができます。

参照

SFZFlexListBoxControl::SetItemCommandId | SFZFlexListBoxControl::FirstIndexOfCommandId

引数

戻り値

解説

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

作成に成功した場合は null 以外のポインタを返し、exception 引数は常に SFERR_NO_ERROR になります。メモリ不足などで作成に失敗した場合は null ポインタを返し、exception 引数にエラー値が返ります。

使用例

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

// フレックスリストボックスのインスタンスを生成する
SFCError error;
SFZFlexListBoxControlSmp _list;

if ((_list = SFZFlexListBoxControl::NewInstance(&error)) != null) {
    // ...
}

解説

この関数は、 指定されたインデックスの位置または範囲の項目を削除します。

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

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

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

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

	注意
	削除後の項目数が SFYControl クラスの最大値として設定されます。

使用例

SFZFlexListBoxControlSmp    listbox;

// インスタンスの作成等 ... 

// 項目を追加
if (listbox->InsertLast("0番目") == SFERR_NO_ERROR) {
    // 項目を追加
    if (listbox->InsertLast("1番目") == SFERR_NO_ERROR) {
        // 項目を追加
        if (listbox->InsertLast("2番目") == SFERR_NO_ERROR) {
            // 項目を追加
            if (listbox->InsertLast("3番目") == SFERR_NO_ERROR) {
                // 2 番目を選択する
                listbox->SetCurrentValue(2);

                //////////////////////////
                // リストボックスの状態 //
                // 0: "0番目"           //
                // 1: "1番目"           //
                // 2: "2番目" ←        //
                // 3: "3番目"           //
                //////////////////////////

                // 項目1 から項目2 までを削除する
                listbox->Remove(1, 3);

                //////////////////////////
                // リストボックスの状態 //
                // 0: "0番目"           //
                // 1: "3番目" ←        //
                //////////////////////////
            }
        }
    }
}

参照

SFZFlexListBoxControl::Clear | SFZFlexListBoxControl::RemoveFirst | SFZFlexListBoxControl::RemoveLast | SFZFlexListBoxControl::Insert | SFYControl::SetMaximumValue

解説

この関数は、先頭の項目を削除します。

	注意
	削除後の項目数が SFYControl クラスの最大値として設定されます。

参照

SFZFlexListBoxControl::Clear | SFZFlexListBoxControl::Remove | SFZFlexListBoxControl::RemoveLast | SFZFlexListBoxControl::InsertFirst | SFYControl::SetMaximumValue

解説

この関数は、末尾の項目を削除します。

	注意
	削除後の項目数が SFYControl クラスの最大値として設定されます。

参照

SFZFlexListBoxControl::Clear | SFZFlexListBoxControl::Remove | SFZFlexListBoxControl::RemoveFirst | SFZFlexListBoxControl::InsertLast | SFYControl::SetMaximumValue

解説

この関数は、アクセスキー有効フラグを設定します。

	注意
	アクセスキー有効フラグは、 リストボックスコントロール全体でアクセスキーの設定が有効であるかどうかを表します。 このフラグを true に設定すると、 SFZFlexListBoxControl::SetItemEnable 関数で設定する、 項目の有効フラグの値が true のときだけアクセスキーの設定が有効になります。 逆に、false に設定すると、全ての項目のアクセスキーの設定が無効になります。

参照

SFZFlexListBoxControl::GetAccessKeyEnable | SFZFlexListBoxControl::SetItemEnable

解説

この関数は、フレックスリストボックスの ESCAPE キーを設定します。

デフォルト値: AVK_CLR

	注意
	ESCAPE キーが押下されると、 SFZFlexListBoxControl::HandleEscapeKey 関数が呼び出されます。

参照

SFZFlexListBoxControl::GetEscapeKey | SFZFlexListBoxControl::HandleEscapeKey

解説

この関数は、偶数番目の非選択項目の背景色を設定します。

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

SFZFlexListBoxControl::SetItemEnable 関数を使用して項目の有効フラグが false に設定されているとき、 この関数によって設定される色で背景は描画されません。

このときは、 この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x33 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x33 を加算した色で背景は描画されます。

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

	奇数番目の非選択項目の背景色
	SFZFlexListBoxControl::SetOddListColor 関数の解説を参照してください。

	選択項目の背景色
	SFZFlexListBoxControl::SetSelectListColor 関数の解説を参照してください。

	項目の前景色
	SFZFlexListBoxControl::SetTextColor 関数の解説を参照してください。

参照

SFZFlexListBoxControl::GetEvenListColor | SFZFlexListBoxControl::SetOddListColor | SFZFlexListBoxControl::SetSelectListColor | SFZFlexListBoxControl::SetTextColor | SFZFlexListBoxControl::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor

解説

この関数は、指定された文字列定数に対応するフォントを設定します。

デフォルト値: AEE_FONT_NORMAL

参照

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::GetFont | BREW API AEEFont

解説

この関数は、グリッド線の色を設定します。

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

	注意
	グリッド線は、SFZFlexListBoxControl::SetGridLineEnable 関数を使用して有効フラグが true に設定されているときだけ描画されます。

参照

SFZFlexListBoxControl::GetGridLineColor | SFZFlexListBoxControl::SetGridLineEnable | SFXRGBColor

解説

この関数は、グリッド線を有効フラグを設定します。

デフォルト値: false

	注意
	有効フラグが true に設定されているときだけ、 グリッド線は SFZFlexListBoxControl::SetGridLineColor 関数で設定した色で描画されます。

	グリッド線の描画領域
	グリッド線は各項目の矩形領域の最下端１ピクセルの線上に描画されます。 グリッド線有効フラグを true に設定する場合は、 SFZFlexListBoxControl::SetListMargin 関数を使用してその分の余白領域を設定することを推奨します。

参照

SFZFlexListBoxControl::GetGridLineEnable | SFZFlexListBoxControl::SetGridLineColor | SFZFlexListBoxControl::SetListMargin

解説

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

デフォルト値: SFZFlexListBoxControl::DEFAULT_HORIZONTAL

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

参照

SFZFlexListBoxControl::GetHorizontalAlign | SFZFlexListBoxControl::HorizontalEnum

解説

この関数は、指定された項目のアイテム構造体を設定します。

	アイテム構造体
	アイテム構造体については、SFZFlexListBoxControl::ItemRec の解説を参照してください。

参照

SFZFlexListBoxControl::GetItem | SFZFlexListBoxControl::ItemRec

解説

この関数は、指定された項目のアクセスキーを設定します。

デフォルト値: static_cast<AVKType>(0)

	注意
	この関数を使用して設定されたアクセスキーが押下されると、 SFZFlexListBoxControl::HandleAccessKey 関数が呼び出されます。 ただし、この関数が呼び出されるには、 SFZFlexListBoxControl::SetAccessKeyEnable 関数によりアクセスキー有効フラグが true、 SFZFlexListBoxControl::SetItemEnable 関数により項目の有効フラグが true に設定されている必要があります。

参照

SFZFlexListBoxControl::GetItemAccessKey | SFZFlexListBoxControl::HandleAccessKey | SFZFlexListBoxControl::SetAccessKeyEnable | SFZFlexListBoxControl::SetItemEnable | SFZFlexListBoxControl::ItemRec | AVKType

解説

この関数は、 指定された項目のコマンド ID を設定します。

デフォルト値: UINT32_MAXIMUM

	コマンド ID
	コマンド ID とは、リスト内の項目に識別子として自由に設定できる 32ビット符号なし整数（UInt32 型）のことです。 FirstIndexOfCommandId / LastIndexOfCommandId 関数で コマンド ID を指定して項目を検索することができます。

参照

SFZFlexListBoxControl::GetItemCommandId | SFZFlexListBoxControl::FirstIndexOfCommandId | SFZFlexListBoxControl::LastIndexOfCommandId | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、指定された項目の有効フラグを設定します。

デフォルト値: true

項目の有効フラグが false に設定されているとき

操作キーやアクセスキーが押下されても結果イベントは送信されません。 項目の前景色（テキストを描画する色）と非選択項目の背景色は以下の通りです。 項目の前景色は、SFZFlexListBoxControl::SetTextColor 関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色になります。 非選択項目の背景色は、SFZFlexListBoxControl::SetEvenListColor 関数や SFZFlexListBoxControl::SetOddListColor 関数で設定された背景色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x33 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x33 を加算した色になります。 色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

	注意
	項目の有効フラグが false に設定されているとき、 選択項目の前景色も上述の補正色になります。 SFZFlexListBoxControl::SetTextColor 関数で設定した選択項目の色ではありません。 選択項目の背景色は、 常に SFZFlexListBoxControl::SetSelectListColor 関数で設定された色になります。 項目の有効フラグが false に設定されているとき、 偶数番目/奇数番目の非選択項目の背景色は、 SFZFlexListBoxControl::SetEvenListColor / SFZFlexListBoxControl::SetOddListColor 関数で設定された背景色を補正した色になります。

参照

SFZFlexListBoxControl::GetItemEnable | SFZFlexListBoxControl::HandleOperateKey | SFZFlexListBoxControl::HandleAccessKey | SFZFlexListBoxControl::SetTextColor | SFZFlexListBoxControl::SetEvenListColor | SFZFlexListBoxControl::SetOddListColor | SFZFlexListBoxControl::SetSelectListColor | SFXRGBColor::GetBrightness | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、 指定された項目に指定されたアイコン定数（SFZFlexListBoxControl::IconEnum）に対応する画像を設定します。

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

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

参照

SFZFlexListBoxControl::GetItemIconImage | SFZFlexListBoxControl::IconEnum | SFZFlexListBoxControl::ItemRec

戻り値

解説

この関数は、 指定された項目に指定された文字列定数（SFZFlexListBoxControl::TextEnum）に対応するテキストを設定します。

テキストは直接、あるいは、リソースファイルから読み込むように指定します。

参照

SFZFlexListBoxControl::GetItemText | SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::ItemRec

解説

この関数は、リスト項目のマージンを設定します。

デフォルト値: SFXMargin(1, 1, 1, 1)

リスト項目のコンテンツは、この関数で設定したマージンを除く領域に描画されます。

参照

SFZFlexListBoxControl::GetListMargin | SFXMargin

解説

この関数は、奇数番目の非選択項目の背景色を設定します。

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

SFZFlexListBoxControl::SetItemEnable 関数を使用して項目の有効フラグが false に設定されているとき、 この関数によって設定される色で背景は描画されません。

このときは、 この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x33 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x33 を加算した色で背景は描画されます。

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

	偶数番目の非選択項目の背景色
	SFZFlexListBoxControl::SetEvenListColor 関数の解説を参照してください。

	選択項目の背景色
	SFZFlexListBoxControl::SetSelectListColor 関数の解説を参照してください。

	項目の前景色
	SFZFlexListBoxControl::SetTextColor 関数の解説を参照してください。

参照

SFZFlexListBoxControl::GetOddListColor | SFZFlexListBoxControl::SetEvenListColor | SFZFlexListBoxControl::SetSelectListColor | SFZFlexListBoxControl::SetTextColor | SFZFlexListBoxControl::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor

解説

この関数は、項目を下方向に 1 ページ分スクロールする PageDown キーを設定します。

デフォルト値: AVK_TXPGDOWN

	注意
	PageDown キーが押下された場合、 現在の選択項目よりも１ページ（フレックスリストの実領域の高さ）分下の項目が新しい選択項目となり、 実領域の下端の位置に来るようにスクロールします。 現在の選択項目より下に 1 ページ分未満の項目しか存在しなければ、 末尾の項目がフレックスリストの新しい選択項目になります。 仮想領域≧実領域の場合、新しい選択項目（＝末尾の項目）が実領域の下端の位置に来るようにスクロールします。

	値イベント
	選択項目が変化した場合、 フレックスリストボックスコントロールは値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] を受信します。

参照

SFZFlexListBoxControl::GetPageDownKey | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | AVKType

解説

この関数は、項目を上方向に 1 ページ分スクロールする PageUp キーを設定します。

デフォルト値: AVK_TXPGUP

	注意
	PageUp キーが押下された場合、 現在の選択項目よりも１ページ（フレックスリストの実領域の高さ）分上の項目が新しい選択項目となり、 実領域の上端の位置に来るようにスクロールします。 現在の選択項目より上に 1 ページ分未満の項目しか存在しなければ、 先頭の項目がフレックスリストの新しい選択項目になります。 仮想領域≧実領域の場合、新しい選択項目（＝先頭の項目）が実領域の上端の位置に来るようにスクロールします。

	値イベント
	選択項目が変化した場合、 フレックスリストボックスコントロールは値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] を受信します。

参照

SFZFlexListBoxControl::GetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | AVKType

解説

この関数は、リストボックスで使用されるスクロールバーコントロールを設定します。

	注意
	開発者が独自のスクロールバーを設定したいときに利用します。

使用例

以下は、カスタムスクロールバーを設定するコードです。

// 独自のスクロールバーコントロール
class CustomScrollBarControl : public SFYScrollBarControl {
    // 独自の定義
};

Void UserApplication::SomeFunction {
    SFZFlexListBoxControlSmp        list;
    CustomScrollBarControlSmp       bar;

    // リストボックスの生成
    list = SFZFlexListBoxControl::NewInstance();

    // リストボックスの設定
    // …

    // スクロールバーの生成
    bar = CustomScrollBarControl::NewInstance();

    // 独自のスクロールバーをリストボックスに設定する
    list->SetScrollBarControl(bar);
    return;
}

参照

SFZFlexListBoxControl::GetScrollBarControl

解説

この関数は、スクロールバーコントロールの横幅を設定します。[単位:ピクセル]

デフォルト値: SFZFlexListBoxControl::DEFAULT_BAR_WIDTH ピクセル

	注意
	SFZFlexListBoxControl::DEFAULT_BAR_WIDTH の値は SFZFlexListBoxControl::DefaultEnum を参照してください。

	スクロールバーコントロールの幅について
	スクロールバーコントロールの幅として、4 ピクセル以上の値を指定できます。 減分・増分矢印を矩形領域内にバランス良く描画するには、5 以上の奇数を指定することを推奨します。

参照

SFZFlexListBoxControl::GetScrollBarWidth | SFZFlexListBoxControl::DefaultEnum

解説

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

デフォルト値: SFZFlexListBoxControl::DEFAULT_DIRECTION

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

参照

SFZFlexListBoxControl::GetScrollDirection | SFZFlexListBoxControl::DirectionEnum

解説

この関数は、項目を下方向に１項目スクロールする ScrollDown キーを設定します。

デフォルト値: AVK_DOWN

	注意
	ScrollDown キーが押下された場合、 現在の選択項目よりも１つ下の項目がフレックスリストの新しい選択項目になります。 新しい選択項目が実領域内に完全に表示されていない場合は、 実領域の下端の位置に来るようにスクロールします。 連続スクロールフラグの値が true、かつ、 現在の選択項目が末尾の項目であるときに ScrollDown キーを押下すると、 先頭の項目が新しい選択項目となり、実領域の下端の位置に来るようにスクロールします。 このとき、末尾の項目は下から 2 行目の位置に表示されます（先頭の項目は最下行に表示されます）。

	値イベント
	選択項目が変化した場合、 フレックスリストボックスコントロールは値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] を受信します。

参照

SFZFlexListBoxControl::GetScrollDownKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollRepeat | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | AVKType

解説

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

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

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

参照

SFZFlexListBoxControl::GetScrollInterval | SFZFlexListBoxControl::DefaultEnum

解説

この関数は、連続スクロールフラグを指定された値に設定します。

	注意
	連続スクロールフラグの値が true の場合、 フォーカスを持つ先頭/末尾の項目を更に上/下方向にフォーカスを移動させようとすると 末尾/先頭の項目にフォーカスが移動します。 先頭の項目から末尾の項目にフォーカスが移動した場合は、 末尾の項目が実領域の最下部の位置に来るように表示されます。 末尾の項目から先頭の項目にフォーカスが移動した場合は、 先頭の項目が実領域の最上部の位置に来るように表示されます。 なお、スクロールするだけの項目が存在しない場合は、 何も起こりません。

参照

SFZFlexListBoxControl::GetScrollRepeat

解説

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

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

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

参照

SFZFlexListBoxControl::GetScrollStep | SFZFlexListBoxControl::DefaultEnum

解説

この関数は、項目を上方向に１項目スクロールする ScrollUp キーを設定します。

デフォルト値: AVK_UP

	注意
	ScrollUp キーが押下された場合、 現在の選択項目よりも１つ上の項目がフレックスリストの新しい選択項目になります。 新しい選択項目が実領域内に完全に表示されていない場合は、 実領域の上端の位置に来るようにスクロールします。 連続スクロールフラグの値が true、かつ、 現在の選択項目が先頭の項目であるときに ScrollUp キーを押下すると、 末尾の項目が新しい選択項目となり、実領域の上端の位置に来るようにスクロールします。 このとき、先頭の項目は上から 2 行目の位置に表示されます（末尾の項目は最上行に表示されます）。

	値イベント
	選択項目が変化した場合、 フレックスリストボックスコントロールは値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] を受信します。

参照

SFZFlexListBoxControl::GetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetScrollRepeat | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | AVKType

解説

この関数は、選択項目の背景色を設定します。

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

	奇数番目の非選択項目の背景色
	SFZFlexListBoxControl::SetOddListColor 関数の解説を参照してください。

	偶数番目の非選択項目の背景色
	SFZFlexListBoxControl::SetEvenListColor 関数の解説を参照してください。

	項目の前景色
	SFZFlexListBoxControl::SetTextColor 関数の解説を参照してください。

参照

SFZFlexListBoxControl::GetSelectListColor | SFZFlexListBoxControl::SetEvenListColor | SFZFlexListBoxControl::SetOddListColor | SFZFlexListBoxControl::SetTextColor | SFXRGBColor

解説

この関数は、項目を下端までスクロールする SnapDown キーを設定します。

デフォルト値: AVK_TXEND

	注意
	SnapDown キーがが押下された場合、 末尾の項目がフレックスリストの新しい選択項目になります。 仮想領域≧実領域の場合、新しい選択項目（＝末尾の項目）が実領域の下端の位置に来るようにスクロールします。

	値イベント
	選択項目が変化した場合、 フレックスリストボックスコントロールは値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] を受信します。

参照

SFZFlexListBoxControl::GetSnapDownKey SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetPageUpKey | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | AVKType

解説

この関数は、項目を上端までスクロールする SnapUp キーを設定します。

デフォルト値: AVK_TXHOME

	注意
	SnapUp キーがが押下された場合、 先頭の項目がフレックスリストの新しい選択項目になります。 仮想領域≧実領域の場合、新しい選択項目（＝先頭の項目）が実領域の上端の位置に来るようにスクロールします。

	値イベント
	選択項目が変化した場合、 フレックスリストボックスコントロールは値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, 選択された項目のインデックス)] を受信します。

参照

SFZFlexListBoxControl::GetSnapUpKey SFZFlexListBoxControl::SetSnapDownKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetPageUpKey | SFXEvent | 値イベント [SFEVT_RESPONDER_VALUE] | AVKType

解説

この関数は、項目の要素間スペースサイズを設定します。[単位:ピクセル]

デフォルト値: SFZFlexListBoxControl::DEFAULT_SPACE ピクセル

	注意
	SFZFlexListBoxControl::DEFAULT_SPACE の値は SFZFlexListBoxControl::DefaultEnum を参照してください。

参照

SFZFlexListBoxControl::GetSpaceSize | SFZFlexListBoxControl::DefaultEnum

解説

この関数は、 指定された文字列定数（SFZFlexListBoxControl::TextEnum） に対応する文字列の色を設定します。

デフォルト値： 非選択項目のヘッダ文字列（TEXT_HEADER_NORMAL）: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]、 選択項目のヘッダ文字列（TEXT_HEADER_SELECT）: SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00)[白色]、 非選択項目のボディ文字列（TEXT_BODY_NORMAL）: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]、 選択項目のボディ文字列（TEXT_BODY_SELECT）: SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00)[白色]

SFZFlexListBoxControl::SetItemEnable 関数を使用して項目の有効フラグが false に設定されているとき、 またはフレックスリストボックスコントロールの状態が非活性状態にあるときは、 この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色でテキストは描画されます。

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

	奇数番目の非選択項目の背景色
	SFZFlexListBoxControl::SetOddListColor 関数の解説を参照してください。

	偶数番目の非選択項目の背景色
	SFZFlexListBoxControl::SetEvenListColor 関数の解説を参照してください。

	選択項目の背景色
	SFZFlexListBoxControl::SetSelectListColor 関数の解説を参照してください。

参照

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::GetTextColor | SFZFlexListBoxControl::SetOddListColor | SFZFlexListBoxControl::SetEvenListColor | SFZFlexListBoxControl::SetSelectListColor | SFZFlexListBoxControl::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、トグル状態（SFZFlexListBoxControl::ToggleEnum の論理和）を設定します。

デフォルト値: 0

使用例

以下は、トグル状態を設定するコードです。

SFZFlexListBoxControl       listbox;

// ...

listbox->SetToggle(
    SFZFlexListBoxControl::TOGGLE_EMPTY_BODY_ICON |
    SFZFlexListBoxControl::TOGGLE_MULTIPLE_BODY_TEXT
);

参照

SFZFlexListBoxControl::ToggleEnum | SFZFlexListBoxControl::GetToggle

解説

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

デフォルト値: SFZFlexListBoxControl::DEFAULT_VERTICAL

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

参照

SFZFlexListBoxControl::GetVerticalAlign | SFZFlexListBoxControl::VerticalEnum

解説

この関数は、選択項目のスクロールが開始されるまでの待ちインターバルを設定します 。[単位: ミリ秒]

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

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

参照

SFZFlexListBoxControl::GetWaitInterval | SFZFlexListBoxControl::DefaultEnum

参照

SFYResponder::GetType | SFYResponder::SetType

解説

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

ICON_BODY_SELECT: 選択時のボディアイコン画像

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

ICON_FOOTER_SELECT: 選択時のフッタアイコン画像

解説

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

参照

SFZFlexListBoxControl::Insert | SFZFlexListBoxControl::InsertFirst | SFZFlexListBoxControl::InsertLast | SFZFlexListBoxControl::GetItem | SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::SetItemText | SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::SetItemAccessKey | SFZFlexListBoxControl::SetItemCommandId | SFZFlexListBoxControl::SetItemEnable

解説

NORMAL: 通常時 (非選択時)

SELECT: 選択時

解説

TEXT_HEADER_NORMAL: 非選択項目のヘッダ文字列

TEXT_HEADER_SELECT: 選択項目のヘッダ文字列

TEXT_BODY_NORMAL: 非選択項目のボディ文字列

TEXT_BODY_SELECT: 選択項目のボディ文字列

解説

TOGGLE_EMPTY_HEADER_TEXT: 選択時のヘッダ文字列が空のとき表示しません。(通常時のヘッダ文字列で代用しません)

TOGGLE_EMPTY_BODY_ICON: 選択時のボディアイコン画像が空のとき表示しません。

TOGGLE_EMPTY_BODY_TEXT: 選択時のボディ文字列が空のとき表示しません。

TOGGLE_EMPTY_FOOTER_ICON: 選択時のフッタアイコン画像が空のとき表示しません。

TOGGLE_MULTIPLE_BODY_TEXT: 選択時のボディ文字列表示を複数行表示にします。

TOGGLE_SWAP_BODY: ボディアイコン画像とボディ文字列の配置を入れ替えます。

これらは論理和により同時指定することができます。

デフォルト値: 0

使用例

SFZFlexListBoxControlSmp    list;

// インスタンスの作成等
// ...

// トグル状態の設定 (複数の状態を論理和で設定)
list->SetToggle(
    SFZFlexListBoxControl::TOGGLE_EMPTY_HEADER_TEXT |
    SFZFlexListBoxControl::TOGGLE_EMPTY_FOOTER_ICON |
    SFZFlexListBoxControl::TOGGLE_MULTIPLE_BODY_TEXT
);

実行結果:

参照

SFZFlexListBoxControl::ToggleEnum