offapi/com/sun/star/rendering/ViewState.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: ViewState.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_ViewState_idl__
  31 #define __com_sun_star_rendering_ViewState_idl__
  32
  33 #ifndef __com_sun_star_geometry_AffineMatrix2D_idl__
  34 #include <com/sun/star/geometry/AffineMatrix2D.idl>
  35 #endif
  36
  37 module com { module sun { module star { module rendering {
  38
  39 interface XPolyPolygon2D;
  40
  41 /** This structure contains information considered the view state.<p>
  42
  43     This structure contains information considered the view state,
  44     i.e. the invariant setup used when painting a whole view of
  45     something.<p>
  46
  47     @since OOo 2.0.0
  48  */
  49 struct ViewState
  50 {
  51     /** The affine transform associated with the view.<p>
  52
  53         This member is used to transform coordinates of draw
  54         operations from user space to screen space.<p>
  55      */
  56     ::com::sun::star::geometry::AffineMatrix2D  AffineTransform;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** The clipping area associated with the view.<p>
  61
  62         This clipping is interpreted in the view coordinate systems,
  63         i.e. subject to the view transform before mapping to the
  64         device coordinate space.<p>
  65
  66         Specifying an empty interface denotes no clipping,
  67         i.e. everything rendered to the canvas will be visible
  68         (subject to device-dependent constraints, of
  69         course). Specifying an empty XPolyPolygon2D, i.e. a
  70         poly-polygon containing zero polygons, or an XPolyPolygon2D
  71         with any number of empty sub-polygons, denotes the NULL
  72         clip. That means, nothing rendered to the canvas will be
  73         visible.<p>
  74      */
  75     XPolyPolygon2D                                                                              Clip;
  76 };
  77
  78 }; }; }; };
  79
  80 #endif