LibreOffice: com/sun/star/embed/XEmbeddedObject.idl Source File

LibreOffice LibreOffice 7.3 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
22#include <com/sun/star/lang/XComponent.idl>
23#include <com/sun/star/embed/XEmbeddedClient.idl>
24#include <com/sun/star/embed/XVisualObject.idl>
25#include <com/sun/star/embed/XClassifiedObject.idl>
26#include <com/sun/star/embed/XComponentSupplier.idl>
27#include <com/sun/star/embed/XStateChangeBroadcaster.idl>
28#include <com/sun/star/datatransfer/XTransferable.idl>
29#include <com/sun/star/document/XEventBroadcaster.idl>
30#include <com/sun/star/embed/VerbDescriptor.idl>
31#include <com/sun/star/embed/UnreachableStateException.idl>
32#include <com/sun/star/embed/WrongStateException.idl>
33#include <com/sun/star/embed/NeedsRunningStateException.idl>
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#include <com/sun/star/util/XCloseable.idl>
36
37
38
39
40 module com { module sun { module star { module embed {
41
44published interface XEmbeddedObject
45{
46 // INTERFACES
49 interface XVisualObject;
50
53 interface XClassifiedObject;
54
57 interface XComponentSupplier;
58
61 interface XStateChangeBroadcaster;
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 )
88 raises( ::com::sun::star::embed::UnreachableStateException,
89 ::com::sun::star::embed::WrongStateException,
90 ::com::sun::star::uno::Exception );
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: */
IllegalArgumentException.idl
NeedsRunningStateException.idl
UnreachableStateException.idl
VerbDescriptor.idl
WrongStateException.idl
XClassifiedObject.idl
XComponentSupplier.idl
XComponent.idl
XEmbeddedClient.idl
XEventBroadcaster.idl
XStateChangeBroadcaster.idl
XTransferable.idl
XVisualObject.idl
com::sun::star::embed::NeedsRunningStateException
This exception can be thrown in case a list of accepted verbs of states is requested and the object i...
Definition: NeedsRunningStateException.idl:39
com::sun::star::embed::UnreachableStateException
This exception can be thrown in case specified state can not be reached.
Definition: UnreachableStateException.idl:32
com::sun::star::embed::WrongStateException
This exception can be thrown in case the object's state does not allow to call requested functionalit...
Definition: WrongStateException.idl:33
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition: Exception.idl:33
com::sun::star::embed::XClassifiedObject
represents common functionality for embedded objects
Definition: XClassifiedObject.idl:32
com::sun::star::embed::XComponentSupplier
provides access to a component.
Definition: XComponentSupplier.idl:30
com::sun::star::embed::XEmbeddedClient
represents common functionality for embedded clients.
Definition: XEmbeddedClient.idl:35
com::sun::star::embed::XEmbeddedObject
represents common functionality for embedded objects.
Definition: XEmbeddedObject.idl:45
com::sun::star::embed::XEmbeddedObject::changeState
void changeState([in] long nNewState)
changes the state of the object to the requested one.
com::sun::star::embed::XEmbeddedObject::getReachableStates
sequence< long > getReachableStates()
returns supported states for the object.
com::sun::star::embed::XStateChangeBroadcaster
broadcasts message in case embedded object object changes it's state.
Definition: XStateChangeBroadcaster.idl:34
com::sun::star::embed::XVisualObject
represents common visualization functionality for embedded objects.
Definition: XVisualObject.idl:35
com
Definition: Ambiguous.idl:22
com::sun::star::embed::VerbDescriptor
describes a verb.
Definition: VerbDescriptor.idl:30
XCloseable.idl