font_metrics.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):
**
**    Magnus Norddahl
**    Harry Storbacka
**    Mark Page
*/


#pragma once

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

class CL_FontMetrics_Impl;

class CL_API_DISPLAY CL_FontMetrics
{

public:
        CL_FontMetrics();

        CL_FontMetrics(
                float height,
                float ascent=0.0f,
                float descent=0.0f,
                float internal_leading=0.0f,
                float external_leading=0.0f,
                float average_character_width=0.0f,
                float max_character_width=0.0f,
                float weight=0.0f,
                float overhang=0.0f,
                float digitized_aspect_x=0.0f,
                float digitized_aspect_y=0.0f,
                bool italic=false,
                bool underlined=false,
                bool struck_out=false,
                bool fixed_pitch=false
        );

        ~CL_FontMetrics();


public:
        float get_height() const;

        float get_ascent() const;

        float get_descent() const;

        float get_internal_leading() const;

        float get_external_leading() const;


        float get_average_character_width() const;

        float get_max_character_width() const;

        float get_weight() const;

        float get_overhang() const;

        float get_digitized_aspect_x() const;

        float get_digitized_aspect_y() const;

        CL_String::char_type get_first_char() const;

        CL_String::char_type get_last_char() const;

        CL_String::char_type get_default_char() const;

        CL_String::char_type get_word_break_char() const;

        bool is_italic() const;

        bool is_underlined() const;

        bool is_struck_out() const;

        bool is_fixed_pitch() const;


public:

        void set_height(float value);

        void set_ascent(float value);

        void set_descent(float value);

        void set_internal_leading(float value);

        void set_external_leading(float value);

        void set_average_character_width(float value);

        void set_max_character_width(float value);

        void set_weight(float value);

        void set_overhang(float value);

        void set_digitized_aspect_x(float value);

        void set_digitized_aspect_y(float value);

        void set_italic(bool value);

        void set_underlined(bool value);

        void set_struck_out(bool value);

        void set_fixed_pitch(bool value);



private:
        CL_SharedPtr<CL_FontMetrics_Impl> impl;
};

---