1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
25#define __com_sun_star_sheet_XExternalDocLinks_idl__
26
27#include <com/sun/star/sheet/XExternalDocLink.idl>
28#include <com/sun/star/container/XNameAccess.idl>
29#include <com/sun/star/container/XIndexAccess.idl>
30#include <com/sun/star/container/XEnumerationAccess.idl>
31
32module com {  module sun {  module star {  module sheet {
33
34/** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLinks</type> service.
35
36    @see com::sun::star::sheet::ExternalDocLinks
37
38    @since OpenOffice 3.1
39 */
40interface XExternalDocLinks
41{
42    interface com::sun::star::container::XNameAccess;
43    interface com::sun::star::container::XIndexAccess;
44    interface com::sun::star::container::XEnumerationAccess;
45
46    /** This method adds a new external document link by its URL, and returns
47        its instance.  If a document instance already exists for the specified URL,
48        then that instance gets returned instead of creating a new one.
49
50        @param aDocName document URL (e.g. file:///path/to/document.ods)
51
52        @return com::sun::star::sheet::XExternalDocLink external document link instance
53     */
54    com::sun::star::sheet::XExternalDocLink addDocLink( [in] string aDocName );
55};
56
57}; }; }; };
58
59#endif
60