offapi/com/sun/star/i18n/NativeNumberMode.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_i18n_NativeNumberMode_idl__
  29 #define __com_sun_star_i18n_NativeNumberMode_idl__
  30
  31 //=============================================================================
  32
  33 module com { module sun { module star { module i18n {
  34
  35 //=============================================================================
  36
  37 /**
  38     Constants to use with
  39     <member>XExtendedCalendar::getDisplayString()</member> and the
  40     <type>XNativeNumberSupplier</type> methods.
  41
  42     <p> The constants have different meanings if used with different
  43     locales. However, <const>NATNUM1</const> always tries to convert to
  44     a string matching the native number mode of the corresponding
  45     locale. </p>
  46
  47     <p> Where available, the corresponding Microsoft Excel (tm) DBNum
  48     number format code modifier is listed. </p>
  49
  50     <p> Modifiers supported by XExtendedCalendar::getDisplayString() are
  51     marked with CAL: for the specific language and the corresponding
  52     DBNum modifier and the NatNum values used for Y/M/D are listed </p>
  53
  54      @since OOo 1.1.2
  55  */
  56
  57 published constants NativeNumberMode
  58 {
  59     /** Transliteration to ASCII Arabic digits.
  60         Try to convert any native number string to ASCII.
  61         If already ASCII it remains ASCII.
  62      */
  63     const short NATNUM0     = 0;
  64
  65     /** Transliteration in <br/>
  66         Chinese:    Chinese lower case characters; CAL: 1/7/7 [DBNum1] <br/>
  67         Japanese:   short Kanji characters [DBNum1]; CAL: 1/4/4 [DBNum1] <br/>
  68         Korean:     Korean lower case characters [DBNum1]; CAL: 1/7/7 [DBNum1] <br/>
  69         Thai:       Thai characters <br/>
  70         Arabic:     Indic characters <br/>
  71         Indic:      Indic characters
  72      */
  73     const short NATNUM1     = 1;
  74
  75     /** Transliteration in <br/>
  76         Chinese:    Chinese upper case characters; CAL: 2/8/8 [DBNum2] <br/>
  77         Japanese:   traditional Kanji characters; CAL: 2/5/5 [DBNum2] <br/>
  78         Korean:     Korean upper case characters [DBNum2]; CAL: 2/8/8 [DBNum2]
  79      */
  80     const short NATNUM2     = 2;
  81
  82     /** Transliteration in <br/>
  83         Chinese:    fullwidth Arabic digits; CAL: 3/3/3 [DBNum3] <br/>
  84         Japanese:   fullwidth Arabic digits; CAL: 3/3/3 [DBNum3] <br/>
  85         Korean:     fullwidth Arabic digits [DBNum3]; CAL: 3/3/3 [DBNum3]
  86      */
  87     const short NATNUM3     = 3;
  88
  89     /** Transliteration in <br/>
  90         Chinese:    lower case text [DBNum1] <br/>
  91         Japanese:   modern long Kanji text [DBNum2] <br/>
  92         Korean:     formal lower case text
  93      */
  94     const short NATNUM4     = 4;
  95
  96     /** Transliteration in <br/>
  97         Chinese:    Chinese upper case text [DBNum2] <br/>
  98         Japanese:   traditional long Kanji text [DBNum3] <br/>
  99         Korean:     formal upper case text
 100      */
 101     const short NATNUM5     = 5;
 102
 103     /** Transliteration in <br/>
 104         Chinese:    fullwidth text [DBNum3] <br/>
 105         Japanese:   fullwidth text <br/>
 106         Korean:     fullwidth text
 107      */
 108     const short NATNUM6     = 6;
 109
 110     /** Transliteration in <br/>
 111         Chinese:    short lower case text <br/>
 112         Japanese:   modern short Kanji text <br/>
 113         Korean:     informal lower case text
 114      */
 115     const short NATNUM7     = 7;
 116
 117     /** Transliteration in <br/>
 118         Chinese:    short upper case text <br/>
 119         Japanese:   traditional short Kanji text [DBNum4] <br/>
 120         Korean:     informal upper case text
 121      */
 122     const short NATNUM8     = 8;
 123
 124     /** Transliteration in <br/>
 125         Korean:     Hangul characters
 126      */
 127     const short NATNUM9     = 9;
 128
 129     /** Transliteration in <br/>
 130         Korean:     formal Hangul text [DBNum4]; CAL: 9/11/11 [DBNum4]
 131      */
 132     const short NATNUM10    = 10;
 133
 134     /** Transliteration in <br/>
 135         Korean:     informal Hangul text
 136       */
 137     const short NATNUM11    = 11;
 138
 139 };
 140
 141 //=============================================================================
 142 }; }; }; };
 143
 144 #endif