offapi/com/sun/star/awt/XRegion.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XRegion_idl__
  20 #define __com_sun_star_awt_XRegion_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/Rectangle.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** manages multiple rectangles which make up a region.
  32  */
  33 published interface XRegion: com::sun::star::uno::XInterface
  34 {
  35
  36     /** returns the bounding box of the shape.
  37      */
  38     Rectangle getBounds();
  39
  40
  41     /** makes this region an empty region.
  42      */
  43     void clear();
  44
  45
  46     /** moves this region by the specified horizontal and vertical delta.
  47      */
  48     void move( [in] long nHorzMove,
  49              [in] long nVertMove );
  50
  51
  52     /** adds the specified rectangle to this region.
  53      */
  54     void unionRectangle( [in] Rectangle Rect );
  55
  56
  57     /** intersects the specified rectangle with the current region.
  58      */
  59     void intersectRectangle( [in] Rectangle Region );
  60
  61
  62     /** removes the area of the specified rectangle from this region.
  63      */
  64     void excludeRectangle( [in] Rectangle Rect );
  65
  66
  67     /** applies an exclusive-or operation with the specified rectangle
  68         to this region.
  69      */
  70     void xOrRectangle( [in] Rectangle Rect );
  71
  72
  73     /** adds the specified region to this region.
  74      */
  75     void unionRegion( [in] XRegion Region );
  76
  77
  78     /** intersects the specified region with the current region.
  79      */
  80     void intersectRegion( [in] XRegion Region );
  81
  82
  83     /** removes the area of the specified region from this region.
  84      */
  85     void excludeRegion( [in] XRegion Region );
  86
  87
  88     /** applies an exclusive-or operation with the specified region
  89         to this region.
  90      */
  91     void xOrRegion( [in] XRegion Region );
  92
  93
  94     /** returns all rectangles which are making up this region.
  95      */
  96     sequence<Rectangle> getRectangles();
  97
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */