offapi/com/sun/star/sheet/XExternalDocLinks.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: XExternalDocLinks.idl,v $
  10  * $Revision: 1.1.2.3 $
  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_XExternalDocLinks_idl__
  32 #define __com_sun_star_sheet_XExternalDocLinks_idl__
  33
  34 #include <com/sun/star/sheet/XExternalDocLink.idl>
  35 #include <com/sun/star/container/XNameAccess.idl>
  36 #include <com/sun/star/container/XIndexAccess.idl>
  37 #include <com/sun/star/container/XEnumerationAccess.idl>
  38
  39 module com {  module sun {  module star {  module sheet {
  40
  41 /** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLinks</type> service.
  42
  43     @see com::sun::star::sheet::ExternalDocLinks
  44
  45     @since OOo 3.1.0
  46  */
  47 interface XExternalDocLinks
  48 {
  49     interface com::sun::star::container::XNameAccess;
  50     interface com::sun::star::container::XIndexAccess;
  51     interface com::sun::star::container::XEnumerationAccess;
  52
  53     /** This method adds a new external document link by its URL, and returns
  54         its instance.  If a document instance already exists for the specified URL,
  55         then that instance gets returned instead of creating a new one.
  56
  57         @param aDocName document URL (e.g. file:///path/to/document.ods)
  58
  59         @return com::sun::star::sheet::XExternalDocLink external document link instance
  60      */
  61     com::sun::star::sheet::XExternalDocLink addDocLink( [in] string aDocName );
  62 };
  63
  64 }; }; }; };
  65
  66 #endif