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#ifndef __com_sun_star_task_XUrlContainer_idl__
24#define __com_sun_star_task_XUrlContainer_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_task_XInteractionHandler_idl__
31#include <com/sun/star/task/XInteractionHandler.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module task {
38
39//=============================================================================
40/** Allows to store and retrieve URLs. URLs can be stored persistently or
41    until end of OpenOffice session.
42
43    @since OpenOffice 3.2
44*/
45published interface XUrlContainer : com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48    /** Add a URL to the container.
49
50        @param Url        URL to add to the container
51        @param MakePersistent indicates whether the URL shall be stored
52                          persistently or just in memory (until end of
53                          OpenOffice session)
54    */
55    void addUrl( [in] string Url, [in] boolean MakePersistent );
56
57    //-------------------------------------------------------------------------
58    /** Lookup a URL in the container.
59
60        @param Url     URL to lookup.
61        @returns       Best matched URL or empty string.
62    */
63    string findUrl( [in] string Url );
64
65    //-------------------------------------------------------------------------
66    /** Remove a URL from the container.
67
68        @param Url      URL to remove.
69    */
70    void removeUrl( [in] string Url );
71
72    //-------------------------------------------------------------------------
73    /** Get all URLs.
74
75        @param OnlyPersistent Only URLs that are stored persistently shall
76                        be returned.
77        @returns        List of URLs.
78    */
79    sequence<string> getUrls( [in] boolean OnlyPersistent );
80
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88