offapi/com/sun/star/sheet/XExternalDocLinks.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 #ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
  21 #define __com_sun_star_sheet_XExternalDocLinks_idl__
  22
  23 #include <com/sun/star/sheet/XExternalDocLink.idl>
  24 #include <com/sun/star/container/XNameAccess.idl>
  25 #include <com/sun/star/container/XIndexAccess.idl>
  26 #include <com/sun/star/container/XEnumerationAccess.idl>
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30 /** Primary interface for the com::sun::star::sheet::ExternalDocLinks service.
  31
  32     @see com::sun::star::sheet::ExternalDocLinks
  33
  34     @since OOo 3.1
  35  */
  36 interface XExternalDocLinks
  37 {
  38     interface com::sun::star::container::XNameAccess;
  39     interface com::sun::star::container::XIndexAccess;
  40     interface com::sun::star::container::XEnumerationAccess;
  41
  42     /** This method adds a new external document link by its URL, and returns
  43         its instance.  If a document instance already exists for the specified URL,
  44         then that instance gets returned instead of creating a new one.
  45
  46         @param aDocName document URL (e.g. file:///path/to/document.ods)
  47
  48         @return com::sun::star::sheet::XExternalDocLink external document link instance
  49      */
  50     com::sun::star::sheet::XExternalDocLink addDocLink( [in] string aDocName );
  51 };
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */