offapi/com/sun/star/sheet/SheetLink.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 sheet {
  22
  23
  24 /** represents a sheet link.
  25
  26     <p>A sheet link contains the source data of linked sheets, i.e. the
  27     URL and sheet name of the external document.</p>
  28
  29     <p>To create a linked sheet, the sheet which will be used as linked
  30     sheet has to exist already. The method
  31     XSheetLinkable::link() creates a SheetLink
  32     object in the document's SheetLinks collection and links
  33     the sheet to the specified external sheet.</p>
  34  */
  35 published service SheetLink
  36 {
  37
  38     /** provides access to the name of the linked document.
  39
  40         <p>This name is equal to the Url property.</p>
  41      */
  42     interface com::sun::star::container::XNamed;
  43
  44
  45     /** provides methods to reload the external data.
  46      */
  47     interface com::sun::star::util::XRefreshable;
  48
  49
  50 //!published service PropertySet
  51     /** provides access to the properties.
  52      */
  53     interface com::sun::star::beans::XPropertySet;
  54
  55
  56     /** specifies the URL of the source document.
  57      */
  58     [property] string Url;
  59
  60
  61     /** specifies the name of the filter needed to load the source
  62         document.
  63      */
  64     [property] string Filter;
  65
  66
  67     /** specifies the filter options needed to load the source document.
  68      */
  69     [property] string FilterOptions;
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */