Text.hpp

#ifndef TEXT_H_
#define TEXT_H_

#include "UIObject.hpp"
#include "Color.hpp"
#include <string>

namespace spic {

    /**
     * @brief Enumeration for different text alignments.
     * @spicapi
     */
    enum class Alignment {
        left,
        center,
        right
    };

    /**
     * @brief Class representing a piece of text which can be rendered.
     * @spicapi
     */
    class Text : public UIObject {
        public:
            /**
             * @brief Constructor.
             * @param name The name for the game object.
             * @param tag The tag for the game object.
             * @param layer The layer for the game object.
             * @param width The width of the UI object.
             * @param height The height of the UI object.
             * @sharedapi
             */
            Text(const std::string& name, const std::string& tag, int layer, double width, double height);
            
            /**
             * @brief Constructor.
             * @param name The name for the game object.
             * @param tag The tag for the game object.
             * @param layer The layer for the game object.
             * @param width The width of the UI object.
             * @param height The height of the UI object.
             * @param text The content of the Text object
             * @param font The font the Text object will use to render
             * @param size The size the font will be rendered at
             * @param alignment The alignment the content will be rendered with 
             * @param color The color the content will be rendered in
             * @sharedapi
             */
            Text(const std::string& name, const std::string& tag, int layer, double width, double height, const std::string& text, const std::string& font, int size, Alignment alignment, const Color& color);

            /**
             * @brief Get the content of the Text object
             * @return A reference to the content of the Text object
             * @sharedapi
             */
            const std::string& Content() const;

            /**
             * @brief Set the text content of the Text object
             * @param text new content
             * @sharedapi
             */
            void Content(const std::string& text);

            /**
             * @brief Get the font of the Text object
             * @return A reference to the font of the Text object
             * @sharedapi
             */
            const std::string& Font() const;

            /**
             * @brief Set the font of the Text object
             * @param font the new font
             * @sharedapi
             */
            void Font(const std::string& font);

            /**
             * @brief Get the size of the Text object
             * @return A reference to the size of the Text object
             * @sharedapi
             */
            int Size() const;

            /**
             * @brief Set the size of the Text object
             * @param size the new size
             * @sharedapi
             */
            void Size(int size);

            /**
             * @brief Get the alignment of the Text object
             * @return A reference to the alignment of the Text object
             * @sharedapi
             */
            Alignment TextAlignment() const;

            /**
             * @brief Set the alignment of the content of the Text object
             * @param alignment the new alignment
             * @sharedapi
             */
            void TextAlignment(Alignment alignment);

            /**
             * @brief Get the color of the Text object
             * @return A reference to the color of the Text object
             * @sharedapi
             */
            const Color& TextColor() const;

            /**
             * @brief Set the color of the Text object
             * @param color the new color
             * @sharedapi
             */
            void TextColor(const Color& color);

        private:
            std::string text;
            std::string font;
            int size;
            Alignment alignment;
            Color color;
    };

}

#endif // TEXT_H_