src/gui/guiTable.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include <map>
  23 #include <set>
  24 #include <string>
  25 #include <vector>
  26 #include <iostream>
  27
  28 #include "irrlichttypes_extrabloated.h"
  29 #include "guiScrollBar.h"
  30
  31 class ISimpleTextureSource;
  32
  33 /*
  34         A table GUI element for GUIFormSpecMenu.
  35
  36         Sends a EGET_TABLE_CHANGED event to the parent when
  37         an item is selected or double-clicked.
  38         Call checkEvent() to get info.
  39
  40         Credits: The interface and implementation of this class are (very)
  41         loosely based on the Irrlicht classes CGUITable and CGUIListBox.
  42         CGUITable and CGUIListBox are licensed under the Irrlicht license;
  43         they are Copyright (C) 2002-2012 Nikolaus Gebhardt
  44 */
  45 class GUITable : public gui::IGUIElement
  46 {
  47 public:
  48         /*
  49                 Stores dynamic data that should be preserved
  50                 when updating a formspec
  51         */
  52         struct DynamicData
  53         {
  54                 s32 selected = 0;
  55                 s32 scrollpos = 0;
  56                 s32 keynav_time = 0;
  57                 core::stringw keynav_buffer;
  58                 std::set<s32> opened_trees;
  59         };
  60
  61         /*
  62                 An option of the form <name>=<value>
  63         */
  64         struct Option
  65         {
  66                 std::string name;
  67                 std::string value;
  68
  69                 Option(const std::string &name_, const std::string &value_) :
  70                         name(name_),
  71                         value(value_)
  72                 {}
  73         };
  74
  75         /*
  76                 A list of options that concern the entire table
  77         */
  78         typedef std::vector<Option> TableOptions;
  79
  80         /*
  81                 A column with options
  82         */
  83         struct TableColumn
  84         {
  85                 std::string type;
  86                 std::vector<Option> options;
  87         };
  88         typedef std::vector<TableColumn> TableColumns;
  89
  90
  91         GUITable(gui::IGUIEnvironment *env,
  92                         gui::IGUIElement *parent, s32 id,
  93                         core::rect<s32> rectangle,
  94                         ISimpleTextureSource *tsrc);
  95
  96         virtual ~GUITable();
  97
  98         /* Split a string of the form "name=value" into name and value */
  99         static Option splitOption(const std::string &str);
 100
 101         /* Set textlist-like options, columns and data */
 102         void setTextList(const std::vector<std::string> &content,
 103                         bool transparent);
 104
 105         /* Set generic table options, columns and content */
 106         // Adds empty strings to end of content if there is an incomplete row
 107         void setTable(const TableOptions &options,
 108                         const TableColumns &columns,
 109                         std::vector<std::string> &content);
 110
 111         /* Clear the table */
 112         void clear();
 113
 114         /* Get info about last event (string such as "CHG:1:2") */
 115         // Call this after EGET_TABLE_CHANGED
 116         std::string checkEvent();
 117
 118         /* Get index of currently selected row (first=1; 0 if none selected) */
 119         s32 getSelected() const;
 120
 121         /* Set currently selected row (first=1; 0 if none selected) */
 122         // If given index is not visible at the moment, select its parent
 123         // Autoscroll to make the selected row fully visible
 124         void setSelected(s32 index);
 125
 126         /* Get selection, scroll position and opened (sub)trees */
 127         DynamicData getDynamicData() const;
 128
 129         /* Set selection, scroll position and opened (sub)trees */
 130         void setDynamicData(const DynamicData &dyndata);
 131
 132         /* Returns "GUITable" */
 133         virtual const c8* getTypeName() const;
 134
 135         /* Must be called when position or size changes */
 136         virtual void updateAbsolutePosition();
 137
 138         /* Irrlicht draw method */
 139         virtual void draw();
 140
 141         /* Irrlicht event handler */
 142         virtual bool OnEvent(const SEvent &event);
 143
 144 protected:
 145         enum ColumnType {
 146                 COLUMN_TYPE_TEXT,
 147                 COLUMN_TYPE_IMAGE,
 148                 COLUMN_TYPE_COLOR,
 149                 COLUMN_TYPE_INDENT,
 150                 COLUMN_TYPE_TREE,
 151         };
 152
 153         struct Cell {
 154                 s32 xmin;
 155                 s32 xmax;
 156                 s32 xpos;
 157                 ColumnType content_type;
 158                 s32 content_index;
 159                 s32 tooltip_index;
 160                 video::SColor color;
 161                 bool color_defined;
 162                 s32 reported_column;
 163         };
 164
 165         struct Row {
 166                 Cell *cells;
 167                 s32 cellcount;
 168                 s32 indent;
 169                 // visible_index >= 0: is index of row in m_visible_rows
 170                 // visible_index == -1: parent open but other ancestor closed
 171                 // visible_index == -2: parent closed
 172                 s32 visible_index;
 173         };
 174
 175         // Texture source
 176         ISimpleTextureSource *m_tsrc;
 177
 178         // Table content (including hidden rows)
 179         std::vector<Row> m_rows;
 180         // Table content (only visible; indices into m_rows)
 181         std::vector<s32> m_visible_rows;
 182         bool m_is_textlist = false;
 183         bool m_has_tree_column = false;
 184
 185         // Selection status
 186         s32 m_selected = -1; // index of row (1...n), or 0 if none selected
 187         s32 m_sel_column = 0;
 188         bool m_sel_doubleclick = false;
 189
 190         // Keyboard navigation stuff
 191         u64 m_keynav_time = 0;
 192         core::stringw m_keynav_buffer = L"";
 193
 194         // Drawing and geometry information
 195         bool m_border = true;
 196         video::SColor m_color = video::SColor(255, 255, 255, 255);
 197         video::SColor m_background = video::SColor(255, 0, 0, 0);
 198         video::SColor m_highlight = video::SColor(255, 70, 100, 50);
 199         video::SColor m_highlight_text = video::SColor(255, 255, 255, 255);
 200         s32 m_rowheight = 1;
 201         gui::IGUIFont *m_font = nullptr;
 202         GUIScrollBar *m_scrollbar = nullptr;
 203
 204         // Allocated strings and images
 205         std::vector<core::stringw> m_strings;
 206         std::vector<video::ITexture*> m_images;
 207         std::map<std::string, s32> m_alloc_strings;
 208         std::map<std::string, s32> m_alloc_images;
 209
 210         s32 allocString(const std::string &text);
 211         s32 allocImage(const std::string &imagename);
 212         void allocationComplete();
 213
 214         // Helper for draw() that draws a single cell
 215         void drawCell(const Cell *cell, video::SColor color,
 216                         const core::rect<s32> &rowrect,
 217                         const core::rect<s32> &client_clip);
 218
 219         // Returns the i-th visible row (NULL if i is invalid)
 220         const Row *getRow(s32 i) const;
 221
 222         // Key navigation helper
 223         bool doesRowStartWith(const Row *row, const core::stringw &str) const;
 224
 225         // Returns the row at a given screen Y coordinate
 226         // Returns index i such that m_rows[i] is valid (or -1 on error)
 227         s32 getRowAt(s32 y, bool &really_hovering) const;
 228
 229         // Returns the cell at a given screen X coordinate within m_rows[row_i]
 230         // Returns index j such that m_rows[row_i].cells[j] is valid
 231         // (or -1 on error)
 232         s32 getCellAt(s32 x, s32 row_i) const;
 233
 234         // Make the selected row fully visible
 235         void autoScroll();
 236
 237         // Should be called when m_rowcount or m_rowheight changes
 238         void updateScrollBar();
 239
 240         // Sends EET_GUI_EVENT / EGET_TABLE_CHANGED to parent
 241         void sendTableEvent(s32 column, bool doubleclick);
 242
 243         // Functions that help deal with hidden rows
 244         // The following functions take raw row indices (hidden rows not skipped)
 245         void getOpenedTrees(std::set<s32> &opened_trees) const;
 246         void setOpenedTrees(const std::set<s32> &opened_trees);
 247         void openTree(s32 to_open);
 248         void closeTree(s32 to_close);
 249         // The following function takes a visible row index (hidden rows skipped)
 250         // dir: -1 = left (close), 0 = auto (toggle), 1 = right (open)
 251         void toggleVisibleTree(s32 row_i, int dir, bool move_selection);
 252
 253         // Aligns cell content in column according to alignment specification
 254         // align = 0: left aligned, 1: centered, 2: right aligned, 3: inline
 255         static void alignContent(Cell *cell, s32 xmax, s32 content_width,
 256                         s32 align);
 257 };