Line data Source code
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_PRIMITIVE2D_TEXTPRIMITIVE2D_HXX
21 : #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_TEXTPRIMITIVE2D_HXX
22 :
23 : #include <drawinglayer/drawinglayerdllapi.h>
24 :
25 : #include <drawinglayer/primitive2d/baseprimitive2d.hxx>
26 : #include <basegfx/matrix/b2dhommatrix.hxx>
27 : #include <rtl/ustring.hxx>
28 : #include <vcl/font.hxx>
29 : #include <basegfx/color/bcolor.hxx>
30 : #include <vector>
31 : #include <com/sun/star/lang/Locale.hpp>
32 : #include <drawinglayer/attribute/fontattribute.hxx>
33 : #include <basegfx/polygon/b2dpolypolygon.hxx>
34 :
35 :
36 : // predefines
37 :
38 : class OutputDevice;
39 :
40 :
41 :
42 : namespace drawinglayer
43 : {
44 : namespace primitive2d
45 : {
46 : /** TextSimplePortionPrimitive2D class
47 :
48 : This is the basic primitive for representing a text portion. It contains
49 : all needed information. If it is not handled by a renderer, its decomposition
50 : will provide the text tools::PolyPolygon outlines as filled polygons, correctly
51 : transformed.
52 :
53 : To get better text quality, it is suggested to handle tis primitive directly
54 : in a renderer. In that case, e.g. hintings on the system can be supported.
55 :
56 : @param maTextTransform
57 : The text transformation contains the text start position (always baselined)
58 : as translation, the FontSize as scale (where width relative to height defines
59 : font scaling and width == height means no font scaling) and the font rotation
60 : and shear.
61 : When shear is used and a renderer does not support it, it may be better to use
62 : the decomposition which will do everything correctly. Same is true for mirroring
63 : which would be expressed as negative scalings.
64 :
65 : @param rText
66 : The text to be used. Only a part may be used, but a bigger part of the string
67 : may be necessary for correct layouting (e.g. international)
68 :
69 : @param aTextPosition
70 : The index to the first character to use from rText
71 :
72 : @param aTextLength
73 : The number of characters to use from rText
74 :
75 : @param rDXArray
76 : The distances between the characters. This parameter may be empty, in that case
77 : the renderer is responsible to do something useful. If it is given, it has to be of
78 : the size aTextLength. Its values are in logical coordinates and describe the
79 : distance for each character to use. This is independent from the font width which
80 : is given with maTextTransform. The first value is the offset to use from the start
81 : point in FontCoordinateSystem X-Direction (given by maTextTransform) to the start
82 : point of the second character
83 :
84 : @param rFontAttribute
85 : The font definition
86 :
87 : @param rLocale
88 : The locale to use
89 :
90 : @param rFontColor
91 : The font color to use
92 :
93 : @param bFilled
94 :
95 : @param nWidthToFill
96 :
97 : @param rFillColor
98 : Text background color (has nothing to do with bFilled and nWidthToFill)
99 :
100 : */
101 50421 : class DRAWINGLAYER_DLLPUBLIC TextSimplePortionPrimitive2D : public BufferedDecompositionPrimitive2D
102 : {
103 : private:
104 : /// text transformation (FontCoordinateSystem)
105 : basegfx::B2DHomMatrix maTextTransform;
106 :
107 : /// The text, used from maTextPosition up to maTextPosition + maTextLength
108 : OUString maText;
109 :
110 : /// The index from where on maText is used
111 : sal_Int32 mnTextPosition;
112 :
113 : /// The length for maText usage, starting from maTextPosition
114 : sal_Int32 mnTextLength;
115 :
116 : /// The DX array in logic units
117 : ::std::vector< double > maDXArray;
118 :
119 : /// The font definition
120 : attribute::FontAttribute maFontAttribute;
121 :
122 : /// The Locale for the text
123 : ::com::sun::star::lang::Locale maLocale;
124 :
125 : /// font color
126 : basegfx::BColor maFontColor;
127 :
128 :
129 : /// #i96669# internal: add simple range buffering for this primitive
130 : basegfx::B2DRange maB2DRange;
131 : bool mbFilled; // Whether to fill a given width with the text
132 : long mnWidthToFill; // the width to fill
133 :
134 : /// The fill color of the text
135 : Color maTextFillColor;
136 :
137 : protected:
138 : /// local decomposition.
139 : virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const SAL_OVERRIDE;
140 :
141 : public:
142 : /// constructor
143 : TextSimplePortionPrimitive2D(
144 : const basegfx::B2DHomMatrix& rNewTransform,
145 : const OUString& rText,
146 : sal_Int32 nTextPosition,
147 : sal_Int32 nTextLength,
148 : const ::std::vector< double >& rDXArray,
149 : const attribute::FontAttribute& rFontAttribute,
150 : const ::com::sun::star::lang::Locale& rLocale,
151 : const basegfx::BColor& rFontColor,
152 : bool bFilled = false,
153 : long nWidthToFill = 0,
154 : const Color& rFillColor = COL_TRANSPARENT );
155 :
156 : /// helpers
157 : /** get text outlines as polygons and their according ObjectTransformation. Handles all
158 : the necessary VCL outline extractins, scaling adaptions and other stuff.
159 : */
160 : void getTextOutlinesAndTransformation(basegfx::B2DPolyPolygonVector& rTarget, basegfx::B2DHomMatrix& rTransformation) const;
161 :
162 : /// data read access
163 45747 : const basegfx::B2DHomMatrix& getTextTransform() const { return maTextTransform; }
164 44305 : const OUString& getText() const { return maText; }
165 47196 : sal_Int32 getTextPosition() const { return mnTextPosition; }
166 71362 : sal_Int32 getTextLength() const { return mnTextLength; }
167 137657 : const ::std::vector< double >& getDXArray() const { return maDXArray; }
168 95655 : const attribute::FontAttribute& getFontAttribute() const { return maFontAttribute; }
169 46800 : const ::com::sun::star::lang::Locale& getLocale() const { return maLocale; }
170 23067 : const basegfx::BColor& getFontColor() const { return maFontColor; }
171 15239 : const Color& getTextFillColor() const { return maTextFillColor; }
172 14603 : bool isFilled() const { return mbFilled; }
173 0 : long getWidthToFill() const { return mnWidthToFill; }
174 :
175 : /// compare operator
176 : virtual bool operator==( const BasePrimitive2D& rPrimitive ) const SAL_OVERRIDE;
177 :
178 : /// get range
179 : virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const SAL_OVERRIDE;
180 :
181 : /// provide unique ID
182 : DeclPrimitive2DIDBlock()
183 : };
184 :
185 : /// small helper to have a compare operator for Locale
186 : bool DRAWINGLAYER_DLLPUBLIC LocalesAreEqual(const ::com::sun::star::lang::Locale& rA, const ::com::sun::star::lang::Locale& rB);
187 :
188 : } // end of namespace primitive2d
189 : } // end of namespace drawinglayer
190 :
191 :
192 :
193 : #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_TEXTPRIMITIVE2D_HXX
194 :
195 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
