LibreOffice
LibreOffice 24.2 SDK API Reference
UserDefinedIndex.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 
21 
22 module com { module sun { module star { module text {
23 
24 
27 published service UserDefinedIndex
28 {
30 
36 
39  [optional, property] boolean CreateFromMarks;
40 
43  [optional, property] boolean UseLevelFromSource;
44 
47  [optional, property] boolean CreateFromTables;
48 
51  [optional, property] boolean CreateFromTextFrames;
52 
55  [optional, property] boolean CreateFromGraphicObjects;
56 
59  [optional, property] boolean CreateFromEmbeddedObjects;
60 
64  [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
65 };
66 
67 
68 }; }; }; };
69 
70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean CreateFromTextFrames
determines if text frames are included in the index.
Definition: UserDefinedIndex.idl:51
specifies service of user defined indexes within a document.
Definition: UserDefinedIndex.idl:27
boolean CreateFromMarks
determines if the document index marks are included in this index.
Definition: UserDefinedIndex.idl:39
This is the generic interface for supporting the replacement of indexed elements. ...
Definition: XIndexReplace.idl:28
boolean CreateFromGraphicObjects
determines if graphic objects are included in the index.
Definition: UserDefinedIndex.idl:55
Definition: Ambiguous.idl:20
boolean CreateFromEmbeddedObjects
determines if embedded objects are included in the index.
Definition: UserDefinedIndex.idl:59
sequence< com::sun::star::text::XDocumentIndexMark > DocumentIndexMarks
contains all index marks that are related to this index.
Definition: UserDefinedIndex.idl:64
com::sun::star::container::XIndexReplace LevelParagraphStyles
contains the interface to access the paragraph style names that are included in this index...
Definition: UserDefinedIndex.idl:29
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:29
boolean UseLevelFromSource
determines if the outline level of the location of the indexed object is used as index level of the i...
Definition: UserDefinedIndex.idl:43
boolean CreateFromTables
determines if tables are included in the index.
Definition: UserDefinedIndex.idl:47