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

   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 #ifndef __com_sun_star_rendering_XCachedPrimitive_idl__
  20 #define __com_sun_star_rendering_XCachedPrimitive_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/rendering/ViewState.idl>
  25
  26 module com { module sun { module star { module rendering {
  27
  28 /** Interface for cached repaint of already drawn XCanvas
  29     primitives.<p>
  30
  31     This interface provides a method to quickly redraw some
  32     XCanvas primitives, using cached data.<p>
  33
  34     @since OOo 2.0
  35  */
  36 interface XCachedPrimitive : ::com::sun::star::uno::XInterface
  37 {
  38     /** Redraw the cached primitive.<p>
  39
  40         Redraw the cached primitive, with a possibly new view state.<p>
  41
  42         @param aState
  43         The view state to be used when redrawing the primitive. The
  44         view state is of course permitted to differ from the one used
  45         for initial rendering.
  46
  47         @return a value of type RepaintResult, denoting
  48         the result of this operation.
  49
  50         @throws com::sun::star::lang::IllegalArgumentException
  51         if the view transformation matrix is singular.
  52      */
  53     byte redraw( [in] ViewState aState )
  54         raises (com::sun::star::lang::IllegalArgumentException);
  55 };
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */