LibreOffice LibreOffice 25.2 SDK API Reference

UserIndex.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
21module com { module sun { module star { module text {
22
26published service UserIndex
27{
28 service com::sun::star::text::BaseIndex;
29
34 [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
35
38 [optional, property] boolean CreateFromMarks;
39
42 [optional, property] boolean UseLevelFromSource;
43
46 [optional, property] boolean CreateFromTables;
47
50 [optional, property] boolean CreateFromTextFrames;
51
54 [optional, property] boolean CreateFromGraphicObjects;
55
58 [optional, property] boolean CreateFromEmbeddedObjects;
61 [property] string UserIndexName;
62};
63
64
65}; }; }; };
66
67/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::XIndexReplace
This is the generic interface for supporting the replacement of indexed elements.
Definition: XIndexReplace.idl:29
com
Definition: Ambiguous.idl:20
com::sun::star::text::BaseIndex
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:30
com::sun::star::text::UserIndex
specifies service of user defined indexes within a document.
Definition: UserIndex.idl:27
com::sun::star::text::UserIndex::CreateFromTextFrames
boolean CreateFromTextFrames
determines if text frames are included in the index.
Definition: UserIndex.idl:50
com::sun::star::text::UserIndex::LevelParagraphStyles
com::sun::star::container::XIndexReplace LevelParagraphStyles
contains the interface to access the paragraph style names that are included in this index.
Definition: UserIndex.idl:28
com::sun::star::text::UserIndex::CreateFromTables
boolean CreateFromTables
determines if tables are included in the index.
Definition: UserIndex.idl:46
com::sun::star::text::UserIndex::CreateFromEmbeddedObjects
boolean CreateFromEmbeddedObjects
determines if embedded objects are included in the index.
Definition: UserIndex.idl:58
com::sun::star::text::UserIndex::CreateFromMarks
boolean CreateFromMarks
determines if the document index marks are included in this index.
Definition: UserIndex.idl:38
com::sun::star::text::UserIndex::UseLevelFromSource
boolean UseLevelFromSource
determines if the outline level of the location of the indexed object is used as index level of the i...
Definition: UserIndex.idl:42
com::sun::star::text::UserIndex::UserIndexName
string UserIndexName
contains the name of the user index.
Definition: UserIndex.idl:61
com::sun::star::text::UserIndex::CreateFromGraphicObjects
boolean CreateFromGraphicObjects
determines if graphic objects are included in the index.
Definition: UserIndex.idl:54