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

   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
  25 /** represents common functionality for embedded objects.
  26  */
  27 published interface XEmbeddedObject
  28 {
  29     // INTERFACES
  30     /** represents common visualization functionality for embedded objects.
  31      */
  32     interface XVisualObject;
  33
  34     /** allows to detect class ID of the object.
  35      */
  36     interface XClassifiedObject;
  37
  38     /** allows to get access to the component handled by the object.
  39      */
  40     interface XComponentSupplier;
  41
  42     /** allows to be notified when object changes the state.
  43      */
  44     interface XStateChangeBroadcaster;
  45
  46     /** allows to be notified about object related events.
  47      */
  48     interface ::com::sun::star::document::XEventBroadcaster;
  49
  50     /** allows to control lifetime of the object.
  51      */
  52     interface ::com::sun::star::util::XCloseable;
  53
  54     // METHODS
  55     /** changes the state of the object to the requested one.
  56
  57         @param nNewState
  58             specifies the new state, can take values from the constant set
  59             com::sun::star::embed::EmbedStates
  60
  61         @throws com::sun::star::embed::UnreachableStateException
  62             the specified state can not be reached
  63
  64         @throws com::sun::star::embed::WrongStateException
  65             in case object is in invalid state
  66
  67         @throws com::sun::star::uno::Exception
  68             in case of other problems
  69      */
  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
  75     /** returns supported states for the object.
  76
  77         @returns
  78             the sequence of states the object can be set to
  79
  80         @throws com::sun::star::embed::NeedsRunningStateException
  81             means that the object is in loaded state now and can be switched
  82             to running state, other possible states can be detected only when
  83             the object is not in loaded state any more
  84
  85         @throws com::sun::star::embed::WrongStateException
  86             in case object is in invalid state
  87      */
  88     sequence< long > getReachableStates()
  89         raises( ::com::sun::star::embed::NeedsRunningStateException,
  90                 ::com::sun::star::embed::WrongStateException );
  91
  92     /** returns the current state of the object.
  93
  94         @returns
  95             the current state of the object
  96
  97         @throws com::sun::star::embed::WrongStateException
  98             in case object is in invalid state
  99      */
 100     long getCurrentState()
 101         raises( ::com::sun::star::embed::WrongStateException );
 102
 103     /** lets object perform an action referenced by nVerbID.
 104
 105         @param nVerbID
 106             specifies an action to perform, can take values from
 107             EmbedVerbs
 108
 109         @throws ::com::sun::star::lang::IllegalArgumentException
 110             the verb is not supported
 111
 112         @throws com::sun::star::embed::WrongStateException
 113             the object is in wrong state to call the function
 114
 115         @throws com::sun::star::embed::UnreachableStateException
 116             the state, required by the verb, can not be reached
 117
 118         @throws com::sun::star::uno::Exception
 119             in case of other problems
 120      */
 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
 127     /** returns supported verbs for the object.
 128
 129         @returns
 130             the sequence of verbs the object supports
 131
 132         @throws com::sun::star::embed::NeedsRunningStateException
 133             means that the object is in loaded state now and can be switched
 134             to running state, acceptable verbs can be detected only when the
 135             object is not in loaded state any more
 136
 137         @throws com::sun::star::embed::WrongStateException
 138             the object is in wrong state to call the function
 139      */
 140     sequence< VerbDescriptor > getSupportedVerbs()
 141         raises( ::com::sun::star::embed::NeedsRunningStateException,
 142                 ::com::sun::star::embed::WrongStateException );
 143
 144     /** sets a connection to the container's client.
 145
 146         @param xClient
 147             provides a reference to a client implementation
 148
 149         @throws com::sun::star::embed::WrongStateException
 150             the object is in wrong state
 151      */
 152     void setClientSite( [in] XEmbeddedClient xClient )
 153         raises( ::com::sun::star::embed::WrongStateException );
 154
 155     /** provides access to the internal link to the container client.
 156
 157         @returns
 158             a reference to related container client if any is set
 159
 160         @throws com::sun::star::embed::WrongStateException
 161             the object is in wrong state
 162      */
 163     XEmbeddedClient getClientSite()
 164         raises( ::com::sun::star::embed::WrongStateException );
 165
 166     /** updates object's representations.
 167
 168         @throws com::sun::star::embed::WrongStateException
 169             the object is in wrong state to call the function
 170
 171         @throws com::sun::star::uno::Exception
 172             in case problems detected
 173      */
 174     void update()
 175         raises( ::com::sun::star::embed::WrongStateException,
 176                 ::com::sun::star::uno::Exception );
 177
 178     /** specifies how often the object's representation should be updated.
 179
 180         @param nMode
 181             the new update mode, can take values from
 182             EmbeddedUpdateModes
 183
 184         @throws ::com::sun::star::embed::WrongStateException
 185             the object is in wrong state
 186      */
 187     void setUpdateMode( [in] long nMode )
 188         raises( ::com::sun::star::embed::WrongStateException );
 189
 190     /** retrieves the status of the object.
 191
 192         @param nAspect
 193             the aspect specifying the form of object representation
 194
 195         @return
 196             the value specifying the status of the object for specified aspect
 197             can take values from EmbedMisc constant set
 198
 199         @throws com::sun::star::embed::WrongStateException
 200             the object is in wrong state
 201      */
 202     hyper getStatus( [in] hyper nAspect )
 203         raises( ::com::sun::star::embed::WrongStateException );
 204
 205     /** provides object with the name of container document.
 206
 207         @param sName
 208             name of the container document
 209      */
 210     void setContainerName( [in] string sName );
 211
 212 };
 213
 214
 215 }; }; }; };
 216
 217 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */