offapi/com/sun/star/awt/XRegion.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: XRegion.idl,v $
  10  * $Revision: 1.12 $
  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_awt_XRegion_idl__
  31 #define __com_sun_star_awt_XRegion_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Rectangle_idl__
  38 #include <com/sun/star/awt/Rectangle.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** manages multiple rectangles which make up a region.
  49  */
  50 published interface XRegion: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns the bounding box of the shape.
  55      */
  56     Rectangle getBounds();
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** makes this region an empty region.
  61      */
  62     [oneway] void clear();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** moves this region by the specified horizontal and vertical delta.
  67      */
  68     [oneway] void move( [in] long nHorzMove,
  69              [in] long nVertMove );
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** adds the specified rectangle to this region.
  74      */
  75     [oneway] void unionRectangle( [in] Rectangle Rect );
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** intersects the specified rectangle with the current region.
  80      */
  81     [oneway] void intersectRectangle( [in] Rectangle Region );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** removes the area of the specified rectangle from this region.
  86      */
  87     [oneway] void excludeRectangle( [in] Rectangle Rect );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** applies an exclusive-or operation with the specified rectangle
  92         to this region.
  93      */
  94     [oneway] void xOrRectangle( [in] Rectangle Rect );
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** adds the specified region to this region.
  99      */
 100     [oneway] void unionRegion( [in] XRegion Region );
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** intersects the specified region with the current region.
 105      */
 106     [oneway] void intersectRegion( [in] XRegion Region );
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** removes the area of the specified region from this region.
 111      */
 112     [oneway] void excludeRegion( [in] XRegion Region );
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** applies an exclusive-or operation with the specified region
 117         to this region.
 118      */
 119     [oneway] void xOrRegion( [in] XRegion Region );
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** returns all rectangles which are making up this region.
 124      */
 125     sequence<Rectangle> getRectangles();
 126
 127 };
 128
 129 //=============================================================================
 130
 131 }; }; }; };
 132
 133 #endif