summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/task/XUrlContainer.idl
blob: 9a20a3e9238d2bba9d9c6880e26c15d7611d4768 (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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_task_XUrlContainer_idl__
#define __com_sun_star_task_XUrlContainer_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_task_XInteractionHandler_idl__
#include <com/sun/star/task/XInteractionHandler.idl>
#endif


//=============================================================================

module com { module sun { module star { module task {

//=============================================================================
/** Allows to store and retrieve URLs. URLs can be stored persistently or
    until end of OOo session.

    @since OOo 3.2
*/
published interface XUrlContainer : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Add a URL to the container.

        @param Url        URL to add to the container
        @param MakePersistent indicates whether the URL shall be stored
                          persistently or just in memory (until end of
                          OOo session)
    */
    void addUrl( [in] string Url, [in] boolean MakePersistent );

    //-------------------------------------------------------------------------
    /** Lookup a URL in the container.

        @param Url     URL to lookup.
        @returns       Best matched URL or empty string.
    */
    string findUrl( [in] string Url );

    //-------------------------------------------------------------------------
    /** Remove a URL from the container.

        @param Url      URL to remove.
    */
    void removeUrl( [in] string Url );

    //-------------------------------------------------------------------------
    /** Get all URLs.

        @param OnlyPersistent Only URLs taht are stored persistently shall
                        be returned.
        @returns        List of URLs.
    */
    sequence<string> getUrls( [in] boolean OnlyPersistent );

};

//=============================================================================

}; }; }; };

#endif