継承図

協調図

解説

■ 仕様と使い方

SFZGridMenu は、 マトリックス形式のメニュー（グリッドメニュー）のユーザーインターフェースを 提供するクラスです。

グリッドメニューのセルは、すべて同じサイズです。 ローカル領域のサイズと、 行数と列数から自動的に決定されます。

グリッドメニューのデザインは、用意された様々な関数で変更可能です。

テキストやイメージを項目に設定できます。

SFZGridMenu クラスは、 グリッドメニューのデザイン用に境界線描画フラグ、 項目とタイトルの色、タイトルの高さ、パディングサイズ、行数と列数、 フォントなどのプロパティを設定する関数を提供します。

また、項目にテキストやイメージを設定する関数や、 タイトルテキストを設定する関数も提供します。

メニューに項目を追加するには、 SFZGridMenu::Insert / SFZGridMenu::InsertFirst / SFZGridMenu::InsertLast 関数を使います。 メニューから項目を削除するには、 SFZGridMenu::Remove / SFZGridMenu::RemoveFirst / SFZGridMenu::RemoveLast 関数を使います。

SFZGridMenu::Clear 関数を呼び出すと、すべての項目がメニューから削除されます。

選択キーは、 SFYMenu::SetSelectUpKey / SFYMenu::SetSelectDownKey / SFYMenu::SetSelectRightKey / SFYMenu::SetSelectLeftKey 関数を使用して設定します。 デフォルトでは、↑キー、↓キー、→キー、←キーが上下左右の選択キーとして割り当てられています。

デフォルトの実装では、 グリッドメニュー[SFZGridMenu]は 下記の結果イベント[SFEVT_RESPONDER_RESULT]を受信します。

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

ハンドラを登録しない場合、上記結果イベントを受信するとデフォルトのハンドラが起動されます。 デフォルトのハンドラは、メニューを閉じる処理だけを行います。

操作キーは、SFYMenu::SetOperateKey 関数を使用して設定します。 デフォルトでは、セレクトキーが操作キーとして割り当てられています。

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

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

	タイマーのキャンセル
	SFYMenu::ScheduleTimer 関数で設定したタイマー処理は、 操作キーまたは ESCAPE キーを押したときに自動的にキャンセルされます。 サスペンド時もタイマーはキャンセルされますが、 レジューム時に SFYMenu::ScheduleTimer 関数の引数に指定した時間でタイマー処理は再開されます。 メニューの有効状態が無効になったときもタイマーはキャンセルされます。

参照: 結果イベント[SFEVT_RESPONDER_RESULT] | SFZGridMenu::HandleOperateKey | SFZGridMenu::HandleSelectUpKey | SFZGridMenu::HandleSelectDownKey | SFZGridMenu::HandleSelectRightKey | SFZGridMenu::HandleSelectLeftKey

以下は、グリッドメニューを利用するためのサンプルコードです。

	注意
	ここでは簡略化のため、エラー処理が省略されています。

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

     // ウインドウを生成する
     _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));

     // グリッドメニューを生成する
     SFZGridMenuSmp _gridmenu = SFZGridMenu::NewInstance(&error);

     // 結果イベントを受信する結果ハンドラをグリッドメニューに登録する	
     _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));

     SFBShellSmp  shell;
     SFBImageSmp  image;
     SFBImageSmp  image1;

     shell = SFBShell::GetInstance();
     SInt32 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->InsertLast(SFXWideString::Format("%d", i), image, image1);
     }

     _gridmenu->SetDrawItemText(true);

     return;
}

// 結果イベントを受信する結果ハンドラ	
XANDLER_IMPLEMENT_VOIDRESULT(USRApplication, OnGridMenu, invoker, reason, result)
{
    // invoker にはグリッドメニューが渡される
    // reason には結果イベントの P16 値が渡される


    switch (reason) {

        case SFP16_RESULT_OK:  // 操作キー押下時
            
            // result には選択された項目のインデックスが渡される

            if (result == 0) {       // 1 番目の項目が選択されたとき

                // ...（省略）...

            }
            else if (result == 1) {  // 2 番目の項目が押されたときの処理

                // ...（省略）...

            }
            else if (result == 2) {  // 3 番目の項目が押されたときの処理

                // ...（省略）...

            }

            // ...（省略）...
            break;

        case SFP16_RESULT_ESCAPE:  // ESCAPE キー押下時、または ScheduleTimer 関数で設定した時間が経過した時

            // result には 0 が渡される

            // グリッドメニューを閉じる
            invoker->Terminate();  
            // "_gridmenu->Terminate();" と記述しても良い

            break;
    }

    return;
}

実行結果:

参照

グリッドメニュー[SFZGridMenu] | SFYMenu | SFZTextMenu | SFZFlexListMenu

メンバ

解説

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

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

内部実装

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

/*protected */SFZGridMenu::SFZGridMenu(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xDD, 0xDD, 0xDD}}},   // glay:        TitleBack
        {{{0x00, 0x00, 0x00, 0x00}}},   // black:       TitleFore,  ItemFore
        {{{0x00, 0xFF, 0xFF, 0xFF}}},   // white:       SelFore,    ItemBack
        {{{0x00, 0x11, 0x22, 0xBB}}}    // blue:        SelBack,    SelBorader
    };
    static SFXEventRange::AtomRecConst          range[] = {
        {SFEVT_KEY, SFEVT_KEY, SFP16_BEGIN, SFP16_END}
    };
    SFYHandler::RuleRec                         rule[lengthof(range)];

    if (static_try()) {
        SetType(CODE_TYPE);
        rule[0].spp = XANDLER_FUNCTION(OnAccessKey);
        rule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(range), rule, lengthof(range)));
        if (static_try()) {
            SetType(CODE_TYPE);
            _font = AEE_FONT_NORMAL;
            _color.titleBack.Set(rgb[0]);
            _color.titleFore.Set(rgb[1]);
            _color.itemBack.Set(rgb[2]);
            _color.itemFore.Set(rgb[1]);
            _color.selFore.Set(rgb[1]);
            _color.selBack.Set(rgb[2]);
            _color.selBorder.Set(rgb[3]);
            _title        = "";
            _titleHeight  = SFXGraphics::GetFontHeight(_font) + TITLE_MARGIN;
            _selectedItem = 0;
            _rownum       = 4;
            _colnum       = 3;
            _padding      = 0;
            _drawText     = true;
            _selBorder    = true;
        }
    }
}// SFZGridMenu::SFZGridMenu //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZGridMenu, OnAccessKey, invoker, event)
{
    MenuItemPtr                                 item;
    SInt32                                      i;
    Bool                                        result(false);
    unused(invoker);

    for (i = 0; i < GetItemCount(); ++ i) {
        if ((item = GetMenuItem(i)) != null) {
            if (item->key == event.GetP16()) {
                SetSelect(i);
                Invalidate();
                HandleOperateKey();
                result = true;
                break;
            }
        }
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZGridMenu, OnAccessKey) //

参照

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 | タイプ | イベント | キーイベント[SFEVT_KEY]

解説

このグリッドメニューからすべての項目を削除します。

内部実装

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

/*protected virtual */SFZGridMenu::~SFZGridMenu(Void)
{
    Clear();
}// SFZGridMenu::~SFZGridMenu //

参照

SFZGridMenu::Clear

解説

この関数は、メニューに項目を追加します。

追加された項目はメニューの最後の項目となります。

	廃止予定
	この関数は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。 この関数の代わりに SFZGridMenu::InsertLast 関数を利用することを推奨します。

参照

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

解説

この関数は、メニューからすべての項目を削除します。

参照

SFZGridMenu::AppendItem | SFZGridMenu::RemoveItem

戻り値

グリッドメニューの列数。

解説

この関数は、グリッドメニューの列数を取得します。

参照

SFZGridMenu::SetRowCol SFZGridMenu::GetRowNumber

戻り値

非選択項目のデフォルトの背景色。

解説

この関数は、非選択項目のデフォルトの背景色を取得します。

参照

SFZGridMenu::SetDefaultItemBackColor | SFXRGBColor

戻り値

非選択項目のデフォルトの前景色（テキストを描画する色）。

解説

この関数は、非選択項目のデフォルトの前景色（テキストを描画する色）を取得します。

参照

SFZGridMenu::SetDefaultItemForeColor | SFXRGBColor

戻り値

グリッドメニューのタイトルと項目のフォント。

解説

この関数は、グリッドメニューのタイトルと項目のフォントを取得します。

参照

SFZGridMenu::SetFont | BREW API AEEFont

戻り値

指定された項目のアクセスキー。アクセスキーが設定されていない場合、AVK_UNDEFINED。

解説

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

参照

SFZGridMenu::SetItemAccessKey | AVKType

戻り値

指定された項目の非選択時の背景色。

解説

この関数は、指定された項目の非選択時の背景色を取得します。

参照

SFZGridMenu::SetItemBackColor | SFXRGBColor

戻り値

項目の数。

解説

この関数は、項目の数を取得します。

参照

SFZGridMenu::AppendItem | SFZGridMenu::RemoveItem

戻り値

指定された項目の非選択時の前景色（テキストを描画する色）。

解説

この関数は、指定された項目の非選択時の前景色（テキストを描画する色）を取得します。

参照

SFZGridMenu::SetItemForeColor | SFXRGBColor

戻り値

指定された項目に設定されたアイコン画像。

解説

この関数は、指定された項目のアイコン画像を取得します。

参照

SFZGridMenu::SetItemImage

戻り値

指定された項目の選択されたときの画像。

解説

この関数は、指定された項目の選択されたときの画像を取得します。

参照

SFZGridMenu::SetItemSelImage

戻り値

指定された項目に設定されている文字列。

解説

この関数は、指定された項目の文字列を取得します。

参照

SFZGridMenu::SetItemText

戻り値

グリッドメニューのパディング（連続する項目間のスペース）の量。

解説

この関数は、パディングサイズを取得します。

	注意
	このパディング領域は、SFYWidget::SetBackgroundColor 関数によって設定されたグリッドメニューの背景色で塗り潰されます。

参照

SFZGridMenu::SetPadding | SFYWidget::SetBackgroundColor

戻り値

グリッドメニューの行数。

解説

この関数は、グリッドメニューの行数を取得します。

参照

SFZGridMenu::SetRowCol SFZGridMenu::GetColNumber

戻り値

選択項目の背景色。

解説

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

参照

SFZGridMenu::SetSelBackColor | SFXRGBColor

戻り値

選択された項目の境界線を描画する色。

解説

この関数は、選択された項目の境界線を描画する色を取得します。

参照

SFZGridMenu::SetSelBorderColor | SFXRGBColor

戻り値

選択された項目のる前景色（テキストを描画する色）。

解説

この関数は、選択項目の前景色（テキストを描画する色）を取得します。

参照

SFZGridMenu::SetSelForeColor | SFXRGBColor

戻り値

選択された項目のインデックス。

解説

この関数は、選択された項目のインデックスを取得します。

参照

SFZGridMenu::SetSelect

戻り値

メニュータイトル（文字列）。

解説

この関数は、タイトル（文字列）を取得します。

参照

SFZGridMenu::SetTitle

戻り値

タイトルの背景色。

解説

この関数は、タイトルの背景色を取得します。

参照

SFZGridMenu::SetTitleBackColor | SFXRGBColor

戻り値

タイトルの前景色（テキストを描画する色）。

解説

この関数は、タイトルの前景色（テキストを描画する色）を取得します。

参照

SFZGridMenu::SetTitleForeColor | SFXRGBColor

戻り値

タイトルの高さ。

解説

この関数は、タイトルの高さを取得します。

参照

SFZGridMenu::SetTitleHeight

解説

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

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、仮想領域を実領域に一致させます。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

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

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

参照

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

解説

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

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

デフォルトの実装では、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 選択された項目 ID)] を送信します。

内部実装

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

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

参照

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

解説

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

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

デフォルトの実装は、グリッドメニューを描画します。

レスポンダの描画手順

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

内部実装

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

/*protected virtual */Void 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 //

参照

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | SFXEvent | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | イベントループ | レスポンダツリー

解説

この関数は、SFYMenu::SetSelectDownKey 関数によって設定された DOWN キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

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

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

内部実装

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

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

参照

SFYMenu::SetSelectDownKey | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、SFYMenu::SetSelectLeftKey 関数によって設定された LEFT キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

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

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

内部実装

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

/*protected virtual */Void SFZGridMenu::HandleSelectLeftKey(Void)
{
    if (_selectedItem > 0) {
        --_selectedItem;
    }
    else if (_selectedItem == 0) {
        _selectedItem = GetItemCount() - 1;
    }
    Invalidate();
    return;
}// SFZGridMenu::HandleSelectLeftKey //

参照

SFYMenu::SetSelectLeftKey | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、SFYMenu::SetSelectRightKey 関数によって設定された RIGHT キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

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

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

内部実装

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

/*protected virtual */Void SFZGridMenu::HandleSelectRightKey(Void)
{
    if (_selectedItem < GetItemCount() - 1) {
        ++_selectedItem;
    }
    else if (_selectedItem == GetItemCount() - 1) {
        _selectedItem = 0;
    }
    Invalidate();
    return;
}// SFZGridMenu::HandleSelectRightKey //

参照

SFYMenu::SetSelectRightKey | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、 SFYMenu::SetSelectUpKey 関数によって設定された UP キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

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

内部実装

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

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

参照

SFYMenu::SetSelectUpKey | SFXEvent | キーイベント[SFEVT_KEY]

戻り値

解説

この関数は、メニューに項目を挿入します。

インデックスが 0 以下の場合は先頭に挿入されます。

インデックスが項目数以上の場合は末尾に挿入されます。

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

参照

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

戻り値

解説

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

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

参照

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

戻り値

解説

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

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

参照

SFZGridMenu::Insert | SFZGridMenu::InsertFirst | SFZGridMenu::RemoveLast

引数

戻り値

解説

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

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、4 行 3 列のグリッドメニューのインスタンスを生成するためのコードです。

// グリッドメニューのインスタンスを生成する
SFCError error;
SFZGridMenuSmp _gridmenu;

if ((_gridmenu = SFZGridMenu::NewInstance(&error)) != null) {
    _menu->SetRowCol(4, 3);
    // ...
}

解説

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

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

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

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

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

参照

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

解説

この関数は、メニューの先頭にある項目を削除します。

参照

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

解説

この関数は、メニューから指定された項目を削除します。

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

	廃止予定
	この関数は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。 この関数の代わりに SFZGridMenu::Remove 関数を利用することを推奨します。

参照

SFZGridMenu::Remove | SFZGridMenu::AppendItem | SFZGridMenu::Clear

解説

この関数は、メニューの末尾にある項目を削除します。

参照

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

解説

この関数は、非選択項目のデフォルトの背景色を設定します。

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

	非選択項目の背景色
	非選択項目の背景色は、SFZGridMenu::SetItemBackColor 関数を使用して項目毎に変えることが可能です。 すべての項目の背景色を同じ色にしたい場合は、 この関数を使用してデフォルトの背景色を指定し、 個別に背景色を指定できる SFZGridMenu::SetItemBackColor 関数は使用しません。 選択項目の背景は、 常に SFZGridMenu::SetSelBackColor 関数で指定した色で描画されます。

参照

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

解説

この関数は、非選択項目のデフォルトの前景色（テキストを描画する色）を設定します。

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

	非選択項目の前景色
	非選択項目の前景色は、SFZGridMenu::SetItemForeColor 関数を使用して項目毎に変えることが可能です。 すべての項目の前景色を同じ色にしたい場合は、 この関数を使用してデフォルトの前景色を指定し、 個別に前景色を指定できる SFZGridMenu::SetItemForeColor 関数は使用しません。 選択項目のテキストは、 SFZGridMenu::SetSelForeColor 関数で指定した色で描画されます。

参照

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

解説

この関数は、項目のテキストを描画するかどうかを設定します。

項目のテキストを描画する場合は true、 しない場合は false を設定します。

デフォルト値: true（項目のテキストは描画されます）

解説

この関数は、選択された項目の境界線を描画するかどうかを設定します。

選択された項目の境界線を描画する場合は true、描画しない場合は false を設定します。

デフォルト値: true（選択された項目の境界線は描画されます）

解説

この関数は、メニューのタイトルや項目のテキストを描画するためのフォントを設定します。

デフォルト値: AEE_FONT_NORMAL

参照

SFZGridMenu::GetFont | BREW API AEEFont

戻り値

解説

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

参照

SFZGridMenu::GetItemAccessKey | AVKType

戻り値

解説

この関数は、指定された項目の非選択時の背景色を設定します。

デフォルト値: SFZGridMenu::SetDefaultItemBackColor 関数で設定されている色。 SFZGridMenu::SetDefaultItemBackColor 関数でデフォルトの背景色を設定していない場合は、SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00)[白色]。

	非選択項目の前景色
	SFZGridMenu::SetItemForeColor 関数の解説を参照してください。

	選択項目の前景色
	SFZGridMenu::SetSelForeColor 関数の解説を参照してください。

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

参照

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

戻り値

解説

この関数は、指定された項目の非選択時の前景色（テキストを描画する色）を設定します。

デフォルト値: SFZGridMenu::SetDefaultItemForeColor 関数で設定されている色。 SFZGridMenu::SetDefaultItemForeColor 関数でデフォルトの前景色を設定していない場合は、 SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]。

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

	選択項目の前景色
	SFZGridMenu::SetSelForeColor 関数の解説を参照してください。

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

参照

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

解説

この関数は、指定された項目にアイコン画像を設定します。

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

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

参照

SFZGridMenu::GetItemImage

戻り値

解説

この関数は、指定された項目に選択されたときの画像を設定します。

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

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

参照

SFZGridMenu::GetItemSelImage

戻り値

解説

この関数は、指定された項目にテキストを設定します。

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

参照

SFZGridMenu::GetItemText

解説

この関数は、グリッドメニューのパディング（連続する項目間のスペース）の量を設定します。

	注意
	このパディング領域は、SFYWidget::SetBackgroundColor 関数によって設定されたグリッドメニューの背景色で塗り潰されます。

デフォルト値: 0

参照

SFZGridMenu::GetPadding

解説

この関数は、グリッドメニューの行と列の数を設定します。

各項目のサイズは、グリッドメニューの実領域のサイズと、行と列の数から自動的に決まります。

デフォルト値: 4 行 3 列

参照

SFZGridMenu::GetRowNumber | SFZGridMenu::GetColNumber

解説

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

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

	選択項目の前景色
	SFZGridMenu::SetSelForeColor 関数の解説を参照してください。

	非選択項目の前景色
	SFZGridMenu::SetItemForeColor 関数の解説を参照してください。

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

参照

SFZGridMenu::GetSelBackColor | SFZGridMenu::SetSelForeColor | SFZGridMenu::SetItemForeColor | SFZGridMenu::SetItemBackColor | SFXRGBColor

解説

この関数は、選択された項目の境界線を描画する色を設定します。

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

参照

SFZGridMenu::GetSelBorderColor | SFXRGBColor

解説

この関数は、 選択項目の前景色（テキストを描画する色）を設定します。

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

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

	非選択項目の前景色
	SFZGridMenu::SetItemForeColor 関数の解説を参照してください。

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

参照

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

解説

この関数は、指定された項目を選択状態（選択されている状態）に設定します。

参照

SFZGridMenu::GetSelect

解説

この関数は、タイトル（文字列）を設定します。

デフォルト値: ""[空文字列]

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

参照

SFZGridMenu::GetTitle

解説

この関数は、 メニューのタイトル領域の背景色を設定します。

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

参照

SFZGridMenu::GetTitleBackColor | SFXRGBColor

解説

この関数は、 タイトルの前景色（テキストを描画する色）を設定します。

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

参照

SFZGridMenu::GetTitleForeColor | SFXRGBColor

解説

この関数は、メニュータイトルの高さを設定します。

デフォルト値: フォントの高さ + 4

	注意
	タイトルを表示しない場合は、0 に設定します。

参照

SFZGridMenu::GetTitleHeight