summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/DocumentIndex.idl
blob: dc9aa4e03f2095e937217b9946f83c9d8f26f072 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*************************************************************************
 *
 *  $RCSfile: DocumentIndex.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:22:20 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/


#ifndef __com_sun_star_text_DocumentIndex_idl__
#define __com_sun_star_text_DocumentIndex_idl__

#include <com/sun/star/text/BaseIndex.idl>

//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

// DocMerge from xml: service com::sun::star::text::DocumentIndex
/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
 */
service DocumentIndex
{
    // DocMerge: empty anyway
    service  com::sun::star::text::BaseIndex;

    /* determins if alphabetical separators are genererated.
     */
    // DocMerge: empty anyway
    [optional, property] boolean UseAlphabeticalSeparators;
    /* determins if a index entry is generated for each primary/secondary key.
     */
    // DocMerge: empty anyway
    [optional, property] boolean UseKeyAsEntry;
    /* determins if same entries on different pages are combined into one index entry.
     */
    // DocMerge: empty anyway
    [optional, property] boolean UseCombinedEntries;
    /* determins if the similarity of index entries is checked case sensitively.
     */
    // DocMerge: empty anyway
    [optional, property] boolean IsCaseSensitive;
    /* determins if following page numbers are displayed using a 'pp.'.
     */
    // DocMerge: empty anyway
    [optional, property] boolean UsePP;
    /* determins if if following page numbers are displayed using a dash.
     */
    // DocMerge: empty anyway
    [optional, property] boolean UseDash;
    /* determins if all entries start with a capital letter.
     */
    // DocMerge: empty anyway
    [optional, property] boolean UseUpperCase;
    /* determins the name of the character style that is applied to the number
     of a page where main index entry is located.
     */
    // DocMerge: empty anyway
    [optional, property] string MainEntryCharacterStyleName;
};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:59  hjs
    initial import

    Revision 1.8  2000/09/11 11:52:59  mi
    documentation merged from XML

    Revision 1.6  2000/08/09 15:54:55  os
    several new index services

    Revision 1.5  2000/06/29 12:27:31  os
    TransparentBackground -> ~BackTransparent

    Revision 1.4  2000/06/16 11:42:16  os
    #75622# BackGraphicLocation/URL/Filter added/changed

    Revision 1.3  2000/02/14 12:03:08  os
    #72990# service specified

    Revision 1.2  2000/02/07 11:25:00  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:46  jsc
    new


=============================================================================*/
#endif