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