offapi/com/sun/star/embed/XEmbeddedObject.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XEmbeddedObject.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_embed_XEmbeddedObject_idl__
  31 #define __com_sun_star_embed_XEmbeddedObject_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_embed_XEmbeddedClient_idl__
  38 #include <com/sun/star/embed/XEmbeddedClient.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_embed_XVisualObject_idl__
  42 #include <com/sun/star/embed/XVisualObject.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_embed_XClassifiedObject_idl__
  46 #include <com/sun/star/embed/XClassifiedObject.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_embed_XComponentSupplier_idl__
  50 #include <com/sun/star/embed/XComponentSupplier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_embed_XStateChangeBroadcaster_idl__
  54 #include <com/sun/star/embed/XStateChangeBroadcaster.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_datatransfer_XTransferable_idl__
  58 #include <com/sun/star/datatransfer/XTransferable.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_document_XEventBroadcaster_idl__
  62 #include <com/sun/star/document/XEventBroadcaster.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_embed_VerbDescriptor_idl__
  66 #include <com/sun/star/embed/VerbDescriptor.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_embed_UnreachableStateException_idl__
  70 #include <com/sun/star/embed/UnreachableStateException.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_embed_WrongStateException_idl__
  74 #include <com/sun/star/embed/WrongStateException.idl>
  75 #endif
  76
  77 #ifndef __com_sun_star_embed_NeedsRunningStateException_idl__
  78 #include <com/sun/star/embed/NeedsRunningStateException.idl>
  79 #endif
  80
  81 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  82 #include <com/sun/star/lang/IllegalArgumentException.idl>
  83 #endif
  84
  85 #ifndef __com_sun_star_util_XCloseable_idl__
  86 #include <com/sun/star/util/XCloseable.idl>
  87 #endif
  88
  89
  90
  91 //============================================================================
  92
  93  module com {  module sun {  module star {  module embed {
  94
  95 //============================================================================
  96 /** represents common functionality for embedded objects.
  97  */
  98 interface XEmbeddedObject
  99 {
 100     // INTERFACES
 101     //
 102     //------------------------------------------------------------------------
 103     /** represents common visualisation functionality for embedded objects.
 104      */
 105     interface XVisualObject;
 106
 107     //------------------------------------------------------------------------
 108     /** allows to detect class ID of the object.
 109      */
 110     interface XClassifiedObject;
 111
 112     //------------------------------------------------------------------------
 113     /** allows to get access to the component handled by the object.
 114      */
 115     interface XComponentSupplier;
 116
 117     //------------------------------------------------------------------------
 118     /** allows to be notified when object changes the state.
 119      */
 120     interface XStateChangeBroadcaster;
 121
 122     //------------------------------------------------------------------------
 123     /** allows to be notified about object related events.
 124      */
 125     interface ::com::sun::star::document::XEventBroadcaster;
 126
 127     //------------------------------------------------------------------------
 128     /** allows to control lifetime of the object.
 129      */
 130     interface ::com::sun::star::util::XCloseable;
 131
 132     // METHODS
 133     //
 134     //------------------------------------------------------------------------
 135     /** changes the state of the object to the requested one.
 136
 137         @param nNewState
 138             specifies the new state, can take values from the constant set
 139             <type scope="com::sun::star::embed">EmbedStates</type>
 140
 141         @throws com::sun::star::embed::UnreachableStateException
 142             the specified state can not be reached
 143
 144         @throws com::sun::star::embed::WrongStateException
 145             in case object is in invalid state
 146
 147         @throws com::sun::star::uno::Exception
 148             in case of other problems
 149      */
 150     void changeState( [in] long nNewState )
 151         raises( ::com::sun::star::embed::UnreachableStateException,
 152                 ::com::sun::star::embed::WrongStateException,
 153                 ::com::sun::star::uno::Exception );
 154
 155     //------------------------------------------------------------------------
 156     /** returns supported states for the object.
 157
 158         @returns
 159             the sequence of states the object can be set to
 160
 161         @throws com::sun::star::embed::NeedsRunnignStateException
 162             means that the object is in loaded state now and can be switched
 163             to running state, other possible states can be detected only when
 164             the object is not in loaded state any more
 165
 166         @throws com::sun::star::embed::WrongStateException
 167             in case object is in invalid state
 168      */
 169     sequence< long > getReachableStates()
 170         raises( ::com::sun::star::embed::NeedsRunningStateException,
 171                 ::com::sun::star::embed::WrongStateException );
 172
 173     //------------------------------------------------------------------------
 174     /** returns the current state of the object.
 175
 176         @returns
 177             the current state of the object
 178
 179         @throws com::sun::star::embed::WrongStateException
 180             in case object is in invalid state
 181      */
 182     long getCurrentState()
 183         raises( ::com::sun::star::embed::WrongStateException );
 184
 185     //------------------------------------------------------------------------
 186     /** lets object perform an action referenced by nVerbID.
 187
 188         @param nVerbID
 189             specifies an action to perform, can take values from
 190             <type>EmbedVerbs</type>
 191
 192         @throws ::com::sun::star::lang::IllegalArgumentException
 193             the verb is not supported
 194
 195         @throws com::sun::star::embed::WrongStateException
 196             the object is in wrong state to call the function
 197
 198         @throws com::sun::star::embed::UnreachableStateException
 199             the state, required by the verb, can not be reached
 200
 201         @throws com::sun::star::uno::Exception
 202             in case of other problems
 203      */
 204     void doVerb( [in] long nVerbID )
 205         raises( ::com::sun::star::lang::IllegalArgumentException,
 206                 ::com::sun::star::embed::WrongStateException,
 207                 ::com::sun::star::embed::UnreachableStateException,
 208                 ::com::sun::star::uno::Exception );
 209
 210     //------------------------------------------------------------------------
 211     /** returns supported verbs for the object.
 212
 213         @returns
 214             the sequence of verbs the object supports
 215
 216         @throws com::sun::star::embed::NeedsRunnignStateException
 217             means that the object is in loaded state now and can be switched
 218             to running state, acceptable verbs can be detected only when the
 219             object is not in loaded state any more
 220
 221         @throws com::sun::star::embed::WrongStateException
 222             the object is in wrong state to call the function
 223      */
 224     sequence< VerbDescriptor > getSupportedVerbs()
 225         raises( ::com::sun::star::embed::NeedsRunningStateException,
 226                 ::com::sun::star::embed::WrongStateException );
 227
 228     //------------------------------------------------------------------------
 229     /** sets a connection to the container's client.
 230
 231         @param xClient
 232             provides a reference to a client implementation
 233
 234         @throws com::sun::star::embed::WrongStateException
 235             the object is in wrong state
 236      */
 237     void setClientSite( [in] XEmbeddedClient xClient )
 238         raises( ::com::sun::star::embed::WrongStateException );
 239
 240     //------------------------------------------------------------------------
 241     /** provides access to the internal link to the container client.
 242
 243         @returns
 244             a reference to related container client if any is set
 245
 246         @throws com::sun::star::embed::WrongStateException
 247             the object is in wrong state
 248      */
 249     XEmbeddedClient getClientSite()
 250         raises( ::com::sun::star::embed::WrongStateException );
 251
 252     //------------------------------------------------------------------------
 253     /** updates object's representations.
 254
 255         @throws com::sun::star::embed::WrongStateException
 256             the object is in wrong state to call the function
 257
 258         @throws com::sun::star::uno::Exception
 259             in case problems detected
 260      */
 261     void update()
 262         raises( ::com::sun::star::embed::WrongStateException,
 263                 ::com::sun::star::uno::Exception );
 264
 265     //------------------------------------------------------------------------
 266     /** specifies how often the object's representation should be updated.
 267
 268         @param nMode
 269             the new update mode, can take values from
 270             <type>EmbeddedUpdateModes</type>
 271
 272         @throws ::com::sun::star::embed::WrongStateException
 273             the object is in wrong state
 274      */
 275     void setUpdateMode( [in] long nMode )
 276         raises( ::com::sun::star::embed::WrongStateException );
 277
 278     //------------------------------------------------------------------------
 279     /** retrieves the status of the object.
 280
 281         @param nAspect
 282             the aspect specifying the form of object representation
 283
 284         @return
 285             the value specifying the status of the object for specified aspect
 286             can take values from <type>EmbedMisc</type> constant set
 287
 288         @throws com::sun::star::embed::WrongStateException
 289             the object is in wrong state
 290      */
 291     hyper getStatus( [in] hyper nAspect )
 292         raises( ::com::sun::star::embed::WrongStateException );
 293
 294     //-------------------------------------------------------------------------
 295     /** provides object with the name of container document.
 296
 297         @param sName
 298             name of the container document
 299      */
 300     void setContainerName( [in] string sName );
 301
 302 };
 303
 304 //============================================================================
 305
 306 }; }; }; };
 307
 308 #endif
 309