LibreOffice
LibreOffice 6.2 SDK API Reference
XEmbeddedObject.idl
Go to the documentation of this file.
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 #ifndef __com_sun_star_embed_XEmbeddedObject_idl__
20 #define __com_sun_star_embed_XEmbeddedObject_idl__
21 
36 
37 
38 
39 
40  module com { module sun { module star { module embed {
41 
44 published interface XEmbeddedObject
45 {
46  // INTERFACES
49  interface XVisualObject;
50 
53  interface XClassifiedObject;
54 
57  interface XComponentSupplier;
58 
62 
65  interface ::com::sun::star::document::XEventBroadcaster;
66 
69  interface ::com::sun::star::util::XCloseable;
70 
71  // METHODS
87  void changeState( [in] long nNewState )
91 
105  sequence< long > getReachableStates()
106  raises( ::com::sun::star::embed::NeedsRunningStateException,
107  ::com::sun::star::embed::WrongStateException );
108 
117  long getCurrentState()
118  raises( ::com::sun::star::embed::WrongStateException );
119 
138  void doVerb( [in] long nVerbID )
139  raises( ::com::sun::star::lang::IllegalArgumentException,
140  ::com::sun::star::embed::WrongStateException,
141  ::com::sun::star::embed::UnreachableStateException,
142  ::com::sun::star::uno::Exception );
143 
157  sequence< VerbDescriptor > getSupportedVerbs()
158  raises( ::com::sun::star::embed::NeedsRunningStateException,
159  ::com::sun::star::embed::WrongStateException );
160 
169  void setClientSite( [in] XEmbeddedClient xClient )
170  raises( ::com::sun::star::embed::WrongStateException );
171 
180  XEmbeddedClient getClientSite()
181  raises( ::com::sun::star::embed::WrongStateException );
182 
191  void update()
192  raises( ::com::sun::star::embed::WrongStateException,
193  ::com::sun::star::uno::Exception );
194 
204  void setUpdateMode( [in] long nMode )
205  raises( ::com::sun::star::embed::WrongStateException );
206 
219  hyper getStatus( [in] hyper nAspect )
220  raises( ::com::sun::star::embed::WrongStateException );
221 
227  void setContainerName( [in] string sName );
228 
229 };
230 
231 
232 }; }; }; };
233 
234 #endif
235 
236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception can be thrown in case specified state can not be reached.
Definition: UnreachableStateException.idl:31
the base of all UNO exceptions
Definition: Exception.idl:32
Definition: Ambiguous.idl:22
provides access to a component.
Definition: XComponentSupplier.idl:29
This exception can be thrown in case a list of accepted verbs of states is requested and the object i...
Definition: NeedsRunningStateException.idl:38
represents common visualization functionality for embedded objects.
Definition: XVisualObject.idl:34
This exception can be thrown in case the object&#39;s state does not allow to call requested functionalit...
Definition: WrongStateException.idl:32
represents common functionality for embedded objects.
Definition: XEmbeddedObject.idl:44
represents common functionality for embedded objects
Definition: XClassifiedObject.idl:31
broadcasts message in case embedded object object changes it&#39;s state.
Definition: XStateChangeBroadcaster.idl:33
represents common functionality for embedded clients.
Definition: XEmbeddedClient.idl:34
describes a verb.
Definition: VerbDescriptor.idl:29