/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DocumentIndexMarkAsian.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:10:36 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_DocumentIndexMarkAsian_idl__
#define __com_sun_star_text_DocumentIndexMarkAsian_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>.
    For Asian languages the user can provide an additional string
    which is used for sorting. If the user does not provide these
    strings, they are not considered for sorting.

    @since OOo 1.1.2
 */
published service DocumentIndexMarkAsian
{
    //-------------------------------------------------------------------------
    /** contains the reading of the string which has been chosen for the
        index entry.
     */
    [property] string TextReading;
    //-------------------------------------------------------------------------
    /** contains the reading of the primary key of the index entry.
         It is used to build a hierarchical document index.
     */
    [property] string PrimaryKeyReading;
    //-------------------------------------------------------------------------
    /** contains the reading the secondary key of the index entry.
         It is used to build a hierarchical document index.
     */
    [property] string SecondaryKeyReading;
};

//=============================================================================

}; }; }; };
#endif


