offapi/com/sun/star/rendering/XCachedPrimitive.idl

   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: XCachedPrimitive.idl,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 #ifndef __com_sun_star_rendering_XCachedPrimitive_idl__
  31 #define __com_sun_star_rendering_XCachedPrimitive_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  37 #include <com/sun/star/lang/IllegalArgumentException.idl>
  38 #endif
  39 #ifndef __com_sun_star_rendering_ViewState_idl__
  40 #include <com/sun/star/rendering/ViewState.idl>
  41 #endif
  42
  43 module com { module sun { module star { module rendering {
  44
  45 /** Interface for cached repaint of already drawn <type>XCanvas</type>
  46     primitives.<p>
  47
  48     This interface provides a method to quickly redraw some
  49     <type>XCanvas</type> primitives, using cached data.<p>
  50
  51     @since OOo 2.0.0
  52  */
  53 interface XCachedPrimitive : ::com::sun::star::uno::XInterface
  54 {
  55     /** Redraw the cached primitive.<p>
  56
  57         Redraw the cached primitive, with a possibly new view state.<p>
  58
  59         @param aState
  60         The view state to be used when redrawing the primitive. The
  61         view state is of course permitted to differ from the one used
  62         for initial rendering.
  63
  64         @return a value of type <type>RepaintResult</type>, denoting
  65         the result of this operation.
  66
  67         @throws <type>com::sun::star::lang::IllegalArgumentException</type>
  68         if the view transformation matrix is singular.
  69      */
  70     byte redraw( [in] ViewState aState )
  71         raises (com::sun::star::lang::IllegalArgumentException);
  72 };
  73
  74 }; }; }; };
  75
  76 #endif