office-gobmx/offapi/com/sun/star/i18n/XNumberFormatCode.idl
2011-04-02 00:08:53 +02:00

95 lines
3.5 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_i18n_XNumberFormatCode_idl__
#define __com_sun_star_i18n_XNumberFormatCode_idl__
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/i18n/NumberFormatCode.idl>
//=============================================================================
module com { module sun { module star { module i18n {
//=============================================================================
/**
Access number format codes defined in locale data.
*/
published interface XNumberFormatCode : com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/**
returns the default number format code of a specific category
(usage group) for a given locale and format length type.
@param nFormatType
one of the constants listed in <type>KNumberFormatType</type>
@param nFormatUsage
one of <type>KNumberFormatUsage</type> values
*/
NumberFormatCode getDefault( [in] short nFormatType,
[in] short nFormatUsage,
[in] com::sun::star::lang::Locale rLocale );
//------------------------------------------------------------------------
/**
returns the number format pointed to by <em>nFormatIndex</em> for
a given locale.
@param nFormatIndex
one of <type>NumberFormatIndex</type> values
*/
NumberFormatCode getFormatCode( [in] short nFormatIndex,
[in] com::sun::star::lang::Locale rLocale );
//------------------------------------------------------------------------
/**
returns all format codes for a given <em>nFormatUsage</em> and locale.
@param nFormatUsage
one of <type>KNumberFormatUsage</type> values
*/
sequence< NumberFormatCode > getAllFormatCode(
[in] short nFormatUsage,
[in] com::sun::star::lang::Locale rLocale );
//------------------------------------------------------------------------
/**
returns all format codes for a given locale.
*/
sequence< NumberFormatCode > getAllFormatCodes(
[in] com::sun::star::lang::Locale rLocale );
};
//=============================================================================
}; }; }; };
#endif