offapi/com/sun/star/geometry/RealRectangle2D.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_geometry_RealRectangle2D_idl__
  29 #define __com_sun_star_geometry_RealRectangle2D_idl__
  30
  31 module com {  module sun {  module star {  module geometry {
  32
  33 /*  Removed, because XCanvas is private API until further notice.
  34
  35     The values are stored as reals. Please note that the
  36     <type>com.sun.star.rendering.XCanvas</type> defines the
  37     screen representation of rectangles in such a way that the lower
  38     and the rightmost line of the rectangle are not drawn on
  39     screen. Thus, if for two rectangles R1 and R2, R1.x2 equals R2.x1,
  40     the screen representation of these rectangles will not overlap,
  41     but being exactly adjacent. That also means, that an
  42     IntegerRectangle2D with X1 equal X2 or Y1 equal Y2 can be
  43     considered empty.<p>
  44 */
  45
  46 /** This structure contains the necessary information for a
  47     two-dimensional rectangle.<p>
  48
  49     @since OOo 2.0
  50  */
  51 struct RealRectangle2D
  52 {
  53     /// X coordinate of upper left corner .
  54     double X1;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /// Y coordinate of upper left corner.
  59     double Y1;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** X coordinate of lower right corner.<p>
  64
  65         Must be greater than x1 for non-empty rectangles.<p>.
  66     */
  67     double X2;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** Y coordinate of lower right corner.<p>
  72
  73         Must be greater than y1 for non-empty rectangles.<p>
  74      */
  75     double Y2;
  76 };
  77
  78 }; }; }; };
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */