LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XNumberFormatCode Interface Referencepublished

Access number format codes defined in locale data. More...

import"XNumberFormatCode.idl";

Inheritance diagram for XNumberFormatCode:
XInterface NumberFormatMapper

Public Member Functions

NumberFormatCode getDefault ([in] short nFormatType, [in] short nFormatUsage, [in] com::sun::star::lang::Locale rLocale)
 returns the default number format code of a specific category (usage group) for a given locale and format length type. More...
 
NumberFormatCode getFormatCode ([in] short nFormatIndex, [in] com::sun::star::lang::Locale rLocale)
 returns the number format pointed to by nFormatIndex for a given locale. More...
 
sequence< NumberFormatCodegetAllFormatCode ([in] short nFormatUsage, [in] com::sun::star::lang::Locale rLocale)
 returns all format codes for a given nFormatUsage and locale. More...
 
sequence< NumberFormatCodegetAllFormatCodes ([in] com::sun::star::lang::Locale rLocale)
 returns all format codes for a given locale. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

Access number format codes defined in locale data.

Developers Guide
OfficeDev - Overview and Using the API - XNumberFormatCode

Member Function Documentation

sequence< NumberFormatCode > getAllFormatCode ( [in] short  nFormatUsage,
[in] com::sun::star::lang::Locale  rLocale 
)

returns all format codes for a given nFormatUsage and locale.

Parameters
nFormatUsageone of KNumberFormatUsage values
rLocaleThe locale for which the format codes are requested.
sequence< NumberFormatCode > getAllFormatCodes ( [in] com::sun::star::lang::Locale  rLocale)

returns all format codes for a given locale.

Parameters
rLocaleThe locale for which the format codes are requested.
NumberFormatCode getDefault ( [in] short  nFormatType,
[in] short  nFormatUsage,
[in] com::sun::star::lang::Locale  rLocale 
)

returns the default number format code of a specific category (usage group) for a given locale and format length type.

Parameters
nFormatTypeone of the constants listed in KNumberFormatType
nFormatUsageone of KNumberFormatUsage values
rLocaleThe locale for which the format code is requested.
NumberFormatCode getFormatCode ( [in] short  nFormatIndex,
[in] com::sun::star::lang::Locale  rLocale 
)

returns the number format pointed to by nFormatIndex for a given locale.

Parameters
nFormatIndexone of NumberFormatIndex values
rLocaleThe locale for which the format code is requested.

The documentation for this interface was generated from the following file: