offapi/com/sun/star/task/XUrlContainer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com { module sun { module star { module task {
  23
  24 /** Allows to store and retrieve URLs. URLs can be stored persistently or
  25     until end of OOo session.
  26
  27     @since OOo 3.2
  28 */
  29 published interface XUrlContainer : com::sun::star::uno::XInterface
  30 {
  31     /** Add a URL to the container.
  32
  33         @param Url        URL to add to the container
  34         @param MakePersistent indicates whether the URL shall be stored
  35                           persistently or just in memory (until end of
  36                           OOo session)
  37     */
  38     void addUrl( [in] string Url, [in] boolean MakePersistent );
  39
  40     /** Lookup a URL in the container.
  41
  42         @param Url     URL to lookup.
  43         @returns       Best matched URL or empty string.
  44     */
  45     string findUrl( [in] string Url );
  46
  47     /** Remove a URL from the container.
  48
  49         @param Url      URL to remove.
  50     */
  51     void removeUrl( [in] string Url );
  52
  53     /** Get all URLs.
  54
  55         @param OnlyPersistent Only URLs that are stored persistently shall
  56                         be returned.
  57         @returns        List of URLs.
  58     */
  59     sequence<string> getUrls( [in] boolean OnlyPersistent );
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */