summaryrefslogtreecommitdiff log msg author committer range
path: root/include/cppcanvas/renderer.hxx
blob: 113bda783f20996f5e3d1afa17c99fbef85713a6 (plain)
 ```1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 ``` ``````/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_CPPCANVAS_RENDERER_HXX #define INCLUDED_CPPCANVAS_RENDERER_HXX #include #include #include #include #include #include #include namespace basegfx { class B2DRange; } /* Definition of Renderer interface */ namespace cppcanvas { class Renderer : public virtual CanvasGraphic { public: /** Render subset of metafile to given canvas This method renders the given subset of the content to the associated canvas. @param nStartIndex The index of the first action to be rendered (the indices correspond roughly to the action indices of the originating GDIMetaFile. Note, although, that certain actions, e.g. text, accounts for more than one index: a text produces as many addressable indices as it has characters). @param nEndIndex The index of the first action _not_ painted anymore, i.e. the action after the last action rendered (the indices correspond roughly to the action indices of the originating GDIMetaFile. Note, although, that certain actions, e.g. text, accounts for more than one index: a text produces as many addressable indices as it has characters). @return whether the rendering finished successfully. */ virtual bool drawSubset( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) const = 0; /** Query bounding box of metafile subset This method queries the actual bounding box of the given subset, when rendered on the associated canvas. @param nStartIndex The index of the first action to be rendered (the indices correspond roughly to the action indices of the originating GDIMetaFile. Note, although, that certain actions, e.g. text, accounts for more than one index: a text produces as many addressable indices as it has characters). @param nEndIndex The index of the first action _not_ painted anymore, i.e. the action after the last action rendered (the indices correspond roughly to the action indices of the originating GDIMetaFile. Note, although, that certain actions, e.g. text, accounts for more than one index: a text produces as many addressable indices as it has characters). @return the bounding box of the specified subset */ virtual ::basegfx::B2DRange getSubsetArea( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) const = 0; /** Parameters for the Renderer */ struct Parameters { /// Optionally forces the fill color attribute for all actions ::boost::optional< IntSRGBA > maFillColor; /// Optionally forces the line color attribute for all actions ::boost::optional< IntSRGBA > maLineColor; /// Optionally forces the text color attribute for all actions ::boost::optional< IntSRGBA > maTextColor; /// Optionally forces the given fontname for all text actions ::boost::optional< OUString > maFontName; /** Optionally transforms all text output actions with the given matrix (in addition to the overall canvas transformation). Note that the matrix given here is applied to the unit rect coordinate system, i.e. the metafile is assumed to be contained in the unit rect. */ ::boost::optional< ::basegfx::B2DHomMatrix > maTextTransformation; /// Optionally forces the given font weight for all text actions ::boost::optional< sal_Int8 > maFontWeight; /// Optionally forces the given font letter form (italics etc.) for all text actions ::boost::optional< sal_Int8 > maFontLetterForm; /// Optionally forces underlining for all text actions ::boost::optional< bool > maFontUnderline; }; }; typedef std::shared_ptr< ::cppcanvas::Renderer > RendererSharedPtr; } #endif // INCLUDED_CPPCANVAS_RENDERER_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ ``````