include/drawinglayer/primitive2d/textlayoutdevice.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_DRAWINGLAYER_TEXTLAYOUTDEVICE_HXX
  21 #define INCLUDED_DRAWINGLAYER_TEXTLAYOUTDEVICE_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <tools/solar.h>
  26 #include <tools/poly.hxx>
  27 #include <basegfx/range/b2drange.hxx>
  28 #include <vector>
  29 #include <com/sun/star/lang/Locale.hpp>
  30 #include <basegfx/polygon/b2dpolypolygon.hxx>
  31
  32 //////////////////////////////////////////////////////////////////////////////
  33 // predefines
  34 class VirtualDevice;
  35 class Font;
  36 class String;
  37 class OutputDevice;
  38 class GDIMetaFile;
  39
  40 namespace drawinglayer { namespace attribute {
  41     class FontAttribute;
  42 }}
  43
  44 //////////////////////////////////////////////////////////////////////////////
  45 // access to one global impTimedRefDev incarnation in namespace drawinglayer::primitive
  46
  47 namespace drawinglayer
  48 {
  49     namespace primitive2d
  50     {
  51         /** TextLayouterDevice class
  52
  53             This helper class exists to isolate all accesses to VCL
  54             text formatting/handling functionality for primitive implementations.
  55             When in the future FontHandling may move to an own library independent
  56             from VCL, primitives will be prepared.
  57          */
  58         class DRAWINGLAYER_DLLPUBLIC TextLayouterDevice
  59         {
  60             /// internally used VirtualDevice
  61             VirtualDevice&                  mrDevice;
  62
  63         public:
  64             /// constructor/destructor
  65             TextLayouterDevice();
  66             ~TextLayouterDevice();
  67
  68             /// tooling methods
  69             void setFont(const Font& rFont);
  70             void setFontAttribute(
  71                 const attribute::FontAttribute& rFontAttribute,
  72                 double fFontScaleX,
  73                 double fFontScaleY,
  74                 const ::com::sun::star::lang::Locale & rLocale);
  75
  76             double getTextHeight() const;
  77             double getOverlineHeight() const;
  78             double getOverlineOffset() const;
  79             double getUnderlineHeight() const;
  80             double getUnderlineOffset() const;
  81             double getStrikeoutOffset() const;
  82
  83             double getTextWidth(
  84                 const String& rText,
  85                 sal_uInt32 nIndex,
  86                 sal_uInt32 nLength) const;
  87
  88             bool getTextOutlines(
  89                 basegfx::B2DPolyPolygonVector&,
  90                 const String& rText,
  91                 sal_uInt32 nIndex,
  92                 sal_uInt32 nLength,
  93                 const ::std::vector< double >& rDXArray) const;
  94
  95             basegfx::B2DRange getTextBoundRect(
  96                 const String& rText,
  97                 sal_uInt32 nIndex,
  98                 sal_uInt32 nLength) const;
  99
 100             double getFontAscent() const;
 101             double getFontDescent() const;
 102
 103             void addTextRectActions(
 104                 const Rectangle& rRectangle,
 105                 const String& rText,
 106                 sal_uInt16 nStyle,
 107                 GDIMetaFile& rGDIMetaFile) const;
 108
 109             ::std::vector< double > getTextArray(
 110                 const String& rText,
 111                 sal_uInt32 nIndex,
 112                 sal_uInt32 nLength) const;
 113         };
 114     } // end of namespace primitive2d
 115 } // end of namespace drawinglayer
 116
 117 //////////////////////////////////////////////////////////////////////////////
 118 // helper methods for vcl font handling
 119
 120 namespace drawinglayer
 121 {
 122     namespace primitive2d
 123     {
 124         /** Create a VCL-Font based on the definitions in FontAttribute
 125             and the given FontScaling. The FontScaling defines the FontHeight
 126             (fFontScaleY) and the FontWidth (fFontScaleX). The combination of
 127             both defines FontStretching, where no stretching happens at
 128             fFontScaleY == fFontScaleX
 129          */
 130         Font DRAWINGLAYER_DLLPUBLIC getVclFontFromFontAttribute(
 131             const attribute::FontAttribute& rFontAttribute,
 132             double fFontScaleX,
 133             double fFontScaleY,
 134             double fFontRotation,
 135             const ::com::sun::star::lang::Locale & rLocale);
 136
 137         /** Generate FontAttribute DataSet derived from the given VCL-Font.
 138             The FontScaling with fFontScaleY, fFontScaleX relationship (see
 139             above) will be set in return parameter o_rSize to allow further
 140             processing
 141          */
 142         attribute::FontAttribute DRAWINGLAYER_DLLPUBLIC getFontAttributeFromVclFont(
 143             basegfx::B2DVector& o_rSize,
 144             const Font& rFont,
 145             bool bRTL,
 146             bool bBiDiStrong);
 147
 148     } // end of namespace primitive2d
 149 } // end of namespace drawinglayer
 150
 151 //////////////////////////////////////////////////////////////////////////////
 152
 153 #endif //_DRAWINGLAYER_TEXTLAYOUTDEVICE_HXX
 154
 155 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */