]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/guiFormSpecMenu.cpp
Send a on_receive_fields event when formspec is closed, with fields.quit = "true"
[dragonfireclient.git] / src / guiFormSpecMenu.cpp
index b0cfa38c20783cbc05d87d79190df55bd2a72f2e..f3d4568ef6303e097bae3362560ff1fb0420167d 100644 (file)
@@ -69,12 +69,14 @@ GUIFormSpecMenu::GUIFormSpecMenu(irr::IrrlichtDevice* dev,
                gui::IGUIElement* parent, s32 id,
                IMenuManager *menumgr,
                InventoryManager *invmgr,
-               IGameDef *gamedef
+               IGameDef *gamedef,
+               ISimpleTextureSource *tsrc
 ):
        GUIModalMenu(dev->getGUIEnvironment(), parent, id, menumgr),
        m_device(dev),
        m_invmgr(invmgr),
        m_gamedef(gamedef),
+       m_tsrc(tsrc),
        m_form_src(NULL),
        m_text_dst(NULL),
        m_selected_item(NULL),
@@ -124,11 +126,89 @@ void GUIFormSpecMenu::removeChildren()
                if(e != NULL)
                        e->remove();
        }*/
+
        if(m_tooltip_element)
        {
                m_tooltip_element->remove();
+               m_tooltip_element->drop();
                m_tooltip_element = NULL;
        }
+
+}
+
+void GUIFormSpecMenu::setInitialFocus()
+{
+       // Set initial focus according to following order of precedence:
+       // 1. first empty editbox
+       // 2. first editbox
+       // 3. first listbox
+       // 4. last button
+       // 5. first focusable (not statictext, not tabheader)
+       // 6. first child element
+
+       core::list<gui::IGUIElement*> children = getChildren();
+
+       // in case "children" contains any NULL elements, remove them
+       for (core::list<gui::IGUIElement*>::Iterator it = children.begin();
+                       it != children.end();) {
+               if (*it)
+                       ++it;
+               else
+                       it = children.erase(it);
+       }
+
+       // 1. first empty editbox
+       for (core::list<gui::IGUIElement*>::Iterator it = children.begin();
+                       it != children.end(); ++it) {
+               if ((*it)->getType() == gui::EGUIET_EDIT_BOX
+                               && (*it)->getText()[0] == 0) {
+                       Environment->setFocus(*it);
+                       return;
+               }
+       }
+
+       // 2. first editbox
+       for (core::list<gui::IGUIElement*>::Iterator it = children.begin();
+                       it != children.end(); ++it) {
+               if ((*it)->getType() == gui::EGUIET_EDIT_BOX) {
+                       Environment->setFocus(*it);
+                       return;
+               }
+       }
+
+       // 3. first listbox
+       for (core::list<gui::IGUIElement*>::Iterator it = children.begin();
+                       it != children.end(); ++it) {
+               if ((*it)->getType() == gui::EGUIET_LIST_BOX) {
+                       Environment->setFocus(*it);
+                       return;
+               }
+       }
+
+       // 4. last button
+       for (core::list<gui::IGUIElement*>::Iterator it = children.getLast();
+                       it != children.end(); --it) {
+               if ((*it)->getType() == gui::EGUIET_BUTTON) {
+                       Environment->setFocus(*it);
+                       return;
+               }
+       }
+
+       // 5. first focusable (not statictext, not tabheader)
+       for (core::list<gui::IGUIElement*>::Iterator it = children.begin();
+                       it != children.end(); ++it) {
+               if ((*it)->getType() != gui::EGUIET_STATIC_TEXT &&
+                               (*it)->getType() != gui::EGUIET_TAB_CONTROL) {
+                       Environment->setFocus(*it);
+                       return;
+               }
+       }
+
+       // 6. first child element
+       if (children.empty())
+               Environment->setFocus(this);
+       else
+               Environment->setFocus(*(children.begin()));
 }
 
 int GUIFormSpecMenu::getListboxIndex(std::string listboxname) {
@@ -387,6 +467,11 @@ void GUIFormSpecMenu::parseCheckbox(parserData* data,std::string element) {
                spec.flabel = wlabel; //Needed for displaying text on MSVC
                gui::IGUICheckBox* e = Environment->addCheckBox(fselected, rect, this,
                                        spec.fid, spec.flabel.c_str());
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
+
                m_checkboxes.push_back(std::pair<FieldSpec,gui::IGUICheckBox*>(spec,e));
                m_fields.push_back(spec);
                return;
@@ -400,7 +485,7 @@ void GUIFormSpecMenu::parseImage(parserData* data,std::string element) {
        if (parts.size() == 3) {
                std::vector<std::string> v_pos = split(parts[0],',');
                std::vector<std::string> v_geom = split(parts[1],',');
-               std::string name = parts[2];
+               std::string name = unescape_string(parts[2]);
 
                MY_CHECKPOS("image",0);
                MY_CHECKGEOM("image",1);
@@ -421,7 +506,7 @@ void GUIFormSpecMenu::parseImage(parserData* data,std::string element) {
 
        if (parts.size() == 2) {
                std::vector<std::string> v_pos = split(parts[0],',');
-               std::string name = parts[1];
+               std::string name = unescape_string(parts[1]);
 
                MY_CHECKPOS("image",0);
 
@@ -503,7 +588,13 @@ void GUIFormSpecMenu::parseButton(parserData* data,std::string element,std::stri
                if(type == "button_exit")
                        spec.is_exit = true;
 
-               Environment->addButton(rect, this, spec.fid, spec.flabel.c_str());
+               gui::IGUIButton* e = Environment->addButton(rect, this, spec.fid,
+                               spec.flabel.c_str());
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
+
                m_fields.push_back(spec);
                return;
        }
@@ -516,7 +607,7 @@ void GUIFormSpecMenu::parseBackground(parserData* data,std::string element) {
        if (parts.size() == 3) {
                std::vector<std::string> v_pos = split(parts[0],',');
                std::vector<std::string> v_geom = split(parts[1],',');
-               std::string name = parts[2];
+               std::string name = unescape_string(parts[2]);
 
                MY_CHECKPOS("background",0);
                MY_CHECKGEOM("background",1);
@@ -582,9 +673,8 @@ void GUIFormSpecMenu::parseTextList(parserData* data,std::string element) {
                //now really show list
                gui::IGUIListBox *e = Environment->addListBox(rect, this,spec.fid);
 
-               //don't reset if we already have a user specified selection
-               if (data->listbox_selections.find(fname_w) == data->listbox_selections.end()) {
-                       e->setAutoScrollEnabled(false);
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
                }
 
                if (str_transparent == "false")
@@ -670,10 +760,9 @@ void GUIFormSpecMenu::parseDropDown(parserData* data,std::string element) {
                //now really show list
                gui::IGUIComboBox *e = Environment->addComboBox(rect, this,spec.fid);
 
-               //don't reset if we already have a user specified selection
-               //if (data->combobox_selections.find(fname_w) == data->listbox_selections.end()) {
-               //      e->setAutoScrollEnabled(false);
-               //}
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
 
                for (unsigned int i=0; i < items.size(); i++) {
                        e->addItem(narrow_to_wide(items[i]).c_str());
@@ -682,11 +771,6 @@ void GUIFormSpecMenu::parseDropDown(parserData* data,std::string element) {
                if (str_initial_selection != "")
                        e->setSelected(stoi(str_initial_selection.c_str())-1);
 
-               //if (data->listbox_selections.find(fname_w) != data->listbox_selections.end()) {
-               //      e->setSelected(data->listbox_selections[fname_w]);
-               //}
-
-               //m_listboxes.push_back(std::pair<FieldSpec,gui::IGUIListBox*>(spec,e));
                m_fields.push_back(spec);
                return;
        }
@@ -732,7 +816,10 @@ void GUIFormSpecMenu::parsePwdField(parserData* data,std::string element) {
 
                spec.send = true;
                gui::IGUIEditBox * e = Environment->addEditBox(0, rect, true, this, spec.fid);
-               Environment->setFocus(e);
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
 
                if (label.length() > 1)
                {
@@ -811,7 +898,10 @@ void GUIFormSpecMenu::parseSimpleField(parserData* data,std::vector<std::string>
        {
                spec.send = true;
                gui::IGUIEditBox *e = Environment->addEditBox(spec.fdefault.c_str(), rect, true, this, spec.fid);
-               Environment->setFocus(e);
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
 
                irr::SEvent evt;
                evt.EventType            = EET_KEY_INPUT_EVENT;
@@ -894,7 +984,10 @@ void GUIFormSpecMenu::parseTextArea(parserData* data,std::vector<std::string>& p
        {
                spec.send = true;
                gui::IGUIEditBox *e = Environment->addEditBox(spec.fdefault.c_str(), rect, true, this, spec.fid);
-               Environment->setFocus(e);
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
 
                if (type == "textarea")
                {
@@ -976,7 +1069,7 @@ void GUIFormSpecMenu::parseVertLabel(parserData* data,std::string element) {
 
        if (parts.size() == 2) {
                std::vector<std::string> v_pos = split(parts[0],',');
-               std::string text = parts[1];
+               std::wstring text = narrow_to_wide(unescape_string(parts[1]));
 
                MY_CHECKPOS("vertlabel",1);
 
@@ -989,17 +1082,16 @@ void GUIFormSpecMenu::parseVertLabel(parserData* data,std::string element) {
                if(data->bp_set != 2)
                        errorstream<<"WARNING: invalid use of label without a size[] element"<<std::endl;
 
-               text = unescape_string(text);
-               std::string label = "";
+               std::wstring label = L"";
 
                for (unsigned int i=0; i < text.length(); i++) {
-                       label += text.c_str()[i];
-                       label += "\n";
+                       label += text[i];
+                       label += L"\n";
                }
 
                FieldSpec spec = FieldSpec(
                        L"",
-                       narrow_to_wide(label.c_str()),
+                       label,
                        L"",
                        258+m_fields.size()
                );
@@ -1052,8 +1144,10 @@ void GUIFormSpecMenu::parseImageButton(parserData* data,std::string element,std:
                core::rect<s32> rect = core::rect<s32>(pos.X, pos.Y, pos.X+geom.X, pos.Y+geom.Y);
 
                if(data->bp_set != 2)
-                       errorstream<<"WARNING: invalid use of item_image_button without a size[] element"<<std::endl;
+                       errorstream<<"WARNING: invalid use of image_button without a size[] element"<<std::endl;
 
+               image_name = unescape_string(image_name);
+               pressed_image_name = unescape_string(pressed_image_name);
                label = unescape_string(label);
 
                std::wstring wlabel = narrow_to_wide(label.c_str());
@@ -1070,27 +1164,18 @@ void GUIFormSpecMenu::parseImageButton(parserData* data,std::string element,std:
 
                video::ITexture *texture = 0;
                video::ITexture *pressed_texture = 0;
-               //if there's no gamedef specified try to get direct
-               //TODO check for possible texture leak
-               if (m_gamedef != 0) {
-                       texture = m_gamedef->tsrc()->getTexture(image_name);
-                       if ((parts.size() == 8)) {
-                               pressed_texture = m_gamedef->tsrc()->getTexture(pressed_image_name);
-                       }
-               } else {
-                       if (fs::PathExists(image_name)) {
-                               texture = Environment->getVideoDriver()->getTexture(image_name.c_str());
-                               m_Textures.push_back(texture);
-                       }
-                       if (fs::PathExists(pressed_image_name)) {
-                               pressed_texture = Environment->getVideoDriver()->getTexture(pressed_image_name.c_str());
-                               m_Textures.push_back(pressed_texture);
-                       }
-               }
-               if (parts.size() < 8)
+               texture = m_tsrc->getTexture(image_name);
+               if (parts.size() == 8)
+                       pressed_texture = m_tsrc->getTexture(pressed_image_name);
+               else
                        pressed_texture = texture;
 
                gui::IGUIButton *e = Environment->addButton(rect, this, spec.fid, spec.flabel.c_str());
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
+
                e->setUseAlphaChannel(true);
                e->setImage(texture);
                e->setPressedImage(pressed_texture);
@@ -1146,12 +1231,17 @@ void GUIFormSpecMenu::parseTabHeader(parserData* data,std::string element) {
 
                gui::IGUITabControl *e = Environment->addTabControl(rect,this,show_background,show_border,spec.fid);
 
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
+
                e->setNotClipped(true);
 
                for (unsigned int i=0; i< buttons.size(); i++) {
                        wchar_t* wbutton = 0;
 
-                       wbutton = (wchar_t*) narrow_to_wide(buttons[i].c_str()).c_str();
+                       std::wstring wlabel = narrow_to_wide(buttons[i]); //Needed for displaying text on windows
+                       wbutton = (wchar_t*) wlabel.c_str();
 
                        e->addTab(wbutton,-1);
                }
@@ -1213,6 +1303,11 @@ void GUIFormSpecMenu::parseItemImageButton(parserData* data,std::string element)
                );
 
                gui::IGUIButton *e = Environment->addButton(rect, this, spec.fid, spec.flabel.c_str());
+
+               if (spec.fname == data->focused_fieldname) {
+                       Environment->setFocus(e);
+               }
+
                e->setUseAlphaChannel(true);
                e->setImage(texture);
                e->setPressedImage(texture);
@@ -1400,6 +1495,21 @@ void GUIFormSpecMenu::regenerateGui(v2u32 screensize)
                }
        }
 
+       //preserve focus
+       gui::IGUIElement *focused_element = Environment->getFocus();
+       if (focused_element && focused_element->getParent() == this) {
+               s32 focused_id = focused_element->getID();
+               if (focused_id > 257) {
+                       for (u32 i=0; i<m_fields.size(); i++) {
+                               if (m_fields[i].fid == focused_id) {
+                                       mydata.focused_fieldname =
+                                               m_fields[i].fname;
+                                       break;
+                               }
+                       }
+               }
+       }
+
        // Remove children
        removeChildren();
 
@@ -1484,7 +1594,16 @@ void GUIFormSpecMenu::regenerateGui(v2u32 screensize)
                m_tooltip_element->setOverrideColor(video::SColor(255,255,255,255));
                m_tooltip_element->setTextAlignment(gui::EGUIA_CENTER, gui::EGUIA_CENTER);
                m_tooltip_element->setWordWrap(false);
+               //we're not parent so no autograb for this one!
+               m_tooltip_element->grab();
        }
+
+       //set initial focus if parser didn't set it
+       focused_element = Environment->getFocus();
+       if (!focused_element
+                       || !isMyChild(focused_element)
+                       || focused_element->getType() == gui::EGUIET_TAB_CONTROL)
+               setInitialFocus();
 }
 
 GUIFormSpecMenu::ItemSpec GUIFormSpecMenu::getItemAtPos(v2s32 p) const
@@ -1663,15 +1782,7 @@ void GUIFormSpecMenu::drawMenu()
        for(u32 i=0; i<m_backgrounds.size(); i++)
        {
                const ImageDrawSpec &spec = m_backgrounds[i];
-               video::ITexture *texture = 0;
-
-               if (m_gamedef != 0)
-                       texture = m_gamedef->tsrc()->getTexture(spec.name);
-               else
-               {
-                       texture = driver->getTexture(spec.name.c_str());
-                       m_Textures.push_back(texture);
-               }
+               video::ITexture *texture = m_tsrc->getTexture(spec.name);
 
                if (texture != 0) {
                        // Image size on screen
@@ -1713,15 +1824,8 @@ void GUIFormSpecMenu::drawMenu()
        for(u32 i=0; i<m_images.size(); i++)
        {
                const ImageDrawSpec &spec = m_images[i];
-               video::ITexture *texture = 0;
+               video::ITexture *texture = m_tsrc->getTexture(spec.name);
 
-               if (m_gamedef != 0)
-                       texture = m_gamedef->tsrc()->getTexture(spec.name);
-               else
-               {
-                       texture = driver->getTexture(spec.name.c_str());
-                       m_Textures.push_back(texture);
-               }
                if (texture != 0) {
                        const core::dimension2d<u32>& img_origsize = texture->getOriginalSize();
                        // Image size on screen
@@ -1937,12 +2041,16 @@ ItemStack GUIFormSpecMenu::verifySelectedItem()
        return ItemStack();
 }
 
-void GUIFormSpecMenu::acceptInput()
+void GUIFormSpecMenu::acceptInput(bool quit=false)
 {
        if(m_text_dst)
        {
                std::map<std::string, std::string> fields;
 
+               if (quit) {
+                       fields["quit"] = "true";
+               }
+
                if (current_keys_pending.key_down) {
                        fields["key_down"] = "true";
                        current_keys_pending.key_down = false;
@@ -2041,6 +2149,41 @@ void GUIFormSpecMenu::acceptInput()
        }
 }
 
+bool GUIFormSpecMenu::preprocessEvent(const SEvent& event)
+{
+       // Fix Esc/Return key being eaten by checkboxen and listboxen
+       if(event.EventType==EET_KEY_INPUT_EVENT)
+       {
+               KeyPress kp(event.KeyInput);
+               if (kp == EscapeKey || kp == getKeySetting("keymap_inventory")
+                               || event.KeyInput.Key==KEY_RETURN)
+               {
+                       gui::IGUIElement *focused = Environment->getFocus();
+                       if (focused && isMyChild(focused) &&
+                                       (focused->getType() == gui::EGUIET_LIST_BOX ||
+                                        focused->getType() == gui::EGUIET_CHECK_BOX)) {
+                               OnEvent(event);
+                               return true;
+                       }
+               }
+       }
+       // Mouse wheel events: send to hovered element instead of focused
+       if(event.EventType==EET_MOUSE_INPUT_EVENT
+                       && event.MouseInput.Event == EMIE_MOUSE_WHEEL)
+       {
+               s32 x = event.MouseInput.X;
+               s32 y = event.MouseInput.Y;
+               gui::IGUIElement *hovered =
+                       Environment->getRootGUIElement()->getElementFromPoint(
+                               core::position2d<s32>(x, y));
+               if (hovered && isMyChild(hovered)) {
+                       hovered->OnEvent(event);
+                       return true;
+               }
+       }
+       return false;
+}
+
 bool GUIFormSpecMenu::OnEvent(const SEvent& event)
 {
        if(event.EventType==EET_KEY_INPUT_EVENT)
@@ -2049,10 +2192,12 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                if (event.KeyInput.PressedDown && (kp == EscapeKey ||
                        kp == getKeySetting("keymap_inventory")))
                {
-                       if (m_allowclose)
+                       if (m_allowclose) {
+                               acceptInput(true);
                                quitMenu();
-                       else
+                        } else {
                                m_text_dst->gotText(narrow_to_wide("MenuQuit"));
+                       }
                        return true;
                }
                if (event.KeyInput.PressedDown &&
@@ -2065,7 +2210,7 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                        switch (event.KeyInput.Key) {
                                case KEY_RETURN:
                                        if (m_allowclose) {
-                                               acceptInput();
+                                               acceptInput(true);
                                                quitMenu();
                                        }
                                        else
@@ -2391,8 +2536,6 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                                        s.send = true;
                                        acceptInput();
                                        s.send = false;
-                                       // Restore focus to the full form
-                                       Environment->setFocus(this);
                                        return true;
                                }
                        }
@@ -2414,11 +2557,13 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                        unsigned int btn_id = event.GUIEvent.Caller->getID();
 
                        if (btn_id == 257) {
-                               acceptInput();
-                               if (m_allowclose)
+                               if (m_allowclose) {
+                                       acceptInput(true);
                                        quitMenu();
-                               else
+                               } else {
+                                       acceptInput();
                                        m_text_dst->gotText(narrow_to_wide("ExitButton"));
+                               }
                                // quitMenu deallocates menu
                                return true;
                        }
@@ -2435,15 +2580,15 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                                        s.send = true;
                                        acceptInput();
                                        if(s.is_exit){
-                                               if (m_allowclose)
+                                               if (m_allowclose) {
+                                                       acceptInput(true);
                                                        quitMenu();
-                                               else
+                                               } else {
                                                        m_text_dst->gotText(narrow_to_wide("ExitButton"));
+                                               }
                                                return true;
                                        }else{
                                                s.send = false;
-                                               // Restore focus to the full form
-                                               Environment->setFocus(this);
                                                return true;
                                        }
                                }
@@ -2455,7 +2600,7 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                        {
 
                                if (m_allowclose) {
-                                       acceptInput();
+                                       acceptInput(true);
                                        quitMenu();
                                }
                                else {
@@ -2488,8 +2633,6 @@ bool GUIFormSpecMenu::OnEvent(const SEvent& event)
                                                s.send = true;
                                                acceptInput();
                                                s.send=false;
-                                               // Restore focus to the full form
-                                               Environment->setFocus(this);
                                        }
                                }
                                return true;