offapi/com/sun/star/text/DocumentIndexes.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: DocumentIndexes.idl,v $
  10  * $Revision: 1.5 $
  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_text_DocumentIndexes_idl__
  31 #define __com_sun_star_text_DocumentIndexes_idl__
  32
  33 #ifndef __com_sun_star_container_XNameAccess_idl__
  34 #include <com/sun/star/container/XNameAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XIndexAccess_idl__
  38 #include <com/sun/star/container/XIndexAccess.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module text {
  45
  46 //=============================================================================
  47
  48 /** provides access to all indexes in a document.
  49  */
  50 published service DocumentIndexes
  51 {
  52     /** This interface makes it possible to access all <type>BaseIndex</type>
  53                 instances within this context (e.g., a document) by its name.
  54
  55                 <p>The type of the interfaces returned by this collection is
  56                 always <type>XDocumentIndex</type>.
  57      */
  58     interface com::sun::star::container::XNameAccess;
  59
  60     /** This interface makes it possible to access all <type>BaseIndex</type>
  61                 instances within this context (e.g., a document) by its index.
  62
  63                 <p>The type of the interfaces returned by this collection is
  64                 always <type>XDocumentIndex</type>.
  65      */
  66     interface com::sun::star::container::XIndexAccess;
  67
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76