offapi/com/sun/star/i18n/NativeNumberMode.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: NativeNumberMode.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
  31 #ifndef __com_sun_star_i18n_NativeNumberMode_idl__
  32 #define __com_sun_star_i18n_NativeNumberMode_idl__
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module i18n {
  37
  38 //=============================================================================
  39
  40 /**
  41     Constants to use with
  42     <member>XExtendedCalendar::getDisplayString()</member> and the
  43     <type>XNativeNumberSupplier</type> methods.
  44
  45     <p> The constants have different meanings if used with different
  46     locales. However, <const>NATNUM1</const> always tries to convert to
  47     a string matching the native number mode of the corresponding
  48     locale. </p>
  49
  50     <p> Where available, the corresponding Microsoft Excel (tm) DBNum
  51     number format code modifier is listed. </p>
  52
  53     <p> Modifiers supported by XExtendedCalendar::getDisplayString() are
  54     marked with CAL: for the specific language and the corresponding
  55     DBNum modifier and the NatNum values used for Y/M/D are listed </p>
  56
  57      @since OOo 1.1.2
  58  */
  59
  60 published constants NativeNumberMode
  61 {
  62     /** Transliteration to ASCII Arabic digits.
  63         Try to convert any native number string to ASCII.
  64         If already ASCII it remains ASCII.
  65      */
  66     const short NATNUM0     = 0;
  67
  68     /** Transliteration in <br/>
  69         Chinese:    Chinese lower case characters; CAL: 1/7/7 [DBNum1] <br/>
  70         Japanese:   short Kanji characters [DBNum1]; CAL: 1/4/4 [DBNum1] <br/>
  71         Korean:     Korean lower case characters [DBNum1]; CAL: 1/7/7 [DBNum1] <br/>
  72         Thai:       Thai characters <br/>
  73         Arabic:     Indic characters <br/>
  74         Indic:      Indic characters
  75      */
  76     const short NATNUM1     = 1;
  77
  78     /** Transliteration in <br/>
  79         Chinese:    Chinese upper case characters; CAL: 2/8/8 [DBNum2] <br/>
  80         Japanese:   traditional Kanji characters; CAL: 2/5/5 [DBNum2] <br/>
  81         Korean:     Korean upper case characters [DBNum2]; CAL: 2/8/8 [DBNum2]
  82      */
  83     const short NATNUM2     = 2;
  84
  85     /** Transliteration in <br/>
  86         Chinese:    fullwidth Arabic digits; CAL: 3/3/3 [DBNum3] <br/>
  87         Japanese:   fullwidth Arabic digits; CAL: 3/3/3 [DBNum3] <br/>
  88         Korean:     fullwidth Arabic digits [DBNum3]; CAL: 3/3/3 [DBNum3]
  89      */
  90     const short NATNUM3     = 3;
  91
  92     /** Transliteration in <br/>
  93         Chinese:    lower case text [DBNum1] <br/>
  94         Japanese:   modern long Kanji text [DBNum2] <br/>
  95         Korean:     formal lower case text
  96      */
  97     const short NATNUM4     = 4;
  98
  99     /** Transliteration in <br/>
 100         Chinese:    Chinese upper case text [DBNum2] <br/>
 101         Japanese:   traditional long Kanji text [DBNum3] <br/>
 102         Korean:     formal upper case text
 103      */
 104     const short NATNUM5     = 5;
 105
 106     /** Transliteration in <br/>
 107         Chinese:    fullwidth text [DBNum3] <br/>
 108         Japanese:   fullwidth text <br/>
 109         Korean:     fullwidth text
 110      */
 111     const short NATNUM6     = 6;
 112
 113     /** Transliteration in <br/>
 114         Chinese:    short lower case text <br/>
 115         Japanese:   modern short Kanji text <br/>
 116         Korean:     informal lower case text
 117      */
 118     const short NATNUM7     = 7;
 119
 120     /** Transliteration in <br/>
 121         Chinese:    short upper case text <br/>
 122         Japanese:   traditional short Kanji text [DBNum4] <br/>
 123         Korean:     informal upper case text
 124      */
 125     const short NATNUM8     = 8;
 126
 127     /** Transliteration in <br/>
 128         Korean:     Hangul characters
 129      */
 130     const short NATNUM9     = 9;
 131
 132     /** Transliteration in <br/>
 133         Korean:     formal Hangul text [DBNum4]; CAL: 9/11/11 [DBNum4]
 134      */
 135     const short NATNUM10    = 10;
 136
 137     /** Transliteration in <br/>
 138         Korean:     informal Hangul text
 139       */
 140     const short NATNUM11    = 11;
 141
 142 };
 143
 144 //=============================================================================
 145 }; }; }; };
 146
 147 #endif