3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
28 #include "irrlichttypes_extrabloated.h"
29 #include "guiScrollBar.h"
31 class ISimpleTextureSource;
34 A table GUI element for GUIFormSpecMenu.
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.
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
45 class GUITable : public gui::IGUIElement
49 Stores dynamic data that should be preserved
50 when updating a formspec
57 core::stringw keynav_buffer;
58 std::set<s32> opened_trees;
62 An option of the form <name>=<value>
69 Option(const std::string &name_, const std::string &value_) :
76 A list of options that concern the entire table
78 typedef std::vector<Option> TableOptions;
86 std::vector<Option> options;
88 typedef std::vector<TableColumn> TableColumns;
91 GUITable(gui::IGUIEnvironment *env,
92 gui::IGUIElement *parent, s32 id,
93 core::rect<s32> rectangle,
94 ISimpleTextureSource *tsrc);
98 /* Split a string of the form "name=value" into name and value */
99 static Option splitOption(const std::string &str);
101 /* Set textlist-like options, columns and data */
102 void setTextList(const std::vector<std::string> &content,
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);
111 /* Clear the table */
114 /* Get info about last event (string such as "CHG:1:2") */
115 // Call this after EGET_TABLE_CHANGED
116 std::string checkEvent();
118 /* Get index of currently selected row (first=1; 0 if none selected) */
119 s32 getSelected() const;
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);
126 //! Sets another skin independent font. If this is set to zero, the button uses the font of the skin.
127 virtual void setOverrideFont(gui::IGUIFont *font = nullptr);
129 //! Gets the override font (if any)
130 virtual gui::IGUIFont *getOverrideFont() const;
132 /* Get selection, scroll position and opened (sub)trees */
133 DynamicData getDynamicData() const;
135 /* Set selection, scroll position and opened (sub)trees */
136 void setDynamicData(const DynamicData &dyndata);
138 /* Returns "GUITable" */
139 virtual const c8* getTypeName() const;
141 /* Must be called when position or size changes */
142 virtual void updateAbsolutePosition();
144 /* Irrlicht draw method */
147 /* Irrlicht event handler */
148 virtual bool OnEvent(const SEvent &event);
163 ColumnType content_type;
175 // visible_index >= 0: is index of row in m_visible_rows
176 // visible_index == -1: parent open but other ancestor closed
177 // visible_index == -2: parent closed
182 ISimpleTextureSource *m_tsrc;
184 // Table content (including hidden rows)
185 std::vector<Row> m_rows;
186 // Table content (only visible; indices into m_rows)
187 std::vector<s32> m_visible_rows;
188 bool m_is_textlist = false;
189 bool m_has_tree_column = false;
192 s32 m_selected = -1; // index of row (1...n), or 0 if none selected
193 s32 m_sel_column = 0;
194 bool m_sel_doubleclick = false;
196 // Keyboard navigation stuff
197 u64 m_keynav_time = 0;
198 core::stringw m_keynav_buffer = L"";
200 // Drawing and geometry information
201 bool m_border = true;
202 video::SColor m_color = video::SColor(255, 255, 255, 255);
203 video::SColor m_background = video::SColor(255, 0, 0, 0);
204 video::SColor m_highlight = video::SColor(255, 70, 100, 50);
205 video::SColor m_highlight_text = video::SColor(255, 255, 255, 255);
207 gui::IGUIFont *m_font = nullptr;
208 GUIScrollBar *m_scrollbar = nullptr;
210 // Allocated strings and images
211 std::vector<core::stringw> m_strings;
212 std::vector<video::ITexture*> m_images;
213 std::map<std::string, s32> m_alloc_strings;
214 std::map<std::string, s32> m_alloc_images;
216 s32 allocString(const std::string &text);
217 s32 allocImage(const std::string &imagename);
218 void allocationComplete();
220 // Helper for draw() that draws a single cell
221 void drawCell(const Cell *cell, video::SColor color,
222 const core::rect<s32> &rowrect,
223 const core::rect<s32> &client_clip);
225 // Returns the i-th visible row (NULL if i is invalid)
226 const Row *getRow(s32 i) const;
228 // Key navigation helper
229 bool doesRowStartWith(const Row *row, const core::stringw &str) const;
231 // Returns the row at a given screen Y coordinate
232 // Returns index i such that m_rows[i] is valid (or -1 on error)
233 s32 getRowAt(s32 y, bool &really_hovering) const;
235 // Returns the cell at a given screen X coordinate within m_rows[row_i]
236 // Returns index j such that m_rows[row_i].cells[j] is valid
238 s32 getCellAt(s32 x, s32 row_i) const;
240 // Make the selected row fully visible
243 // Should be called when m_rowcount or m_rowheight changes
244 void updateScrollBar();
246 // Sends EET_GUI_EVENT / EGET_TABLE_CHANGED to parent
247 void sendTableEvent(s32 column, bool doubleclick);
249 // Functions that help deal with hidden rows
250 // The following functions take raw row indices (hidden rows not skipped)
251 void getOpenedTrees(std::set<s32> &opened_trees) const;
252 void setOpenedTrees(const std::set<s32> &opened_trees);
253 void openTree(s32 to_open);
254 void closeTree(s32 to_close);
255 // The following function takes a visible row index (hidden rows skipped)
256 // dir: -1 = left (close), 0 = auto (toggle), 1 = right (open)
257 void toggleVisibleTree(s32 row_i, int dir, bool move_selection);
259 // Aligns cell content in column according to alignment specification
260 // align = 0: left aligned, 1: centered, 2: right aligned, 3: inline
261 static void alignContent(Cell *cell, s32 xmax, s32 content_width,