canvas/source/vcl/outdevprovider.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: outdevprovider.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _VCLCANVAS_OUTDEVPROVIDER_HXX
  32 #define _VCLCANVAS_OUTDEVPROVIDER_HXX
  33
  34 #include <sal/types.h>
  35 #include <boost/shared_ptr.hpp>
  36
  37
  38 class OutputDevice;
  39
  40 namespace vclcanvas
  41 {
  42     /* Definition of OutDevProvider interface */
  43
  44     /** Implementers of this interface provide the CanvasHelper
  45         with its OutputDevice.
  46
  47         This additional level of indirection was necessary, as the
  48         OutputDevice is not an interface. There had to be a mechanism
  49         to detect the moment when an OutputDevice is rendered to
  50         (e.g. for the BitmapBackBuffer).
  51      */
  52     class OutDevProvider
  53     {
  54     public:
  55         virtual ~OutDevProvider() {}
  56
  57         virtual OutputDevice&           getOutDev() = 0;
  58         virtual const OutputDevice& getOutDev() const = 0;
  59     };
  60
  61     typedef ::boost::shared_ptr< OutDevProvider > OutDevProviderSharedPtr;
  62 }
  63
  64 #endif /* _VCLCANVAS_OUTDEVPROVIDER_HXX */