/* -*- 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_task_XUrlContainer_idl__
#define __com_sun_star_task_XUrlContainer_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/task/XInteractionHandler.idl>



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 that are stored persistently shall
                        be returned.
        @returns        List of URLs.
    */
    sequence<string> getUrls( [in] boolean OnlyPersistent );

};


}; }; }; };

#endif

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