include/cppcanvas/canvasgraphic.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_CPPCANVAS_CANVASGRAPHIC_HXX
  21 #define INCLUDED_CPPCANVAS_CANVASGRAPHIC_HXX
  22
  23 #include <sal/types.h>
  24 #include <cppcanvas/color.hxx>
  25 #include <cppcanvas/canvas.hxx>
  26 #include <memory>
  27
  28 namespace basegfx
  29 {
  30     class B2DHomMatrix;
  31     class B2DPolyPolygon;
  32 }
  33
  34
  35 /* Definition of CanvasGraphic interface */
  36
  37 namespace cppcanvas
  38 {
  39     // forward declaration, since tools::PolyPolygon also derives from CanvasGraphic
  40     typedef std::shared_ptr< class PolyPolygon > PolyPolygonSharedPtr;
  41
  42
  43     /** This interface defines basic properties of
  44         objects that can be painted on a Canvas
  45      */
  46     class CanvasGraphic
  47     {
  48     public:
  49
  50         virtual ~CanvasGraphic() {}
  51
  52         /** Set object transformation matrix
  53          */
  54         virtual void                             setTransformation( const ::basegfx::B2DHomMatrix& rMatrix ) = 0;
  55
  56         /** Set object clipping polygon
  57          */
  58         virtual void                             setClip( const ::basegfx::B2DPolyPolygon& rClipPoly ) = 0;
  59         /** Clear object clipping polygon
  60          */
  61         virtual void                             setClip() = 0;
  62
  63         /** Set object composite mode
  64          * @see css::rendering::CompositeOperation
  65          */
  66         virtual void                             setCompositeOp( sal_Int8 aOp ) = 0;
  67
  68         /** Render to parent canvas
  69
  70             This method renders the content to the parent canvas,
  71             i.e. the canvas this object was constructed for.
  72
  73             @return whether the rendering finished successfully.
  74          */
  75         virtual bool draw() const = 0;
  76
  77     };
  78
  79     typedef std::shared_ptr< ::cppcanvas::CanvasGraphic > CanvasGraphicSharedPtr;
  80 }
  81
  82 #endif // INCLUDED_CPPCANVAS_CANVASGRAPHIC_HXX
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */