Author: hanya
Date: Wed Jan 14 14:27:43 2015
New Revision: 1651680
URL: http://svn.apache.org/r1651680
Log:
#i53565# add descriptions about parameters of member methods
Modified:
openoffice/trunk/main/offapi/com/sun/star/util/XNumberFormats.idl
Modified: openoffice/trunk/main/offapi/com/sun/star/util/XNumberFormats.idl
URL:
http://svn.apache.org/viewvc/openoffice/trunk/main/offapi/com/sun/star/util/XNumberFormats.idl?rev=1651680&r1=1651679&r2=1651680&view=diff
==============================================================================
--- openoffice/trunk/main/offapi/com/sun/star/util/XNumberFormats.idl (original)
+++ openoffice/trunk/main/offapi/com/sun/star/util/XNumberFormats.idl Wed Jan
14 14:27:43 2015
@@ -47,6 +47,8 @@
//=============================================================================
/** provides access to multiple <type>NumberFormat</type>s.
+
+ The number formats are managed by their unique key in the document.
*/
published interface XNumberFormats: com::sun::star::uno::XInterface
{
@@ -54,6 +56,9 @@ published interface XNumberFormats: com:
/** @returns
a readonly
<type>NumberFormatProperties</type>.
+
+ @param nKey
+ the key for the format
*/
com::sun::star::beans::XPropertySet getByKey( [in] long nKey );
@@ -66,8 +71,8 @@ published interface XNumberFormats: com:
the type of number formats to
return. Must be one of the
<type>NumberFormat</type>
constants.
- @param nLanguage
- the language of number formats
to return.
+ @param nLocale
+ the locale of number formats to
return.
@param bCreate
<TRUE/>: create new entries if
no formats for the selected language exist<BR>
@@ -80,6 +85,18 @@ published interface XNumberFormats: com:
//-------------------------------------------------------------------------
/** 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,
@@ -88,6 +105,18 @@ published interface XNumberFormats: com:
//-------------------------------------------------------------------------
/** 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 )
@@ -98,6 +127,21 @@ published interface XNumberFormats: com:
/** 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,
@@ -107,6 +151,9 @@ published interface XNumberFormats: com:
//-------------------------------------------------------------------------
/** removes a number format from the list.
+
+ @param nKey
+ the key for the numberformat
*/
void removeByKey( [in] long nKey );
@@ -114,6 +161,27 @@ published interface XNumberFormats: com:
/** 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,
