offapi/com/sun/star/text/DocumentIndexMark.idl

   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 #ifndef __com_sun_star_text_DocumentIndexMark_idl__
  20 #define __com_sun_star_text_DocumentIndexMark_idl__
  21
  22 #include <com/sun/star/text/TextContent.idl>
  23 #include <com/sun/star/text/BaseIndexMark.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module text {
  28
  29
  30 /** is a TextRange which is explicitly marked
  31     as an index entry for a DocumentIndex.
  32  */
  33 published service DocumentIndexMark
  34 {
  35     service com::sun::star::text::TextContent;
  36
  37     service com::sun::star::text::BaseIndexMark;
  38
  39     /** contains the primary key of the index entry.
  40          It is used to build a hierarchical document index.
  41      */
  42     [property] string PrimaryKey;
  43     /** contains the secondary key of the index entry.
  44          It is used to build a hierarchical document index.
  45      */
  46     [property] string SecondaryKey;
  47     /** determines if this entry is a main entry. In a document index this entry will
  48         be emphasized by assigning a character style to it.
  49      */
  50     [property] boolean IsMainEntry;
  51 };
  52
  53
  54 }; }; }; };
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */