xref: /trunk/main/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl (revision 2a413f17)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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 OpenOffice 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