Initial commit

engines/ultima/ultima4/views/menuitem.h

@@ -0,0 +1,146 @@
+/* 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_MENUITEM_H
+#define ULTIMA4_VIEWS_MENUITEM_H
+
+#include "common/str.h"
+#include "ultima/shared/std/containers.h"
+
+namespace Ultima {
+namespace Ultima4 {
+
+class MenuEvent;
+
+/**
+ * custom output types for with menu items that need
+ * to perform special calculations before displaying
+ * its associated value
+ */
+enum menuOutputType {
+	MENU_OUTPUT_INT,
+	MENU_OUTPUT_GAMMA,
+	MENU_OUTPUT_SHRINE,
+	MENU_OUTPUT_SPELL,
+	MENU_OUTPUT_VOLUME,
+	MENU_OUTPUT_REAGENT
+};
+
+class MenuItem {
+public:
+	/**
+	 * MenuItem class
+	 */
+	MenuItem(const Common::String &text, short x, short y, int shortcutKey = -1);
+	virtual ~MenuItem() {}
+
+	virtual void activate(MenuEvent &event) {}
+
+	// Accessor Methods
+	int getId() const;
+	short getX() const;
+	short getY() const;
+	int getScOffset() const;
+
+	virtual Common::String getText() const;
+	bool isHighlighted() const;
+	bool isSelected() const;
+	bool isVisible() const;
+	bool hasShortcutKey(int key) const;
+	bool getClosesMenu() const;
+
+	void setId(int id);
+	void setX(int x);
+	void setY(int y);
+	void setText(const Common::String &text);
+	void setHighlighted(bool h = true);
+	void setSelected(bool s = true);
+	void setVisible(bool v = true);
+	void addShortcutKey(int shortcutKey);
+	void setClosesMenu(bool closesMenu);
+
+protected:
+	int _id;
+	short _x, _y;
+	Common::String _text;
+	bool _highlighted;
+	bool _selected;
+	bool _visible;
+	int _scOffset;
+	Common::Array<int> _shortcutKeys;
+	bool _closesMenu;
+};
+
+/**
+ * A menu item that toggles a boolean value, and displays the current
+ * setting as part of the text.
+ */
+class BoolMenuItem : public MenuItem {
+public:
+	BoolMenuItem(const Common::String &text, short xp, short yp, int shortcutKey, bool *val);
+
+	BoolMenuItem *setValueStrings(const Common::String &onString, const Common::String &offString);
+
+	void activate(MenuEvent &event) override;
+	Common::String getText() const override;
+
+protected:
+	bool *_val;
+	Common::String _on, _off;
+};
+
+/**
+ * A menu item that cycles through a list of possible Common::String values, and
+ * displays the current setting as part of the text.
+ */
+class StringMenuItem : public MenuItem {
+public:
+	StringMenuItem(const Common::String &text, short xp, short yp, int shortcutKey, Common::String *val, const Std::vector<Common::String> &validSettings);
+
+	void activate(MenuEvent &event) override;
+	Common::String getText() const override;
+
+protected:
+	Common::String *_val;
+	Std::vector<Common::String> _validSettings;
+};
+
+/**
+ * A menu item that cycles through a list of possible integer values,
+ * and displays the current setting as part of the text.
+ */
+class IntMenuItem : public MenuItem {
+public:
+	IntMenuItem(const Common::String &text, short xp, short yp, int shortcutKey, int *val, int min, int max, int increment, menuOutputType output = MENU_OUTPUT_INT);
+
+	void activate(MenuEvent &event) override;
+	Common::String getText() const override;
+
+protected:
+	int *_val;
+	int _min, _max, _increment;
+	menuOutputType _output;
+};
+
+} // End of namespace Ultima4
+} // End of namespace Ultima
+
+#endif