offapi/com/sun/star/i18n/XNumberFormatCode.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: XNumberFormatCode.idl,v $
  10  * $Revision: 1.10 $
  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_XNumberFormatCode_idl__
  32 #define __com_sun_star_i18n_XNumberFormatCode_idl__
  33
  34 #ifndef __com_sun_star_lang_Locale_idl__
  35 #include <com/sun/star/lang/Locale.idl>
  36 #endif
  37 #include <com/sun/star/uno/XInterface.idl>
  38 #include <com/sun/star/i18n/NumberFormatCode.idl>
  39
  40 //=============================================================================
  41
  42 module com { module sun { module star { module i18n {
  43
  44 //=============================================================================
  45
  46 /**
  47     Access number format codes defined in locale data.
  48  */
  49
  50 published interface XNumberFormatCode : com::sun::star::uno::XInterface
  51 {
  52     //------------------------------------------------------------------------
  53     /**
  54         returns the default number format code of a specific category
  55         (usage group) for a given locale and format length type.
  56
  57         @param nFormatType
  58             one of the constants listed in <type>KNumberFormatType</type>
  59
  60         @param nFormatUsage
  61             one of <type>KNumberFormatUsage</type> values
  62      */
  63     NumberFormatCode getDefault( [in] short nFormatType,
  64                                  [in] short nFormatUsage,
  65                                  [in] com::sun::star::lang::Locale rLocale );
  66
  67     //------------------------------------------------------------------------
  68     /**
  69         returns the number format pointed to by <em>nFormatIndex</em> for
  70         a given locale.
  71
  72         @param nFormatIndex
  73             one of <type>NumberFormatIndex</type> values
  74      */
  75     NumberFormatCode getFormatCode( [in] short nFormatIndex,
  76                                     [in] com::sun::star::lang::Locale rLocale );
  77
  78     //------------------------------------------------------------------------
  79     /**
  80         returns all format codes for a given <em>nFormatUsage</em> and locale.
  81
  82         @param nFormatUsage
  83             one of <type>KNumberFormatUsage</type> values
  84      */
  85     sequence< NumberFormatCode > getAllFormatCode(
  86                                 [in] short nFormatUsage,
  87                                 [in] com::sun::star::lang::Locale rLocale );
  88
  89     //------------------------------------------------------------------------
  90     /**
  91         returns all format codes for a given locale.
  92      */
  93     sequence< NumberFormatCode > getAllFormatCodes(
  94                                 [in] com::sun::star::lang::Locale rLocale );
  95
  96 };
  97
  98 //=============================================================================
  99 }; }; }; };
 100 #endif