Text.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_TEXT_HPP
#define TGUI_TEXT_HPP
 
#include <TGUI/Font.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/Vector2f.hpp>
#include <TGUI/TextStyle.hpp>
#include <SFML/Graphics/Text.hpp>
#include <SFML/Graphics/Transformable.hpp>
 
 
namespace tgui
{
 
    class TGUI_API Text : public sf::Transformable
    {
    public:
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use as (non-static) member function instead") static float getExtraHorizontalPadding(const Text& text);
#endif
 
        static float getExtraHorizontalPadding(Font font, unsigned int characterSize, TextStyle textStyle = {});
 
 
        static float getExtraHorizontalOffset(Font font, unsigned int characterSize, TextStyle textStyle = {});
 
 
        static float getExtraVerticalPadding(unsigned int characterSize);
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use as (non-static) member function instead") static float getLineHeight(const Text& text);
#endif
 
        static float getLineHeight(Font font, unsigned int characterSize, TextStyle textStyle = {});
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use as (non-static) member function instead") static float getLineWidth(const Text& text);
#endif
 
        static float getLineWidth(const sf::String &text, Font font, unsigned int characterSize, TextStyle textStyle = {});
 
 
        static unsigned int findBestTextSize(Font font, float height, int fit = 0);
 
 
        static float calculateExtraVerticalSpace(Font font, unsigned int characterSize, TextStyle style = {});
 
 
        static sf::String wordWrap(float maxWidth, const sf::String& text, Font font, unsigned int textSize, bool bold, bool dropLeadingSpace = true);
 
 
    public:
 
        Vector2f getSize() const;
 
 
        void setString(const sf::String& string);
 
 
        const sf::String& getString() const;
 
 
        void setCharacterSize(unsigned int size);
 
 
        unsigned int getCharacterSize() const;
 
 
        void setColor(Color color);
 
 
        Color getColor() const;
 
 
        void setOpacity(float opacity);
 
 
        float getOpacity() const;
 
 
        void setFont(Font font);
 
 
        Font getFont() const;
 
 
        void setStyle(TextStyle style);
 
 
        TextStyle getStyle() const;
 
 
        void setOutlineColor(Color color);
 
 
        Color getOutlineColor() const;
 
 
        void setOutlineThickness(float thickness);
 
 
        float getOutlineThickness() const;
 
 
        Vector2f findCharacterPos(std::size_t index) const;
 
 
        void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
        float getExtraHorizontalPadding() const;
 
 
        float getExtraHorizontalOffset() const;
 
 
        float getLineHeight() const;
 
 
        float getLineWidth() const;
 
 
    private:
 
        // Calculates the size of the text again after something changed.
        void recalculateSize();
 
 
    private:
 
        sf::Text     m_text;
        Vector2f     m_size;
        Font         m_font;
        Color        m_color;
        Color        m_outlineColor;
        float        m_opacity = 1;
    };
 
}
 
 
#endif // TGUI_TEXT_HPP