offapi/com/sun/star/text/DocumentIndexMarkAsian.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_DocumentIndexMarkAsian_idl__
  20 #define __com_sun_star_text_DocumentIndexMarkAsian_idl__
  21
  22
  23
  24
  25  module com {  module sun {  module star {  module text {
  26
  27
  28 /** is a TextRange which is explicitly marked
  29     as an index entry for a DocumentIndex.
  30     For Asian languages the user can provide an additional string
  31     which is used for sorting. If the user does not provide these
  32     strings, they are not considered for sorting.
  33
  34     @since OOo 1.1.2
  35  */
  36 published service DocumentIndexMarkAsian
  37 {
  38     /** contains the reading of the string which has been chosen for the
  39         index entry.
  40      */
  41     [property] string TextReading;
  42     /** contains the reading of the primary key of the index entry.
  43          It is used to build a hierarchical document index.
  44      */
  45     [property] string PrimaryKeyReading;
  46     /** contains the reading the secondary key of the index entry.
  47          It is used to build a hierarchical document index.
  48      */
  49     [property] string SecondaryKeyReading;
  50 };
  51
  52
  53 }; }; }; };
  54 #endif
  55
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */