String.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// 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 SFML_STRING_HPP
#define SFML_STRING_HPP

// Headers
#include <SFML/System/Resource.hpp>
#include <SFML/System/Unicode.hpp>
#include <SFML/Graphics/Drawable.hpp>
#include <SFML/Graphics/Font.hpp>
#include <SFML/Graphics/Rect.hpp>
#include <string>


namespace sf
{
class SFML_API String : public Drawable
{
public :

    enum Style
    {
        Regular    = 0,      
        Bold       = 1 << 0, 
        Italic     = 1 << 1, 
        Underlined = 1 << 2  
    };

    String();

    explicit String(const Unicode::Text& Text, const Font& CharFont = Font::GetDefaultFont(), float Size = 30.f);

    void SetText(const Unicode::Text& Text);

    void SetFont(const Font& CharFont);

    void SetSize(float Size);

    void SetStyle(unsigned long TextStyle);

    const Unicode::Text& GetText() const;

    const Font& GetFont() const;

    float GetSize() const;

    unsigned long GetStyle() const;

    sf::Vector2f GetCharacterPos(std::size_t Index) const;

    FloatRect GetRect() const;

protected :

    virtual void Render(RenderTarget& Target) const;

private :

    void RecomputeRect();

    // Member data
    Unicode::Text     myText;           
    ResourcePtr<Font> myFont;           
    float             mySize;           
    unsigned long     myStyle;          
    FloatRect         myBaseRect;       
    bool              myNeedRectUpdate; 
};

} // namespace sf


#endif // SFML_STRING_HPP