scummvm/gui/PopUpWidget.h
2005-10-18 01:30:26 +00:00

83 lines
2.4 KiB
C++

/* ScummVM - Scumm Interpreter
* Copyright (C) 2002-2005 The ScummVM project
*
* 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.
*
* $Header$
*/
#ifndef POPUPWIDGET_H
#define POPUPWIDGET_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:
const WidgetSize _ws;
EntryList _entries;
int _selectedItem;
String _label;
uint _labelWidth;
public:
PopUpWidget(GuiObject *boss, int x, int y, int w, int h, const String &label, uint labelWidth = 0, WidgetSize ws = kDefaultWidgetSize);
void handleMouseDown(int x, int y, int button, int clickCount);
void appendEntry(const String &entry, uint32 tag = (uint32)-1);
void clearEntries();
/** 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; }
protected:
void drawWidget(bool hilite);
};
} // End of namespace GUI
#endif