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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module embed {
/** represents common functionality for embedded objects.
*/
published interface XEmbeddedObject
{
// INTERFACES
/** represents common visualization functionality for embedded objects.
*/
interface XVisualObject;
/** allows to detect class ID of the object.
*/
interface XClassifiedObject;
/** allows to get access to the component handled by the object.
*/
interface XComponentSupplier;
/** allows to be notified when object changes the state.
*/
interface XStateChangeBroadcaster;
/** allows to be notified about object related events.
*/
interface ::com::sun::star::document::XEventBroadcaster;
/** allows to control lifetime of the object.
*/
interface ::com::sun::star::util::XCloseable;
// METHODS
/** changes the state of the object to the requested one.
@param nNewState
specifies the new state, can take values from the constant set
com::sun::star::embed::EmbedStates
@throws com::sun::star::embed::UnreachableStateException
the specified state can not be reached
@throws com::sun::star::embed::WrongStateException
in case object is in invalid state
@throws com::sun::star::uno::Exception
in case of other problems
*/
void changeState( [in] long nNewState )
raises( ::com::sun::star::embed::UnreachableStateException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception );
/** returns supported states for the object.
@returns
the sequence of states the object can be set to
@throws com::sun::star::embed::NeedsRunningStateException
means that the object is in loaded state now and can be switched
to running state, other possible states can be detected only when
the object is not in loaded state any more
@throws com::sun::star::embed::WrongStateException
in case object is in invalid state
*/
sequence< long > getReachableStates()
raises( ::com::sun::star::embed::NeedsRunningStateException,
::com::sun::star::embed::WrongStateException );
/** returns the current state of the object.
@returns
the current state of the object
@throws com::sun::star::embed::WrongStateException
in case object is in invalid state
*/
long getCurrentState()
raises( ::com::sun::star::embed::WrongStateException );
/** lets object perform an action referenced by nVerbID.
@param nVerbID
specifies an action to perform, can take values from
EmbedVerbs
@throws ::com::sun::star::lang::IllegalArgumentException
the verb is not supported
@throws com::sun::star::embed::WrongStateException
the object is in wrong state to call the function
@throws com::sun::star::embed::UnreachableStateException
the state, required by the verb, can not be reached
@throws com::sun::star::uno::Exception
in case of other problems
*/
void doVerb( [in] long nVerbID )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::embed::UnreachableStateException,
::com::sun::star::uno::Exception );
/** returns supported verbs for the object.
@returns
the sequence of verbs the object supports
@throws com::sun::star::embed::NeedsRunningStateException
means that the object is in loaded state now and can be switched
to running state, acceptable verbs can be detected only when the
object is not in loaded state any more
@throws com::sun::star::embed::WrongStateException
the object is in wrong state to call the function
*/
sequence< VerbDescriptor > getSupportedVerbs()
raises( ::com::sun::star::embed::NeedsRunningStateException,
::com::sun::star::embed::WrongStateException );
/** sets a connection to the container's client.
@param xClient
provides a reference to a client implementation
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
*/
void setClientSite( [in] XEmbeddedClient xClient )
raises( ::com::sun::star::embed::WrongStateException );
/** provides access to the internal link to the container client.
@returns
a reference to related container client if any is set
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
*/
XEmbeddedClient getClientSite()
raises( ::com::sun::star::embed::WrongStateException );
/** updates object's representations.
@throws com::sun::star::embed::WrongStateException
the object is in wrong state to call the function
@throws com::sun::star::uno::Exception
in case problems detected
*/
void update()
raises( ::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception );
/** specifies how often the object's representation should be updated.
@param nMode
the new update mode, can take values from
EmbeddedUpdateModes
@throws ::com::sun::star::embed::WrongStateException
the object is in wrong state
*/
void setUpdateMode( [in] long nMode )
raises( ::com::sun::star::embed::WrongStateException );
/** retrieves the status of the object.
@param nAspect
the aspect specifying the form of object representation
@return
the value specifying the status of the object for specified aspect
can take values from EmbedMisc constant set
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
*/
hyper getStatus( [in] hyper nAspect )
raises( ::com::sun::star::embed::WrongStateException );
/** provides object with the name of container document.
@param sName
name of the container document
*/
void setContainerName( [in] string sName );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
