include/canvas/rendering/icachedprimitive.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_ICACHEDPRIMITIVE_HXX
  21 #define INCLUDED_CANVAS_ICACHEDPRIMITIVE_HXX
  22
  23 #include <sal/types.h>
  24
  25 #include <boost/shared_ptr.hpp>
  26
  27
  28 namespace basegfx
  29 {
  30     class B2IRange;
  31     class B2IPoint;
  32 }
  33
  34 namespace canvas
  35 {
  36     /** Objects with this interface are returned from every Bitmap
  37         render operation.
  38
  39         These objects can be used to implement the
  40         rendering::XCachedPrimitive interface, which in turn caches
  41         render state and objects to facilitate quick redraws.
  42      */
  43     struct ICachedPrimitive
  44     {
  45         virtual ~ICachedPrimitive() {}
  46
  47         /** Redraw the primitive with the given view state
  48
  49             Note that the primitive will <em>always</em> be redrawn on
  50             the bitmap it was created from.
  51          */
  52         virtual sal_Int8 redraw( const ::com::sun::star::rendering::ViewState& aState ) const = 0;
  53     };
  54
  55     typedef ::boost::shared_ptr< ICachedPrimitive > ICachedPrimitiveSharedPtr;
  56 }
  57
  58 #endif /* INCLUDED_CANVAS_ICACHEDPRIMITIVE_HXX */
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */