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.
21 #ifndef GUIINVENTORYMENU_HEADER
22 #define GUIINVENTORYMENU_HEADER
26 #include "irrlichttypes_extrabloated.h"
27 #include "inventory.h"
28 #include "inventorymanager.h"
29 #include "modalMenu.h"
33 class InventoryManager;
34 class ISimpleTextureSource;
53 virtual ~TextDest() {};
54 // This is deprecated I guess? -celeron55
55 virtual void gotText(std::wstring text){}
56 virtual void gotText(std::map<std::string, std::string> fields) = 0;
57 virtual void setFormName(std::string formname)
58 { m_formname = formname;};
60 std::string m_formname;
66 virtual ~IFormSource(){}
67 virtual std::string getForm() = 0;
68 // Fill in variables in field text
69 virtual std::string resolveText(std::string str){ return str; }
72 class GUIFormSpecMenu : public GUIModalMenu
80 ItemSpec(const InventoryLocation &a_inventoryloc,
81 const std::string &a_listname,
84 inventoryloc = a_inventoryloc;
85 listname = a_listname;
93 InventoryLocation inventoryloc;
103 ListDrawSpec(const InventoryLocation &a_inventoryloc,
104 const std::string &a_listname,
105 v2s32 a_pos, v2s32 a_geom, s32 a_start_item_i):
106 inventoryloc(a_inventoryloc),
107 listname(a_listname),
110 start_item_i(a_start_item_i)
114 InventoryLocation inventoryloc;
115 std::string listname;
126 ImageDrawSpec(const std::string &a_name,
127 v2s32 a_pos, v2s32 a_geom):
134 ImageDrawSpec(const std::string &a_name,
152 FieldSpec(const std::wstring &name, const std::wstring &label,
153 const std::wstring &fdeflt, int id) :
165 std::wstring fdefault;
168 FormspecFieldType ftype;
170 core::rect<s32> rect;
174 BoxDrawSpec(v2s32 a_pos, v2s32 a_geom,irr::video::SColor a_color):
182 irr::video::SColor color;
189 TooltipSpec(std::string a_tooltip, irr::video::SColor a_bgcolor,
190 irr::video::SColor a_color):
197 irr::video::SColor bgcolor;
198 irr::video::SColor color;
202 GUIFormSpecMenu(irr::IrrlichtDevice* dev,
203 gui::IGUIElement* parent, s32 id,
204 IMenuManager *menumgr,
205 InventoryManager *invmgr,
207 ISimpleTextureSource *tsrc,
210 GUIFormSpecMenu** ext_ptr
215 void setFormSpec(const std::string &formspec_string,
216 InventoryLocation current_inventory_location)
218 m_formspec_string = formspec_string;
219 m_current_inventory_location = current_inventory_location;
220 regenerateGui(m_screensize_old);
223 // form_src is deleted by this GUIFormSpecMenu
224 void setFormSource(IFormSource *form_src)
226 if (m_form_src != NULL) {
229 m_form_src = form_src;
232 // text_dst is deleted by this GUIFormSpecMenu
233 void setTextDest(TextDest *text_dst)
235 if (m_text_dst != NULL) {
238 m_text_dst = text_dst;
241 void allowClose(bool value)
243 m_allowclose = value;
246 void lockSize(bool lock,v2u32 basescreensize=v2u32(0,0)) {
248 m_lockscreensize = basescreensize;
251 void removeChildren();
252 void setInitialFocus();
254 Remove and re-add (or reposition) stuff
256 void regenerateGui(v2u32 screensize);
258 ItemSpec getItemAtPos(v2s32 p) const;
259 void drawList(const ListDrawSpec &s, int phase);
260 void drawSelectedItem();
262 void updateSelectedItem();
263 ItemStack verifySelectedItem();
265 void acceptInput(FormspecQuitMode quitmode);
266 bool preprocessEvent(const SEvent& event);
267 bool OnEvent(const SEvent& event);
269 bool pausesGame() { return doPause; }
271 GUITable* getTable(std::wstring tablename);
273 static bool parseColor(const std::string &value,
274 video::SColor &color, bool quiet);
277 v2s32 getBasePos() const
279 return padding + offset + AbsoluteRect.UpperLeftCorner;
287 irr::IrrlichtDevice* m_device;
288 InventoryManager *m_invmgr;
290 ISimpleTextureSource *m_tsrc;
292 std::string m_formspec_string;
293 InventoryLocation m_current_inventory_location;
295 std::vector<ListDrawSpec> m_inventorylists;
296 std::vector<ImageDrawSpec> m_backgrounds;
297 std::vector<ImageDrawSpec> m_images;
298 std::vector<ImageDrawSpec> m_itemimages;
299 std::vector<BoxDrawSpec> m_boxes;
300 std::vector<FieldSpec> m_fields;
301 std::vector<std::pair<FieldSpec,GUITable*> > m_tables;
302 std::vector<std::pair<FieldSpec,gui::IGUICheckBox*> > m_checkboxes;
303 std::map<std::wstring, TooltipSpec> m_tooltips;
305 ItemSpec *m_selected_item;
306 u32 m_selected_amount;
307 bool m_selected_dragging;
309 // WARNING: BLACK MAGIC
310 // Used to guess and keep up with some special things the server can do.
311 // If name is "", no guess exists.
312 ItemStack m_selected_content_guess;
313 InventoryLocation m_selected_content_guess_inventory;
316 gui::IGUIStaticText *m_tooltip_element;
318 u32 m_tooltip_show_delay;
320 s32 m_old_tooltip_id;
321 std::string m_old_tooltip;
325 v2u32 m_lockscreensize;
329 bool m_clipbackground;
330 video::SColor m_bgcolor;
331 video::SColor m_slotbg_n;
332 video::SColor m_slotbg_h;
333 video::SColor m_slotbordercolor;
334 video::SColor m_default_tooltip_bgcolor;
335 video::SColor m_default_tooltip_color;
338 IFormSource *m_form_src;
339 TextDest *m_text_dst;
340 GUIFormSpecMenu **m_ext_ptr;
341 gui::IGUIFont *m_font;
345 core::rect<s32> rect;
349 std::wstring focused_fieldname;
350 GUITable::TableOptions table_options;
351 GUITable::TableColumns table_columns;
352 // used to restore table selection/scroll/treeview state
353 std::map<std::wstring,GUITable::DynamicData> table_dyndata;
363 fs_key_pendig current_keys_pending;
365 void parseElement(parserData* data,std::string element);
367 void parseSize(parserData* data,std::string element);
368 void parseList(parserData* data,std::string element);
369 void parseCheckbox(parserData* data,std::string element);
370 void parseImage(parserData* data,std::string element);
371 void parseItemImage(parserData* data,std::string element);
372 void parseButton(parserData* data,std::string element,std::string typ);
373 void parseBackground(parserData* data,std::string element);
374 void parseTableOptions(parserData* data,std::string element);
375 void parseTableColumns(parserData* data,std::string element);
376 void parseTable(parserData* data,std::string element);
377 void parseTextList(parserData* data,std::string element);
378 void parseDropDown(parserData* data,std::string element);
379 void parsePwdField(parserData* data,std::string element);
380 void parseField(parserData* data,std::string element,std::string type);
381 void parseSimpleField(parserData* data,std::vector<std::string> &parts);
382 void parseTextArea(parserData* data,std::vector<std::string>& parts,
384 void parseLabel(parserData* data,std::string element);
385 void parseVertLabel(parserData* data,std::string element);
386 void parseImageButton(parserData* data,std::string element,std::string type);
387 void parseItemImageButton(parserData* data,std::string element);
388 void parseTabHeader(parserData* data,std::string element);
389 void parseBox(parserData* data,std::string element);
390 void parseBackgroundColor(parserData* data,std::string element);
391 void parseListColors(parserData* data,std::string element);
392 void parseTooltip(parserData* data,std::string element);
395 * check if event is part of a double click
396 * @param event event to evaluate
397 * @return true/false if a doubleclick was detected
399 bool DoubleClickDetection(const SEvent event);
406 clickpos m_doubleclickdetect[2];
411 class FormspecFormSource: public IFormSource
414 FormspecFormSource(std::string formspec)
416 m_formspec = formspec;
419 ~FormspecFormSource()
422 void setForm(std::string formspec) {
423 m_formspec = formspec;
426 std::string getForm()
431 std::string m_formspec;