offapi/com/sun/star/geometry/RealRectangle2D.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: RealRectangle2D.idl,v $
  10  * $Revision: 1.5 $
  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_geometry_RealRectangle2D_idl__
  31 #define __com_sun_star_geometry_RealRectangle2D_idl__
  32
  33 module com {  module sun {  module star {  module geometry {
  34
  35 /*  Removed, because XCanvas is private API until further notice.
  36
  37     The values are stored as reals. Please note that the
  38     <type>com.sun.star.rendering.XCanvas</type> defines the
  39     screen representation of rectangles in such a way that the lower
  40     and the rightmost line of the rectangle are not drawn on
  41     screen. Thus, if for two rectangles R1 and R2, R1.x2 equals R2.x1,
  42     the screen representation of these rectangles will not overlap,
  43     but being exactly adjacent. That also means, that an
  44     IntegerRectangle2D with X1 equal X2 or Y1 equal Y2 can be
  45     considered empty.<p>
  46 */
  47
  48 /** This structure contains the necessary information for a
  49     two-dimensional rectangle.<p>
  50
  51     @since OOo 2.0.0
  52  */
  53 struct RealRectangle2D
  54 {
  55     /// X coordinate of upper left corner .
  56     double X1;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /// Y coordinate of upper left corner.
  61     double Y1;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** X coordinate of lower right corner.<p>
  66
  67         Must be greater than x1 for non-empty rectangles.<p>.
  68     */
  69     double X2;
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** Y coordinate of lower right corner.<p>
  74
  75         Must be greater than y1 for non-empty rectangles.<p>
  76      */
  77     double Y2;
  78 };
  79
  80 }; }; }; };
  81
  82 #endif