font_description.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  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.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Mark Page
**    Harry Storbacka
*/

#pragma once

#include <memory>

namespace uicore
{
    class DisplayWindow;
    class FontDescription_Impl;

    enum class FontWeight : int
    {
        thin = 100,
        extra_light = 200,
        light = 300,
        normal = 400,
        medium = 500,
        semi_bold = 600,
        bold = 700,
        extra_bold = 800,
        heavy = 900
    };

    enum class FontStyle
    {
        normal,
        italic,
        oblique // Currently not supported by UICore
    };

    class FontDescription
    {
    public:
        FontDescription();

        virtual ~FontDescription();

        static FontDescription create_null_object();

        enum Charset
        {
            charset_default,
            charset_ansi,
            charset_baltic,
            charset_chinesebig5,
            charset_easteurope,
            charset_gb2312,
            charset_greek,
            charset_hangul,
            charset_mac,
            charset_oem,
            charset_russian,
            charset_shiftjis,
            charset_symbol,
            charset_turkish,
            charset_vietnamese,
            charset_johab,
            charset_arabic,
            charset_hebrew,
            charset_thai
        };

        bool is_null() const { return !impl; }

        void throw_if_null() const;

        float height() const;

        float line_height() const;

        float average_width() const;

        float escapement() const;

        float orientation() const;

        FontWeight weight() const;

        FontStyle style() const;

        bool anti_alias() const;

        bool subpixel() const;

        Charset charset() const;

        bool operator==(const FontDescription &other) const;

        std::string unique_id() const;

        FontDescription &operator =(const FontDescription &copy);

        // \brief Copy the entire font description (not just the implementation)
        FontDescription clone() const;

        void set_height(float value = 20.0f);

        void set_average_width(float value = 0.0f);

        void set_escapement(float value);

        void set_orientation(float value);

        void set_weight(FontWeight value = FontWeight::normal);

        void set_line_height(float height);

        void set_style(FontStyle setting = FontStyle::normal);

        void set_anti_alias(bool setting = true);

        void set_subpixel(bool setting = true);

        void set_charset(Charset new_charset);

    private:
        std::shared_ptr<FontDescription_Impl> impl;
    };
}