xref: /aoo4110/main/offapi/com/sun/star/task/XUrlContainer.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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 OpenOffice session.

    @since OpenOffice 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
                          OpenOffice 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