offapi/com/sun/star/sheet/SheetLink.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_SheetLink_idl__
  29 #define __com_sun_star_sheet_SheetLink_idl__
  30
  31 #ifndef __com_sun_star_container_XNamed_idl__
  32 #include <com/sun/star/container/XNamed.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_util_XRefreshable_idl__
  36 #include <com/sun/star/util/XRefreshable.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_beans_XPropertySet_idl__
  40 #include <com/sun/star/beans/XPropertySet.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module sheet {
  46
  47 //=============================================================================
  48
  49 /** represents a sheet link.
  50
  51     <p>A sheet link contains the source data of linked sheets, i.e. the
  52     URL and sheet name of the external document.</p>
  53
  54     <p>To create a linked sheet, the sheet which will be used as linked
  55     sheet has to exist already. The method
  56     <member>XSheetLinkable::link</member> creates a <type>SheetLink</type>
  57     object in the document's <type>SheetLinks</type> collection and links
  58     the sheet to the specified external sheet.</p>
  59  */
  60 published service SheetLink
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** provides access to the name of the linked document.
  65
  66         <p>This name is equal to the <const>Url</const> property.</p>
  67      */
  68     interface com::sun::star::container::XNamed;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** provides methods to reload the external data.
  73      */
  74     interface com::sun::star::util::XRefreshable;
  75
  76     //-------------------------------------------------------------------------
  77
  78 //!published service PropertySet
  79     /** provides access to the properties.
  80      */
  81     interface com::sun::star::beans::XPropertySet;
  82
  83     //=========================================================================
  84
  85     /** specifies the URL of the source document.
  86      */
  87     [property] string Url;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies the name of the filter needed to load the source
  92         document.
  93      */
  94     [property] string Filter;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** specifies the filter options needed to load the source document.
  99      */
 100     [property] string FilterOptions;
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif
 109