summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XExternalDocLinks.idl
blob: 0fca782f2ace7e90d0a95b83db4e7871f4c57c6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
#define __com_sun_star_sheet_XExternalDocLinks_idl__

#include <com/sun/star/sheet/XExternalDocLink.idl>
#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>

module com {  module sun {  module star {  module sheet {

/** Primary interface for the com::sun::star::sheet::ExternalDocLinks service.

    @see com::sun::star::sheet::ExternalDocLinks

    @since OOo 3.1
 */
interface XExternalDocLinks
{
    interface com::sun::star::container::XNameAccess;
    interface com::sun::star::container::XIndexAccess;
    interface com::sun::star::container::XEnumerationAccess;

    /** This method adds a new external document link by its URL, and returns
        its instance.  If a document instance already exists for the specified URL,
        then that instance gets returned instead of creating a new one.

        @param aDocName document URL (e.g. file:///path/to/document.ods)

        @return com::sun::star::sheet::XExternalDocLink external document link instance
     */
    com::sun::star::sheet::XExternalDocLink addDocLink( [in] string aDocName );
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */