font_description.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib 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 ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Mark Page
**    Harry Storbacka
*/


#pragma once

#include "../api_display.h"
#include "../../Core/Text/string_types.h"
#include "../../Core/System/sharedptr.h"

class CL_DisplayWindow;
class CL_FontDescription_Impl;

class CL_API_DISPLAY CL_FontDescription
{

public:
        CL_FontDescription();

        CL_FontDescription(const CL_FontDescription &copy);

        virtual ~CL_FontDescription();

        static CL_FontDescription create_null_object();


public:

        bool is_null() const;

        const CL_String &get_typeface_name() const;

        int get_height() const;

        int get_average_width() const;

        float get_escapement() const;

        float get_orientation() const;

        int get_weight() const;

        bool get_italic() const;

        bool get_underline() const;

        bool get_strikeout() const;

        bool get_fixed_pitch() const;

        bool get_anti_alias() const;

        bool get_anti_alias_set() const;

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


public:
        CL_FontDescription &operator =(const CL_FontDescription &copy);

        // \brief Copy the entire font description (not just the implementation)
        void clone(const CL_FontDescription &copy);

        void set_typeface_name(const CL_String &name);

        void set_height(int value);

        void set_average_width(int value);

        void set_escapement(float value);

        void set_orientation(float value);

        void set_weight(int value);

        void set_italic(bool setting = true);

        void set_underline(bool setting = true);

        void set_strikeout(bool setting = true);

        void set_fixed_pitch(bool setting = true);

        void set_anti_alias(bool setting = true);


private:
        CL_SharedPtr<CL_FontDescription_Impl> impl;
};

---