1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_VCL_METRIC_HXX
21 #define INCLUDED_VCL_METRIC_HXX
22
23 #include <vcl/dllapi.h>
24 #include <vcl/font.hxx>
25 #include <tools/ref.hxx>
26 #include <tools/gen.hxx>
27
28 class FontCharMap;
29
30 typedef tools::SvRef<FontCharMap> FontCharMapRef;
31
32 class VCL_DLLPUBLIC FontMetric : public vcl::Font
33 {
34 public:
35 explicit FontMetric();
36 FontMetric( const FontMetric& ); // TODO make this explicit
37 ~FontMetric() override;
38
GetAscent() const39 tools::Long GetAscent() const { return mnAscent; }
GetDescent() const40 tools::Long GetDescent() const { return mnDescent; }
GetInternalLeading() const41 tools::Long GetInternalLeading() const { return mnIntLeading; }
GetExternalLeading() const42 tools::Long GetExternalLeading() const { return mnExtLeading; }
GetLineHeight() const43 tools::Long GetLineHeight() const { return mnLineHeight; } // TODO this is ascent + descnt
GetSlant() const44 tools::Long GetSlant() const { return mnSlant; }
GetBulletOffset() const45 tools::Long GetBulletOffset() const { return mnBulletOffset; }
46
SetAscent(tools::Long nAscent)47 void SetAscent( tools::Long nAscent ) { mnAscent = nAscent; }
SetDescent(tools::Long nDescent)48 void SetDescent( tools::Long nDescent ) { mnDescent = nDescent; }
SetExternalLeading(tools::Long nExtLeading)49 void SetExternalLeading( tools::Long nExtLeading ) { mnExtLeading = nExtLeading; }
SetInternalLeading(tools::Long nIntLeading)50 void SetInternalLeading( tools::Long nIntLeading ) { mnIntLeading = nIntLeading; }
SetLineHeight(tools::Long nHeight)51 void SetLineHeight( tools::Long nHeight ) { mnLineHeight = nHeight; } // TODO this is ascent + descent
SetSlant(tools::Long nSlant)52 void SetSlant( tools::Long nSlant ) { mnSlant = nSlant; }
SetBulletOffset(tools::Long nOffset)53 void SetBulletOffset( tools::Long nOffset ) { mnBulletOffset = nOffset; }
54
IsFullstopCentered() const55 bool IsFullstopCentered() const { return mbFullstopCentered; }
56
SetFullstopCenteredFlag(bool bCentered)57 void SetFullstopCenteredFlag( bool bCentered ) { mbFullstopCentered = bCentered; }
58
59 using Font::operator=;
60 FontMetric& operator=( const FontMetric& rMetric );
61 FontMetric& operator=( FontMetric&& rMetric );
62 bool operator==( const FontMetric& rMetric ) const;
operator !=(const FontMetric & rMetric) const63 bool operator!=( const FontMetric& rMetric ) const
64 { return !operator==( rMetric ); }
65 private:
66 tools::Long mnAscent; // Ascent
67 tools::Long mnDescent; // Descent
68 tools::Long mnIntLeading; // Internal Leading
69 tools::Long mnExtLeading; // External Leading
70 tools::Long mnLineHeight; // Ascent+Descent+EmphasisMark
71 tools::Long mnSlant; // Slant
72 tools::Long mnBulletOffset; // Offset for non-printing character
73
74 bool mbFullstopCentered;
75 };
76
77 template< typename charT, typename traits >
operator <<(std::basic_ostream<charT,traits> & stream,const FontMetric & rMetric)78 inline std::basic_ostream<charT, traits> & operator <<(
79 std::basic_ostream<charT, traits> & stream, const FontMetric& rMetric )
80 {
81 stream << "{"
82 << "name=" << "\"" << rMetric.GetFamilyName() << "\""
83 << ",size=(" << rMetric.GetFontSize().Width() << "," << rMetric.GetFontSize().Height() << ")"
84 << ",ascent=" << rMetric.GetAscent()
85 << ",descent=" << rMetric.GetDescent()
86 << ",intLeading=" << rMetric.GetInternalLeading()
87 << ",extLeading=" << rMetric.GetExternalLeading()
88 << ",lineHeight=" << rMetric.GetLineHeight()
89 << ",slant=" << rMetric.GetSlant()
90 << "}";
91 return stream;
92 }
93
94 #endif // INCLUDED_VCL_METRIC_HXX
95
96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
97