aboutsummaryrefslogtreecommitdiff
path: root/gui/widgets/popup.h
diff options
context:
space:
mode:
Diffstat (limited to 'gui/widgets/popup.h')
-rw-r--r--gui/widgets/popup.h91
1 files changed, 91 insertions, 0 deletions
diff --git a/gui/widgets/popup.h b/gui/widgets/popup.h
new file mode 100644
index 0000000000..b3b3e30837
--- /dev/null
+++ b/gui/widgets/popup.h
@@ -0,0 +1,91 @@
+/* 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 2
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef GUI_WIDGETS_POPUP_H
+#define GUI_WIDGETS_POPUP_H
+
+#include "gui/widget.h"
+#include "common/str.h"
+#include "common/array.h"
+
+namespace GUI {
+
+enum {
+ kPopUpItemSelectedCmd = 'POPs'
+};
+
+/**
+ * Popup or dropdown widget which, when clicked, "pop up" a list of items and
+ * lets the user pick on of them.
+ *
+ * Implementation wise, when the user selects an item, then a kPopUpItemSelectedCmd
+ * is broadcast, with data being equal to the tag value of the selected entry.
+ */
+class PopUpWidget : public Widget, public CommandSender {
+ friend class PopUpDialog;
+ typedef Common::String String;
+
+ struct Entry {
+ String name;
+ uint32 tag;
+ };
+ typedef Common::Array<Entry> EntryList;
+protected:
+ EntryList _entries;
+ int _selectedItem;
+
+ int _leftPadding;
+ int _rightPadding;
+
+public:
+ PopUpWidget(GuiObject *boss, const String &name, const char *tooltip = 0);
+
+ void handleMouseDown(int x, int y, int button, int clickCount);
+ void handleMouseWheel(int x, int y, int direction);
+
+ void appendEntry(const String &entry, uint32 tag = (uint32)-1);
+ void clearEntries();
+ int numEntries() { return _entries.size(); }
+
+ /** Select the entry at the given index. */
+ void setSelected(int item);
+
+ /** Select the first entry matching the given tag. */
+ void setSelectedTag(uint32 tag);
+
+ int getSelected() const { return _selectedItem; }
+ uint32 getSelectedTag() const { return (_selectedItem >= 0) ? _entries[_selectedItem].tag : (uint32)-1; }
+// const String& getSelectedString() const { return (_selectedItem >= 0) ? _entries[_selectedItem].name : String::emptyString; }
+
+ void handleMouseEntered(int button) { setFlags(WIDGET_HILITED); draw(); }
+ void handleMouseLeft(int button) { clearFlags(WIDGET_HILITED); draw(); }
+
+ virtual void reflowLayout();
+protected:
+ void drawWidget();
+};
+
+} // End of namespace GUI
+
+#endif