Debian Codegraph @

cppcanvas/source/mtfrenderer/textaction.hxx

raw
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 #pragma once
21
22 #include <sal/config.h>
23
24 #include <span>
25
26 #include <action.hxx>
27 #include <cppcanvas/canvas.hxx>
28 #include <cppcanvas/renderer.hxx>
29 #include <vcl/kernarray.hxx>
30
31 class VirtualDevice;
32 class Point;
33 class Size;
34 class Color;
35
36
37 /* Definition of internal::TextActionFactory */
38
39 namespace cppcanvas::internal
40 {
41 struct OutDevState;
42
43 /** Creates encapsulated converters between GDIMetaFile and
44 XCanvas. The Canvas argument is deliberately placed at the
45 constructor, to force reconstruction of this object for a
46 new canvas. This considerably eases internal state
47 handling, since a lot of the internal state (e.g. fonts,
48 text layout) is Canvas-dependent.
49 */
50 namespace TextActionFactory
51 {
52 /** Create text action, optionally shadow/relief effect
53
54 Note that this method accepts all coordinates in
55 logical coordinates.
56
57 @param pDXArray
58 Pointer to array of logical character offsets (or NULL)
59
60 @param bSubsettable
61 When this parameter is set to true, the generated
62 action might consume slightly more memory, but is
63 subsettable (Action::render( Subset ) works on
64 characters)
65 */
66 std::shared_ptr<Action> createTextAction( const ::Point& rStartPoint,
67 const ::Size& rReliefOffset,
68 const ::Color& rReliefColor,
69 const ::Size& rShadowOffset,
70 const ::Color& rShadowColor,
71 const ::Color& rTextFillColor,
72 const OUString& rText,
73 sal_Int32 nStartPos,
74 sal_Int32 nLen,
75 KernArraySpan pDXArray,
76 std::span<const sal_Bool> pKashidaArray,
77 VirtualDevice& rVDev,
78 const CanvasSharedPtr& rCanvas,
79 const OutDevState& rState,
80 const Renderer::Parameters& rParms,
81 bool bSubsettable );
82 }
83 }
84
85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */