include/vcl/metric.hxx

   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 <vcl/outdev.hxx>
  26
  27 class ImplFontMetric;
  28 class ImplFontCharMap;
  29 class CmapResult;
  30
  31 typedef sal_uInt32 sal_UCS4;
  32 typedef tools::SvRef<FontCharMap> FontCharMapRef;
  33
  34 class VCL_DLLPUBLIC FontMetric : public vcl::Font
  35 {
  36 public:
  37     explicit            FontMetric();
  38                         FontMetric( const FontMetric& );  // TODO make this explicit
  39     virtual             ~FontMetric() override;
  40
  41     long                GetAscent() const;
  42     long                GetDescent() const;
  43     long                GetInternalLeading() const;
  44     long                GetExternalLeading() const;
  45     long                GetLineHeight() const;
  46     long                GetSlant() const;
  47     long                GetBulletOffset() const;
  48
  49     void                SetAscent(long);
  50     void                SetDescent(long);
  51     void                SetExternalLeading(long);
  52     void                SetInternalLeading(long);
  53     void                SetLineHeight(long);
  54     void                SetSlant(long);
  55     void                SetBulletOffset(long);
  56
  57     bool                IsFullstopCentered() const;
  58
  59     void                SetFullstopCenteredFlag(bool);
  60
  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     tools::SvRef<ImplFontMetric> mxImplMetric;    // Implementation
  68 };
  69
  70 template< typename charT, typename traits >
  71 inline std::basic_ostream<charT, traits> & operator <<(
  72     std::basic_ostream<charT, traits> & stream, const FontMetric& rMetric )
  73 {
  74     stream << "{"
  75            << "name=" << "\"" << rMetric.GetFamilyName() << "\""
  76            << ",size=(" << rMetric.GetFontSize().Width() << "," << rMetric.GetFontSize().Height() << ")"
  77            << ",ascent=" << rMetric.GetAscent()
  78            << ",descent=" << rMetric.GetDescent()
  79            << ",intLeading=" << rMetric.GetInternalLeading()
  80            << ",extLeading=" << rMetric.GetExternalLeading()
  81            << ",lineHeight=" << rMetric.GetLineHeight()
  82            << ",slant=" << rMetric.GetSlant()
  83            << "}";
  84     return stream;
  85 }
  86
  87 #endif // INCLUDED_VCL_METRIC_HXX
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */