summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XRegion.idl
blob: eabc39ac669720b6e2d57042fe54f83c4ead10b5 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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