textbox: 'editable' property

src/frontend/gui/controls.h

@@ -175,6 +175,7 @@ namespace gui {
         size_t selectionOrigin = 0;
 
         bool multiline = false;
+        bool editable = true;
 
         size_t normalizeIndex(int index);
 
@@ -192,34 +193,83 @@ namespace gui {
 
         /// @brief Set maxLocalCaret to local (line) caret position
         void resetMaxLocalCaret();
+
+        void performEditingKeyboardEvents(keycode key);
     public:
-        TextBox(std::wstring placeholder, 
-                glm::vec4 padding=glm::vec4(4.0f));
+        TextBox(
+            std::wstring placeholder, 
+            glm::vec4 padding=glm::vec4(4.0f)
+        );
 
         virtual void setTextSupplier(wstringsupplier supplier);
+
+        /// @brief Consumer called on stop editing text (textbox defocus)
+        /// @param consumer std::wstring consumer function
         virtual void setTextConsumer(wstringconsumer consumer);
+
+        /// @brief Text validator called while text editing and returns true if
+        /// text is valid
+        /// @param validator std::wstring consumer returning boolean 
         virtual void setTextValidator(wstringchecker validator);
+
         virtual void setFocusedColor(glm::vec4 color);
         virtual glm::vec4 getFocusedColor() const;
+
+        /// @brief Set color of textbox marked by validator as invalid
         virtual void setErrorColor(glm::vec4 color);
+
+        /// @brief Get color of textbox marked by validator as invalid
         virtual glm::vec4 getErrorColor() const;
+        
         /// @brief Get TextBox content text or placeholder if empty
         virtual std::wstring getText() const;
+
         /// @brief Set TextBox content text
         virtual void setText(std::wstring value);
+
+        /// @brief Get text placeholder
         virtual std::wstring getPlaceholder() const;
-        virtual void setPlaceholder(const std::wstring&);
+
+        /// @brief Set text placeholder
+        /// @param text will be used instead of empty
+        virtual void setPlaceholder(const std::wstring& text);
+        
+        /// @brief Get selected text
         virtual std::wstring getSelection() const;
+
+        /// @brief Get current caret position in text
+        /// @return integer in range [0, text.length()]
         virtual uint getCaret() const;
+
+        /// @brief Set caret position in the text
+        /// @param position integer in range [0, text.length()]
         virtual void setCaret(uint position);
+
+        /// @brief Select part of the text
+        /// @param start index of the first selected character
+        /// @param end index of the last selected character + 1
         virtual void select(int start, int end);
+
+        /// @brief Check text with validator set with setTextValidator
+        /// @return true if text is valid
         virtual bool validate();
+
         virtual void setValid(bool valid);
         virtual bool isValid() const;
 
-        // multiline mode is in development
+        /// @brief Enable/disable multiline mode        
         virtual void setMultiline(bool multiline);
+
+        /// @brief Check if multiline mode is enabled 
         virtual bool isMultiline() const;
+
+        /// @brief Enable/disable text editing feature
+        virtual void setEditable(bool editable);
+
+        /// @brief Check if text editing feature is enabled 
+        virtual bool isEditable() const;
+
+        /// @brief Set runnable called on textbox focus
         virtual void setOnEditStart(runnable oneditstart);
 
         virtual void focus(GUI*) override;