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
  20
  21
  22  module com {  module sun {  module star {  module awt {
  23
  24
  25 /** manages multiple rectangles which make up a region.
  26  */
  27 published interface XRegion: com::sun::star::uno::XInterface
  28 {
  29
  30     /** returns the bounding box of the shape.
  31      */
  32     Rectangle getBounds();
  33
  34
  35     /** makes this region an empty region.
  36      */
  37     void clear();
  38
  39
  40     /** moves this region by the specified horizontal and vertical delta.
  41      */
  42     void move( [in] long nHorzMove,
  43              [in] long nVertMove );
  44
  45
  46     /** adds the specified rectangle to this region.
  47      */
  48     void unionRectangle( [in] Rectangle Rect );
  49
  50
  51     /** intersects the specified rectangle with the current region.
  52      */
  53     void intersectRectangle( [in] Rectangle Region );
  54
  55
  56     /** removes the area of the specified rectangle from this region.
  57      */
  58     void excludeRectangle( [in] Rectangle Rect );
  59
  60
  61     /** applies an exclusive-or operation with the specified rectangle
  62         to this region.
  63      */
  64     void xOrRectangle( [in] Rectangle Rect );
  65
  66
  67     /** adds the specified region to this region.
  68      */
  69     void unionRegion( [in] XRegion Region );
  70
  71
  72     /** intersects the specified region with the current region.
  73      */
  74     void intersectRegion( [in] XRegion Region );
  75
  76
  77     /** removes the area of the specified region from this region.
  78      */
  79     void excludeRegion( [in] XRegion Region );
  80
  81
  82     /** applies an exclusive-or operation with the specified region
  83         to this region.
  84      */
  85     void xOrRegion( [in] XRegion Region );
  86
  87
  88     /** returns all rectangles which are making up this region.
  89      */
  90     sequence<Rectangle> getRectangles();
  91
  92 };
  93
  94
  95 }; }; }; };
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */