summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/DocumentIndexMark.idl
blob: a50123fa5a51ea46cfcff0c9b25ef4086a8842ef (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_text_DocumentIndexMark_idl__
#define __com_sun_star_text_DocumentIndexMark_idl__

#include <com/sun/star/text/TextContent.idl>
#include <com/sun/star/text/BaseIndexMark.idl>



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


/** is a <type>TextRange</type> which is explicitly marked
    as an index entry for a <type>DocumentIndex</type>.
 */
published service DocumentIndexMark
{
    service com::sun::star::text::TextContent;

    service com::sun::star::text::BaseIndexMark;

    /** contains the primary key of the index entry.
         It is used to build a hierarchical document index.
     */
    [property] string PrimaryKey;
    /** contains the secondary key of the index entry.
         It is used to build a hierarchical document index.
     */
    [property] string SecondaryKey;
    /** determines if this entry is a main entry. In a document index this entry will
        be emphasized by assigning a character style to it.
     */
    [property] boolean IsMainEntry;
};


}; }; }; };
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */