FontMetrics.h

/* Copyright (C) 2015-2024 Marc Boris Duerner
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  As a special exception, you may use this file as part of a free
  software library without restriction. Specifically, if other files
  instantiate templates or use macros or inline functions from this
  file, or you compile this file and link it with other files to
  produce an executable, this file does not by itself cause the
  resulting executable to be covered by the GNU General Public
  License. This exception does not however invalidate any other
  reasons why the executable file might be covered by the GNU Library
  General Public License.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  MA 02110-1301 USA
*/
 
#ifndef PT_GFX_FONTMETRICS_H
#define PT_GFX_FONTMETRICS_H
 
#include <Pt/Gfx/Api.h>
 
namespace Pt {
 
namespace Gfx {
 
class PT_GFX_API FontMetrics
{
    public:
        FontMetrics();
 
        Float ascent() const
        {
            return _ascent;
        }
 
        void setAscent(Float n)
        {
            _ascent = n;
        }
 
        Float descent() const
        {
            return _descent;
        }
 
        void setDescent(Float n)
        {
            _descent = n;
        }
 
        Float height() const
        {
            return _ascent + _descent;
        }
 
        Float capHeight() const
        {
            return _capHeight;
        }
 
        void setCapHeight(Float n)
        {
            _capHeight = n;
        }
 
        Float xHeight() const
        {
            return _xHeight;
        }
 
        void setXHeight(Float n)
        {
            _xHeight = n;
        }
 
        Float leading() const
        {
            return _leading;
        }
 
        void setLeading(Float n)
        {
            _leading = n;
        }
 
        Float lineHeight() const
        {
            return _ascent + _descent + _leading;
        }
 
        Float underlinePos() const
        {
            return _underlinePos;
        }
 
        void setUnderlinePos(Float n)
        {
            _underlinePos = n;
        }
 
        Float underlineThickness() const
        {
            return _underlineThickness;
        }
 
        void setUnderlineThickness(Float n)
        {
            _underlineThickness = n;
        }
 
        Float strikeoutPos() const
        {
            return _strikeoutPos;
        }
 
        void setStrikeoutPos(Float n)
        {
            _strikeoutPos = n;
        }
 
        Float strikeoutThickness() const
        {
            return _strikeoutThickness;
        }
 
        void setStrikeoutThickness(Float n)
        {
            _strikeoutThickness = n;
        }
 
    private:
        Float _ascent;
        Float _descent;
        Float _capHeight;
        Float _xHeight;
        Float _leading;
        Float _underlinePos;
        Float _underlineThickness;
        Float _strikeoutPos;
        Float _strikeoutThickness;
};
 
} // namespace
 
} // namespace
 
#endif