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