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

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