LibreOffice Module vcl (master)  1
metric.hxx
Go to the documentation of this file.
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 
29 
31 
33 {
34 public:
35  explicit FontMetric();
36  FontMetric( const FontMetric& ); // TODO make this explicit
37  ~FontMetric() override;
38 
39  tools::Long GetAscent() const { return mnAscent; }
40  tools::Long GetDescent() const { return mnDescent; }
41  tools::Long GetInternalLeading() const { return mnIntLeading; }
42  tools::Long GetExternalLeading() const { return mnExtLeading; }
43  tools::Long GetLineHeight() const { return mnLineHeight; } // TODO this is ascent + descnt
44  tools::Long GetSlant() const { return mnSlant; }
45  tools::Long GetBulletOffset() const { return mnBulletOffset; }
46 
47  void SetAscent( tools::Long nAscent ) { mnAscent = nAscent; }
48  void SetDescent( tools::Long nDescent ) { mnDescent = nDescent; }
49  void SetExternalLeading( tools::Long nExtLeading ) { mnExtLeading = nExtLeading; }
50  void SetInternalLeading( tools::Long nIntLeading ) { mnIntLeading = nIntLeading; }
51  void SetLineHeight( tools::Long nHeight ) { mnLineHeight = nHeight; } // TODO this is ascent + descent
52  void SetSlant( tools::Long nSlant ) { mnSlant = nSlant; }
53  void SetBulletOffset( tools::Long nOffset ) { mnBulletOffset = nOffset; }
54 
55  bool IsFullstopCentered() const { return mbFullstopCentered; }
56 
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;
63  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 
75 };
76 
77 template< typename charT, typename traits >
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: */
tools::Long mnAscent
Definition: metric.hxx:66
Font & operator=(const Font &)
Definition: font/font.cxx:281
const OUString & GetFamilyName() const
Definition: font/font.cxx:671
std::basic_ostream< charT, traits > & operator<<(std::basic_ostream< charT, traits > &stream, const FontMetric &rMetric)
Definition: metric.hxx:78
tools::Long GetSlant() const
Definition: metric.hxx:44
tools::Long mnLineHeight
Definition: metric.hxx:70
tools::Long mnExtLeading
Definition: metric.hxx:69
tools::Long mnBulletOffset
Definition: metric.hxx:72
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
long Long
void SetInternalLeading(tools::Long nIntLeading)
Definition: metric.hxx:50
bool mbFullstopCentered
Definition: metric.hxx:74
tools::Long GetExternalLeading() const
Definition: metric.hxx:42
tools::Long mnSlant
Definition: metric.hxx:71
tools::SvRef< FontCharMap > FontCharMapRef
Definition: metric.hxx:28
tools::Long GetAscent() const
Definition: metric.hxx:39
void SetExternalLeading(tools::Long nExtLeading)
Definition: metric.hxx:49
tools::Long mnIntLeading
Definition: metric.hxx:68
bool IsFullstopCentered() const
Definition: metric.hxx:55
void SetBulletOffset(tools::Long nOffset)
Definition: metric.hxx:53
tools::Long Width() const
const Size & GetFontSize() const
Definition: font/font.cxx:674
void SetLineHeight(tools::Long nHeight)
Definition: metric.hxx:51
bool operator==(const Font &) const
Definition: font/font.cxx:293
void SetDescent(tools::Long nDescent)
Definition: metric.hxx:48
tools::Long GetDescent() const
Definition: metric.hxx:40
tools::Long Height() const
tools::Long GetInternalLeading() const
Definition: metric.hxx:41
void SetAscent(tools::Long nAscent)
Definition: metric.hxx:47
tools::Long GetBulletOffset() const
Definition: metric.hxx:45
bool operator!=(const FontMetric &rMetric) const
Definition: metric.hxx:63
void SetSlant(tools::Long nSlant)
Definition: metric.hxx:52
void SetFullstopCenteredFlag(bool bCentered)
Definition: metric.hxx:57
tools::Long mnDescent
Definition: metric.hxx:67
tools::Long GetLineHeight() const
Definition: metric.hxx:43