Inheritance diagram

Collaboration diagram

Description

How to use

SFZFlexListBoxControl is a control to have a user select one item among list items, which has more advanced features than the SFZListBoxControl class.

Below is the layout of flex list box control:

Each item has three parts(header, body, and footer from left) as follows:

Note

The horizontal alignment of the header part or the footer part is always left-alighed or right-aligned respectively. However, that of the body part can be specified with the SFZFlexListBoxControl::SetHorizontalAlign function. For the body part, it is possible to display the corresponding multiple text for the selected item or change the order of the icon image and the text by setting the toggle state. The SFZFlexListBoxControl::SetHorizontalAlign function specifies only the horizontal alignment for the latter element of the body part(by default, text of the body part). The vertical alignment for all the parts is set using the SFZFlexListBoxControl::SetVerticalAlign function.

Difference between SFZFlexListBoxControl and SFZListBoxControl

Performance and memory usage

In the SFZFlexListBoxControl class, each item is implemented using the widget class. Since the number of the responder increases as that of the items increases, there is possibility that the performance may deteriorate in destroying the instance of the SFZFlexListBoxControl class which has more than several hundred items. For the memory usage, the same can be said. It is recommended to use the SFZListBoxControl class when the number of items is more than several hundred.

Usage of the flex list box control

To insert an item, use the SFZFlexListBoxControl::Insert / SFZFlexListBoxControl::InsertFirst / SFZFlexListBoxControl::InsertLast function. To remove an item, use the SFZFlexListBoxControl::Remove / SFZFlexListBoxControl::RemoveFirst / SFZFlexListBoxControl::RemoveLast function. If the SFZFlexListBoxControl::Clear function is called, all items are removed.

The selected item can be moved by one item using the ScrollUp or ScrollDown key set with the SFZFlexListBoxControl::SetScrollUpKey or SFZFlexListBoxControl::SetScrollDownKey function respectively.

The selected item can be moved by one page using the PageUp or PageDown key set with the SFZFlexListBoxControl::SetPageUpKey or SFZFlexListBoxControl::SetPageDownKey function respectively.

The selected item can be moved to the top or bottom using the SnapUp or SnapDown key set with the SFZFlexListBoxControl::SetSnapUpKey or SFZFlexListBoxControl::SetSnapDownKey function respectively.

The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will occur when the selected item is moved.

In the selected item, the text is drawn in the color set with the SFZFlexListBoxControl::SetTextColor function, and the background is filled in the color set with the SFZFlexListBoxControl::SetSelectListColor function.

In the unselected item, the text is drawn in the color set with the SFZFlexListBoxControl::SetTextColor function, the background of each item at the odd or even index is filled in the color set with the SFZFlexListBoxControl::SetOddListColor or SFZFlexListBoxControl::SetEvenListColor function respectively.

In the item of which the enable flag is set to "false", the text is drawn in the color which is calculated for the "invalid" item using the color set with the SFZFlexListBoxControl::SetTextColor function, and the background of item at the odd or even index is filled in the color which is calculated for the "invalid" item using the SFZFlexListBoxControl::SetOddListColor or SFZFlexListBoxControl::SetEvenListColor function respectively. However, the background of selected item is always filled in the color set with the SFZFlexListBoxControl::SetSelectListColor function. And when the state of this responder is in the "inactive" state, each item is drawn in the same way as its enable flag is set to "false".

The grid line can be drawn using the SFZFlexListBoxControl::SetGridLineEnable function and the SFZFlexListBoxControl::SetGridLineColor function. The margin in each item is set with the SFZFlexListBoxControl::SetListMargin function.

In the default implementation, the flex list menu[SFZFlexListBoxControl] will receive the following result events[SFEVT_RESPONDER_RESULT].

The developer can register handlers for these events.

The operation key of the menu is set with the SFYBoxControl::SetOperateKey function. By default, the operation key is set to the SELECT key.

The access key of the menu is set with the SFZFlexListBoxControl::SetItemAccessKey function.

The ESCAPE key is set with the SFZFlexListBoxControl::SetEscapeKey function. By default, the ESCAPE key is set to the CLEAR key.

	Caution
	The result event will not occur when the enable flag of selected item is set to "false" using the SFZFlexListBoxControl::SetItemEnable function.

Reference: Result Event[SFEVT_RESPONDER_RESULT] | SFZFlexListBoxControl::HandleOperateKey | SFZFlexListBoxControl::HandleAccessKey | SFZFlexListBoxControl::HandleEscapeKey

Code to create a flex list box control

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);

    // create the window
    window = SFZWindow::NewInstance();
    window->SetParent(GetThis());
    window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));
    window->SetRealBound(GetLocalBound());
    window->SetState(true, true, true, true);

    // [Required] create flex list box control
    list = SFZFlexListBoxControl::NewInstance(&error);

    // [Required] set flex list box control's parent responder to window
    list->SetParent(window);

    // [Optional] set background color of even item
    list->SetEvenListColor(SFXRGBColor(0xFF, 0xFF, 0xCC, 0x00));

    // [Optional] set background color of odd item
    list->SetOddListColor(SFXRGBColor(0xFF, 0xCC, 0xFF, 0x00));

    // [Optional] set horizontal alignment of unselected item to "center-aligned"
    list->SetHorizontalAlign(SFZFlexListBoxControl::NORMAL, SFZFlexListBoxControl::HORIZONTAL_CENTER);

    // [Optional] set list margin within each item
    list->SetListMargin(SFXMargin(2, 1, 2, 1));

    // [Optional] make grid line invalid (default)
    list->SetGridLineEnable(false);

    // [Optional] set space size
    list->SetSpaceSize(4);

    // [Optional] set repeat-scroll flag to "true"
    list->SetScrollRepeat(true);

    // [Optional] set width of scroll bar control to 5
    list->SetScrollBarWidth(5);

    // [Optional] make multiple text displayed for selected item
    list->SetToggle(SFZFlexListBoxControl::TOGGLE_MULTIPLE_BODY_TEXT);

    // here insert item using item structure

    // in case of using image 
    // it is easier to insert item using item structure.

    // [Required to select] set enable flag of item structure to "true"
    item.property.enable = true;

    // [Required to select] set access key and command id of item structure
    //            (unused in this example)
    item.property.key = 0;
    item.property.id = SFZFlexListBoxControl::INVALID_COMMAND_ID;

    // [Optional] set image of item structure
    item.normal.body.icon = normal;
    item.select.body.icon = select;

    // [Required] insert 20 items
    for (SInt32 i = 0;  i < 20 ; ++i) {

        // [Required to select] set text of item structure
        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));

        // set icon image of footer only for 5th item
        if (i == 5) {
            item.normal.footer.icon = disable;
        }
        else {
            item.normal.footer.icon = SFBImageSmp::EmptyInstance();
        }

        // insert at tail
        list->InsertLast(item);
    }

    // [Optional] make 5th item invalid
    list->SetItemEnable(5, false);

    // [Required] set flex list box control's real region to suitable region
    list->SetRealBound(list->GetSuitableBound(window->GetLocalBound().Deflate(10, 10)).SnapCenterMiddle(GetLocalBound().GetCenterMiddle()));

    // [Required] set flex list box control's state to "visible" + "active" + "enable" + "focus" together
    list->SetState(true, true, true, true);

    // [Optional] make 1st item selected(*)
    list->SetCurrentValue(1);

    // (*note)
    // after setting flex list box control's state to "enable", select item
    //

    return;
}

Execution Result:

Reference

SFYBoxControl | SFZListBoxControl | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE] | Result Event[SFEVT_RESPONDER_RESULT] | State

Member

Description

This constructor performs the initializations as follows:

	Note
	In a responder inheriting from SFZFlexListBoxControl, the corresponding handler will be called when one of the above events occurs.

Reference

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 | Type | Real Region | Event | Key Event[SFEVT_KEY] | Value Event[SFEVT_RESPONDER_VALUE] | Region Event[SFEVT_RESPONDER_BOUND]

Description

Delete all items from this flex list box control.

Reference

SFZFlexListBoxControl::Clear

Reference

SFZFlexListBoxControl::Remove

Return value

Return value

Description

This function gets the index of the first item among the items matching with the specified command ID, of which the index equals or is greater than the specified index to search from the head.

	Note
	The beginning index of the item to search can be specified.

Reference

SFZFlexListBoxControl::LastIndexOfCommandId

Return value

Description

This function gets the value of enable flag of the access key of this flex list box control.

Reference

SFZFlexListBoxControl::SetAccessKeyEnable

Return value

ESCAPE key set with the SFZFlexListBoxControl::SetEscapeKey function.

Reference

SFZFlexListBoxControl::SetEscapeKey

Return value

Background color(SFXRGBColor) of unselected item at the even index of this flex list box control.

Reference

SFZFlexListBoxControl::SetEvenListColor

Return value

Font of the text of this flex list box control, which is specified by the text enum(SFZFlexListBoxControl::TextEnum).

Description

This function gets the font for the specified text of this flex list box control.

Reference

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::SetFont

Return value

Color(SFXRGBColor) of grid line of this flex list box control.

Reference

SFZFlexListBoxControl::SetGridLineColor | SFZFlexListBoxControl::SetGridLineEnable

Return value

Value of the enable flag of the grid line of this flex list box control.

Reference

SFZFlexListBoxControl::SetGridLineEnable | SFZFlexListBoxControl::SetGridLineColor

Return value

Value of the horizontal alignment(SFZFlexListBoxControl::HorizontalEnum).

Reference

SFZFlexListBoxControl::SetHorizontalAlign | SFZFlexListBoxControl::HorizontalEnum

Return value

Item structure(SFZFlexListBoxControl::ItemRec) of the specified item of this flex list box control.

Description

This function gets the item structure of the specified item of this flex list box control.

	Item structure
	For the item structure, refer to SFZFlexListBoxControl::ItemRec.

Reference

SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::ItemRec

Description

This function gets the access key of the specified item of this flex list box control. "0" will be returned if the access key is not set.

Reference

SFZFlexListBoxControl::SetItemAccessKey

Return value

Command ID of the specified item of this flex list box control.

Reference

SFZFlexListBoxControl::SetItemCommandId |

Return value

Number of the items of this flex list box control.

Return value

Description

This function gets the value of enable flag of the specified item of this flex list box control. If the item is valid, "true" will be returned. Otherwise "false" will be returned.

Reference

SFZFlexListBoxControl::SetItemEnable

Return value

Item height of this flex list box control. [pixels]

Description

This function gets the item height of this flex list box control[pixels], which is calculated using the following values:

Reference

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

Return value

Icon image of the specified item of this flex list box control which corresponds to the specified icon enum(SFZFlexListBoxControl::IconEnum).

Reference

SFZFlexListBoxControl::IconEnum | SFZFlexListBoxControl::SetItemIconImage

Return value

Text(SFXWideString) of the specified item of this flex list box control which corresponds to the specified text enum(SFZFlexListBoxControl::TextEnum).

Reference

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::SetItemText

Return value

Margin(SFXMargin) within each item of this flex list box control

Reference

SFZFlexListBoxControl::SetListMargin

Return value

Background color(SFXRGBColor) of unselected item at the odd index of this flex list box control.

Reference

SFZFlexListBoxControl::SetOddListColor

Return value

PageDown key to move the selected item down by one page.

Reference

SFZFlexListBoxControl::SetPageDownKey

Return value

PageUp key to move the selected item up by one page.

Reference

SFZFlexListBoxControl::SetPageUpKey

Description

This function gets the scroll bar control, which this flex list box control contains internally.

The developer can change the appearance the scroll bar control such as its color using the scroll bar control obtained.

The scroll bar control of the developer's own can be set using the SFZFlexListBoxControl::SetScrollBarControl function.

Example

The code below is to get the scroll bar control and change the color of its track.

// get the scroll bar control and change the color of its track
SFZFlexListBoxControlSmp    _list;
SFYScrollBarControlSmp      _bar;

_list = SFZFlexListBoxControl::NewInstance();

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

Reference

SFYScrollBarControl | SFZFlexListBoxControl::SetScrollBarControl

Return value

Width of the scroll bar control, which this flex list box control contains internally. [pixels]

Reference

SFZFlexListBoxControl::SetScrollBarWidth

Return value

Scroll direction(SFZFlexListBoxControl::DirectionEnum) set with the SFZFlexListBoxControl::SetScrollDirection function.

Reference

SFZFlexListBoxControl::SetScrollDirection | SFZFlexListBoxControl::DirectionEnum

Return value

ScrollDown key to move the selected item down by one item, which is set by the SFZFlexListBoxControl::SetScrollDownKey function.

Reference

SFZFlexListBoxControl::SetScrollDownKey

Return value

Scroll-interval set with the SFZFlexListBoxControl::SetScrollInterval function. [milliseconds]

Reference

SFZFlexListBoxControl::SetScrollInterval

Return value

Reference

SFZFlexListBoxControl::SetScrollRepeat

Return value

Scroll-step set with the SFZFlexListBoxControl::SetScrollStep function. [pixels]

Reference

SFZFlexListBoxControl::SetScrollStep

Return value

ScrollUp key to move the selected item up by one item, which is set by the SFZFlexListBoxControl::SetScrollUpKey function.

Reference

SFZFlexListBoxControl::SetScrollUpKey

Return value

Background color(SFXRGBColor) of selected item of this flex list box control.

Reference

SFZFlexListBoxControl::SetSelectListColor

Return value

SnapDown key to scroll down the items to the bottom.

Reference

SFZFlexListBoxControl::SetSnapDownKey

Return value

SnapUp key to move the selected item up to the top.

Reference

SFZFlexListBoxControl::SetSnapUpKey

Return value

Space size between the elements of each item of this flex list box control. [pixels]

Reference

SFZFlexListBoxControl::SetSpaceSize

Return value

Color(SFXRGBColor) of text specified with a text enum(SFZFlexListBoxControl::TextEnum) of this flex list box control.

Reference

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::SetTextColor

Return value

Value of the toggle state of this flex list box control(logical sum of SFZFlexListBoxControl::ToggleEnum).

Reference

SFZFlexListBoxControl::ToggleEnum | SFZFlexListBoxControl::SetToggle

Return value

The value(SFZFlexListBoxControl::VerticalEnum) of vertical alignment.

Reference

SFZFlexListBoxControl::SetVerticalAlign | SFZFlexListBoxControl::VerticalEnum

Return value

Waiting time to start the scroll set with the SFZFlexListBoxControl::SetWaitInterval function. [milliseconds]

Reference

SFZFlexListBoxControl::SetWaitInterval

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the access key set with the SFZFlexListBoxControl::SetItemAccessKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as follows:

	Note
	If the same access key is set to more than one item, only the setting of the first item is valid.

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleAccessKey function is as follows:

/*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 //

Reference

SFZFlexListBoxControl::SetItemAccessKey | SFZFlexListBoxControl::SetAccessKeyEnable | SFZFlexListBoxControl::SetItemEnable SFYControl::GetCurrentValue | SFXEvent | Result Event | Key Event[SFEVT_KEY]

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] is received.

This function calculates the suitable rectangle size of this responder within the specified hint rectangle[i.e., rectangle element (P32 parameter) of the region event].

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin of the rectangle argument in this function.

	Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event]
	If the rectangle argument of the hint region is specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] to this responder. Then, the SFYWidget::HandleBoundOptimize virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the hint region as an initial value.

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleBoundOptimize function is as follows:

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 //

Reference

SFYResponder::GetSuitableBound | SFZFlexListBoxControl::SetFont | SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::SetItemText | SFZFlexListBoxControl::SetSpaceSize | SFZFlexListBoxControl::SetListMargin | SFZFlexListBoxControl::SetScrollBarWidth | SFYBoxControl::GetBoxMargin | SFXMargin | SFZListBoxControl | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] is received.

This function calculates the suitable rectangle size of this responder.

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin element of the rectangle argument within this function.

Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event]

If the rectangle argument of the hint region is not specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] to this responder. Then, the SFYWidget::HandleBoundRequest virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the real region as an initial value. Tip Default value of the real region: SFXRectangle(0, 0, 0, 0)

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleBoundRequest function is as follows:

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 //

Reference

SFYResponder::GetSuitableBound | SFZFlexListBoxControl::SetFont | SFZFlexListBoxControl::SetItem | SFZFlexListBoxControl::SetItemIconImage | SFZFlexListBoxControl::SetItemText | SFZFlexListBoxControl::SetSpaceSize | SFZFlexListBoxControl::SetListMargin | SFYBoxControl::GetBoxMargin | SFXMargin | SFZListBoxControl | SFXEvent | Real Region Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

In case you want to perform your own processing when the virtual region is changed, override this virtual function.

The default implementation is to equalize the real region with the new local region and relocate this responder to fit into the new virtual region.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event will occur when the virtual region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function.

Another method when the virtual region is changed

Other than overriding this virtual function, it is possible to define and implement the handler for region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the virtual region is updated, this virtual function is executed first, and next the handlers for region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for region event can be omitted.

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleBoundVirtual function is as follows:

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 //

Reference

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Virtual Region | Real Region | Local Region

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the ESCAPE key set with the SFZFlexListBoxControl::SetEscapeKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is to send the SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0) event.

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleEscapeKey function is as follows:

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

Reference

SFZFlexListBoxControl::SetEscapeKey | SFXEvent | Result Event[SFEVT_RESPONDER_RESULT] | Key Event[SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the operaion key set with the SFYBoxControl::SetOperateKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as below.

The result event of SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, return value of SFYControl::GetCurrentValue function) will be sent if the enable flag is set to "true" with the SFZFlexListBoxControl::SetItemEnable function.

If the enable flag is set to "false", the result event will not be sent.

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleOperateKey function is as follows:

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

Reference

SFYBoxControl::SetOperateKey | SFZFlexListBoxControl::SetItemEnable | SFXEvent | Result Event[SFEVT_RESPONDER_RESULT] | Key Event[SFEVT_KEY]

Description

This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received.

In case you want to perform your own drawing of this responder, override this function.

The default implementation is to draw this responder.

The method to darw a responder

In addition to overriding this virtual function, it is possible to define and implement the handler for drawing event(drawing handler)[XANDLER_DECLARE_VOIDRENDER], and register it into the responder. Then, the overridden virtual function will be called first, and next the drawing handlers registered into the responder will be booted up in the registered order. In almost all cases, the method to override this function is used to draw the responder since there is no need to declare and register the drawing handler.

Procedure of drawing a responder

The drawing handler will be booted up when the drawing event(SFEVT_RESPONDER_RENDER) occurs. And then the drawing handler draw the responder actually. The drawing event will be sent to only the responders including the region to be redrawn out of the redraw regions registered into the renderer using the SFYResponder::InvokeBackward function after the SFYResponder::Render function boots up the renderer. Here, the SFYResponder::Render function will be called at the following situations: At the end of the event loop At the applet start / resume or the end of a highest priority event handler In the callback, which is outside the event loop. If calling the SFYResponder::Render function with specifying "true" as an argument, the drawing event will be sent to all the responders to be actually displayed on the screen which are located below the responder in the responder tree, regardless of the registration of redraw region.

Internal Implementation

Internal implementation of the SFZFlexListBoxControl::HandleRenderRequest function is as follows:

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

Reference

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree

Return value

Description

This function inserts the specified item before the specified index.

If the value of the specified index is less than or equals 0, the item will be inserted at the head.

If the value of the specified index is greater than or equals the maximum value, the item will be inserted at the tail.

	Note
	The numuber of items is set to the maximum value of the SFYControl class.

	Item structure
	For the item structure, refer to SFZFlexListBoxControl::ItemRec.

Reference

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

Return value

Description

This function inserts the specified item at the head.

	Note
	The numuber of items is set to the maximum value of the SFYControl class.

	Item structure
	For the item structure, refer to SFZFlexListBoxControl::ItemRec.

Reference

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

Return value

Description

This function inserts the specified item at the tail.

	Note
	The numuber of items is set to the maximum value of the SFYControl class.

	Item structure
	For the item structure, refer to SFZFlexListBoxControl::ItemRec.

Reference

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

Return value

Description

This function gets the index of the first item among the items matching with the specified command ID, of which the index equals or is smaller than the specified index to search from the tail.

	Note
	The beginning index of the item to search can be specified.

Reference

SFZFlexListBoxControl::FirstIndexOfCommandId

Argument

Return value

Description

This function creates a new instance of this responder class.

If succeeds, a not null pointer will be returned, and the "exception" argument is SFERR_NO_ERROR. If fails such as insufficient memory, a null pointer will be returned, and the "exception" argument holds the error value.

Example

The code to create a new instance of this responder class is as follows:

SFZFlexListBoxControlSmp _flexlistbox;
SFCError error;

if ((_flexlistbox = SFZFlexListBoxControl::NewInstance(&error)) != null) {

    ...
}

Description

This function removes the item at the specified index or the items in the specified index range from this flex list box control.

If the specified index is less than 0 or greater than or equals the number of items, no item will be removed

If the beginning index to remove is greater than or equals the number of items or the ending index to remove is less than or equals 0, no item will be removed

If the beginning index to remove is less than or equals 0, it will be reset to 0.

If the ending index to remove is greater than the number of items, it will be reset to the number of items.

	Note
	The numuber of items is set to the maximum value of the SFYControl class.

Example

SFZFlexListBoxControlSmp    listbox;

// create instance etc. 

       ...

// insert item at the tail
if (listbox->InsertLast("0 index") == SFERR_NO_ERROR) {
    // insert item at the tail
    if (listbox->InsertLast("1 index") == SFERR_NO_ERROR) {
        // insert item at the tail
        if (listbox->InsertLast("2 index") == SFERR_NO_ERROR) {
            // insert item at the tail
            if (listbox->InsertLast("3 index") == SFERR_NO_ERROR) {
                // select "2 index" item
                listbox->SetCurrentValue(2);

                ////////////////////////////
                // state of list box      //
                // 0: "0 index"           //
                // 1: "1 index"           //
                // 2: "2 index" <---***//
                // 3: "3 index"           //
                ////////////////////////////

                // remove items from "1 index" to "2 index"
                listbox->Remove(1, 3);

                ////////////////////////////
                // state of list box      //
                // 0: "0 index"           //
                // 1: "3 index" <---***//
                ////////////////////////////
            }
        }
    }
}

Reference

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

Description

This function removes the first item from this flex list box control.

	Note
	The numuber of items is set to the maximum value of the SFYControl class.

Reference

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

Description

This function removes the last item from this flex list box control.

	Note
	The numuber of items is set to the maximum value of the SFYControl class.

Reference

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

Description

This function sets the enable flag of access key of this flex list box control to the specified value.

When the enable flag of access key is set to "false", the access key for all items will be invalid regardless of the value of enable flag of item set with the SFZFlexListBoxControl::SetItemEnable function.

On the other hand, when the enable flag of access key is set to "true", the access key for an item will be valid only if the enable flag of item is set to "true" using the SFZFlexListBoxControl::SetItemEnable function.

Reference

SFZFlexListBoxControl::GetAccessKeyEnable | SFZFlexListBoxControl::SetItemEnable

Description

This function sets the ESCAPE key of this flex list box control to the specified value.

Default: AVK_CLR

The SFZFlexListBoxControl::HandleEscapeKey function will be called if the ESCAPE key is pressed.

Reference

SFZFlexListBoxControl::GetEscapeKey | SFZFlexListBoxControl::HandleEscapeKey

Description

This function sets the background color(SFXRGBColor) of unselected item at the even index of this flex list box control to the specified value, in which color the background of item will be filled.

Default: SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00) [white color]

When "false" is set to the enable flag using the SFZFlexListBoxControl::SetItemEnable function, the background will not be filled in the color set with this function.

In this case, the background will be drawn in the color of which each RGB value is subtracted 0x33 from the color set with this function if the brightness of this color is greater than 0x7F. Otherwise it will be drawn in the color of which each RGB value is added 0x33 on the color set with this function.

The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

	Background color of unselected item at the odd index
	For the background color of unselected item at the odd index, refer to SFZFlexListBoxControl::SetOddListColor.

	Foreground color of selected item
	For the foreground color of selected item, refer to SFZFlexListBoxControl::SetTextColor.

	Background color of selected item
	For the background color of selected item, refer to SFZFlexListBoxControl::SetSelectListColor.

Reference

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

Description

This function sets the font for the text of this flex list box control to the specified value, which is specified by the text enum(SFZFlexListBoxControl::TextEnum).

Default: AEE_FONT_NORMAL

Reference

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::GetFont

Description

This function sets the color of the grid line of this flex list box control to the specified value(SFXRGBColor).

The grid line will be drawn in the color set with this function only if "true" is set to its enable flag using the SFZFlexListBoxControl::SetGridLineEnable function.

Default: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[black color].

	Drawing region of the grid line
	The grid line will be drawn in the bottom line of 1 pixel width within the rectangular region of each item. It is recommended to set the margin region for the grid line using the SFZFlexListBoxControl::SetListMargin function in case "true" is set to this enable flag.

Reference

SFZFlexListBoxControl::GetGridLineColor | SFZFlexListBoxControl::SetGridLineEnable | SFXRGBColor

Description

This function sets the enable flag of the grid line of this flex list box control to the specified value.

The grid line will be drawn in the color set with the SFZFlexListBoxControl::SetGridLineColor function only if its enable flag is set to "true" using this function.

Default: false.

	Drawing region of the grid line
	The grid line will be drawn in the bottom line of 1 pixel width within the rectangular region of each item. It is recommended to set the margin region for the grid line using the SFZFlexListBoxControl::SetListMargin function in case this enable flag is set to "true".

Reference

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

Description

This function sets the horizontal alignment to the specified value.

Default: SFZFlexListBoxControl::DEFAULT_HORIZONTAL

For the value of SFZFlexListBoxControl::DEFAULT_HORIZONTAL, refer to SFZFlexListBoxControl::HorizontalEnum.

Reference

SFZFlexListBoxControl::GetHorizontalAlign | SFZFlexListBoxControl::HorizontalEnum

Description

This function sets the specified item of this flex list box control to the specified value.

	Item structure
	For the item structure, refer to SFZFlexListBoxControl::ItemRec.

Reference

SFZFlexListBoxControl::GetItem | SFZFlexListBoxControl::ItemRec

Description

This function sets the access key of the specified item of this flex list box control to the specified value.

When "true" is set to both the enable flag of access key and the item using the SFZFlexListBoxControl::SetAccessKeyEnable function and the SFZFlexListBoxControl::SetItemEnable function respectively, the SFZFlexListBoxControl::HandleAccessKey function will be called if the access key set with this function is pressed.

Reference

SFZFlexListBoxControl::GetItemAccessKey | SFZFlexListBoxControl::HandleAccessKey | SFZFlexListBoxControl::SetAccessKeyEnable | SFZFlexListBoxControl::SetItemEnable

Description

This function sets the command ID of the specified item of this flex list box control to the specified value.

Reference

SFZFlexListBoxControl::GetItemCommandId

Description

This function sets the enable flag of the specified item of this flex list box control to the specified value.

Default: "true"(The item is valid.)

When the enable flag of an item is set to "false"

Even if the operation key or the access key is pressed, the result event will not be sent. The foreground color will be the color subtracted 0x44 from each RGB value of the item foreground color set with the SFZFlexListBoxControl::SetTextColor function if the brightness of item foreground color is bigger than 0x7F, otherwise it will be the color added 0x44 on each RGB value of the item foreground color. The background color will be the color subtracted 0x33 from each RGB value of the item background color set with the SFZFlexListBoxControl::SetEvenListColor or SFZFlexListBoxControl::SetOddListColor function if the brightness of item background color is bigger than 0x7F, otherwise it will be the color added 0x33 on each RGB value of the item background color. The brightness of color is the value obtained using the SFXRGBColor::GetBrightness function.

	Note
	If the enable flag of an item is set to "false", the text of item will be drawn in the above adjusted foreground color when selected. It will not be drawn in the color set with the SFZFlexListBoxControl::SetTextColor function. The background of item is drawn in the color set with the SFZFlexListBoxControl::SetSelectListColor function when selected, regardless of the value of enable flag of item.

Reference

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

Description

This function sets the icon image of the specified icon enum(SFZFlexListBoxControl::IconEnum) of the specified item of this flex list box control to the specified value.

The image is set directly in the argument, or read from the resource file.

This function cannot be used with the image such as the image of invalid size or the animation bitmap.

Reference

SFZFlexListBoxControl::IconEnum | SFZFlexListBoxControl::GetItemIconImage

Description

This function the text of the specified text enum(SFZFlexListBoxControl::TextEnum) of the specified item of this flex list box control to the specified value.

The value of string is set directly in the argument, or read from the resource file.

Reference

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::GetItemText

Description

This function sets the margin within each item of this flex list box control to the specified value.

The contents of each item are drawn within the item region excluding this margin sepecified with this function.

Default: SFXMargin(1, 1, 1, 1)

Reference

SFZFlexListBoxControl::GetListMargin | SFXMargin

Description

This function sets the background color(SFXRGBColor) of unselected item at the odd index of this flex list box control to the specified value, in which color the background of item will be filled.

Default: SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00) [white color]

When "false" is set to the enable flag using the SFZFlexListBoxControl::SetItemEnable function, the background will not be filled in the color set with this function.

In this case, the background will be drawn in the color of which each RGB value is subtracted 0x33 from the color set with this function if the brightness of this color is greater than 0x7F. Otherwise it will be drawn in the color of which each RGB value is added 0x33 on the color set with this function.

The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

	Background color of unselected item at the even index
	For the background color of unselected item at the even index, refer to SFZFlexListBoxControl::SetEvenListColor.

	Foreground color of selected item
	For the foreground color of selected item, refer to SFZFlexListBoxControl::SetTextColor.

	Background color of selected item
	For the background color of selected item, refer to SFZFlexListBoxControl::SetSelectListColor.

Reference

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

Description

This function sets the PageDown key to move the selected item down by one page to the specified value.

Default: AVK_TXPGDOWN

If the PageDown key is pressed, the internal handler(*) of this flex list box control will move the selected item down by one page and send the value event.

However, in case the selected item will not be changed, it will not send the value event.

	Internal handler
	The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will be sent by the internal handler of this flex list box control when the PageDown key is pressed.

Reference

SFZFlexListBoxControl::GetPageDownKey | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

This function sets the PageUp key to move the selected item up by one page to the specified value.

Default: AVK_TXPGUP

If the PageUp key is pressed, the internal handler(*) of this flex list box control will move the selected item up by one page and send the value event.

However, in case the selected item will not be changed, it will not send the value event.

	Internal handler
	The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will be sent by the internal handler of this flex list box control when the PageUp key is pressed.

Reference

SFZFlexListBoxControl::GetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

This function sets the scroll bar control used by the flex list box control to the specified value.

The developer can set his or her own scroll bar control to the flex list box control.

Example

The code below is to set the custom scroll bar control to the flex list box control.

// define class of original scroll bar control
class CustomScrollBarControl : public SFYScrollBarControl {
    // definition
};

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

    // create flex list box control
    list = SFZFlexListBoxControl::NewInstance();

    // settings of flex list box control
    // …

    // create scroll bar control
    bar = CustomScrollBarControl::NewInstance();

    // set original scroll bar to flex list box control
    list->SetScrollBarControl(bar);
    return;
}

Reference

SFZFlexListBoxControl::GetScrollBarControl

Description

This function sets the width of the scroll bar control to the specified value, which this flex list box control contains internally.

Default: SFZFlexListBoxControl::DEFAULT_BAR_WIDTH

For the value of SFZFlexListBoxControl::DEFAULT_BAR_WIDTH, refer to SFZFlexListBoxControl::DefaultEnum.

Reference

SFZFlexListBoxControl::GetScrollBarWidth | SFZFlexListBoxControl::DefaultEnum

Description

This function sets the scroll direction of currently selected item to the specified value.

Default: SFZFlexListBoxControl::DEFAULT_DIRECTION

For the value of SFZFlexListBoxControl::DEFAULT_DIRECTION, refer to SFZFlexListBoxControl::DirectionEnum.

Reference

SFZFlexListBoxControl::GetScrollDirection | SFZFlexListBoxControl::DirectionEnum

Description

This function sets the ScrollDown key to move the selected item down by one item to the specified value.

Default: AVK_DOWN

If the ScrollDown key is pressed, the internal handler(*) of this flex list box control will move the selected item down by one item and send the value event.

When "true" is set to the "repeat-scroll" flag using the SFZFlexListBoxControl::SetScrollRepeat and the bottom item is currently selected, the top item will be selected if the ScrollDown key is pressed.

On the contrary, when "false" is set to the "repeat-scroll" flag and the bottom item is currently selected, the bottom item will be still selected even if the ScrollDown key is pressed. At this time, the value event will not be sent.

	Internal handler
	The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will be sent by the internal handler of this list box control when the ScrollDown key is pressed.

Reference

SFZFlexListBoxControl::GetScrollDownKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollRepeat | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

This function sets Set the scroll-interval of currently selected item to the specified value. [milliseconds]

Default: SFZFlexListBoxControl::DEFAULT_SCROLL

For the value of SFZFlexListBoxControl::DEFAULT_SCROLL, refer to SFZFlexListBoxControl::DefaultEnum.

Reference

SFZFlexListBoxControl::GetScrollInterval | SFZFlexListBoxControl::DefaultEnum

Description

This function sets the repeat-scroll flag of this flex list box control to the specified value.

When the repeat-scroll flag is set to "true" and the top item or the bottom item is currently selected item, the bottom item or the top item will be currently selected item if the ScrollUp key or ScrollDown key is pressed, respectively.

When the repeat-scroll flag is set to "false" and the top item or the bottom item is currently selected item, the top item or the bottom item will be still currently selected item even if the ScrollUp key or ScrollDown key is pressed, respectively.

	About the ScrollUp key and the ScrollDown key
	The ScrollUp key or ScrollDown key is set with the SFZFlexListBoxControl::SetScrollUpKey function or SFZFlexListBoxControl::SetScrollDownKey function respectively.

Reference

SFZFlexListBoxControl::GetScrollRepeat | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey

Description

This function sets the number of pixels of each scroll of currently selected item . If "-1"(this is default value) is set, the height of the " " character of the currently used font will be the scroll-step.

Default: SFZFlexListBoxControl::DEFAULT_STEP

For the value of SFZFlexListBoxControl::DEFAULT_STEP, refer to SFZFlexListBoxControl::DefaultEnum.

Reference

SFZFlexListBoxControl::GetScrollStep | SFZFlexListBoxControl::DefaultEnum

Description

This function sets the ScrollUp key to move the selected item up by one item to the specified value.

Default: AVK_UP

If the ScrollUp key is pressed, the internal handler(*) of this flex list box control will move the selected item up by one item and send the value event.

When the "repeat-scroll" flag is set to "true" using the SFZFlexListBoxControl::SetScrollRepeat and the top item is currently selected, the bottom item will be selected if the ScrollUp key is pressed.

On the contrary, when the "repeat-scroll" flag is set to "false" and the top item is currently selected, the top item will be still selected even if the ScrollUp key is pressed. At this time, the value event will not be sent.

	Internal handler
	The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will be sent by the internal handler of this list box control when the ScrollUp key is pressed.

Reference

SFZFlexListBoxControl::GetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetScrollRepeat | SFZFlexListBoxControl::SetPageUpKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetSnapDownKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

This function sets the background color(SFXRGBColor) of selected item of this flex list box control to the specified value, in which color the background of item will be filled.

Default: SFXRGBColor(0x11, 0x22, 0xBB, 0x00) [blue]

	Background color of unselected item at the odd index
	For the background color of unselected item at the odd index, refer to SFZFlexListBoxControl::SetOddListColor.

	Background color of unselected item at the even index
	For the background color of unselected item at the even index, refer to SFZFlexListBoxControl::SetEvenListColor.

	Foreground color of selected item
	For the foreground color of selected item, refer to SFZFlexListBoxControl::SetTextColor.

Reference

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

Description

This function sets the SnapDown key to move the selected item down to the bottom to the specified value.

Default: AVK_TXEND

If the SnapDown key is pressed, the internal handler(*) of this flex list box control will move the selected item down to the bottom and send the value event.

However, in case the selected item will not be changed, it will not send the value event.

	Internal handler
	The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will be sent by the internal handler of this flex list box control when the SnapDown key is pressed.

Reference

SFZFlexListBoxControl::GetSnapDownKey SFZFlexListBoxControl::SetSnapUpKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetPageUpKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

This function sets the SnapUp key to move the selected item up to the top to the specified value.

Default: AVK_TXHOME

If the SnapUp key is pressed, the internal handler(*) of this flex list box control will move the selected item up to the top and send the value event.

However, in case the selected item will not be changed, it will not send the value event.

	Internal handler
	The value event of SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, index of selected item) will be sent by the internal handler of this flex list box control when the SnapUp key is pressed.

Reference

SFZFlexListBoxControl::GetSnapUpKey SFZFlexListBoxControl::SetSnapDownKey | SFZFlexListBoxControl::SetScrollUpKey | SFZFlexListBoxControl::SetScrollDownKey | SFZFlexListBoxControl::SetPageDownKey | SFZFlexListBoxControl::SetPageUpKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

This function sets the space size between the elements of each item of this flex list box control to the specified value. [pixels]

Default: SFZFlexListBoxControl::DEFAULT_SPACE

For the value if SFZFlexListBoxControl::DEFAULT_SPACE, refer to SFZFlexListBoxControl::DefaultEnum.

Reference

SFZFlexListBoxControl::GetSpaceSize | SFZFlexListBoxControl::DefaultEnum

Description

This function sets the color(SFXRGBColor) of text of the specified text enum(SFZFlexListBoxControl::TextEnum) of this flex list box control to the specified value.

Default values are as follows:

When the enable flag is set to "false" using the SFZFlexListBoxControl::SetItemEnable function or the state of this flex list box control is "inactive", each of the above colors will be the color subtracted 0x44 from each RGB value of the color set with this function if the brightness of color is bigger than 0x7F, otherwise it will be the color added 0x44 on each RGB value of the color.

The brightness of color is the value obtained using the SFXRGBColor::GetBrightness function.

	Background color of unselected item at the odd index
	For the background color of unselected item at the odd index, refer to SFZFlexListBoxControl::SetOddListColor.

	Background color of unselected item at the even index
	For the background color of unselected item at the even index, refer to SFZFlexListBoxControl::SetEvenListColor.

	Background color of selected item
	For the background color of selected item, refer to SFZFlexListBoxControl::SetSelectListColor.

Reference

SFZFlexListBoxControl::TextEnum | SFZFlexListBoxControl::GetTextColor | SFZFlexListBoxControl::SetOddListColor | SFZFlexListBoxControl::SetEvenListColor | SFZFlexListBoxControl::SetSelectListColor | SFZFlexListBoxControl::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets the toggle state of this flex list box control to the specified value, which is the logical sum of SFZFlexListBoxControl::ToggleEnum.

Default: 0.

Example

The code below is to set the value of toggle state.

SFZFlexListBoxControl       listbox;

// ...

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

Reference

SFZFlexListBoxControl::ToggleEnum | SFZFlexListBoxControl::GetToggle

Description

This function sets the vertical alignment to the specified value.

Default: SFZFlexListBoxControl::DEFAULT_VERTICAL

For the value of SFZFlexListBoxControl::DEFAULT_VERTICAL, refer to SFZFlexListBoxControl::VerticalEnum.

Reference

SFZFlexListBoxControl::GetVerticalAlign | SFZFlexListBoxControl::VerticalEnum

Description

This function sets the waiting time to start the scroll of currently selected item to the specified value. [milliseconds]

Default: SFZFlexListBoxControl::DEFAULT_WAIT

For the value of SFZFlexListBoxControl::DEFAULT_WAIT, refer to SFZFlexListBoxControl::DefaultEnum.

Reference

SFZFlexListBoxControl::GetWaitInterval | SFZFlexListBoxControl::DefaultEnum

Reference

SFYResponder::GetType | SFYResponder::SetType

Description

ICON_BODY_NORMAL: body icon image of unselected item

ICON_BODY_SELECT: body icon image of selected item

ICON_FOOTER_NORMAL: footer icon image of unselected item

ICON_FOOTER_SELECT: footer icon image of selected item

Description

An item can be inserted into this flex list box control using this item structure.

Reference

SFZFlexListBoxControl::Insert | SFZFlexListBoxControl::InsertFirst | SFZFlexListBoxControl::InsertLast | SFZFlexListBoxControl::GetItem | SFZFlexListBoxControl::SetItem

Description

NORMAL: the item is not selected

SELECT: the item is selected

Description

TEXT_HEADER_NORMAL: header text of unselected item

TEXT_HEADER_SELECT: header text of selected item

TEXT_BODY_NORMAL: body text of unselected item

TEXT_BODY_SELECT: body text of selected item

Description

TOGGLE_EMPTY_HEADER_TEXT: the header text will not be displayed if that of selected item is null. (the header text of unselected item will not be displayed.)

TOGGLE_EMPTY_BODY_ICON: the body icon image will not be displayed if that of selected item is null.

TOGGLE_EMPTY_BODY_TEXT: the body text will not be displayed if that of selected item is null.

TOGGLE_EMPTY_FOOTER_ICON: the footer icon image will not be displayed if that of selected item is null.

TOGGLE_MULTIPLE_BODY_TEXT: the body text of selected item will be displayed as a multiple text.

TOGGLE_SWAP_BODY: swap the body icon image with the body text.

These states can be set using the logical sum operator at the same time together.

Default: 0.

Example

SFZFlexListBoxControlSmp    list;

// create instance etc.
// ...

// setting of toggle state (set multiple state using logical sum operator)
list->SetToggle(
    SFZFlexListBoxControl::TOGGLE_EMPTY_HEADER_TEXT |
    SFZFlexListBoxControl::TOGGLE_EMPTY_FOOTER_ICON |
    SFZFlexListBoxControl::TOGGLE_MULTIPLE_BODY_TEXT
);

Execution Result:

Reference

SFZFlexListBoxControl::ToggleEnum