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

LibreOffice LibreOffice 25.2 SDK API Reference

Loading...
Searching...
No Matches
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
20
21
22
23 module com { module sun { module star { module embed {
24
27published interface XEmbeddedObject
28{
29 // INTERFACES
32 interface XVisualObject;
33
36 interface XClassifiedObject;
37
40 interface XComponentSupplier;
41
44 interface XStateChangeBroadcaster;
45
48 interface ::com::sun::star::document::XEventBroadcaster;
49
52 interface ::com::sun::star::util::XCloseable;
53
54 // METHODS
70 void changeState( [in] long nNewState )
71 raises( ::com::sun::star::embed::UnreachableStateException,
72 ::com::sun::star::embed::WrongStateException,
73 ::com::sun::star::uno::Exception );
74
88 sequence< long > getReachableStates()
89 raises( ::com::sun::star::embed::NeedsRunningStateException,
90 ::com::sun::star::embed::WrongStateException );
91
100 long getCurrentState()
101 raises( ::com::sun::star::embed::WrongStateException );
102
121 void doVerb( [in] long nVerbID )
122 raises( ::com::sun::star::lang::IllegalArgumentException,
123 ::com::sun::star::embed::WrongStateException,
124 ::com::sun::star::embed::UnreachableStateException,
125 ::com::sun::star::uno::Exception );
126
140 sequence< VerbDescriptor > getSupportedVerbs()
141 raises( ::com::sun::star::embed::NeedsRunningStateException,
142 ::com::sun::star::embed::WrongStateException );
143
152 void setClientSite( [in] XEmbeddedClient xClient )
153 raises( ::com::sun::star::embed::WrongStateException );
154
163 XEmbeddedClient getClientSite()
164 raises( ::com::sun::star::embed::WrongStateException );
165
174 void update()
175 raises( ::com::sun::star::embed::WrongStateException,
176 ::com::sun::star::uno::Exception );
177
187 void setUpdateMode( [in] long nMode )
188 raises( ::com::sun::star::embed::WrongStateException );
189
202 hyper getStatus( [in] hyper nAspect )
203 raises( ::com::sun::star::embed::WrongStateException );
204
210 void setContainerName( [in] string sName );
211
212};
213
214
215}; }; }; };
216
217/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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:35
com::sun::star::embed::UnreachableStateException
This exception can be thrown in case specified state can not be reached.
Definition UnreachableStateException.idl:28
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:29
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition Exception.idl:29
com::sun::star::embed::XEmbeddedClient
represents common functionality for embedded clients.
Definition XEmbeddedClient.idl:28
com::sun::star::embed::XEmbeddedObject
represents common functionality for embedded objects.
Definition XEmbeddedObject.idl:28
com::sun::star::embed::XEmbeddedObject::setContainerName
void setContainerName([in] string sName)
provides object with the name of container document.
com::sun::star::embed::XEmbeddedObject::getCurrentState
long getCurrentState()
returns the current state of the object.
com::sun::star::embed::XEmbeddedObject::setClientSite
void setClientSite([in] XEmbeddedClient xClient)
sets a connection to the container's client.
com::sun::star::embed::XEmbeddedObject::getStatus
hyper getStatus([in] hyper nAspect)
retrieves the status of the object.
com::sun::star::embed::XEmbeddedObject::XClassifiedObject
interface XClassifiedObject
allows to detect class ID of the object.
Definition XEmbeddedObject.idl:36
com::sun::star::embed::XEmbeddedObject::XComponentSupplier
interface XComponentSupplier
allows to get access to the component handled by the object.
Definition XEmbeddedObject.idl:40
com::sun::star::embed::XEmbeddedObject::XStateChangeBroadcaster
interface XStateChangeBroadcaster
allows to be notified when object changes the state.
Definition XEmbeddedObject.idl:44
com::sun::star::embed::XEmbeddedObject::getClientSite
XEmbeddedClient getClientSite()
provides access to the internal link to the container client.
com::sun::star::embed::XEmbeddedObject::XVisualObject
interface XVisualObject
represents common visualization functionality for embedded objects.
Definition XEmbeddedObject.idl:32
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::XEmbeddedObject::update
void update()
updates object's representations.
com::sun::star::embed::XEmbeddedObject::getSupportedVerbs
sequence< VerbDescriptor > getSupportedVerbs()
returns supported verbs for the object.
com::sun::star::embed::XEmbeddedObject::doVerb
void doVerb([in] long nVerbID)
lets object perform an action referenced by nVerbID.
com::sun::star::embed::XEmbeddedObject::setUpdateMode
void setUpdateMode([in] long nMode)
specifies how often the object's representation should be updated.
com::sun::star::embed
interfaces related to embedded objects, both native UNO and OLE.
Definition Actions.idl:21
com::sun::star::lang
General UNO concepts like factories etc.
Definition ArrayIndexOutOfBoundsException.idl:22
com::sun::star::uno
Basic UNO interfaces.
Definition modules.idl:72
com::sun::star
the module com::sun::star is the root module of the UNO API.
Definition Ambiguous.idl:20
com::sun
Definition Ambiguous.idl:20
com
Definition Ambiguous.idl:20
com::sun::star::embed::VerbDescriptor
describes a verb.
Definition VerbDescriptor.idl:28