offapi/com/sun/star/sdb/XBookmarksSupplier.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: XBookmarksSupplier.idl,v $
  10  * $Revision: 1.7 $
  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_sdb_XBookmarksSupplier_idl__
  31 #define __com_sun_star_sdb_XBookmarksSupplier_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_container_XNameAccess_idl__
  38 #include <com/sun/star/container/XNameAccess.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module sdb {
  45
  46 //=============================================================================
  47
  48 /** provides access to the collection of all bookmarks associated with a data source.
  49  */
  50 published interface XBookmarksSupplier: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** @returns        the collection of all bookmarks associated with a data source
  55             <p>
  56             A bookmark is simply a string specifying the location of the
  57             bookmarked document.
  58             </p>
  59      */
  60     com::sun::star::container::XNameAccess getBookmarks();
  61
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 /*=============================================================================
  69
  70 =============================================================================*/
  71 #endif