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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPasswordContainer.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_task_XUrlContainer_idl__
  31 #define __com_sun_star_task_XUrlContainer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  38 #include <com/sun/star/task/XInteractionHandler.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module task {
  45
  46 //=============================================================================
  47 /** Allows to store and retrieve URLs. URLs can be stored persistently or
  48     until end of OOo session.
  49 */
  50 /*published*/ interface XUrlContainer : com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /** Add a URL to the container.
  54
  55         @param Url        URL to add to the container
  56         @param MakePersistent indicates whether the URL shall be stored
  57                           persistently or just in memory (until end of
  58                           OOo session)
  59     */
  60     void addUrl( [in] string Url, [in] boolean MakePersistent );
  61
  62     //-------------------------------------------------------------------------
  63     /** Lookup a URL in the container.
  64
  65         @param Url     URL to lookup.
  66          @returns       Best matched URL or empty string.
  67     */
  68     string findUrl( [in] string Url );
  69
  70     //-------------------------------------------------------------------------
  71     /** Remove a URL from the container.
  72
  73         @param Url      URL to remove.
  74     */
  75     void removeUrl( [in] string Url );
  76
  77     //-------------------------------------------------------------------------
  78     /** Get all URLs.
  79
  80         @param OnlyPersistent Only URLs taht are stored persistently shall
  81                         be returned.
  82         @returns        List of URLs.
  83     */
  84     sequence<string> getUrls( [in] boolean OnlyPersistent );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif