offapi/com/sun/star/sheet/XExternalDocLink.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: XExternalDocLink.idl,v $
  10  * $Revision: 1.1.2.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_XExternalDocLink_idl__
  32 #define __com_sun_star_sheet_XExternalDocLink_idl__
  33
  34 #include <com/sun/star/container/XEnumerationAccess.idl>
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #include <com/sun/star/container/XNameAccess.idl>
  37 #include <com/sun/star/sheet/XExternalSheetCache.idl>
  38
  39 module com {  module sun {  module star {  module sheet {
  40
  41 //=============================================================================
  42
  43 /** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLink</type> service.
  44
  45     @see com::sun::star::sheet::ExternalDocLink
  46
  47     @since OOo 3.1.0
  48  */
  49 interface XExternalDocLink
  50 {
  51     interface com::sun::star::container::XNameAccess;
  52     interface com::sun::star::container::XIndexAccess;
  53     interface com::sun::star::container::XEnumerationAccess;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** <p>This method adds a new sheet cache instance to the external document
  58         link for a specified sheet name.  If a sheet cache instance already
  59         exists for the specified name, then the existing instance is returned.</p>
  60
  61         <p>Note that a sheet name lookup is performed in a case-insensitive
  62         fashion.</p>
  63
  64         @param aSheetName sheet name
  65
  66         @return com::sun::star::sheet::XExternalSheetCache sheet cache instance
  67      */
  68     com::sun::star::sheet::XExternalSheetCache addSheetCache( [in] string aSheetName );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** Index corresponding to the external document link.
  73
  74         <p>This index value corresponds with the external document
  75         represented by an instance of
  76         <type scope="com::sun::star::sheet">ExternalDocLink</type>.  This
  77         value is stored within a formula token instance.</p>
  78
  79         <p>Each external document cache instance has a unique index value, and this
  80         index value can be used to retrieve the corresponding external document cache
  81         from the parent <type scope="com::sun::star::sheet">ExternalDocLinks</type> instance.</p>
  82
  83         @see com::sun::star::sheet::ExternalDocLinks
  84         @see com::sun::star::sheet::FormulaToken
  85         @see com::sun::star::sheet::ExternalReference
  86      */
  87     [attribute, readonly] long TokenIndex;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif