Merge pull request #70 from Jarod42/textbox

Textbox

CMakeLists.txt

@@ -54,6 +54,7 @@ FILE(GLOB GUISAN_HEADERS
   include/guisan/rectangle.hpp
   include/guisan/selectionevent.hpp
   include/guisan/selectionlistener.hpp
+  include/guisan.text.hpp
   include/guisan/widget.hpp
   include/guisan/widgetlistener.hpp
 )

ChangeLog

@@ -1,5 +1,11 @@
 Version 1.1.0
 =============
+* A new helper class has been added called Text for manipulating
+  text in widgets. It's utilised by both TextBox and TextField which
+  has reduced the complexity of those widgets significantly.
+* BasicContainer and Container now hos the ability to resize themselves
+  to fit their content with BasicContainer::resizeToContent and 
+  Container::resizeToContent.
 * TabbedArea::isOpaque and TabbedArea::setOpaque have been added to
   control if a tabbed area should draw its background or not.
 * ScrollArea::isOpaque and ScrollArea::setOpaque have been added to

SConstruct

@@ -95,6 +95,7 @@ common_headers = [
     'include/guisan/sdl.hpp',
     'include/guisan/selectionevent.hpp',
     'include/guisan/selectionlistener.hpp',
+    'include/guisan/text.hpp',
     'include/guisan/widget.hpp',
     'include/guisan/widgetlistener.hpp',
     'include/guisan/x.hpp'

TODO

@@ -1,4 +1,4 @@
-* Continue rebasing from 8075bee1c45ba7221ebdc127d0413628591622c6
+* Continue rebasing from 21cd51b5a5c512f19c3aa2deebcee4bcf12e0787
 * Add a focus listener interface.
 * Make focus apply synchronously.
 * Graphics and input objects for DirectX.

include/guisan/text.hpp

@@ -0,0 +1,317 @@
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef GCN_TEXT_HPP
+#define GCN_TEXT_HPP
+
+#include "guisan/platform.hpp"
+#include "guisan/rectangle.hpp"
+
+#include <string>
+#include <vector>
+
+namespace gcn
+{
+    class Font;
+
+    /**
+     * A utility class to ease working with text in widgets such as
+     * TextBox and TextField. The class wraps common text operations
+     * such as inserting and deleting text.
+     */
+    class GCN_CORE_DECLSPEC Text
+    {
+    public:
+        /**
+         * Constructor.
+         */
+        Text();
+
+        /**
+         * Constructor.
+         *
+         * @param content The content of the text.
+         */
+        Text(const std::string& content);
+
+        /**
+         * Destructor.
+         */
+        virtual ~Text();
+
+        /**
+         * Sets the content of the text. Will completely remove
+         * any previous text and reset the caret position.
+         *
+         * @param content The content of the text.
+         */
+        virtual void setContent(const std::string& text);
+
+        /**
+         * Gets the content of the text.
+         *
+         * @return The content of the text.
+         */
+        virtual std::string getContent() const;
+
+        /**
+         * Sets the content of a row.
+         *
+         * @param row The row to set the text of.
+         * @throws Exception when the row does not exist.
+         */
+        virtual void setRow(unsigned int row, const std::string& content);
+
+        /**
+         * Adds a row to the content. Calling this method will
+         * not change the current caret position.
+         *
+         * @param row The row to add.
+         */
+        virtual void addRow(const std::string& row);
+
+        /**
+         * Gets the content of a row.
+         *
+         * @param row The row to get the content of.
+         * @return The content of a row.
+         * @throws Exception when no such row exists.
+         */
+        virtual std::string getRow(unsigned int row) const;
+
+        /**
+         * Inserts a character at the current caret position.
+         *
+         * @parameter character The character to insert.
+         */
+        virtual void insert(int character);
+
+        /**
+         * Removes a given number of characters at starting
+         * at the current caret position.
+         *
+         * If the number of characters to remove is negative
+         * characters will be removed left of the caret position.
+         * If the number is positive characters will be removed
+         * right of the caret position. If a line feed is
+         * removed the row with the line feed will be merged
+         * with the row above the line feed.
+         *
+         * @numberOfCharacters The number of characters to remove.
+         */
+        virtual void remove(int numberOfCharacters);
+
+        /**
+         * Gets the caret position.
+         *
+         * @return The caret position;
+         */
+        virtual int getCaretPosition() const;
+
+        /**
+         * Sets the caret position. The position will be
+         * clamp to the dimension of the content.
+         *
+         * @param position The position of the caret.
+         */
+        virtual void setCaretPosition(int position);
+
+        /**
+         * Sets the caret position given an x and y coordinate in pixels
+         * relative to the text. The coordinates will be clamp to the content.
+         *
+         * @param x The x coordinate of the caret.
+         * @param y The y coordinate of the caret.
+         * @param font The font to use when calculating the position.
+         */
+        virtual void setCaretPosition(int x, int y, Font* font);
+
+        /**
+         * Gets the column the caret is currently in.
+         *
+         * @return The column the caret is currently in.
+         */
+        virtual int getCaretColumn() const;
+
+        /**
+         * Gets the row the caret is currently in.
+         *
+         * @return The row the caret is currently in.
+         */
+        virtual int getCaretRow() const;
+
+        /**
+         * Sets the column the caret should be in. The column
+         * will be clamp to the current row.
+         *
+         * @param column The column the caret should be in.
+         */
+        virtual void setCaretColumn(int column);
+
+        /**
+         * Sets the row the caret should be in. If the row lies
+         * outside of the text, the row will be set to zero or the
+         * maximum row depending on where the row lies outside of the
+         * text.
+         *
+         * Calling this function trigger a recalculation of the caret
+         * column.
+         *
+         * @param row The row the caret should be in.
+         */
+        virtual void setCaretRow(int row);
+
+        /**
+         * Gets the x coordinate of the caret in pixels given a font.
+         *
+         * @param font The font to use when calculating the x coordinate.
+         * @return The x coorinate of the caret in pixels.
+         */
+        virtual int getCaretX(Font* font) const;
+
+        /**
+         * Gets the y coordinate of the caret in pixels given a font.
+         *
+         * @param font The font to use when calculating the y coordinate.
+         * @return The y coorinate of the caret in pixels.
+         */
+        virtual int getCaretY(Font* font) const;
+
+        /**
+         * Gets the dimension in pixels of the text given a font. If there
+         * is no text present a dimension of a white space will be returned.
+         *
+         * @param font The font to use when calculating the dimension.
+         * @return The dimension in pixels of the text given a font.
+         */
+        virtual Rectangle getDimension(Font* font) const;
+
+        /**
+         * Gets the caret dimension relative to this text.
+         * The returned dimension is perfect for use with Widget::showPart
+         * so the caret is always shown.
+         *
+         * @param font The font to use when calculating the dimension.
+         * @return The dimension of the caret.
+         */
+        virtual Rectangle getCaretDimension(Font* font) const;
+
+        /**
+         * Gets the width in pixels of a row. If the row is not
+         * present in the text zero will be returned.
+         *
+         * @param row The row to get the width of.
+         * @return The width in pixels of a row.
+         */
+        virtual int getWidth(int row, Font* font) const;
+
+        /**
+         * Gets the maximum row the caret can be in.
+         *
+         * @return The maximum row the caret can be in.
+         */
+        virtual unsigned int getMaximumCaretRow() const;
+
+        /**
+         * Gets the maximum column of a row the caret can be in.
+         *
+         * @param row The row of the caret.
+         * @return The maximum column of a row the caret can be in.
+         */
+        virtual unsigned int getMaximumCaretRow(unsigned int row) const;
+
+        /**
+         * Gets the number of rows in the text.
+         *
+         * @return The number of rows in the text.
+         */
+        virtual unsigned int getNumberOfRows() const;
+
+        /**
+         * Gets the number of characters in the text.
+         *
+         * @return The number of characters in the text.
+         */
+        virtual unsigned int getNumberOfCharacters() const;
+
+        /**
+         * Gets the number of characters in a certain row in the text.
+         * If the row does not exist, zero will be returned.
+         *
+         * @param row The row to get the number of characters in.
+         * @return The number of characters in a certain row, or zero
+         *         if the row does not exist.
+         */
+        virtual unsigned int getNumberOfCharacters(unsigned int row) const;
+
+    protected:
+        /**
+         * Calculates the caret position from the caret row and caret column.
+         */
+        void calculateCaretPositionFromRowAndColumn();
+
+        /**
+         * Holds the text row by row.
+         */
+        std::vector<std::string> mRows;
+
+        /**
+         * Holds the position of the caret. This variable should
+         * always be valid.
+         */
+        unsigned int mCaretPosition;
+
+        /**
+         * Holds the row the caret is in. This variable should always
+         * be valid.
+         */
+        unsigned int mCaretRow;
+
+        /**
+         * Holds the column the caret is in. This variable should always
+         * be valid.
+         */
+        unsigned int mCaretColumn;
+    };
+} // namespace gcn
+#endif

include/guisan/widgets/textbox.hpp

@@ -68,6 +68,8 @@
 
 namespace gcn
 {
+    class Text;
+
     /**
      * An implementation of a text box where a user can enter text that contains many lines.
      */
@@ -112,7 +114,7 @@ namespace gcn
          * @return A row from the text of the text box.
          * @see setTextRow
          */
-        const std::string& getTextRow(int row) const;
+        std::string getTextRow(int row) const;
 
         /**
          * Sets the text of a certain row of the text.
@@ -273,19 +275,9 @@ namespace gcn
         virtual void adjustSize();
 
         /**
-         * Holds all the rows of the text.
-         */
-        std::vector<std::string> mTextRows;
-
-        /**
-         * Holds the current column of the caret.
-         */
-        int mCaretColumn;
-
-        /**
-         * Holds the current row of the caret.
+         * Holds the text of the text box.
          */
-        int mCaretRow;
+        Text* mText;
 
         /**
          * True if the text box is editable, false otherwise.