1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_embed_XLinkageSupport_idl__ 24cdf0e10cSrcweir#define __com_sun_star_embed_XLinkageSupport_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_embed_XStorage_idl__ 31cdf0e10cSrcweir#include <com/sun/star/embed/XStorage.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_embed_XCommonEmbedPersist_idl__ 35cdf0e10cSrcweir#include <com/sun/star/embed/XCommonEmbedPersist.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 39cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_embed_WrongStateException_idl__ 43cdf0e10cSrcweir#include <com/sun/star/embed/WrongStateException.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir//============================================================================ 47cdf0e10cSrcweir 48cdf0e10cSrcweir module com { module sun { module star { module embed { 49cdf0e10cSrcweir 50cdf0e10cSrcweir//============================================================================ 51cdf0e10cSrcweir/** specifies an additional implementation for linked embedded object support. 52cdf0e10cSrcweir */ 53cdf0e10cSrcweirpublished interface XLinkageSupport: XCommonEmbedPersist 54cdf0e10cSrcweir{ 55cdf0e10cSrcweir //------------------------------------------------------------------------ 56cdf0e10cSrcweir /** breaks the link and provides the object with a parent storage and a 57cdf0e10cSrcweir name for object's entry 58cdf0e10cSrcweir 59cdf0e10cSrcweir <p> 60cdf0e10cSrcweir This method can be used only for links implementations that implement 61cdf0e10cSrcweir the whole set of embedded object interfaces. Usually the sets of 62cdf0e10cSrcweir interfaces are the same for links and objects. An example of exception 63cdf0e10cSrcweir from this are OOo links that do not implement 64cdf0e10cSrcweir <type>XEmbedPersist</type> interface. For such cases the method will 65cdf0e10cSrcweir throw an exception. 66cdf0e10cSrcweir </p> 67cdf0e10cSrcweir 68cdf0e10cSrcweir <p> 69cdf0e10cSrcweir The link will be broken and the linked object will become a normal 70cdf0e10cSrcweir embedded object. 71cdf0e10cSrcweir </p> 72cdf0e10cSrcweir 73cdf0e10cSrcweir <p> 74cdf0e10cSrcweir An entry with the specified name should be created\opened inside 75cdf0e10cSrcweir provided storage. This entry will be used for the object persistence. 76cdf0e10cSrcweir If the entry exists already all it's contents will be ignored. 77cdf0e10cSrcweir </p> 78cdf0e10cSrcweir 79cdf0e10cSrcweir @param xStorage 80cdf0e10cSrcweir a parent storage the entry should be created\opened in 81cdf0e10cSrcweir 82cdf0e10cSrcweir @param sEntryName 83cdf0e10cSrcweir a name for the entry 84cdf0e10cSrcweir 85cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 86cdf0e10cSrcweir one of arguments is illegal 87cdf0e10cSrcweir 88cdf0e10cSrcweir @throws com::sun::star::embed::WrongStateException 89cdf0e10cSrcweir the object is in wrong state or not a linked object 90cdf0e10cSrcweir 91cdf0e10cSrcweir @throws com::sun::star::io::IOException 92cdf0e10cSrcweir in case object has not persistence or other io problems 93cdf0e10cSrcweir 94cdf0e10cSrcweir @throws com::sun::star::uno::Exception 95cdf0e10cSrcweir in case of other problems 96cdf0e10cSrcweir 97cdf0e10cSrcweir @see also XEmbedPersist::setPersistentEntry 98cdf0e10cSrcweir */ 99cdf0e10cSrcweir void breakLink( [in] ::com::sun::star::embed::XStorage xStorage, 100cdf0e10cSrcweir [in] string sEntryName ) 101cdf0e10cSrcweir raises( ::com::sun::star::lang::IllegalArgumentException, 102cdf0e10cSrcweir ::com::sun::star::embed::WrongStateException, 103cdf0e10cSrcweir ::com::sun::star::io::IOException, 104cdf0e10cSrcweir ::com::sun::star::uno::Exception ); 105cdf0e10cSrcweir 106cdf0e10cSrcweir 107cdf0e10cSrcweir //------------------------------------------------------------------------ 108cdf0e10cSrcweir /** allows to detect whether the object is a linked one. 109cdf0e10cSrcweir <p> 110cdf0e10cSrcweir Most of embedded objects will not support this interface, but some 111cdf0e10cSrcweir of them can do it, to allow conversion from link to object. After 112cdf0e10cSrcweir the conversion the object does not change, so interface set staies the 113cdf0e10cSrcweir same, but the object is not a link any more. 114cdf0e10cSrcweir </p> 115cdf0e10cSrcweir 116cdf0e10cSrcweir @return 117cdf0e10cSrcweir <TRUE/> - the object is a linked one. 118cdf0e10cSrcweir <FALSE/> - otherwise 119cdf0e10cSrcweir 120cdf0e10cSrcweir @throws com::sun::star::embed::WrongStateException 121cdf0e10cSrcweir the object is in wrong state 122cdf0e10cSrcweir */ 123cdf0e10cSrcweir boolean isLink() 124cdf0e10cSrcweir raises( ::com::sun::star::embed::WrongStateException ); 125cdf0e10cSrcweir 126cdf0e10cSrcweir //------------------------------------------------------------------------ 127cdf0e10cSrcweir /** returns the URL of the link object. 128cdf0e10cSrcweir 129cdf0e10cSrcweir @throws com::sun::star::embed::WrongStateException 130cdf0e10cSrcweir the object is in wrong state or is not a link 131cdf0e10cSrcweir */ 132cdf0e10cSrcweir string getLinkURL() 133cdf0e10cSrcweir raises( ::com::sun::star::embed::WrongStateException, 134cdf0e10cSrcweir ::com::sun::star::uno::Exception ); 135cdf0e10cSrcweir}; 136cdf0e10cSrcweir 137cdf0e10cSrcweir//============================================================================ 138cdf0e10cSrcweir 139cdf0e10cSrcweir}; }; }; }; 140cdf0e10cSrcweir 141cdf0e10cSrcweir#endif 142cdf0e10cSrcweir 143