Inheritance diagram

Collaboration diagram

Description

How to use

SFZFlexListMenu is an advanced menu to have a user select one item among list items.

Below is the layout of flex list menu:

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 SFZFlexListMenu::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 SFZFlexListMenu::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 SFZFlexListMenu::SetVerticalAlign function.

Difference between SFZFlexListMenu and SFZTextMenu

Performance and memory usage

In the SFZFlexListMenu 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 SFZFlexListMenu class which has more than several hundred items. For the memory usage, the same can be said. It is recommended to use the SFZTextMenu class when the number of items is more than several hundred.

Usage of the flex list menu

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

The selected item can be moved by one item using the UP or DOWN key set with the SFYMenu::SetSelectUpKey or SFYMenu::SetSelectDownKey function respectively.

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

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

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

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

In the item whose enable flag is set to "false" using the SFZFlexListMenu::SetItemEnable function, the text is drawn in the color which is calculated for the "invalid" item using the color set with the SFZFlexListMenu::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 SFZFlexListMenu::SetOddListColor or SFZFlexListMenu::SetEvenListColor function respectively. However, the background of selected item is always filled in the color set with the SFZFlexListMenu::SetSelectListColor function. And when the state of this responder is inactive, each item is drawn in the same way as its enable flag is set to "false".

The access key can be set using the SFZFlexListMenu::SetItemAccessKey function, and the grid line can be drawn using the SFZFlexListMenu::SetGridLineEnable function and the SFZFlexListMenu::SetGridLineColor function. The margin in each item is set with the SFZFlexListMenu::SetListMargin function.

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

The developer can register handlers for these events.

If no handler is registered, the default handler will be booted up when one of the above result events is received. The default handler only closes the menu.

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

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

The ESCAPE key is set with the SFYMenu::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 SFZFlexListMenu::SetItemEnable function.

	Note
	The timer processing callback scheduled with the SFYMenu::ScheduleTimer function will be canceled automatically when the operation key of the menu or the ESCAPE key is pressed.

Reference: Result Event[SFEVT_RESPONDER_RESULT] | SFZFlexListMenu::HandleOperateKey | SFZFlexListMenu::HandleAccessKey | SFZFlexListMenu::HandleEscapeKey | SFZFlexListMenu::HandleSelectUpKey | SFZFlexListMenu::HandleSelectDownKey | SFYMenu::HandleSelectRightKey | SFYMenu::HandleSelectLeftKey

Code to create a flex list menu

Void UserClass::Main(Void)
{
    SFZFlexListMenuSmp              menu;
    SFZFlexListMenu::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);

    // [Required] create flex list menu
    menu = SFZFlexListMenu::NewInstance(&error);

    // [Required] set flex list menu's parent responder to root
    menu->SetParent(GetThis());

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

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

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

    // [Optional] set flex list menu's bevel color
    menu->SetBevelColor(SFXBevelColor(
 SFXRGBColor(0xEE, 0xEE, 0xEE, 0x00),
 SFXRGBColor(0x77, 0x77, 0x77, 0x00),
 SFXRGBColor(0x22, 0x22, 0x22, 0x00)
    ));

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

    // [Optional] set menu margin for outer frame of flex list menu
    menu->SetMenuMargin(SFXMargin(6, 6, 5, 6));

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

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

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

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

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

    // [Optional] make multiple text displayed for selected item
    menu->SetToggle(SFZFlexListMenu::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 = SFZFlexListMenu::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
        menu->InsertLast(item);
    }

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

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

    // [Optional] make 1st item selected(*)
    menu->SetSelect(1);

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

    return;
}

Execution Result:

Reference

SFYMenu | SFZTextMenu | SFXEvent | Result Event[SFEVT_RESPONDER_RESULT] | State

Member

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFZFlexListMenu::CodeEnum | SFZFlexListMenu::SetScrollBarWidth | SFYControl::GetCurrentValue | SFZFlexListMenu::SetBevelColor | SFZFlexListMenu::SetMenuMargin | SFZFlexListMenu::SetScrollRepeat | SFZFlexListMenu::SetEvenListColor | SFZFlexListMenu::SetOddListColor | SFZFlexListMenu::SetSelectListColor | SFZFlexListMenu::SetTextColor | SFZFlexListMenu::SetGridLineColor | SFZFlexListMenu::SetListMargin | SFZFlexListMenu::SetGridLineEnable | SFZFlexListMenu::SetAccessKeyEnable | SFZFlexListMenu::SetFont | SFZFlexListMenu::SetSpaceSize | SFZFlexListMenu::SetToggle | SFZFlexListMenu::SetScrollDirection | SFZFlexListMenu::SetScrollInterval | SFZFlexListMenu::SetScrollStep | SFZFlexListMenu::SetWaitInterval | SFYBoxControl::SetOperateKey | SFZFlexListMenu::SetItemAccessKey | SFZFlexListMenu::HandleOperateKey | SFYMenu::SetEscapeKey | SFZFlexListMenu::HandleEscapeKey | SFYMenu::SetSelectUpKey | SFYMenu::SetSelectDownKey | SFZFlexListMenu::SetPageUpKey | SFZFlexListMenu::SetPageDownKey | SFZFlexListMenu::SetSnapUpKey | SFZFlexListMenu::SetSnapDownKey | SFZFlexListMenu::HorizontalEnum | SFZFlexListMenu::VerticalEnum | SFZFlexListMenu::DirectionEnum | SFZFlexListMenu::DefaultEnum | SFZFlexListMenu::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 menu.

Reference

SFZFlexListMenu::Clear

Reference

SFZFlexListMenu::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

SFZFlexListMenu::LastIndexOfCommandId

Return value

Description

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

Reference

SFZFlexListMenu::SetAccessKeyEnable

Return value

Bevel color (SFXBevelColor) of this flex list menu, which is the color of the outer frame to draw this flex list menu in the 3D style.

Reference

SFZFlexListMenu::SetBevelColor | SFXBevelColor

Return value

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

Reference

SFZFlexListMenu::SetEvenListColor

Return value

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

Description

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

Reference

SFZFlexListMenu::TextEnum | SFZFlexListMenu::SetFont

Return value

Color(SFXRGBColor) of grid line of this flex list menu.

Reference

SFZFlexListMenu::SetGridLineColor | SFZFlexListMenu::SetGridLineEnable

Return value

Value of the enable flag of the grid line of this flex list menu.

Reference

SFZFlexListMenu::SetGridLineEnable | SFZFlexListMenu::SetGridLineColor

Return value

Value of horizontal alignment (SFZFlexListMenu::HorizontalEnum).

Reference

SFZFlexListMenu::SetHorizontalAlign | SFZFlexListMenu::HorizontalEnum

Return value

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

Description

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

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

Reference

SFZFlexListMenu::SetItem | SFZFlexListMenu::ItemRec

Description

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

Reference

SFZFlexListMenu::SetItemAccessKey

Return value

Command ID of the specified item of this flex list menu.

Reference

SFZFlexListMenu::SetItemCommandId |

Return value

Number of the items of this flex list menu.

Return value

Description

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

Reference

SFZFlexListMenu::SetItemEnable

Return value

Item height of this flex list menu. [pixels]

Description

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

Reference

SFZFlexListMenu::SetFont | SFZFlexListMenu::SetItemIconImage | SFZFlexListMenu::SetListMargin

Return value

Icon image of the specified item of this flex list menu which corresponds to the specified icon enum(SFZFlexListMenu::IconEnum).

Reference

SFZFlexListMenu::IconEnum | SFZFlexListMenu::SetItemIconImage

Return value

Text(SFXWideString) of the specified item of this flex list menu which corresponds to the specified text enum(SFZFlexListMenu::TextEnum).

Reference

SFZFlexListMenu::TextEnum | SFZFlexListMenu::SetItemText

Return value

Margin(SFXMargin) within each item of this flex list menu

Reference

SFZFlexListMenu::SetListMargin

Return value

Margin(SFXMargin) for the outer frame of this flex list menu.

Reference

SFZFlexListMenu::SetMenuMargin

Return value

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

Reference

SFZFlexListMenu::SetOddListColor

Return value

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

Reference

SFZFlexListMenu::SetPageDownKey

Return value

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

Reference

SFZFlexListMenu::SetPageUpKey

Description

This function gets the scroll bar control, which this flex list menu 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 SFZFlexListMenu::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
SFZFlexListMenuSmp          menu;
SFYScrollBarControlSmp      bar;

menu = SFZFlexListMenu::NewInstance();

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

Reference

SFYScrollBarControl | SFZFlexListMenu::SetScrollBarControl

Return value

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

Reference

SFZFlexListMenu::SetScrollBarWidth

Return value

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

Reference

SFZFlexListMenu::SetScrollDirection | SFZFlexListMenu::DirectionEnum

Return value

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

Reference

SFZFlexListMenu::SetScrollInterval

Return value

Reference

SFZFlexListMenu::SetScrollRepeat

Return value

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

Reference

SFZFlexListMenu::SetScrollStep

Return value

Index of currently selected item of this flex list menu.

Reference

SFZFlexListMenu::SetSelect

Return value

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

Reference

SFZFlexListMenu::SetSelectListColor

Return value

SnapDown key to move the selected item down to the bottom.

Reference

SFZFlexListMenu::SetSnapDownKey

Return value

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

Reference

SFZFlexListMenu::SetSnapUpKey

Return value

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

Reference

SFZFlexListMenu::SetSpaceSize

Return value

Color(SFXRGBColor) of text specified with a text enum(SFZFlexListMenu::TextEnum) of this flex list menu.

Reference

SFZFlexListMenu::TextEnum | SFZFlexListMenu::SetTextColor

Return value

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

Reference

SFZFlexListMenu::ToggleEnum | SFZFlexListMenu::SetToggle

Return value

Value(SFZFlexListMenu::VerticalEnum) of vertical alignment.

Reference

SFZFlexListMenu::SetVerticalAlign | SFZFlexListMenu::VerticalEnum

Return value

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

Reference

SFZFlexListMenu::SetWaitInterval

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the access key set with the SFZFlexListMenu::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 SFZFlexListMenu::HandleAccessKey function is as follows:

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

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

Reference

SFZFlexListMenu::SetItemAccessKey | SFZFlexListMenu::SetAccessKeyEnable | SFZFlexListMenu::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 SFZFlexListMenu::HandleBoundOptimize function is as follows:

struct ScrollBarRec {
    SFYScrollBarControlSmp              smp;
    SInt16                              width;
};

SFYVerticalFlexListControlSmp   _vertical;
ScrollBarRec                    _bar;

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

    rectangle->Deflate(GetMenuMargin());
    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(GetMenuMargin());
    return;
}// SFZFlexListMenu::HandleBoundRequest //

Reference

SFYResponder::GetSuitableBound | SFZFlexListMenu::SetFont | SFZFlexListMenu::SetItem | SFZFlexListMenu::SetItemIconImage | SFZFlexListMenu::SetItemText | SFZFlexListMenu::SetSpaceSize | SFZFlexListMenu::SetListMargin | SFZFlexListMenu::SetScrollBarWidth | SFZFlexListMenu::GetMenuMargin | SFXMargin | SFZTextMenu | 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 SFZFlexListMenu::HandleBoundRequest function is as follows:

SFYVerticalFlexListControlSmp   _vertical;

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

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

Reference

SFYResponder::GetSuitableBound | SFZFlexListMenu::SetFont | SFZFlexListMenu::SetItem | SFZFlexListMenu::SetItemIconImage | SFZFlexListMenu::SetItemText | SFZFlexListMenu::SetSpaceSize | SFZFlexListMenu::SetListMargin | SFZFlexListMenu::GetMenuMargin | SFXMargin | SFZTextMenu | 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 SFZFlexListMenu::HandleBoundVirtual function is as follows:

struct ScrollBarRec {
    SFYScrollBarControlSmp              smp;
    SInt16                              width;
};

SFYVerticalFlexListControlSmp   _vertical;
ScrollBarRec                    _bar;

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

/*private */Void SFZFlexListMenu::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(GetMenuMargin());
    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(GetSelect())) {
        if ((widget = GetItemWidget(GetSelect())) != null) {
            if (widget->GetStateActive(true)) {
                widget->StartScroll();
            }
        }
    }
    return;
}// SFZFlexListMenu::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 ESCAPE key set with the SFYMenu::SetEscapeKey function is pressed.

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 SFZFlexListMenu::HandleEscapeKey function is as follows:

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

Reference

SFYMenu::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 SFYMenu::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 SFZFlexListMenu::GetSelect function) will be sent if the enable flag is set to "true" with the SFZFlexListMenu::SetItemEnable function.

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

Internal Implementation

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

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

Reference

SFYMenu::SetOperateKey | SFZFlexListMenu::SetItemEnable | SFZFlexListMenu::GetSelect | 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 SFZFlexListMenu::HandleRenderRequest function is as follows:

struct ColorRec {
    SFXBevelColor                       bevel;
};
ColorRec                        _color;

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

/*private */Void SFZFlexListMenu::DrawBevel(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXBevelColor                               bevel;
    SFXRectangle                                result(rectangle);

    bevel.Set(_color.bevel);
    if (!GetStateActive(true) || GetMenuMargin().Equals(SFXMargin(0, 0))) {
        bevel.SetLight(bevel.GetBase());
        bevel.SetDark(bevel.GetBase());
    }
    graphics->FillBevelRectangle(result, bevel);
    return;
}// SFZFlexListMenu::DrawBevel //

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

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the DOWN key set with the SFYMenu::SetSelectDownKey function is received.

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

The default implementation is to make the next item of the currently setected item selected.

Internal Implementation

Internal implementation of the SFZFlexListMenu::HandleSelectDownKey function is as follows:

SFYVerticalFlexListControlSmp   _vertical;

/*protected virtual */Void SFZFlexListMenu::HandleSelectDownKey(Void)
{
    _vertical->ScrollDown();
    return;
}// SFZFlexListMenu::HandleSelectDownKey //

Reference

SFYMenu::SetSelectDownKey | 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 UP key set with the SFYMenu::SetSelectUpKey function is received.

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

The default implementation is to make the previous item of the currently setected item selected.

Internal Implementation

Internal implementation of the SFZFlexListMenu::HandleSelectUpKey function is as follows:

SFYVerticalFlexListControlSmp   _vertical;

/*protected virtual */Void SFZFlexListMenu::HandleSelectUpKey(Void)
{
    _vertical->ScrollUp();
    return;
}// SFZFlexListMenu::HandleSelectUpKey //

Reference

SFYMenu::SetSelectUpKey | SFXEvent | Result Event[SFEVT_RESPONDER_RESULT] | Key Event[SFEVT_KEY]

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 number of items, the item will be inserted at the tail.

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

Reference

SFZFlexListMenu::InsertFirst | SFZFlexListMenu::InsertLast | SFZFlexListMenu::Remove | SFZFlexListMenu::ItemRec

Return value

Description

This function inserts the specified item at the head.

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

Reference

SFZFlexListMenu::Insert | SFZFlexListMenu::InsertLast | SFZFlexListMenu::RemoveFirst | SFZFlexListMenu::ItemRec

Return value

Description

This function inserts the specified item at the tail.

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

Reference

SFZFlexListMenu::Insert | SFZFlexListMenu::InsertFirst | SFZFlexListMenu::RemoveLast | SFZFlexListMenu::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

SFZFlexListMenu::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:

SFZFlexListMenuSmp _flexlistmenu;
SFCError error;

if ((_flexlistmenu = SFZFlexListMenu::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 menu.

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.

Example

SFZFlexListMenuSmp    menu;

// create instance etc. 

       ...

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

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

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

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

Reference

SFZFlexListMenu::Clear | SFZFlexListMenu::RemoveFirst | SFZFlexListMenu::RemoveLast | SFZFlexListMenu::Insert

Description

This function removes the first item from this flex list menu.

Reference

SFZFlexListMenu::Clear | SFZFlexListMenu::Remove | SFZFlexListMenu::RemoveLast | SFZFlexListMenu::InsertFirst

Description

This function removes the last item from this flex list menu.

Reference

SFZFlexListMenu::Clear | SFZFlexListMenu::Remove | SFZFlexListMenu::RemoveFirst | SFZFlexListMenu::InsertLast

Description

This function sets the enable flag of access key of this flex list menu 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 the item set with the SFZFlexListMenu::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 SFZFlexListMenu::SetItemEnable function.

Reference

SFZFlexListMenu::GetAccessKeyEnable | SFZFlexListMenu::SetItemEnable

Description

This function sets the bevel color(SFXBevelColor) for the outer frame of this flex list menu to draw this flex list menu in the 3D style to the specified value.

Default: SFXBevelColor(SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00), SFXRGBColor(0xEE, 0xEE, 0xEE, 0x00), SFXRGBColor(0x88, 0x88, 0x88, 0x00)).

Reference

SFZFlexListMenu::GetBevelColor | SFXBevelColor | SFXRGBColor

Description

This function sets the background color(SFXRGBColor) of unselected item at the even index of this flex list menu 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 SFZFlexListMenu::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 SFZFlexListMenu::SetOddListColor.

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

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

Reference

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

Description

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

Default: AEE_FONT_NORMAL

Reference

SFZFlexListMenu::TextEnum | SFZFlexListMenu::GetFont

Description

This function sets the color of grid line of this flex list menu 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 SFZFlexListMenu::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 SFZFlexListMenu::SetListMargin function in case "true" is set to this enable flag.

Reference

SFZFlexListMenu::GetGridLineColor | SFZFlexListMenu::SetGridLineEnable | SFXRGBColor

Description

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

The grid line will be drawn in the color set with the SFZFlexListMenu::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 SFZFlexListMenu::SetListMargin function in case this enable flag is set to "true".

Reference

SFZFlexListMenu::GetGridLineEnable | SFZFlexListMenu::SetGridLineColor | SFZFlexListMenu::SetListMargin

Description

This function sets the horizontal alignment to the specified value.

Default: SFZFlexListMenu::DEFAULT_HORIZONTAL

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

Reference

SFZFlexListMenu::GetHorizontalAlign | SFZFlexListMenu::HorizontalEnum

Description

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

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

Reference

SFZFlexListMenu::GetItem | SFZFlexListMenu::ItemRec

Description

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

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

Reference

SFZFlexListMenu::GetItemAccessKey | SFZFlexListMenu::HandleAccessKey | SFZFlexListMenu::SetAccessKeyEnable | SFZFlexListMenu::SetItemEnable

Description

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

Reference

SFZFlexListMenu::GetItemCommandId

Description

This function sets the enable flag of the specified item of this flex list menu 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 SFZFlexListMenu::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 SFZFlexListMenu::SetEvenListColor or SFZFlexListMenu::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 SFZFlexListMenu::SetTextColor function. The background of item is drawn in the color set with the SFZFlexListMenu::SetSelectListColor function when selected, regardless of the value of enable flag of item.

Reference

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

Description

This function sets the icon image of the specified icon enum(SFZFlexListMenu::IconEnum) of the specified item of this flex list menu 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

SFZFlexListMenu::IconEnum | SFZFlexListMenu::GetItemIconImage

Description

This function sets the text of the specified text enum(SFZFlexListMenu::TextEnum) of the specified item of this flex list menu to the specified value.

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

Reference

SFZFlexListMenu::TextEnum | SFZFlexListMenu::GetItemText

Description

This function sets the margin within each item of this flex list menu 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

SFZFlexListMenu::GetListMargin | SFXMargin

Description

This function sets the menu margin of this flex list menu to the specified value, which corresponds to the outer frame.

If SFXMargin(0, 0, 0, 0) is specified, this frame will not be drawn.

Default: SFXMargin(2, 2, 2, 2)

Reference

SFZFlexListMenu::GetMenuMargin

Description

This function sets the background color(SFXRGBColor) of unselected item at the odd index of this flex list menu 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 SFZFlexListMenu::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 SFZFlexListMenu::SetEvenListColor.

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

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

Reference

SFZFlexListMenu::GetOddListColor | SFZFlexListMenu::SetEvenListColor | SFZFlexListMenu::SetSelectListColor | SFZFlexListMenu::SetTextColor | SFZFlexListMenu::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 menu 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 menu when the PageDown key is pressed.

Reference

SFZFlexListMenu::GetPageDownKey | SFZFlexListMenu::SetPageUpKey | SFYMenu::SetSelectUpKey | SFYMenu::SetSelectDownKey | SFZFlexListMenu::SetSnapUpKey | SFZFlexListMenu::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 menu 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 menu when the PageUp key is pressed.

Reference

SFZFlexListMenu::GetPageUpKey | SFZFlexListMenu::SetPageDownKey | SFYMenu::SetSelectUpKey | SFYMenu::SetSelectDownKey | SFZFlexListMenu::SetSnapUpKey | SFZFlexListMenu::SetSnapDownKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

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

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

Example

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

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

Void UserApplication::SomeFunction {
    SFZFlexListMenuSmp              menu;
    CustomScrollBarControlSmp       bar;

    // create flex list menu
    menu = SFZFlexListMenu::NewInstance();

    // settings of flex list menu
    // ...

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

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

Reference

SFZFlexListMenu::GetScrollBarControl

Description

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

Default: SFZFlexListMenu::DEFAULT_BAR_WIDTH

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

Reference

SFZFlexListMenu::GetScrollBarWidth | SFZFlexListMenu::DefaultEnum

Description

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

Default: SFZFlexListMenu::DEFAULT_DIRECTION

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

Reference

SFZFlexListMenu::GetScrollDirection | SFZFlexListMenu::DirectionEnum

Description

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

Default: SFZFlexListMenu::DEFAULT_SCROLL

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

Reference

SFZFlexListMenu::GetScrollInterval | SFZFlexListMenu::DefaultEnum

Description

This function sets the repeat-scroll flag of this flex list menu 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 UP key or DOWN 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 UP key or DOWN key is pressed, respectively.

	About the UP key and the DOWN key
	The UP key or ScrollDown key is set with the SFYMenu::SetSelectUpKey function or SFYMenu::SetSelectDownKey function respectively.

Reference

SFZFlexListMenu::GetScrollRepeat | SFYMenu::SetSelectDownKey | SFYMenu::SetSelectUpKey

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: SFZFlexListMenu::DEFAULT_STEP

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

Reference

SFZFlexListMenu::GetScrollStep | SFZFlexListMenu::DefaultEnum

Description

This function sets the index of currently selected item of this flex list menu to the specified value.

Reference

SFZFlexListMenu::GetSelect

Description

This function sets the background color(SFXRGBColor) of selected item of this flex list menu 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 SFZFlexListMenu::SetOddListColor.

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

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

Reference

SFZFlexListMenu::GetSelectListColor | SFZFlexListMenu::SetEvenListColor | SFZFlexListMenu::SetOddListColor | SFZFlexListMenu::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 menu 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 menu when the SnapDown key is pressed.

Reference

SFZFlexListMenu::GetSnapDownKeySFZFlexListMenu::SetSnapUpKey | SFYMenu::SetSelectUpKey | SFYMenu::SetSelectDownKey | SFZFlexListMenu::SetPageDownKey | SFZFlexListMenu::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 menu 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 menu when the SnapUp key is pressed.

Reference

SFZFlexListMenu::GetSnapUpKeySFZFlexListMenu::SetSnapDownKey | SFYMenu::SetSelectUpKey | SFYMenu::SetSelectDownKey | SFZFlexListMenu::SetPageDownKey | SFZFlexListMenu::SetPageUpKey | SFXEvent | Value Event[SFEVT_RESPONDER_VALUE]

Description

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

Default: SFZFlexListMenu::DEFAULT_SPACE

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

Reference

SFZFlexListMenu::GetSpaceSize | SFZFlexListMenu::DefaultEnum

Description

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

Default values are as follows:

When "false" is set to the item using the SFZFlexListMenu::SetItemEnable function or the state of this flex list menu 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 SFZFlexListMenu::SetOddListColor.

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

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

Reference

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

Description

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

Default: 0.

Example

SFZFlexListMenu       menu;

// ...

menu->SetToggle(
    SFZFlexListMenu::TOGGLE_EMPTY_BODY_ICON |
    SFZFlexListMenu::TOGGLE_MULTIPLE_BODY_TEXT
);

Reference

SFZFlexListMenu::ToggleEnum | SFZFlexListMenu::GetToggle

Description

This function sets the vertical alignment to the specified value.

Default: SFZFlexListMenu::DEFAULT_VERTICAL

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

Reference

SFZFlexListMenu::GetVerticalAlign | SFZFlexListMenu::VerticalEnum

Description

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

Default: SFZFlexListMenu::DEFAULT_WAIT

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

Reference

SFZFlexListMenu::GetWaitInterval | SFZFlexListMenu::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 menu using this item structure.

Reference

SFZFlexListMenu::Insert | SFZFlexListMenu::InsertFirst | SFZFlexListMenu::InsertLast | SFZFlexListMenu::GetItem | SFZFlexListMenu::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

SFZFlexListMenuSmp    menu;

// create instance etc.
// ...

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

Execution Result:

Reference

SFZFlexListMenu::ToggleEnum