Font.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2018 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_FONT_HPP
#define TGUI_FONT_HPP

#include <TGUI/Config.hpp>
#include <SFML/Graphics/Font.hpp>
#include <cstdint>
#include <string>
#include <cstddef>
#include <memory>


namespace tgui
{

 class TGUI_API Font
 {
 public:

 // Move constructor has to be explicitly declared since this class has a destructor
 Font(const Font&) = default;
 Font(Font&&) = default;
 Font& operator=(const Font&) = default;
 Font& operator=(Font&&) = default;


 Font(std::nullptr_t = nullptr);


 Font(const std::string& id);


 Font(const char* id);


 Font(const std::shared_ptr<sf::Font>& font);


 Font(const sf::Font& font);


 Font(const void* data, std::size_t sizeInBytes);


 // Destructor
 ~Font();


 const std::string& getId() const;


 std::shared_ptr<sf::Font> getFont() const;


 operator std::shared_ptr<sf::Font>() const;


 operator bool() const;


 bool operator==(std::nullptr_t) const;


 bool operator!=(std::nullptr_t) const;


 bool operator==(const Font& right) const;


 bool operator!=(const Font& right) const;


 const sf::Glyph& getGlyph(std::uint32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) const;


 float getKerning(std::uint32_t first, std::uint32_t second, unsigned int characterSize) const;


 float getLineSpacing(unsigned int characterSize) const;


 private:

 std::shared_ptr<sf::Font> m_font;
 std::string m_id;
 };

}


#endif // TGUI_TEXTURE_HPP