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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*************************************************************************
*
* 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_embed_XVisualObject_idl__
#define __com_sun_star_embed_XVisualObject_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_awt_Size_idl__
#include <com/sun/star/awt/Size.idl>
#endif
#ifndef __com_sun_star_embed_VisualRepresentation_idl__
#include <com/sun/star/embed/VisualRepresentation.idl>
#endif
#ifndef __com_sun_star_embed_WrongStateException_idl__
#include <com/sun/star/embed/WrongStateException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
//=============================================================================
module com { module sun { module star { module embed {
//=============================================================================
/** represents common visualisation functionality for embedded objects.
*/
interface XVisualObject: ::com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** sets the size of object's visual area.
<p>
The size must be provided in logical units according to map mode the
object communicates in.
</p>
<p>
If an object is inplace- or ui-active the method must not initiate
repainting itself.
</p>
@param nAspect
the aspect specifying the form of object representation
can take values from <type>Aspects</type> constant set
@param aSize
the new size of the visual area
@thrown ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws ::com::sun::star::embed::WrongStateException
the object is in wrong state
@throws ::com::sun::star::uno::Exception
the object failed to resize
*/
void setVisualAreaSize( [in] hyper nAspect,
[in] ::com::sun::star::awt::Size aSize )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception );
//-------------------------------------------------------------------------
/** gets the size of object's visual area.
<p>
The size must be provided in logical units according to map mode the
object communicates in.
</p>
@param nAspect
the aspect specifying the form of object representation
can take values from <type>Aspects</type> constant set
@return
the size of visual area
@thrown ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws ::com::sun::star::embed::WrongStateException
the object is in wrong state
*/
::com::sun::star::awt::Size getVisualAreaSize( [in] hyper nAspect )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception );
//------------------------------------------------------------------------
/** retrieves visual representation of the object in preferable format.
<p>
If the object persistance entry contains cached visual representation
then it can be retrieved by using this method even in loaded state.
</p>
@param nAspect
the aspect the representation is requested for
@return
the visual representation of the object in the default format and
the format
@throws ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws ::com::sun::star::embed::WrongStateException
the object is in wrong state
@throws ::com::sun::star::uno::Exception
in case of problems
*/
VisualRepresentation getPreferredVisualRepresentation( [in] hyper nAspect )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception );
//-------------------------------------------------------------------------
/** retrieves map mode the object communicates in.
@param nAspect
the aspect the map mode is requested for
@return
the map mode the object communicates in, it can take values from
<type>EmbedMapUnits</type> constant
@throws ::com::sun::star::embed::WrongStateException
the object is in wrong state
@throws ::com::sun::star::uno::Exception
in case of problems
*/
long getMapUnit( [in] hyper nAspect )
raises( ::com::sun::star::uno::Exception );
};
//=============================================================================
}; }; }; };
#endif
|
