Inheritance diagram

Collaboration diagram

Description

SFZGridMenu is a responder to create, control, update, and destroy a menu(grid menu) in matrix format.

Each cell of a grid menu has the same size, which is automatically set based on the size of real region and the number of rows and colums.

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

A text or an image can be set to grid menu's item.

To append an item, call the SFZGridMenu::AppendItem function. To delete an item, call the SFZGridMenu::RemoveItem function. When the SFZGridMenu::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 grid menu[SFZGridMenu] 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 SFZGridMenu::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] | SFZGridMenu::HandleOperateKey | SFZGridMenu::HandleSelectUpKey | SFZGridMenu::HandleSelectDownKey | SFZGridMenu::HandleSelectRightKey | SFZGridMenu::HandleSelectLeftKey

The code to use a grid 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 grid menu
     SFZGridMenuSmp _gridmenu = SFZGridMenu::NewInstance(&error);

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

     _gridmenu->SetRealBound(GetLocalBound());
     _gridmenu->SetState(true, true, true, true);
     _gridmenu->SetParent(_window);
     _gridmenu->SetRowCol(4, 3);
     _gridmenu->SetTitle("Grid Menu");
     _gridmenu->SetTitleForeColor(SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00));
     _gridmenu->SetTitleBackColor(SFXRGBColor(0x00, 0xBF, 0xF3, 0x00));
     _gridmenu->SetBackgroundColor(SFXRGBColor(0x00, 0x00, 0x00, 0x00));
	 
     SFBShellSmp  shell;
     SFBImageSmp  image;
     SFBImageSmp  image1;

     shell = SFBShell::GetInstance();
     SInt16 i;

     for (i = 0; i < 12; ++i) {
          image = shell->LoadResImage(NEWWORLD_RES_FILE, IDI_OBJECT_5001 + i);
          image1 = shell->LoadResImage(MENU_RES_FILE, IDI_OBJECT_5001 + i);
          _gridmenu->AppendItem(SFXWideString::Format("%d", i), image, image1);
     }

     _gridmenu->ShowItemName(true);
		 
     return;
}

XANDLER_IMPLEMENT_VOIDRESULT(USRApplication, OnGridMenu, invoker, reason, result)
{
    // grid 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

            // 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 grid menu
            invoker->Terminate();  
            // or "_gridmenu->Terminate();"

            break;
    }

    return;
}

Execution result:

Reference

Grid Menu [SFZGridMenu] | SFYMenu | SFZTextMenu | SFZFlexListMenu

Members

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFZGridMenu::CodeEnum | SFZGridMenu::SetFont | SFZGridMenu::SetTitleBackColor | SFZGridMenu::SetTitleForeColor | SFZGridMenu::SetDefaultItemBackColor | SFZGridMenu::SetDefaultItemForeColor | SFZGridMenu::SetSelBackColor | SFZGridMenu::SetSelForeColor | SFZGridMenu::SetSelBorderColor | SFZGridMenu::SetTitle | SFZGridMenu::SetTitleHeight | SFZGridMenu::SetSelect | SFZGridMenu::SetRowCol | SFZGridMenu::SetPadding | SFZGridMenu::SetDrawItemText | SFZGridMenu::SetDrawSelBorder | SFZGridMenu::SetItemAccessKey | SFYMenu::HandleOperateKey | SFXRGBColor | Type | Event | Key Event[SFEVT_KEY]

Description

Delete all items from this grid menu.

Reference

SFZGridMenu::Clear

Description

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

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

Reference

SFZGridMenu::InsertLast | SFZGridMenu::RemoveItem SFZGridMenu::Clear

Description

This function deletes all items from this grid menu.

Reference

SFZGridMenu::AppendItem | SFZGridMenu::RemoveItem

Return value

Number of columns.

Reference

SFZGridMenu::SetRowCol | SFZGridMenu::GetRowNumber

Description

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

Reference

SFZGridMenu::SetDefaultItemBackColor

Description

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

Reference

SFZGridMenu::SetDefaultItemForeColor

Description

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

Reference

SFZGridMenu::SetFont

Description

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

Reference

SFZGridMenu::SetItemAccessKey

Description

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

Reference

SFZGridMenu::SetItemBackColor | SFXRGBColor

Description

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

Reference

SFZGridMenu::AppendItem | SFZGridMenu::RemoveItem

Description

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

Reference

SFZGridMenu::SetItemForeColor | SFXRGBColor

Return value

Pointer to the image (SFBImageSmp) of the grid item. This image is displayed when the item is not selected.

Reference

SFZGridMenu::SetItemImage

Return value

Pointer to the image (SFBImageSmp) which is displayed when the item is selected of the grid item.

Reference

SFZGridMenu::SetItemSelImage

Return value

Text (SFXWideString) of the grid item.

Reference

SFZGridMenu::SetTitleBackColor

Return value

Amount of space (padding) between two neighbouring items of this grid menu.

Description

This function gets the padding size of this grid menu.

This padding region is filled in the background color of this grid menu set with the SFYWidget::SetBackgroundColor function.

Reference

SFZGridMenu::SetPadding | SFYWidget::SetBackgroundColor

Return value

Number of rows.

Reference

SFZGridMenu::SetRowCol SFZGridMenu::GetColNumber

Return value

Background color(SFXRGBColor) of selected item of this grid menu.

Description

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

Reference

SFZGridMenu::SetSelBackColor

Return value

Color (SFXRGBColor) to draw the border of currently selected grid item.

Description

This function gets the border color of currently selected item of this grid menu.

Reference

SFZGridMenu::SetSelBorderColor

Description

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

Reference

SFZGridMenu::SetTitleBackColor

Return value

Index of selected item.

Description

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

Reference

SFZGridMenu::SetSelect

Description

This function gets the menu title of this grid menu.

Reference

SFZGridMenu::SetTitle

Return value

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

Description

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

Reference

SFZGridMenu::SetTitleBackColor | SFXRGBColor

Return value

Foreground color (SFXRGBColor) to draw the menu title.

Description

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

Reference

SFZGridMenu::SetTitleForeColor | SFXRGBColor

Return value

Height of the menu title.

Description

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

Reference

SFZGridMenu::SetTitleHeight

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 SFZGridMenu::HandleBoundVirtual function is as follows:

/*protected virtual */Void SFZGridMenu::HandleBoundVirtual(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFZGridMenu::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 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 to send the result event of SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, index of item).

Internal Implementation

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

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

Reference

SFYMenu::SetOperateKey | 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 grid 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 SFZGridMenu::HandleRenderRequest function is as follows:

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

/*private */Void SFZGridMenu::DrawMenu(SFXGraphicsPtr graphics) const
{
    MenuItemPtr                                 item;
    SFXRectangle                                menuRect;
    SFXRectangle                                titleRect;
    SFXRectangle                                itemRect;
    SFXGrid                                     firstItemOffset;
    SInt32                                      row;
    SInt32                                      col;

    menuRect = GetLocalBound();
    titleRect = menuRect;
    titleRect.SetHeight(_titleHeight);
    menuRect.AddTop(_titleHeight);
    itemRect = menuRect;
    graphics->FillRectangle(titleRect, _color.titleBack);
    graphics->SetFont(_font);
    graphics->DrawSingleText(_title, titleRect.GetOrigin() + SFXGrid(2, 2), titleRect, _color.titleFore);
    if (_rownum == 0 || _colnum == 0) {
        return;
    }
    itemRect.SetSize(
        static_cast<SInt16>((menuRect.GetWidth() - (_colnum + 1) * _padding) / _colnum),
        static_cast<SInt16>((menuRect.GetHeight() - (_rownum + 1) * _padding) / _rownum)
    );
    firstItemOffset.Set(_padding + menuRect.GetX(), _padding + menuRect.GetY());
    itemRect.SetOrigin(firstItemOffset);
    for (row = 0; row < _rownum; ++row) {
        for (col = 0; col < _colnum; ++col) {
            if ((item = GetMenuItem(ToIndex(row, col))) == null) {
                break;
            }
            DrawItem(graphics, itemRect, item);
            itemRect.AddX(itemRect.GetWidth() + _padding);
        }
        itemRect.SnapLeft(firstItemOffset.GetX());
        itemRect.AddY(itemRect.GetHeight() + _padding);
    }
    return;
}// SFZGridMenu::DrawMenu //

/*private */Void SFZGridMenu::DrawItem(SFXGraphicsPtr graphics, SFXRectangleConstRef rect, MenuItemPtr item) const
{
    SFBImageSmp                                 image(item->image);
    SFXRectangle                                imageRect(rect);
    SFXRectangle                                textRect;
    SInt16                                      textHeight;
    SFXRGBColor                                 backColor(item->backColor);
    SFXRGBColor                                 foreColor(item->foreColor);

    if (item == GetMenuItem(_selectedItem)) {
        backColor.Set(_color.selBack);
        foreColor.Set(_color.selFore);
        image = item->selectedImage;
        if (_selBorder) {
            graphics->DrawRectangle(imageRect, _color.selBorder);
            imageRect.Deflate(1, 1);
            graphics->DrawRectangle(imageRect, _color.selBorder);
            imageRect.Deflate(1, 1);
        }
    }
    graphics->FillRectangle(imageRect, backColor);
    textRect = imageRect;
    if ((_drawText) && (item->text !="")) {
        textHeight = SFXGraphics::GetFontHeight(_font);
    }
    else {
        textHeight = 0;
    }
    if (image != null) {
        imageRect.SetHeight(imageRect.GetHeight() - textHeight);
        textRect.AddTop(imageRect.GetHeight());
    }
    if (image != null) {
        AEEImageInfo  info;
 SInt16 dx;
 SInt16 dy;
        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(image, imageRect.GetOrigin() + SFXGrid(dx, dy));
        }
    }
    graphics->SetFont(_font);
    graphics->DrawSingleText(item->text, textRect.AddOrigin(1, 1), foreColor, IDF_ALIGN_CENTER);
    return;
}// SFZGridMenu::DrawItem //

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:

Internal Implementation

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

/*protected virtual */Void SFZGridMenu::HandleSelectDownKey(Void)
{
    SInt32                                      row;
    SInt32                                      maxrow;
    SInt32                                      col;

    row = ToRow(_selectedItem);
    col = ToCol(_selectedItem, row);
    maxrow = ToRow(GetItemCount() - 1);
    ++row;
    if ((ToIndex(row, col) > GetItemCount() - 1) && (row >= maxrow)) {
        row = 0;
        ++col;
        if (col > _colnum - 1) {
            col = 0;
        }
    }
    else if ((ToIndex(row, col) > GetItemCount() - 1) && (col == _colnum)) {
        row = 0;
        col = 0;
    }
    SetSelect(ToIndex(row, col));
    return;
}// SFZGridMenu::HandleSelectDownKey //

/*public */inline SInt32 SFZGridMenu::ToIndex(SInt32 row, SInt32 col) const
{
    return row * _colnum + col;
}// SFZGridMenu::ToIndex //

/*public */inline SInt32 SFZGridMenu::ToRow(SInt32 index) const
{
    return index / _colnum;
}// SFZGridMenu::ToRow //

/*public */inline SInt32 SFZGridMenu::ToCol(SInt32 index) const
{
    return index - ToRow(index) * _colnum;
}// SFZGridMenu::ToCol //

/*public */inline SInt32 SFZGridMenu::ToCol(SInt32 index, SInt32 row) const
{
    return index - row * _colnum;
}// SFZGridMenu::ToCol //

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 SFZGridMenu::HandleSelectLeftKey function is as follows:

/*protected virtual */Void SFZGridMenu::HandleSelectLeftKey(Void)
{
    if (_selectedItem > 0) {
        --_selectedItem;
    }
    else if (_selectedItem == 0) {
        _selectedItem = GetItemCount() - 1;
    }
    Invalidate();
    return;
}// SFZGridMenu::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 SFZGridMenu::HandleSelectRightKey function is as follows:

/*protected virtual */Void SFZGridMenu::HandleSelectRightKey(Void)
{
    if (_selectedItem < GetItemCount() - 1) {
        ++_selectedItem;
    }
    else if (_selectedItem == GetItemCount() - 1) {
        _selectedItem = 0;
    }
    Invalidate();
    return;
}// SFZGridMenu::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.

The default implementation is as follows:

Internal Implementation

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

/*protected virtual */Void SFZGridMenu::HandleSelectUpKey(Void)
{
    SInt32                                      row;
    SInt32                                      maxrow;
    SInt32                                      col;

    row = ToRow(_selectedItem);
    col = ToCol(_selectedItem, row);
    maxrow = ToRow(GetItemCount() - 1);
    --row;
    if (row < 0) {
        row = maxrow;
        col = col - 1;
        if (col < 0) {
            col = _colnum - 1;
        }
        if (ToIndex(row, col) > GetItemCount() - 1) {
            row = (row - 1);
        }
    }
    SetSelect(ToIndex(row, col));
    return;
}// SFZGridMenu::HandleSelectUpKey //

/*public */inline SInt32 SFZGridMenu::ToIndex(SInt32 row, SInt32 col) const
{
    return row * _colnum + col;
}// SFZGridMenu::ToIndex //

/*public */inline SInt32 SFZGridMenu::ToRow(SInt32 index) const
{
    return index / _colnum;
}// SFZGridMenu::ToRow //

/*public */inline SInt32 SFZGridMenu::ToCol(SInt32 index) const
{
    return index - ToRow(index) * _colnum;
}// SFZGridMenu::ToCol //

/*public */inline SInt32 SFZGridMenu::ToCol(SInt32 index, SInt32 row) const
{
    return index - row * _colnum;
}// SFZGridMenu::ToCol //

Reference

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

Reference

SFZGridMenu::InsertFirst | SFZGridMenu::InsertLast | SFZGridMenu::Remove

Return value

Description

This function inserts the specified item at the head.

Reference

SFZGridMenu::Insert | SFZGridMenu::InsertLast | SFZGridMenu::RemoveFirst

Return value

Description

This function inserts the specified item at the tail.

Reference

SFZGridMenu::Insert | SFZGridMenu::InsertFirst | SFZGridMenu::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:

SFZGridMenuSmp _gridmenu;
SFCError error;

if ((_gridmenu = SFZGridMenu::NewInstance(&error)) != null) {

    ...
}

Description

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

Reference

SFZGridMenu::Clear | SFZGridMenu::Remove | SFZGridMenu::RemoveLast | SFZGridMenu::Insert

Description

This function removes the first item from this grid menu.

Reference

SFZGridMenu::Clear | SFZGridMenu::Remove | SFZGridMenu::RemoveLast | SFZGridMenu::InsertFirst

Description

This function removes the item at the specified index from this grid 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 SFZGridMenu::Remove function instead.

Reference

SFZGridMenu::Remove | SFZGridMenu::AppendItem

Description

This function removes the last item from this grid menu.

Reference

SFZGridMenu::Clear | SFZGridMenu::Remove | SFZGridMenu::RemoveFirst | SFZGridMenu::InsertLast

Description

This function sets the default background color(SFXRGBColor) of unselected item of this grid 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 SFZGridMenu::SetItemBackColor function. If you want to make the background color of unselected items be the same one, the background color needs to be set using this function. The SFZGridMenu::SetItemBackColor function to set it individually is not recommended. However, the background color of selected item is always the one set with the SFZGridMenu::SetSelBackColor function.

Reference

SFZGridMenu::GetDefaultItemBackColor | SFZGridMenu::SetDefaultItemForeColor | SFZGridMenu::SetItemBackColor | SFZGridMenu::SetSelBackColor | SFXRGBColor

Description

This function sets the default foreground color(SFXRGBColor) to draw the text of unselected item of this grid 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 SFZGridMenu::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 SFZGridMenu::SetItemForeColor function to set it individually is not recommended. However, the foreground color of selected item is always the one set with the SFZGridMenu::SetSelForeColor function.

Reference

SFZGridMenu::GetDefaultItemForeColor | SFZGridMenu::SetDefaultItemBackColor | SFZGridMenu::SetItemForeColor | SFZGridMenu::SetSelForeColor | SFXRGBColor

Description

This function sets the "draw-item" flag indicating whether or not to draw the text of item of this grid menu to the specified value. If you want to draw the text of item of this grid menu, set "true" to the "draw-item" flag. Otherwise, set "false".

Default: "true"(The text of the item is drawn.)

Description

This function sets the "draw-border" flag indicating whether or not to draw the border of selected item of this grid menu to the specified value. If you want to draw the text of item of this grid menu, set "true" to the "draw-item" flag. Otherwise, set "false".

Default: "true"(The border of selected item is drawn.)

Description

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

Default: AEE_FONT_NORMAL.

Reference

SFZGridMenu::GetFont

Description

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

Reference

SFZGridMenu::GetItemAccessKey

Description

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

Default: The default background color set with the SFZGridMenu::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 SFZGridMenu::SetItemForeColor.

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

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

Reference

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

Description

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

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

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

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

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

Reference

SFZGridMenu::SetDefaultItemForeColor | SFZGridMenu::GetItemForeColor | SFZGridMenu::SetItemBackColor | SFZGridMenu::SetSelForeColor | SFZGridMenu::SetSelBackColor | SFXRGBColor

Description

This function sets the image of the specified grid item to the specified value. This image is displayed when the item is not selected.

Reference

SFZGridMenu::GetItemImage

Description

This function sets the image of the specified selected grid item to the specified value.

Reference

SFZGridMenu::GetItemSelImage

Description

This function sets the text of the specified grid item to the specified value.

Reference

SFZGridMenu::GetItemText

Description

This function sets the padding size of this grid menu to the specified value, which is the amount of space (padding) between two neighbouring items of this grid menu. [pixels]

If this value is greater than 0, the grid lines are drawn in the same color with the background color of this grid menu.

Default: 0 pixel.

Reference

SFZGridMenu::GetItemForeColor

Description

This function sets the numbers of rows and columns of this grid menu to specified values. The size of each item is calculated based on the real region of this grid menu and those two values.

Default: 4 for the number of rows and 3 for the number of columns

Reference

SFZGridMenu::GetRowNumber | SFZGridMenu::GetColNumber | Real Region

Description

This function sets the background color(SFXRGBColor) of selected item of this grid 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 SFZGridMenu::SetSelForeColor.

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

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

Reference

SFZGridMenu::GetSelBackColor

Description

This function sets the border color(SFXRGBColor) of this grid menu to the specified value, in which color the border of currently selected item is drawn.

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

Reference

SFZGridMenu::GetSelBorderColor

Description

This function sets the foreground color(SFXRGBColor) of selected item of this grid 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 SFZGridMenu::SetSelBackColor.

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

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

Reference

SFZGridMenu::GetSelForeColor | SFZGridMenu::SetItemForeColor | SFZGridMenu::SetItemBackColor | SFZGridMenu::SetSelBackColor | SFXRGBColor

Description

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

Reference

SFZGridMenu::GetSelect

Description

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

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

Reference

SFZGridMenu::GetTitle

Description

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

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

Reference

SFZGridMenu::GetTitleBackColor | SFXRGBColor

Description

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

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

Reference

SFZGridMenu::GetTitleForeColor | SFXRGBColor

Description

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

Default: font height + 4 [pixels]

Reference

SFZGridMenu::GetTitleHeight

Reference

SFYResponder::GetType | SFYResponder::SetType