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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentIndexMarkAsian.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_DocumentIndexMarkAsian_idl__
  31 #define __com_sun_star_text_DocumentIndexMarkAsian_idl__
  32
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 //=============================================================================
  40
  41 /** is a <type>TextRange</type> which is explicitly marked
  42     as an index entry for a <type>DocumentIndex</type>.
  43     For Asian languages the user can provide an additional string
  44     which is used for sorting. If the user does not provide these
  45     strings, they are not considered for sorting.
  46
  47     @since OOo 1.1.2
  48  */
  49 published service DocumentIndexMarkAsian
  50 {
  51     //-------------------------------------------------------------------------
  52     /** contains the reading of the string which has been chosen for the
  53         index entry.
  54      */
  55     [property] string TextReading;
  56     //-------------------------------------------------------------------------
  57     /** contains the reading of the primary key of the index entry.
  58          It is used to build a hierarchical document index.
  59      */
  60     [property] string PrimaryKeyReading;
  61     //-------------------------------------------------------------------------
  62     /** contains the reading the secondary key of the index entry.
  63          It is used to build a hierarchical document index.
  64      */
  65     [property] string SecondaryKeyReading;
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71 #endif
  72
  73