include/drawinglayer/processor2d/processor2dtools.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 #ifndef INCLUDED_DRAWINGLAYER_PROCESSOR2D_PROCESSOR2DTOOLS_HXX
  20 #define INCLUDED_DRAWINGLAYER_PROCESSOR2D_PROCESSOR2DTOOLS_HXX
  21
  22 #include <drawinglayer/drawinglayerdllapi.h>
  23 #include <memory>
  24
  25 namespace drawinglayer::geometry { class ViewInformation2D; }
  26 namespace drawinglayer::processor2d { class BaseProcessor2D; }
  27
  28 class OutputDevice;
  29
  30 namespace drawinglayer::processor2d
  31     {
  32         /** create the best available pixel based BaseProcessor2D
  33             (which may be system-dependent)
  34
  35             @param rTargetOutDev
  36             The target OutputDevice
  37
  38             @param rViewInformation2D
  39             The ViewInformation to use
  40
  41             @return
  42             the created BaseProcessor2D (ownership change) or null if
  43             something went wrong
  44         */
  45         DRAWINGLAYER_DLLPUBLIC std::unique_ptr<BaseProcessor2D> createPixelProcessor2DFromOutputDevice(
  46             OutputDevice& rTargetOutDev,
  47             const drawinglayer::geometry::ViewInformation2D& rViewInformation2D);
  48
  49         /** create a BaseProcessor2D dependent on some states of the
  50             given OutputDevice. If metafile is recorded, the needed
  51             VclMetafileProcessor2D will be created. If a pixel renderer
  52             is requested, the best one is incarnated
  53
  54             @param rTargetOutDev
  55             The target OutputDevice
  56
  57             @param rViewInformation2D
  58             The ViewInformation to use
  59
  60             @return
  61             the created BaseProcessor2D (ownership change) or null if
  62             something went wrong
  63         */
  64         DRAWINGLAYER_DLLPUBLIC std::unique_ptr<BaseProcessor2D> createProcessor2DFromOutputDevice(
  65             OutputDevice& rTargetOutDev,
  66             const drawinglayer::geometry::ViewInformation2D& rViewInformation2D);
  67
  68
  69 } // end of namespace drawinglayer::processor2d
  70
  71 #endif //INCLUDED_DRAWINGLAYER_PROCESSOR2D_PROCESSOR2DTOOLS_HXX
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */