Initial commit
This commit is contained in:
208
gui/widgets/list.h
Normal file
208
gui/widgets/list.h
Normal file
@@ -0,0 +1,208 @@
|
||||
/* 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 GUI_WIDGETS_LIST_H
|
||||
#define GUI_WIDGETS_LIST_H
|
||||
|
||||
#include "gui/widgets/editable.h"
|
||||
#include "common/str.h"
|
||||
|
||||
#include "gui/ThemeEngine.h"
|
||||
|
||||
namespace GUI {
|
||||
|
||||
class ScrollBarWidget;
|
||||
|
||||
enum NumberingMode {
|
||||
kListNumberingOff = -1,
|
||||
kListNumberingZero = 0,
|
||||
kListNumberingOne = 1
|
||||
};
|
||||
|
||||
/// Some special commands
|
||||
enum {
|
||||
kListItemSingleClickedCmd = 'LIsc', ///< single click on item (sent on mouse down) - 'data' will be item index
|
||||
kListItemDoubleClickedCmd = 'LIdc', ///< double click on item (sent on mouse up) - 'data' will be item index
|
||||
kListItemActivatedCmd = 'LIac', ///< item activated by return/enter - 'data' will be item index
|
||||
kListItemRemovalRequestCmd = 'LIrm', ///< request to remove the item with the delete/backspace keys - 'data' will be item index
|
||||
kListItemEditModeStartedCmd = 'LIes', ///< edit mode started - 'data' will be item index
|
||||
kListSelectionChangedCmd = 'Lsch' ///< selection changed - 'data' will be item index
|
||||
};
|
||||
|
||||
/* ListWidget */
|
||||
class ListWidget : public EditableWidget {
|
||||
public:
|
||||
typedef bool (*FilterMatcher)(void *arg, int idx, const Common::U32String &item, const Common::U32String &token);
|
||||
|
||||
struct ListData {
|
||||
Common::U32String orig;
|
||||
Common::U32String clean;
|
||||
|
||||
ListData(const Common::U32String &o, const Common::U32String &c) { orig = o; clean = c; }
|
||||
};
|
||||
|
||||
typedef Common::Array<ListData> ListDataArray;
|
||||
|
||||
protected:
|
||||
Common::U32StringArray _list;
|
||||
Common::U32StringArray _cleanedList;
|
||||
ListDataArray _dataList;
|
||||
Common::Array<int> _listIndex;
|
||||
bool _editable;
|
||||
bool _editMode;
|
||||
NumberingMode _numberingMode;
|
||||
int _currentPos;
|
||||
int _entriesPerPage;
|
||||
int _selectedItem;
|
||||
Common::Array<bool> _selectedItems; /// Multiple selected items (bool array)
|
||||
bool _multiSelectEnabled; /// Flag for multi-selection
|
||||
ScrollBarWidget *_scrollBar;
|
||||
int _currentKeyDown;
|
||||
|
||||
Common::String _quickSelectStr;
|
||||
uint32 _quickSelectTime;
|
||||
|
||||
int _hlLeftPadding;
|
||||
int _hlRightPadding;
|
||||
int _leftPadding;
|
||||
int _rightPadding;
|
||||
int _topPadding;
|
||||
int _bottomPadding;
|
||||
int _itemSpacing;
|
||||
int _scrollBarWidth;
|
||||
|
||||
Common::U32String _filter;
|
||||
bool _quickSelect;
|
||||
bool _dictionarySelect;
|
||||
|
||||
uint32 _cmd;
|
||||
|
||||
ThemeEngine::FontColor _editColor;
|
||||
|
||||
int _lastRead;
|
||||
|
||||
FilterMatcher _filterMatcher;
|
||||
void *_filterMatcherArg;
|
||||
public:
|
||||
ListWidget(Dialog *boss, const Common::String &name, const Common::U32String &tooltip = Common::U32String(), uint32 cmd = 0);
|
||||
ListWidget(Dialog *boss, int x, int y, int w, int h, bool scale, const Common::U32String &tooltip = Common::U32String(), uint32 cmd = 0);
|
||||
ListWidget(Dialog *boss, int x, int y, int w, int h, const Common::U32String &tooltip = Common::U32String(), uint32 cmd = 0);
|
||||
|
||||
bool containsWidget(Widget *) const override;
|
||||
Widget *findWidget(int x, int y) override;
|
||||
|
||||
void setList(const Common::U32StringArray &list);
|
||||
const Common::U32StringArray &getList() const { return _cleanedList; }
|
||||
|
||||
void append(const Common::String &s);
|
||||
|
||||
void setSelected(int item);
|
||||
int getSelected() const { return (_filter.empty() || _selectedItem == -1) ? _selectedItem : _listIndex[_selectedItem]; }
|
||||
|
||||
const Common::U32String getSelectedString() const { return stripGUIformatting(_list[_selectedItem]); }
|
||||
|
||||
/// Get visual position (index in filtered list) from real data index
|
||||
int getVisualPos(int dataIndex) const;
|
||||
|
||||
/// Multi-selection support
|
||||
const Common::Array<bool> &getSelectedItems() const { return _selectedItems; }
|
||||
bool isItemSelected(int item) const;
|
||||
void markSelectedItem(int item, bool state);
|
||||
void clearSelection();
|
||||
void selectItemRange(int from, int to);
|
||||
int _lastSelectionStartItem; /// Used for Shift+Click range selection
|
||||
void setNumberingMode(NumberingMode numberingMode) { _numberingMode = numberingMode; }
|
||||
|
||||
void scrollTo(int item);
|
||||
void scrollToEnd();
|
||||
int getCurrentScrollPos() const { return _currentPos; }
|
||||
bool isItemVisible(int item) const { return _currentPos <= item && item < _currentPos + _entriesPerPage; }
|
||||
|
||||
void enableQuickSelect(bool enable) { _quickSelect = enable; }
|
||||
Common::String getQuickSelectString() const { return _quickSelectStr; }
|
||||
|
||||
void enableDictionarySelect(bool enable) { _dictionarySelect = enable; }
|
||||
|
||||
bool isEditable() const { return _editable; }
|
||||
void setEditable(bool editable) { _editable = editable; }
|
||||
void setEditColor(ThemeEngine::FontColor color) { _editColor = color; }
|
||||
void setFilterMatcher(FilterMatcher matcher, void *arg) { _filterMatcher = matcher; _filterMatcherArg = arg; }
|
||||
|
||||
// Multi-selection methods
|
||||
void setMultiSelectEnabled(bool enabled) { _multiSelectEnabled = enabled; }
|
||||
bool isMultiSelectEnabled() const { return _multiSelectEnabled; }
|
||||
|
||||
// Made startEditMode/endEditMode for SaveLoadChooser
|
||||
void startEditMode() override;
|
||||
void endEditMode() override;
|
||||
|
||||
void setFilter(const Common::U32String &filter, bool redraw = true);
|
||||
|
||||
void handleTickle() override;
|
||||
void handleMouseDown(int x, int y, int button, int clickCount) override;
|
||||
void handleMouseUp(int x, int y, int button, int clickCount) override;
|
||||
void handleMouseWheel(int x, int y, int direction) override;
|
||||
void handleMouseMoved(int x, int y, int button) override;
|
||||
void handleMouseLeft(int button) override;
|
||||
bool handleKeyDown(Common::KeyState state) override;
|
||||
bool handleKeyUp(Common::KeyState state) override;
|
||||
void handleCommand(CommandSender *sender, uint32 cmd, uint32 data) override;
|
||||
|
||||
void reflowLayout() override;
|
||||
|
||||
bool wantsFocus() override { return true; }
|
||||
|
||||
static Common::U32String getThemeColor(byte r, byte g, byte b);
|
||||
static Common::U32String getThemeColor(ThemeEngine::FontColor color);
|
||||
static ThemeEngine::FontColor getThemeColor(const Common::U32String &color);
|
||||
static Common::U32String stripGUIformatting(const Common::U32String &str);
|
||||
static Common::U32String escapeString(const Common::U32String &str);
|
||||
|
||||
protected:
|
||||
void drawWidget() override;
|
||||
|
||||
/// Finds the item at position (x,y). Returns -1 if there is no item there.
|
||||
int findItem(int x, int y) const;
|
||||
void scrollBarRecalc();
|
||||
|
||||
void abortEditMode() override;
|
||||
|
||||
Common::Rect getEditRect() const override;
|
||||
int getCaretOffset() const override;
|
||||
|
||||
void copyListData(const Common::U32StringArray &list);
|
||||
|
||||
void receivedFocusWidget() override;
|
||||
void lostFocusWidget() override;
|
||||
void checkBounds();
|
||||
void scrollToCurrent();
|
||||
|
||||
virtual ThemeEngine::WidgetStateInfo getItemState(int item) const { return _state; }
|
||||
|
||||
void drawFormattedText(const Common::Rect &r, const Common::U32String &str, ThemeEngine::WidgetStateInfo state = ThemeEngine::kStateEnabled,
|
||||
Graphics::TextAlign align = Graphics::kTextAlignCenter,
|
||||
ThemeEngine::TextInversionState inverted = ThemeEngine::kTextInversionNone, int deltax = 0, bool useEllipsis = true,
|
||||
ThemeEngine::FontColor color = ThemeEngine::kFontColorFormatting);
|
||||
};
|
||||
|
||||
} // End of namespace GUI
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user