diff options
author | Tsutomu Uchino <hanya@apache.org> | 2015-01-14 14:27:43 +0000 |
---|---|---|
committer | Caolán McNamara <caolanm@redhat.com> | 2015-01-14 16:41:18 +0000 |
commit | a663c789dd19aa93daf69874982b50a2da393d42 (patch) | |
tree | c6d21ba2882a99f0dc78fe4b0d0cd0d73979404c /offapi/com/sun | |
parent | 9977cbba8a36d3e6365cf886630d213ec7c1240c (diff) |
Related: #i53565# add descriptions about parameters of member methods
(cherry picked from commit 77399fdac9a5d5a5d935ec20500247960bf739e8)
Conflicts:
offapi/com/sun/star/util/XNumberFormats.idl
Change-Id: I4046c42598dd6882e5d0a4f9b9328834aede0051
Diffstat (limited to 'offapi/com/sun')
-rw-r--r-- | offapi/com/sun/star/util/XNumberFormats.idl | 70 |
1 files changed, 69 insertions, 1 deletions
diff --git a/offapi/com/sun/star/util/XNumberFormats.idl b/offapi/com/sun/star/util/XNumberFormats.idl index 5df638a57f3f..7d9c0f562213 100644 --- a/offapi/com/sun/star/util/XNumberFormats.idl +++ b/offapi/com/sun/star/util/XNumberFormats.idl @@ -33,12 +33,17 @@ /** provides access to multiple NumberFormats. + + The number formats are managed by their unique key in the document. */ published interface XNumberFormats: com::sun::star::uno::XInterface { /** @returns a readonly NumberFormatProperties. + + @param nKey + the key for the format */ com::sun::star::beans::XPropertySet getByKey( [in] long nKey ); @@ -51,7 +56,7 @@ published interface XNumberFormats: com::sun::star::uno::XInterface NumberFormat constants. @param nLocale - the language of number formats to return. + the locale of number formats to return. @param bCreate `TRUE`: create new entries if no formats for the selected language exist<BR> @@ -63,6 +68,18 @@ published interface XNumberFormats: com::sun::star::uno::XInterface /** finds a number format by its format string and returns its key. + + @returns + the key for the format if found, otherwise -1. + + @param aFormat + the string representation of the number format + + @param nLocale + the locale for number formats to find + + @param bScan + reserved for future use and should be set to false */ long queryKey( [in] string aFormat, [in] com::sun::star::lang::Locale nLocale, @@ -70,6 +87,18 @@ published interface XNumberFormats: com::sun::star::uno::XInterface /** adds a new number format to the list, using a format string. + + @returns + the key for new number format + + @param aFormat + the string representation of the number format + + @param nLocale + the locale for the number format + + @throws com::sun::star::util::MalformedNumberFormatException + if incorrect number format is specified */ long addNew( [in] string aFormat, [in] com::sun::star::lang::Locale nLocale ) @@ -79,6 +108,21 @@ published interface XNumberFormats: com::sun::star::uno::XInterface /** adds a new number format to the list, using a format string in a different locale than the desired locale of the resulting number format. + + @returns + the key for added number format + + @param aFormat + the key for the number format + + @param nLocale + the original locale for the number format + + @param nNewLocale + the new locale for the number format to be converted + + @throws com::sun::star::util::MalformedNumberFormatException + if incorrect number format is specified */ long addNewConverted( [in] string aFormat, [in] com::sun::star::lang::Locale nLocale, @@ -87,12 +131,36 @@ published interface XNumberFormats: com::sun::star::uno::XInterface /** removes a number format from the list. + + @param nKey + the key for the numberformat */ void removeByKey( [in] long nKey ); /** generates a format string from several parameters without creating an actual number format. + + @returns + the string representation for the number format + + @param nBaseKey + the key for the number format to be used as base format + + @param nLocale + the locale for the number format + + @param bThousands + the thousands separator is shown or not + + @param bRed + show negative number in red colored if <TRUE/> + + @param nDecimals + how many digits are shown after the decimal point + + @param nLeading + how many number of leading zeros are shown */ string generateFormat( [in] long nBaseKey, [in] com::sun::star::lang::Locale nLocale, |