gui::PagesControl renamed to gui::Menu

src/graphics/ui/elements/containers.cpp

@@ -246,22 +246,23 @@ Orientation Panel::getOrientation() const {
     return orientation;
 }
 
-PagesControl::PagesControl() : Container(glm::vec2(1)){
+Menu::Menu() : Container(glm::vec2(1)){
 }
 
-bool PagesControl::has(const std::string& name) {
-    return pages.find(name) != pages.end();
+bool Menu::has(const std::string& name) {
+    return pages.find(name) != pages.end() ||
+           pageSuppliers.find(name) != pageSuppliers.end();
 }
 
-void PagesControl::addPage(std::string name, std::shared_ptr<UINode> panel) {
+void Menu::addPage(std::string name, std::shared_ptr<UINode> panel) {
     pages[name] = Page{panel};
 }
 
-void PagesControl::addSupplier(std::string name, supplier<std::shared_ptr<UINode>> pageSupplier) {
+void Menu::addSupplier(std::string name, supplier<std::shared_ptr<UINode>> pageSupplier) {
     pageSuppliers[name] = pageSupplier;
 }
 
-void PagesControl::setPage(std::string name, bool history) {
+void Menu::setPage(std::string name, bool history) {
     auto found = pages.find(name);
     Page page;
     if (found == pages.end()) {
@@ -270,6 +271,7 @@ void PagesControl::setPage(std::string name, bool history) {
             throw std::runtime_error("no page found");
         } else {
             page.panel = supplier->second();
+            // supplied pages caching is not implemented
         }
     } else {
         page = found->second;
@@ -286,7 +288,7 @@ void PagesControl::setPage(std::string name, bool history) {
     setSize(current.panel->getSize());
 }
 
-void PagesControl::back() {
+void Menu::back() {
     if (pageStack.empty())
         return;
     std::string name = pageStack.top();
@@ -294,19 +296,19 @@ void PagesControl::back() {
     setPage(name, false);
 }
 
-Page& PagesControl::getCurrent() {
+Page& Menu::getCurrent() {
     return current;
 }
 
-const std::string& PagesControl::getCurrentName() const {
+const std::string& Menu::getCurrentName() const {
     return curname;
 }
 
-void PagesControl::clearHistory() {
+void Menu::clearHistory() {
     pageStack = std::stack<std::string>();
 }
 
-void PagesControl::reset() {
+void Menu::reset() {
     clearHistory();
     if (current.panel) {
         curname = "";

src/graphics/ui/elements/containers.h

@@ -92,7 +92,7 @@ namespace gui {
         }
     };
 
-    class PagesControl : public Container {
+    class Menu : public Container {
     protected:
         std::unordered_map<std::string, Page> pages;
         std::stack<std::string> pageStack;
@@ -100,17 +100,36 @@ namespace gui {
         std::string curname = "";
         std::unordered_map<std::string, supplier<std::shared_ptr<UINode>>> pageSuppliers;
     public:
-        PagesControl();
+        Menu();
 
+        /// @brief Check menu have page or page supplier
+        /// @param name page name
         bool has(const std::string& name);
+
+        /// @brief Set current page to specified one.
+        /// @param name page or page supplier name
+        /// @param history previous page will not be saved in history if false
         void setPage(std::string name, bool history=true);
         void addPage(std::string name, std::shared_ptr<UINode> panel);
+
+        /// @brief Add page supplier used if page is not found
+        /// @param name page name
+        /// @param pageSupplier page supplier function
         void addSupplier(std::string name, supplier<std::shared_ptr<UINode>> pageSupplier);
+
+        /// @brief Set page to previous saved in history
         void back();
+
+        /// @brief Clear pages history
         void clearHistory();
+
+        /// @brief Clear history and remove and set page to null
         void reset();
     
+        /// @brief Get current page
         Page& getCurrent();
+
+        /// @brief Get current page name
         const std::string& getCurrentName() const;
     };
 }