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