menu.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ULTIMA4_VIEWS_MENU_H
#define ULTIMA4_VIEWS_MENU_H

#include "ultima/ultima4/events/event_handler.h"
#include "ultima/ultima4/views/menuitem.h"
#include "ultima/ultima4/core/observable.h"
#include "ultima/ultima4/core/types.h"
#include "ultima/shared/std/containers.h"

namespace Ultima {
namespace Ultima4 {

class Menu;
class TextView;

class MenuEvent {
public:
    enum Type {
        ACTIVATE,
        INCREMENT,
        DECREMENT,
        SELECT,
        RESET
    };

    MenuEvent(const Menu *menu, Type type, const MenuItem *item = nullptr) {
        this->_menu = menu;
        this->_type = type;
        this->_item = item;
    }

    const Menu *getMenu() {
        return _menu;
    }
    Type getType() {
        return _type;
    }
    const MenuItem *getMenuItem() {
        return _item;
    }

private:
    const Menu *_menu;
    Type _type;
    const MenuItem *_item;
};

class Menu : public Observable<Menu *, MenuEvent &> {
public:
    typedef Common::List<MenuItem *> MenuItemList;

public:
    Menu();
    ~Menu();

    void removeAll();

    void add(int id, Common::String text, short x, short y, int shortcutKey = -1);

    MenuItem *add(int id, MenuItem *item);
    void addShortcutKey(int id, int shortcutKey);
    void setClosesMenu(int id);

    MenuItemList::iterator getCurrent();

    void setCurrent(MenuItemList::iterator i);
    void setCurrent(int id);
    void show(TextView *view);

    bool isVisible();

    void next();

    void prev();

    void highlight(MenuItem *item);

    MenuItemList::iterator begin();

    MenuItemList::iterator end();

    MenuItemList::iterator begin_visible();

    void reset(bool highlightFirst = true);

    MenuItemList::iterator getById(int id);

    MenuItem *getItemById(int id);

    void activateItemAtPos(TextView *view, const Common::Point &pt);

    void activateItem(int id, MenuEvent::Type action);

    bool activateItemByShortcut(int key, MenuEvent::Type action);

    bool getClosed() const;

    void setClosed(bool closed);

    void setTitle(const Common::String &text, int x, int y);

private:
    MenuItemList _items;
    MenuItemList::iterator _current;
    MenuItemList::iterator _selected;
    bool _closed;
    Common::String _title;
    int _titleX, _titleY;
};

} // End of namespace Ultima4
} // End of namespace Ultima

#endif