cppcanvas/source/inc/action.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: action.hxx,v $
  10  * $Revision: 1.8 $
  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 _CPPCANVAS_ACTION_HXX
  32 #define _CPPCANVAS_ACTION_HXX
  33
  34 #include <sal/types.h>
  35
  36 #ifndef BOOST_SHARED_PTR_HPP_INCLUDED
  37 #include <boost/shared_ptr.hpp>
  38 #endif
  39
  40 namespace basegfx
  41 {
  42     class B2DHomMatrix;
  43     class B2DRange;
  44 }
  45
  46
  47 /* Definition of Action interface */
  48
  49 namespace cppcanvas
  50 {
  51     namespace internal
  52     {
  53         /** Interface for internal render actions
  54
  55             This interface is implemented by all objects generated
  56             from the metafile renderer, and corresponds roughly to the
  57             VCL meta action.
  58          */
  59         class Action
  60         {
  61         public:
  62             /** Used for rendering action subsets
  63
  64                 There are several cases where an Action might have
  65                 subsettable content, e.g. text, or referenced
  66                 metafiles, like the transparent action.
  67
  68                 Generally, at the metafile renderer, all actions are
  69                 'flattened' out, i.e. a meta action rendering the
  70                 string "Hello" counts five indices, and a transparent
  71                 action containing a metafile with 100 actions counts
  72                 at least 100 indices (contained transparency or text
  73                 actions recursively add to this value). From the
  74                 outside, the subset to render is referenced via this
  75                 flat index range
  76              */
  77             struct Subset
  78             {
  79                 /** Denotes start of the subset.
  80
  81                     The index given here specifies the first subaction
  82                     to render.
  83                  */
  84                 sal_Int32       mnSubsetBegin;
  85
  86                 /** Denotes end of the subset
  87
  88                     The index given here specifies the first subaction
  89                     <em>not<em> to render, i.e. one action behind the
  90                     subset to be rendered
  91                  */
  92                 sal_Int32       mnSubsetEnd;
  93             };
  94
  95             virtual ~Action() {}
  96
  97             /** Render this action to the associated canvas
  98
  99                 @param rTransformation
 100                 Transformation matrix to apply before rendering
 101
 102                 @return true, if rendering was successful. If
 103                 rendering failed, false is returned.
 104              */
 105             virtual bool render( const ::basegfx::B2DHomMatrix& rTransformation ) const = 0;
 106
 107             /** Render the given part of the action to the associated
 108                 canvas.
 109
 110                 @param rTransformation
 111                 Transformation matrix to apply before rendering
 112
 113                 @param rSubset
 114                 Subset of the action to render. See Subset description
 115                 for index semantics.
 116
 117                 @return true, if rendering was successful. If the
 118                 specified subset is invalid for this action, or if
 119                 rendering failed for other reasons, false is returned.
 120              */
 121             virtual bool render( const ::basegfx::B2DHomMatrix& rTransformation,
 122                                  const Subset&                                  rSubset ) const = 0;
 123
 124             /** Query bounds of this action on the associated canvas
 125
 126                 @param rTransformation
 127                 Transformation matrix to apply
 128
 129                 @return the bounds for this action in device
 130                 coordinate space.
 131              */
 132             virtual ::basegfx::B2DRange getBounds( const ::basegfx::B2DHomMatrix& rTransformation ) const = 0;
 133
 134             /** Query bounds for the given part of the action on the
 135                 associated canvas.
 136
 137                 @param rTransformation
 138                 Transformation matrix to apply.
 139
 140                 @param rSubset
 141                 Subset of the action to query. See Subset description
 142                 for index semantics.
 143
 144                 @return the bounds for the given subset in device
 145                 coordinate space.
 146              */
 147             virtual ::basegfx::B2DRange getBounds( const ::basegfx::B2DHomMatrix&       rTransformation,
 148                                                    const Subset&                                        rSubset ) const = 0;
 149
 150             /** Query action count.
 151
 152                 This method returns the number of subset actions
 153                 contained in this action. The render( Subset ) method
 154                 must accept subset ranges up to the value returned
 155                 here.
 156
 157                 @return the number of subset actions
 158              */
 159             virtual sal_Int32 getActionCount() const = 0;
 160         };
 161
 162         typedef ::boost::shared_ptr< Action > ActionSharedPtr;
 163
 164     }
 165 }
 166
 167 #endif /* _CPPCANVAS_ACTION_HXX */