LibreOffice
LibreOffice 7.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#ifndef __com_sun_star_text_UserDefinedIndex_idl__
22#define __com_sun_star_text_UserDefinedIndex_idl__
23
26
27
28module com { module sun { module star { module text {
29
30
33published service UserDefinedIndex
34{
36
42
45 [optional, property] boolean CreateFromMarks;
46
49 [optional, property] boolean UseLevelFromSource;
50
53 [optional, property] boolean CreateFromTables;
54
57 [optional, property] boolean CreateFromTextFrames;
58
61 [optional, property] boolean CreateFromGraphicObjects;
62
65 [optional, property] boolean CreateFromEmbeddedObjects;
66
70 [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
71};
72
73
74}; }; }; };
75#endif
76
77/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This is the generic interface for supporting the replacement of indexed elements.
Definition: XIndexReplace.idl:39
Definition: Ambiguous.idl:22
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:43
specifies service of user defined indexes within a document.
Definition: UserDefinedIndex.idl:34
boolean CreateFromTextFrames
determines if text frames are included in the index.
Definition: UserDefinedIndex.idl:57
com::sun::star::container::XIndexReplace LevelParagraphStyles
contains the interface to access the paragraph style names that are included in this index.
Definition: UserDefinedIndex.idl:35
boolean CreateFromTables
determines if tables are included in the index.
Definition: UserDefinedIndex.idl:53
boolean CreateFromEmbeddedObjects
determines if embedded objects are included in the index.
Definition: UserDefinedIndex.idl:65
boolean CreateFromMarks
determines if the document index marks are included in this index.
Definition: UserDefinedIndex.idl:45
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:49
boolean CreateFromGraphicObjects
determines if graphic objects are included in the index.
Definition: UserDefinedIndex.idl:61
sequence< com::sun::star::text::XDocumentIndexMark > DocumentIndexMarks
contains all index marks that are related to this index.
Definition: UserDefinedIndex.idl:70