offapi/com/sun/star/embed/XLinkageSupport.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  module com {  module sun {  module star {  module embed {
  22
  23 /** specifies an additional implementation for linked embedded object support.
  24  */
  25 published interface XLinkageSupport: XCommonEmbedPersist
  26 {
  27     /** breaks the link and provides the object with a parent storage and a
  28         name for object's entry
  29
  30         <p>
  31         This method can be used only for links implementations that implement
  32         the whole set of embedded object interfaces. Usually the sets of
  33         interfaces are the same for links and objects. An example of exception
  34         from this are OOo links that do not implement
  35         XEmbedPersist interface. For such cases the method will
  36         throw an exception.
  37         </p>
  38
  39         <p>
  40         The link will be broken and the linked object will become a normal
  41         embedded object.
  42         </p>
  43
  44         <p>
  45         An entry with the specified name should be created or opened inside
  46         provided storage. This entry will be used for the object persistence.
  47         If the entry exists already all its contents will be ignored.
  48         </p>
  49
  50         @param xStorage
  51             a parent storage the entry should be created or opened in
  52
  53         @param sEntryName
  54             a name for the entry
  55
  56         @throws ::com::sun::star::lang::IllegalArgumentException
  57             one of arguments is illegal
  58
  59         @throws com::sun::star::embed::WrongStateException
  60             the object is in wrong state or not a linked object
  61
  62         @throws com::sun::star::io::IOException
  63             in case object has not persistence or other io problems
  64
  65         @throws com::sun::star::uno::Exception
  66             in case of other problems
  67
  68         @see also XEmbedPersist::setPersistentEntry
  69      */
  70     void breakLink( [in] ::com::sun::star::embed::XStorage xStorage,
  71                     [in] string sEntryName )
  72         raises( ::com::sun::star::lang::IllegalArgumentException,
  73                 ::com::sun::star::embed::WrongStateException,
  74                 ::com::sun::star::io::IOException,
  75                 ::com::sun::star::uno::Exception );
  76
  77
  78     /** allows to detect whether the object is a linked one.
  79         <p>
  80             Most of embedded objects will not support this interface, but some
  81         of them can do it, to allow conversion from link to object. After
  82         the conversion the object does not change, so interface set stays the
  83         same, but the object is not a link any more.
  84         </p>
  85
  86         @return
  87             `TRUE` - the object is a linked one.
  88             `FALSE` - otherwise
  89
  90         @throws com::sun::star::embed::WrongStateException
  91             the object is in wrong state
  92      */
  93     boolean isLink()
  94         raises( ::com::sun::star::embed::WrongStateException );
  95
  96     /** returns the URL of the link object.
  97
  98         @throws com::sun::star::embed::WrongStateException
  99             the object is in wrong state or is not a link
 100      */
 101     string getLinkURL()
 102         raises( ::com::sun::star::embed::WrongStateException,
 103                 ::com::sun::star::uno::Exception );
 104 };
 105
 106
 107 }; }; }; };
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */