canvas/source/vcl/outdevprovider.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 #ifndef INCLUDED_CANVAS_SOURCE_VCL_OUTDEVPROVIDER_HXX
  21 #define INCLUDED_CANVAS_SOURCE_VCL_OUTDEVPROVIDER_HXX
  22
  23 #include <sal/types.h>
  24 #include <boost/shared_ptr.hpp>
  25
  26
  27 class OutputDevice;
  28
  29 namespace vclcanvas
  30 {
  31     /* Definition of OutDevProvider interface */
  32
  33     /** Implementers of this interface provide the CanvasHelper
  34         with its OutputDevice.
  35
  36         This additional level of indirection was necessary, as the
  37         OutputDevice is not an interface. There had to be a mechanism
  38         to detect the moment when an OutputDevice is rendered to
  39         (e.g. for the BitmapBackBuffer).
  40      */
  41     class OutDevProvider
  42     {
  43     public:
  44         virtual ~OutDevProvider() {}
  45
  46         virtual OutputDevice&       getOutDev() = 0;
  47         virtual const OutputDevice& getOutDev() const = 0;
  48     };
  49
  50     typedef ::boost::shared_ptr< OutDevProvider > OutDevProviderSharedPtr;
  51 }
  52
  53 #endif // INCLUDED_CANVAS_SOURCE_VCL_OUTDEVPROVIDER_HXX
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */