offapi/com/sun/star/text/DocumentIndex.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: DocumentIndex.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
  31
  32 #ifndef __com_sun_star_text_DocumentIndex_idl__
  33 #define __com_sun_star_text_DocumentIndex_idl__
  34
  35 #include <com/sun/star/text/BaseIndex.idl>
  36 #ifndef __com_sun_star_text_XDocumentIndexMark_idl__
  37 #include <com/sun/star/text/XDocumentIndexMark.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42 module com {  module sun {  module star {  module text {
  43
  44 //=============================================================================
  45
  46 /** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
  47  */
  48 published service DocumentIndex
  49 {
  50     service  com::sun::star::text::BaseIndex;
  51
  52     /** determins if alphabetical separators are genererated.
  53      */
  54     [optional, property] boolean UseAlphabeticalSeparators;
  55
  56     /** determins if a index entry is generated for each primary/secondary key.
  57      */
  58     [optional, property] boolean UseKeyAsEntry;
  59
  60     /** determins if same entries on different pages are combined into one index entry.
  61      */
  62     [optional, property] boolean UseCombinedEntries;
  63
  64     /** determins if the similarity of index entries is checked case sensitively.
  65      */
  66     [optional, property] boolean IsCaseSensitive;
  67
  68     /** determins if following page numbers are displayed using a 'pp.'.
  69      */
  70     [optional, property] boolean UsePP;
  71
  72     /** determins if if following page numbers are displayed using a dash.
  73      */
  74     [optional, property] boolean UseDash;
  75
  76     /** determins if all entries start with a capital letter.
  77      */
  78     [optional, property] boolean UseUpperCase;
  79
  80     /** determins the name of the character style that is applied to the number
  81      of a page where main index entry is located.
  82      */
  83     [optional, property] string MainEntryCharacterStyleName;
  84
  85     /**
  86      contains all index marks that are related to this index.
  87      */
  88     [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
  89
  90     //------------------------------------------------------------------------
  91     /** contains the locale of the index.
  92      */
  93     [property] com::sun::star::lang::Locale  Locale;
  94
  95     //------------------------------------------------------------------------
  96     /** contains the name of the sort algorithm that is used to sort the entries.
  97      */
  98     [property] string SortAlgorithm;
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif