offapi/com/sun/star/text/DocumentIndexes.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_DocumentIndexes_idl__
  28 #define __com_sun_star_text_DocumentIndexes_idl__
  29
  30 #ifndef __com_sun_star_container_XNameAccess_idl__
  31 #include <com/sun/star/container/XNameAccess.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module text {
  42
  43 //=============================================================================
  44
  45 /** provides access to all indexes in a document.
  46  */
  47 published service DocumentIndexes
  48 {
  49     /** This interface makes it possible to access all <type>BaseIndex</type>
  50                 instances within this context (e.g., a document) by its name.
  51
  52                 <p>The type of the interfaces returned by this collection is
  53                 always <type>XDocumentIndex</type>.
  54      */
  55     interface com::sun::star::container::XNameAccess;
  56
  57     /** This interface makes it possible to access all <type>BaseIndex</type>
  58                 instances within this context (e.g., a document) by its index.
  59
  60                 <p>The type of the interfaces returned by this collection is
  61                 always <type>XDocumentIndex</type>.
  62      */
  63     interface com::sun::star::container::XIndexAccess;
  64
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73