summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XRegion.idl
blob: 389e7279cc6c8b92ea0f5a5d7c4976d268c78ff1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XRegion.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:52:30 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XRegion_idl__
#define __com_sun_star_awt_XRegion_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_Rectangle_idl__
#include <com/sun/star/awt/Rectangle.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** manages multiple rectangles which make up a region.
 */
published interface XRegion: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the bounding box of the shape.
     */
    Rectangle getBounds();

    //-------------------------------------------------------------------------

    /** makes this region an empty region.
     */
    [oneway] void clear();

    //-------------------------------------------------------------------------

    /** moves this region by the specified horizontal and vertical delta.
     */
    [oneway] void move( [in] long nHorzMove,
             [in] long nVertMove );

    //-------------------------------------------------------------------------

    /** adds the specified rectangle to this region.
     */
    [oneway] void unionRectangle( [in] Rectangle Rect );

    //-------------------------------------------------------------------------

    /** intersects the specified rectangle with the current region.
     */
    [oneway] void intersectRectangle( [in] Rectangle Region );

    //-------------------------------------------------------------------------

    /** removes the area of the specified rectangle from this region.
     */
    [oneway] void excludeRectangle( [in] Rectangle Rect );

    //-------------------------------------------------------------------------

    /** applies an exclusive-or operation with the specified rectangle
        to this region.
     */
    [oneway] void xOrRectangle( [in] Rectangle Rect );

    //-------------------------------------------------------------------------

    /** adds the specified region to this region.
     */
    [oneway] void unionRegion( [in] XRegion Region );

    //-------------------------------------------------------------------------

    /** intersects the specified region with the current region.
     */
    [oneway] void intersectRegion( [in] XRegion Region );

    //-------------------------------------------------------------------------

    /** removes the area of the specified region from this region.
     */
    [oneway] void excludeRegion( [in] XRegion Region );

    //-------------------------------------------------------------------------

    /** applies an exclusive-or operation with the specified region
        to this region.
     */
    [oneway] void xOrRegion( [in] XRegion Region );

    //-------------------------------------------------------------------------

    /** returns all rectangles which are making up this region.
     */
    sequence<Rectangle> getRectangles();

};

//=============================================================================

}; }; }; };

#endif