xref: /aoo41x/main/offapi/com/sun/star/i18n/NativeNumberMode.idl (revision d695a2a0)

/**************************************************************
 *
 * 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_i18n_NativeNumberMode_idl__
#define __com_sun_star_i18n_NativeNumberMode_idl__

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

module com { module sun { module star { module i18n {

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

/**
    Constants to use with
    <member>XExtendedCalendar::getDisplayString()</member> and the
    <type>XNativeNumberSupplier</type> methods.

    <p> The constants have different meanings if used with different
    locales. However, <const>NATNUM1</const> always tries to convert to
    a string matching the native number mode of the corresponding
    locale. </p>

    <p> Where available, the corresponding Microsoft Excel (tm) DBNum
    number format code modifier is listed. </p>

    <p> Modifiers supported by XExtendedCalendar::getDisplayString() are
    marked with CAL: for the specific language and the corresponding
    DBNum modifier and the NatNum values used for Y/M/D are listed </p>

	 @since OpenOffice 1.1.2
 */

published constants NativeNumberMode
{
    /** Transliteration to ASCII Arabic digits.
        Try to convert any native number string to ASCII.
        If already ASCII it remains ASCII.
     */
    const short NATNUM0     = 0;

    /** Transliteration in <br/>
        Chinese:    Chinese lower case characters; CAL: 1/7/7 [DBNum1] <br/>
        Japanese:   short Kanji characters [DBNum1]; CAL: 1/4/4 [DBNum1] <br/>
        Korean:     Korean lower case characters [DBNum1]; CAL: 1/7/7 [DBNum1] <br/>
        Thai:       Thai characters <br/>
        Arabic:     Indic characters <br/>
        Indic:      Indic characters
     */
    const short NATNUM1     = 1;

    /** Transliteration in <br/>
        Chinese:    Chinese upper case characters; CAL: 2/8/8 [DBNum2] <br/>
        Japanese:   traditional Kanji characters; CAL: 2/5/5 [DBNum2] <br/>
        Korean:     Korean upper case characters [DBNum2]; CAL: 2/8/8 [DBNum2]
     */
    const short NATNUM2     = 2;

    /** Transliteration in <br/>
        Chinese:    fullwidth Arabic digits; CAL: 3/3/3 [DBNum3] <br/>
        Japanese:   fullwidth Arabic digits; CAL: 3/3/3 [DBNum3] <br/>
        Korean:     fullwidth Arabic digits [DBNum3]; CAL: 3/3/3 [DBNum3]
     */
    const short NATNUM3     = 3;

    /** Transliteration in <br/>
        Chinese:    lower case text [DBNum1] <br/>
        Japanese:   modern long Kanji text [DBNum2] <br/>
        Korean:     formal lower case text
     */
    const short NATNUM4     = 4;

    /** Transliteration in <br/>
        Chinese:    Chinese upper case text [DBNum2] <br/>
        Japanese:   traditional long Kanji text [DBNum3] <br/>
        Korean:     formal upper case text
     */
    const short NATNUM5     = 5;

    /** Transliteration in <br/>
        Chinese:    fullwidth text [DBNum3] <br/>
        Japanese:   fullwidth text <br/>
        Korean:     fullwidth text
     */
    const short NATNUM6     = 6;

    /** Transliteration in <br/>
        Chinese:    short lower case text <br/>
        Japanese:   modern short Kanji text <br/>
        Korean:     informal lower case text
     */
    const short NATNUM7     = 7;

    /** Transliteration in <br/>
        Chinese:    short upper case text <br/>
        Japanese:   traditional short Kanji text [DBNum4] <br/>
        Korean:     informal upper case text
     */
    const short NATNUM8     = 8;

    /** Transliteration in <br/>
        Korean:     Hangul characters
     */
    const short NATNUM9     = 9;

    /** Transliteration in <br/>
        Korean:     formal Hangul text [DBNum4]; CAL: 9/11/11 [DBNum4]
     */
    const short NATNUM10    = 10;

    /** Transliteration in <br/>
        Korean:     informal Hangul text
      */
    const short NATNUM11    = 11;

};

//=============================================================================
}; }; }; };

#endif