Inheritance diagram

Collaboration diagram

Description

SFZTextMenu is a responder to create, control, update, and destroy a menu in text format(text menu).

There are 2 types of text menus: page style(default) and scroll style.

The design of a text menu can be customized using its various APIs.

A text, an icon character, or an image can be set to an item of the text menu.

To append an item, call the SFZTextMenu::AppendItem function. To delete an item, call the SFZTextMenu::RemoveItem function. When the SFZTextMenu::Clear function is called, all items will be removed.

The selection key is set with the SFYMenu::SetSelectUpKey / SFYMenu::SetSelectDownKey / SFYMenu::SetSelectRightKey / SFYMenu::SetSelectLeftKey functions. By default, selection keys are set to the UP key, the DOWN key, the RIGHT key, the LEFT key respectively.

In the default implementation, the text menu[SFZTextMenu] 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 is set with the SFZTextMenu::SetItemAccessKey function.

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

	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] | SFZTextMenu::HandleOperateKey | SFZTextMenu::HandleEscapeKey | SFZTextMenu::HandleSelectUpKey | SFZTextMenu::HandleSelectDownKey | SFZTextMenu::HandleSelectRightKey | SFZTextMenu::HandleSelectLeftKey

The code to use a text menu is as follows:

	Note
	To simplify the code, error handling is omitted here.

Void USRApplication::Main(Void)
{
     SFCError error;

     // create the window
     _window = SFZWindow::NewInstance();
     _window->SetParent(GetThis());
     _window->SetRealBound(GetLocalBound());
     _window->SetVirtualBound(SFXRectangle(_window->GetVirtualBound()).SetHeight(640));
     _window->SetState(true, true, true, true);
     _window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

     // create the text menu
     SFZTextMenuSmp _textmenu = SFZTextMenu::NewInstance(&error);

     // register the result handler which means that item is selected	
     _textmenu->RegisterHandler(SFXEventRange(SFEVT_RESPONDER_RESULT, SFEVT_RESPONDER_RESULT, SFP16_BEGIN, SFP16_END), 
                                   XANDLER_INTERNAL(OnTextMenu));

     _textmenu->SetState(true, true, true, true);
     _textmenu->SetParent(_window);
     _textmenu->SetTitle("Text Menu");
     _textmenu->ToFront();

     SFXRectangle menuRect(30,95,165,135);  
     menuRect.SetHeight(_textmenu->GetTitleHeight() + 3 * _textmenu->GetItemHeight());
     _textmenu->SetRealBound(menuRect);

     _textmenu->AppendItem("item 1"); 
     _textmenu->AppendItem("item 2"); 
     _textmenu->AppendItem("item 3"); 
	 
     // disable 3rd item
     _textmenu->SetItemEnable(2, false);

     return;
}

// result handler which means that item is selected
XANDLER_IMPLEMENT_VOIDRESULT(USRApplication, OnTextMenu, invoker, reason, result)
{
    // text menu will be passed via invoker
    // P16 value of result event will be passed via reason

    switch (reason) {

        case SFP16_RESULT_OK:  // when the operation key is pressed[item needs to be enabled with SetItemEnable()]

            // the index of the selected item will be passed via the result argument

            if (result == 0) {       // when 1st item is selected

                 ...

            }
            else if (result == 1) {  // when 2nd item is selected
 
                 ...

            }
            else if (result == 2) {  // when 3rd item is selected

                 ...

            }

            break;

        case SFP16_RESULT_ESCAPE:  // when the ESCAPE key is pressed or the time scheduled with ScheduleTimer() elapses

            // 0 will be passed via the result argument

            // close text menu
            invoker->Terminate();  
            // or "_textmenu->Terminate();"

            break;
    }

    return;
}

Execution result:

Reference

Text Menu [SFZTextMenu] | SFYMenu | SFZGridMenu | SFZFlexListMenu

Members

Description

This constructor performs the initializations as follows:

	Note
	In a responder inheriting from SFZTextMenu the corresponding handler will be called when the above event occurs.

Reference

SFYResponder::SetType | SFZTextMenu::CodeEnum | SFZTextMenu::MenuStyleEnum | SFZTextMenu::SetMenuStyle | SFZTextMenu::SetFont | SFZTextMenu::SetBevelColor | SFZTextMenu::SetTitleBackColor | SFZTextMenu::SetTitleForeColor | SFZTextMenu::SetDefaultItemBackColor | SFZTextMenu::SetDefaultItemForeColor | SFZTextMenu::SetSelBackColor | SFZTextMenu::SetSelForeColor | SFZTextMenu::SetTitle | SFZTextMenu::SetTitleHeight | SFZTextMenu::SetItemHeight | SFZTextMenu::SetItemMargin | SFZTextMenu::SetSelect | SFZTextMenu::SetItemAccessKey | SFZTextMenu::HandleOperateKey | SFXBevelColor | SFXRGBColor | SFXMargin | Type | Event | Key Event[SFEVT_KEY]

Description

Delete all items from this text menu.

Reference

SFZTextMenu::Clear

Description

This function appends an item to this menu. The appended item becomes the last item of this menu.

	Caution
	Since this function is deprecated, use the SFZTextMenu::InsertLast function instead.

Reference

SFZTextMenu::InsertLast | SFZTextMenu::RemoveItem | SFZTextMenu::Clear

Description

This function deletes all items from this menu.

Reference

SFZTextMenu::RemoveItem | SFZTextMenu::AppendItem

Return value

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

Reference

SFZTextMenu::SetBevelColor | SFXBevelColor

Description

This function gets the default background color(SFXRGBColor) of unselected item of this menu.

Reference

SFZTextMenu::SetDefaultItemBackColor

Description

This function gets the default foreground color(SFXRGBColor) to draw the text of unselected item of this menu.

Reference

SFZTextMenu::SetDefaultItemForeColor

Description

This function gets the font to draw the item and the title of this menu.

Reference

SFZTextMenu::SetFont

Description

This function gets the access key of the specified item of this menu. AVK_UNDEFINED will be returned if the access key is not set.

Reference

SFZTextMenu::SetItemAccessKey

Description

This function gets the background color(SFXRGBColor) of the specified unselected item of this menu.

Reference

SFZTextMenu::SetItemBackColor | SFXRGBColor

Description

This function gets the number of the items of this menu.

Description

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

Reference

SFZTextMenu::SetItemEnable

Description

This function gets the foreground color(SFXRGBColor) to draw the text of the specified unselected item of this menu.

Reference

SFZTextMenu::SetItemForeColor | SFXRGBColor

Description

This function gets the item height of this menu.

Reference

SFZTextMenu::SetItemHeight

Return value

Pointer to the image attached with the item.

Description

This function gets the image of the specified item of this menu.

Reference

SFZTextMenu::SetItemImage

Description

This function gets the margin between the border and the text of the item of this menu.

This margin region is filled in the bevel color set with the SFZTextMenu::SetBevelColor function.

Reference

SFZTextMenu::SetItemMargin | SFZTextMenu::GetBevelColor | SFXMargin | SFXBevelColor

Return value

Reference

SFZTextMenu::SetItemSubMenu

Description

This function gets the text of the specified item of this menu.

Reference

SFZTextMenu::SetItemText

Return value

Description

This function gets the menu style of this menu.

Reference

SFZTextMenu::SetMenuStyle | SFZTextMenu::MenuStyleEnum

Return value

Root menu of this menu[The parent menu at the highest position is called "Root menu".]

Description

This function gets the root menu of this menu.

	Tip
	To close a menu which has a parent menu, call only the SFYResponder::Terminate function of its root menu gotten by calling this function.

Reference

SFYResponder::Terminate

Description

This function gets the background color(SFXRGBColor) of selected item of this menu.

Reference

SFZTextMenu::SetSelBackColor | SFXRGBColor

Description

This function gets the foreground color(SFXRGBColor) of selected item of this menu.

Reference

SFZTextMenu::SetSelForeColor | SFXRGBColor

Return value

Index of currently selected item.

Description

This function gets the index of currently selected item of this menu.

Reference

SFZTextMenu::SetSelect

Return value

Menu title.

Description

This function gets the title of this menu.

Reference

SFZTextMenu::SetTitle

Return value

Background color (SFXRGBColor) to fill the rectangle containing the title.

Description

This function gets the background color(SFXRGBColor) of the title of this menu, in which the rectangle containing the title is filled.

Reference

SFZTextMenu::SetTitleBackColor | SFXRGBColor

Return value

Foreground color (SFXRGBColor) of the title.

Description

This function gets the foreground color(SFXRGBColor) of the title of this menu, in which the title is drawn.

Reference

SFZTextMenu::SetTitleForeColor | SFXRGBColor

Return value

Height of the title.

Description

This function gets the height of the title of this menu.

Reference

SFZTextMenu::SetTitleHeight

Description

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

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

The default implementation is as follows:

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) event will occur when the real region is changed by calling the SFYResponder::SetRealBound function.

	Processing when the real region is changed
	Other than overriding this virtual function, there is another method to define and implement the handler for the region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the real region is updated, this virtual function is executed first, and next the handlers for the region event are executed in the registered order.

Internal Implementation

Internal implementation of the SFZTextMenu::HandleBoundReal function is as follows:

/*protected virtual */Void SFZTextMenu::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    if (_itemHeight != 0) {
        _field = (GetLocalBound().GetHeight() - _titleHeight) / _itemHeight;
    }
    Invalidate();
    return;
}// SFZTextMenu::HandleBoundReal //

Reference

SFYResponder::SetRealBound | SFXEvent | Real Region | Virtual 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 virtual region with the real 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 SFZTextMenu::HandleBoundVirtual function is as follows:

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

Reference

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

Description

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

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

The default implementation is as follows:

Internal Implementation

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

/*protected virtual */Void SFZTextMenu::HandleEscapeKey(Void)
{
    if (HasParentMenu()) {
 SetState(false, false, false, false);
 SFZTextMenuSmp parent(static_pointer_cast<SFZTextMenu>(GetParent()));
        if (parent != null) {
            parent->SetState(true, true, true, true);
            parent->ToFront();
        }
    }
    else {
        InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0), false);
    }
    return;
}// SFZTextMenu::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 follows:

Internal Implementation

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

enum CodeEnum {
    CODE_TYPE                           = four_char_code('m', 't', 'm', 'n')
};

/*protected virtual */Void SFZTextMenu::HandleOperateKey(Void)
{
    MenuItemPtr                                 item;
    SFZTextMenuSmp                              subMenu;

    item = GetMenuItem(_selectedItem);
    if (item != null && item->enable) {
        if (item->subMenu != null) {
            subMenu = item->subMenu;
            subMenu->SetState(true, true, true, true);
            subMenu->SetMenuStyle(GetMenuStyle());
            subMenu->SetSelect(0);
            subMenu->ToFront();
        }
        else {
            InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, GetSelect()), false);
        }
    }
    return;
}// SFZTextMenu::HandleOperateKey //

Reference

SFYMenu::SetOperateKey | SFZTextMenu::SetItemEnable | SFXEvent | key event[SFEVT_KEY] | 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 menu.

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 SFZTextMenu::HandleRenderRequest function is as follows:

enum MenuStyleEnum {
    PAGE_STYLE                          = 0,
    SCROLLABLE_STYLE,
    DEFAULT_STYLE                       = PAGE_STYLE
};

/*protected virtual */Void SFZTextMenu::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawMenu(graphics);
    return;
}// SFZTextMenu::HandleRenderRequest //

/*private */Void SFZTextMenu::DrawMenu(SFXGraphicsPtr graphics) const
{
    SFXRectangle                                menuRect(GetLocalBound());
    SFXRectangle                                titleRect;
    SFXRectangle                                pageRect;
    SFXRectangle                                contentRect;
    SFXRectangle                                temp;
    SInt32                                      pageSize;
    SInt32                                      pageNumber;
    SInt32                                      pageCount;

    graphics->FillBevelRectangle(menuRect, _color.bevel);
    titleRect = menuRect;
    titleRect.SetHeight(_titleHeight);
    pageRect = titleRect;
    pageRect.AddLeft(pageRect.GetWidth() - 2 - SFXGraphics::MeasureSingleText(AEE_FONT_NORMAL, "9/9"));
    contentRect = menuRect;
    contentRect.AddTop(_titleHeight);
    pageSize = _field;
    contentRect.SetHeight(static_cast<SInt16>(_itemHeight * pageSize));
    menuRect.SetHeight(_titleHeight + contentRect.GetHeight());
    graphics->SetFont(_font);
    temp = titleRect;
    temp.Deflate(1, 1);
    graphics->FillRectangle(temp, _color.titleBack);
    graphics->SetFont(_font);
    graphics->DrawSingleText(_title, titleRect.GetOrigin() + SFXGrid(2, 2), titleRect, _color.titleFore);
    if (_style == PAGE_STYLE) {
        if (pageSize != 0) {
            pageNumber = Ceil(_selectedItem + 1, pageSize);
            pageCount = Ceil(GetItemCount(), pageSize);
            pageNumber = (pageCount == 0) ? 0 : pageNumber;
            graphics->SetFont(_font);
            graphics->DrawSingleText(SFXAnsiString::Format("%d/%d", pageNumber, pageCount), pageRect.GetOrigin() + SFXGrid(0, 2), pageRect, _color.titleFore, IDF_ALIGN_CENTER);
            DrawPage(graphics, contentRect, pageSize, pageNumber);
        }
    }
    else if (_style == SCROLLABLE_STYLE) {
        pageRect.AddLeft(_itemHeight);
        DrawPage(graphics, contentRect, pageRect);
    }
    return;
}// SFZTextMenu::DrawMenu //

/*private */Void SFZTextMenu::DrawPage(SFXGraphicsPtr graphics, SFXRectangleConstRef rect, SInt32 pageSize, SInt32 pageNumber) const
{
    SInt32                                      i;
    SInt32                                      firstIndex;
    MenuItemPtr                                 item;
    SFXRectangle                                contentRect(rect);
    SFXRectangle                                itemRect;

    firstIndex = (pageNumber - 1) * pageSize;
    contentRect.SetHeight(_itemHeight);
    for (i = firstIndex; i < firstIndex + pageSize; ++ i) {
        if ((item = GetMenuItem(i)) != null) {
            itemRect = contentRect;
            itemRect.Deflate(_itemMargin);
            DrawItem(graphics, itemRect, item);
            contentRect.AddY(_itemHeight);
        }
        else {
            break;
        }
    }
    return;
}// SFZTextMenu::DrawPage //

/*private */Void SFZTextMenu::DrawPage(SFXGraphicsPtr graphics, SFXRectangleConstRef rect, SFXRectangleConstRef scroll) const
{
    SInt32                                      i;
    MenuItemPtr                                 item;
    SFXRectangle                                upRect(scroll);
    SFXRectangle                                downRect;
    SFXRectangle                                contentRect(rect);
    SFXRectangle                                itemRect;

    upRect.SubBottom(upRect.GetHeight() / 2);
    upRect.Deflate(1, 1);
    downRect = upRect;
    //downRect.AddY(upRect.GetHeight() + 1);
    downRect.Offset(0, upRect.GetHeight() + 2);
    if (_selectedItem > 0) {
        DrawTriangle(graphics, upRect, _color.selFore, 0);
    }
    if (_selectedItem < GetItemCount() - 1) {
        DrawTriangle(graphics, downRect, _color.selFore, 1);
    }
    contentRect.SetHeight(_itemHeight);
    for (i = 0; i < _field; ++ i) {
        if ((item = GetMenuItem(i + _topIndex)) != null) {
            itemRect = contentRect;
            itemRect.Deflate(_itemMargin);
            DrawItem(graphics, itemRect, item);
            contentRect.AddY(_itemHeight);
        }
        else {
            break;
        }
    }
    return;
}// SFZTextMenu::DrawPage //

/*private */Void SFZTextMenu::DrawItem(SFXGraphicsPtr graphics, SFXRectangleConstRef rect, MenuItemPtr item) const
{
    SFXRectangle                                itemRect(rect);
    SFXRectangle                                iconRect;
    SFXRectangle                                imageRect;
    SFXRGBColor                                 itemColor(item->foreColor);

    if (item == GetMenuItem(_selectedItem)) {
        graphics->FillRectangle(itemRect, _color.selBack);
        itemColor.Set(_color.selFore);
    }
    else {
        graphics->FillRectangle(itemRect, item->backColor);
    }
    if (!item->enable) {
        itemColor = DiffLightness(item->backColor);
    }
    if (item->subMenu != null) {
        iconRect = itemRect;
        iconRect.Deflate(iconRect.GetWidth() - iconRect.GetHeight() / 3, 0, -1, 0);
        iconRect.Deflate(0, iconRect.GetHeight() / 3 + 1, 0, 0);
        DrawTriangle(graphics, iconRect, itemColor, 2);
        itemRect.SubRight(iconRect.GetWidth() + 1);
    }
    if (item->keyIcon != 0) {
        iconRect = itemRect;
        iconRect.SetWidth(_itemHeight);
        itemRect.AddLeft(_itemHeight);
        graphics->SetFont(_font);
        graphics->DrawSingleText(SFXWideString(item->keyIcon), iconRect, itemColor, IDF_ALIGN_LEFT);
    }
    if (item->image != null) {
        imageRect = itemRect;
        imageRect.SetWidth(_itemHeight);
        itemRect.AddLeft(_itemHeight);
        AEEImageInfo  info;
 SInt16 dx;
 SInt16 dy;
        item->image->GetInfo(&info);
        if (info.cx > 0 && info.cy > 0) {
            dx = (imageRect.GetWidth() - info.cx) / 2;
            dy = (imageRect.GetHeight() - info.cy) / 2;
            imageRect.SetSize(info.cx, info.cy);
            graphics->DrawImage(item->image, imageRect.GetOrigin() + SFXGrid(dx, dy));
        }
    }
    graphics->SetFont(_font);
    graphics->DrawSingleText(item->text, itemRect, itemColor, IDF_ALIGN_LEFT);
    return;
}// SFZTextMenu::DrawItem //

/*private */Void SFZTextMenu::DrawTriangle(SFXGraphicsPtr graphics, SFXRectangleConstRef rect, SFXRGBColorConstRef color, SInt16 direction) const
{
    SFXTriangle                                 triangle;
    SInt16                                      width((rect.GetWidth() / 4) * 2);
    SFXPixel                                    pixel;

    switch (direction) {
        case 0: //up
            pixel.Set(rect.GetVertexLeftBottom());
            triangle.SetFirst(pixel);
            pixel.Offset(width, 0);
            triangle.SetSecond(pixel);
            pixel.Offset(0 - width / 2, 0 - width / 2);
            triangle.SetThird(pixel);
            break;
        case 1: //down
            pixel.Set(rect.GetVertexLeftTop());
            triangle.SetFirst(pixel);
            pixel.Offset(width, 0);
            triangle.SetSecond(pixel);
            pixel.Offset(0 - width / 2, width / 2);
            triangle.SetThird(pixel);
            break;
        case 2: //right
            pixel.Set(rect.GetVertexLeftTop());
            triangle.SetFirst(pixel);
            pixel.Offset(0, width * 2);
            triangle.SetSecond(pixel);
            pixel.Offset(width, 0 - width);
            triangle.SetThird(pixel);
            break;
        default:
            break;
    }
    graphics->SetForeColor(color);
    graphics->SetFillColor(color);
    graphics->SetFillMode(true);
    graphics->DrawTriangle(triangle);
    return;
}// SFZTextMenu::DrawTriangle //

Reference

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFXEvent | 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 as follows:

In case of the paging style

In case of the scrollable style

Internal Implementation

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

enum MenuStyleEnum {
    PAGE_STYLE                          = 0,
    SCROLLABLE_STYLE,
    DEFAULT_STYLE                       = PAGE_STYLE
};

/*protected virtual */Void SFZTextMenu::HandleSelectDownKey(Void)
{
    if (_selectedItem < GetItemCount() - 1) {
        ++_selectedItem;
    }
    else if (_style == PAGE_STYLE && _selectedItem == GetItemCount() - 1) {
        _selectedItem = 0;
    }
    RefreshMenu();
    return;
}// SFZTextMenu::HandleSelectDownKey //

/*private */Void SFZTextMenu::RefreshMenu(Void)
{
    if (_style == SCROLLABLE_STYLE) {
        if (_field > 0 && _selectedItem >= 0 && _selectedItem < GetItemCount()) {
            if (_topIndex > GetItemCount() - _field) {
                _topIndex = GetItemCount() - _field;
            }
            if (_topIndex < 0) {
                _topIndex = 0;
            }
            if (_topIndex > _selectedItem) {
                _topIndex = _selectedItem;
            }
            else if (_topIndex < _selectedItem - _field + 1)  {
                _topIndex = _selectedItem - _field + 1;
            }
        }
    }
    Invalidate();
    return;
}// SFZTextMenu::RefreshMenu

Reference

SFYMenu::SetSelectDownKey | SFXEvent | Key Event[SFEVT_KEY]

Description

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

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

The default implementation is as follows:

Internal Implementation

Internal implementation of the SFZTextMenu::HandleSelectLeftKey function is as follows:

/*protected virtual */Void SFZTextMenu::HandleSelectLeftKey(Void)
{
    if (HasParentMenu()) {
 SetState(false, false, false, false);
 SFYResponderSmp parent = GetParent();
        if (parent != null) {
            parent->SetState(true, true, true, true);
            parent->ToFront();
        }
    }
    return;
}// SFZTextMenu::HandleSelectLeftKey //

Reference

SFYMenu::SetSelectLeftKey | SFXEvent | Key Event[SFEVT_KEY]

Description

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

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

The default implementation is as follows:

Internal Implementation

Internal implementation of the SFZTextMenu::HandleSelectRightKey function is as follows:

/*protected virtual */Void SFZTextMenu::HandleSelectRightKey(Void)
{
    MenuItemPtr                                 item;
    SFZTextMenuSmp                              subMenu;

    if ((item = GetMenuItem(_selectedItem)) != null) {
        if (item->subMenu != null && item->enable) {
            subMenu = item->subMenu;
            subMenu->SetState(true, true, true, true);
            subMenu->SetMenuStyle(GetMenuStyle());
            subMenu->SetSelect(0);
            subMenu->ToFront();
        }
    }
    return;
}// SFZTextMenu::HandleSelectRightKey //

Reference

SFYMenu::SetSelectRightKey | SFXEvent | 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.

In case of the paging style

In case of the scrollable style

Internal Implementation

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

enum MenuStyleEnum {
    PAGE_STYLE                          = 0,
    SCROLLABLE_STYLE,
    DEFAULT_STYLE                       = PAGE_STYLE
};

/*protected virtual */Void SFZTextMenu::HandleSelectUpKey(Void)
{
    if (_selectedItem > 0) {
        --_selectedItem;
    }
    else if (_style == PAGE_STYLE && _selectedItem == 0) {
        _selectedItem = GetItemCount() - 1;
        if (_selectedItem < 0) {
            _selectedItem = 0;
        }
    }
    RefreshMenu();
    return;
}// SFZTextMenu::HandleSelectUpKey //

/*private */Void SFZTextMenu::RefreshMenu(Void)
{
    if (_style == SCROLLABLE_STYLE) {
        if (_field > 0 && _selectedItem >= 0 && _selectedItem < GetItemCount()) {
            if (_topIndex > GetItemCount() - _field) {
                _topIndex = GetItemCount() - _field;
            }
            if (_topIndex < 0) {
                _topIndex = 0;
            }
            if (_topIndex > _selectedItem) {
                _topIndex = _selectedItem;
            }
            else if (_topIndex < _selectedItem - _field + 1)  {
                _topIndex = _selectedItem - _field + 1;
            }
        }
    }
    Invalidate();
    return;
}// SFZTextMenu::RefreshMenu

Reference

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

Return value

Description

This fucntion checks whether or not this menu has any parent menu.

Reference

SFZTextMenu::HandleEscapeKey | SFZTextMenu::HandleSelectLeftKey | SFZTextMenu::GetRootMenu

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.

Reference

SFZTextMenu::InsertFirst | SFZTextMenu::InsertLast | SFZTextMenu::Remove

Return value

Description

This function inserts the specified item at the head.

Reference

SFZTextMenu::Insert | SFZTextMenu::InsertLast | SFZTextMenu::RemoveFirst

Return value

Description

This function inserts the specified item at the tail.

Reference

SFZTextMenu::Insert | SFZTextMenu::InsertFirst | SFZTextMenu::RemoveLast

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:

SFZTextMenuSmp _textmenu;
SFCError error;

if ((_textmenu = SFZTextMenu::NewInstance(&error)) != null) {

    ...
}

Description

This function removes the item at the specified index or the items in the specified index range from this text 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

SFZTextMenuSmp    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

SFZTextMenu::Clear | SFZTextMenu::Remove | SFZTextMenu::RemoveLast | SFZTextMenu::Insert

Description

This function removes the first item from this text menu.

Reference

SFZTextMenu::Clear | SFZTextMenu::Remove | SFZTextMenu::RemoveLast | SFZTextMenu::InsertFirst

Description

This function removes the item at the specified index from this text menu.

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

	Caution
	Since this function is deprecated, use the SFZTextMenu::Remove function instead.

Reference

SFZTextMenu::Remove | SFZTextMenu::AppendItem

Description

This function removes the last item from this text menu.

Reference

SFZTextMenu::Clear | SFZTextMenu::Remove | SFZTextMenu::RemoveFirst | SFZTextMenu::InsertLast

Description

This function sets the bevel color(SFXBevelColor) for the outer frame of this menu to draw this 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

SFZTextMenu::GetBevelColor | SFXBevelColor | SFXRGBColor

Description

This function sets the default background color(SFXRGBColor) of unselected item of this menu to the specified value.

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

Default background color of unselected item

The default background color of unselected item can be changed using the SFZTextMenu::SetItemBackColor function. If you want to make the background color of unselected item be the same one, the background color needs to be set using this function. The SFZTextMenu::SetItemBackColor function to set it individually is not recommended. However, the background color of selected item is always the one set with the SFZTextMenu::SetSelBackColor function.

Reference

SFZTextMenu::GetDefaultItemBackColor | SFZTextMenu::SetDefaultItemForeColor | SFZTextMenu::SetItemBackColor | SFZTextMenu::SetSelBackColor | SFZTextMenu::SetItemEnable

Description

This function sets the default foreground color(SFXRGBColor) to draw the text of unselected item of this menu to the specified value.

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

Default foreground color of unselected item

The default foreground color of unselected item can be changed using the SFZTextMenu::SetItemForeColor function. If you want to make the foreground color of all unselected items be the same one, the foreground color needs to be set using this function. The SFZTextMenu::SetItemForeColor function to set it individually is not recommended. However, the foreground color of selected item is always the one set with the SFZTextMenu::SetSelForeColor function, except when the enable flag of the item is set to "false" using the SFZTextMenu::SetItemEnable function.

Foreground color of unselected item when the enable flag of the item is set to "false"

If the enable flag of the item is set to "false" using the SFZTextMenu::SetItemEnable function, the text will not be drawn in the foreground color of this item set with this function. In this case, the foreground color will be the color subtracted 0x33 from each RGB value of the background color of this item if the brightness of background color is bigger than 0x7F, otherwise it will be the color added 0x33 on each RGB value of the background color of this item. The brightness of color is the value obtained using the SFXRGBColor::GetBrightness function.

Reference

SFZTextMenu::GetDefaultItemForeColor | SFZTextMenu::SetDefaultItemBackColor | SFZTextMenu::SetItemForeColor | SFZTextMenu::SetSelForeColor | SFZTextMenu::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor

Description

This function sets the font of this menu to the specified value, which is used to draw the item and the title of this menu.

Default: AEE_FONT_NORMAL.

Reference

SFZTextMenu::GetFont

Description

This function sets the access key and the key icon of the specified item of this menu to specified values.

	Note
	The access key is valid only if the enable flag of the corresponding item is set to "true" using the SFZTextMenu::SetItemEnable function.

Example

The code to set an access key and a key icon for an item is as follows:

// set access key to AVK_1, key icon to 0xFBF6 for first item of _textmenu menu 
_textmenu->SetItemAccessKey(0, AVK_1, 0xFBF6);

Reference

SFZTextMenu::GetItemAccessKey | SFZTextMenu::SetItemEnable

Description

This function sets the background color(SFXRGBColor) of the specified unselected item of this menu to the specified value.

Default: The default background color set with the SFZTextMenu::SetDefaultItemBackColor function. SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00)[white color] if the default background color is not set.

	Foreground color of unselected item
	For the foreground color of unselected item, refer to SFZTextMenu::SetItemForeColor.

	Foreground color of selected item
	For the foreground color of selected item, refer to SFZTextMenu::SetSelForeColor.

	Background color of selected item
	For the background color of selected item, refer to SFZTextMenu::SetSelBackColor.

Reference

SFZTextMenu::SetDefaultItemBackColor | SFZTextMenu::GetItemBackColor | SFZTextMenu::SetItemForeColor | SFZTextMenu::SetSelForeColor | SFZTextMenu::SetSelBackColor | SFXRGBColor

Description

This function sets the enable flag of the specified item of this menu to the specified value.

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

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

Even if the operation key or the access key is pressed, the result event will not be sent. The sub-menu will not be displayed if it exists. The foreground color will be the color subtracted 0x33 from each RGB value of the background color of this item if the brightness of background color is bigger than 0x7F, otherwise it will be the color added 0x33 on each RGB value of the background color of this item. The brightness of color is the value obtained using the SFXRGBColor::GetBrightness function.

Reference

SFZTextMenu::GetItemEnable | SFZTextMenu::HandleOperateKey | SFZTextMenu::SetItemForeColor | Result Event[SFEVT_RESPONDER_RESULT]

Description

This function sets the foreground color(SFXRGBColor) to draw the text of the specified unselected item of this menu to the specified value.

Default: The default foreground color set with the SFZTextMenu::SetDefaultItemForeColor function. SFXRGBColor(0x00, 0x00, 0x00, 0x00)[black color] if the default background color is not set.

Foreground color of unselected item when the enable flag of the item is set to "false"

If the enable flag of the item is set to "false" using the SFZTextMenu::SetItemEnable function, the text will not be drawn in the foreground color of this item set with this function. In this case, the foreground color will be the color subtracted 0x33 from each RGB value of the background color of this item if the brightness of background color is bigger than 0x7F, otherwise it will be the color added 0x33 on each RGB value of the background color of this item. The brightness of color is the value obtained using the SFXRGBColor::GetBrightness function.

	Background color of unselected item
	For the background color of unselected item, refer to SFZTextMenu::SetItemBackColor.

	Foreground color of selected item
	For the foreground color of selected item, refer to SFZTextMenu::SetSelForeColor.

	Background color of selected item
	For the background color of selected item, refer to SFZTextMenu::SetSelBackColor.

Reference

SFZTextMenu::SetDefaultItemForeColor | SFZTextMenu::GetItemForeColor | SFZTextMenu::SetItemBackColor | SFZTextMenu::SetSelForeColor | SFZTextMenu::SetSelBackColor | SFZTextMenu::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor

Description

This function sets the item height of this menu to the specified value. All items of this menu have the same height value.

Default: font height + 2 [pixels]

Reference

SFZTextMenu::GetItemHeight

Description

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

Reference

SFZTextMenu::GetItemImage

Description

This function sets the margin between the border and the text of the item of this menu to the specified value.

This margin region is filled in the bevel color set with the SFZTextMenu::SetBevelColor function.

Default: SFXMargin(2, 0).

Reference

SFZTextMenu::GetItemMargin | SFZTextMenu::GetBevelColor | SFXMargin | SFXBevelColor

Description

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

Reference

SFZTextMenu::GetItemSubMenu

Description

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

Reference

SFZTextMenu::GetItemText

Description

This function sets the menu style of this menu to the specified value. Text menu can be set to be the scrollable style (SFZTextMenu::SCROLLABLE_STYLE) or the paging style (SFZTextMenu::PAGE_STYLE).

Default: SFZTextMenu::PAGE_STYLE.

Reference

SFZTextMenu::GetMenuStyle | SFZTextMenu::MenuStyleEnum

Description

This function sets the background color(SFXRGBColor) of selected item of this menu to the specified value.

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

	Foreground color of selected item
	For the foreground color of selected item, refer to SFZTextMenu::SetSelForeColor.

	Foreground color of unselected item
	For the foreground color of unselected item, refer to SFZTextMenu::SetItemForeColor.

	Background color of unselected item
	For the background color of unselected item, refer to SFZTextMenu::SetItemBackColor.

Reference

SFZTextMenu::GetSelBackColor | SFZTextMenu::SetSelForeColor | SFZTextMenu::SetItemForeColor | SFZTextMenu::SetItemBackColor | SFXRGBColor

Description

This function sets the foreground color(SFXRGBColor) of selected item of this menu to the specified value.

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

	Background color of selected item
	For the background color of selected item, refer to SFZTextMenu::SetSelBackColor.

	Foreground color of unselected item
	For the foreground color of unselected item, refer to SFZTextMenu::SetItemForeColor.

	Background color of unselected item
	For the background color of unselected item, refer to SFZTextMenu::SetItemBackColor.

Reference

SFZTextMenu::GetSelForeColor | SFZTextMenu::SetItemForeColor | SFZTextMenu::SetItemBackColor | SFZTextMenu::SetSelBackColor | SFZTextMenu::SetItemEnable | SFXRGBColor::GetBrightness | SFXRGBColor

Description

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

Reference

SFZTextMenu::GetSelect

Description

This function sets the title of this menu to the specified value.

The title is set by specifying the string as an argument directly, or by reading from the resource file.

Default: ""[null string]

Reference

SFZTextMenu::GetTitle

Description

This function sets the background color(SFXRGBColor) of the title of this menu to the specified value, in which the rectangle containing the title is filled.

Default: SFXRGBColor(0xDD, 0xDD, 0xDD, 0x00)[gray color]

Reference

SFZTextMenu::GetTitleBackColor | SFXRGBColor

Description

This function sets the foreground color(SFXRGBColor) of the title of this menu to the specified value, in which the title is drawn.

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

Reference

SFZTextMenu::GetTitleForeColor | SFXRGBColor

Description

This function sets the height of the title of this menu to the specified value. If this value is set to "0", the title will be hidden and never drawn.

Default: font height + 2 [pixels]

Reference

SFZTextMenu::GetTitleHeight

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFZTextMenu::SetMenuStyle