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 
30 typedef sal_uInt32 sal_UCS4;
32 
34 {
35 public:
36  explicit FontMetric();
37  FontMetric( const FontMetric& ); // TODO make this explicit
38  ~FontMetric() override;
39 
40  long GetAscent() const { return mnAscent; }
41  long GetDescent() const { return mnDescent; }
42  long GetInternalLeading() const { return mnIntLeading; }
43  long GetExternalLeading() const { return mnExtLeading; }
44  long GetLineHeight() const { return mnLineHeight; } // TODO this is ascent + descnt
45  long GetSlant() const { return mnSlant; }
46  long GetBulletOffset() const { return mnBulletOffset; }
47 
48  void SetAscent( long nAscent ) { mnAscent = nAscent; }
49  void SetDescent( long nDescent ) { mnDescent = nDescent; }
50  void SetExternalLeading( long nExtLeading ) { mnExtLeading = nExtLeading; }
51  void SetInternalLeading( long nIntLeading ) { mnIntLeading = nIntLeading; }
52  void SetLineHeight( long nHeight ) { mnLineHeight = nHeight; } // TODO this is ascent + descent
53  void SetSlant( long nSlant ) { mnSlant = nSlant; }
54  void SetBulletOffset( long nOffset ) { mnBulletOffset = nOffset; }
55 
56  bool IsFullstopCentered() const { return mbFullstopCentered; }
57 
58  void SetFullstopCenteredFlag( bool bCentered ) { mbFullstopCentered = bCentered; }
59 
60  using Font::operator=;
61  FontMetric& operator=( const FontMetric& rMetric );
62  FontMetric& operator=( FontMetric&& rMetric );
63  bool operator==( const FontMetric& rMetric ) const;
64  bool operator!=( const FontMetric& rMetric ) const
65  { return !operator==( rMetric ); }
66 private:
67  long mnAscent; // Ascent
68  long mnDescent; // Descent
69  long mnIntLeading; // Internal Leading
70  long mnExtLeading; // External Leading
71  long mnLineHeight; // Ascent+Descent+EmphasisMark
72  long mnSlant; // Slant
73  long mnBulletOffset; // Offset for non-printing character
74 
76 };
77 
78 template< typename charT, typename traits >
79 inline std::basic_ostream<charT, traits> & operator <<(
80  std::basic_ostream<charT, traits> & stream, const FontMetric& rMetric )
81 {
82  stream << "{"
83  << "name=" << "\"" << rMetric.GetFamilyName() << "\""
84  << ",size=(" << rMetric.GetFontSize().Width() << "," << rMetric.GetFontSize().Height() << ")"
85  << ",ascent=" << rMetric.GetAscent()
86  << ",descent=" << rMetric.GetDescent()
87  << ",intLeading=" << rMetric.GetInternalLeading()
88  << ",extLeading=" << rMetric.GetExternalLeading()
89  << ",lineHeight=" << rMetric.GetLineHeight()
90  << ",slant=" << rMetric.GetSlant()
91  << "}";
92  return stream;
93 }
94 
95 #endif // INCLUDED_VCL_METRIC_HXX
96 
97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long Width() const
void SetLineHeight(long nHeight)
Definition: metric.hxx:52
Font & operator=(const Font &)
Definition: font/font.cxx:280
const OUString & GetFamilyName() const
Definition: font/font.cxx:666
std::basic_ostream< charT, traits > & operator<<(std::basic_ostream< charT, traits > &stream, const FontMetric &rMetric)
Definition: metric.hxx:79
void SetBulletOffset(long nOffset)
Definition: metric.hxx:54
long Height() const
long mnDescent
Definition: metric.hxx:68
void SetInternalLeading(long nIntLeading)
Definition: metric.hxx:51
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
void SetDescent(long nDescent)
Definition: metric.hxx:49
bool mbFullstopCentered
Definition: metric.hxx:75
void SetExternalLeading(long nExtLeading)
Definition: metric.hxx:50
long mnAscent
Definition: metric.hxx:67
tools::SvRef< FontCharMap > FontCharMapRef
Definition: metric.hxx:31
long mnBulletOffset
Definition: metric.hxx:73
long mnLineHeight
Definition: metric.hxx:71
sal_uInt32 sal_UCS4
Definition: metric.hxx:28
long GetDescent() const
Definition: metric.hxx:41
bool IsFullstopCentered() const
Definition: metric.hxx:56
long mnSlant
Definition: metric.hxx:72
const Size & GetFontSize() const
Definition: font/font.cxx:669
long GetAscent() const
Definition: metric.hxx:40
long GetExternalLeading() const
Definition: metric.hxx:43
void SetAscent(long nAscent)
Definition: metric.hxx:48
long mnExtLeading
Definition: metric.hxx:70
bool operator==(const Font &) const
Definition: font/font.cxx:292
long GetInternalLeading() const
Definition: metric.hxx:42
long GetBulletOffset() const
Definition: metric.hxx:46
bool operator!=(const FontMetric &rMetric) const
Definition: metric.hxx:64
void SetFullstopCenteredFlag(bool bCentered)
Definition: metric.hxx:58
void SetSlant(long nSlant)
Definition: metric.hxx:53
long mnIntLeading
Definition: metric.hxx:69
long GetSlant() const
Definition: metric.hxx:45
long GetLineHeight() const
Definition: metric.hxx:44