Attachment #82503 for issue #53565

View | Details | Raw Unified | Return to issue 53565
Collapse All | Expand All

Lines 47-52 Link Here

(-)offapi/com/sun/star/util/XNumberFormats.idl (-2 / +70 lines)
47	//=============================================================================	47	//=============================================================================
48		48
49	/** provides access to multiple <type>NumberFormat</type>s.	49	/** provides access to multiple <type>NumberFormat</type>s.
		50
		51	The number formats are managed by their unique key in the document.
50	*/	52	*/
51	published interface XNumberFormats: com::sun::star::uno::XInterface	53	published interface XNumberFormats: com::sun::star::uno::XInterface
52	{	54	{
Lines 54-59 Link Here
54		56
55	/** @returns	57	/** @returns
56	a readonly <type>NumberFormatProperties</type>.	58	a readonly <type>NumberFormatProperties</type>.
		59
		60	@param nKey
		61	the key for the format
57	*/	62	*/
58	com::sun::star::beans::XPropertySet getByKey( [in] long nKey );	63	com::sun::star::beans::XPropertySet getByKey( [in] long nKey );
59		64
Lines 66-73 Link Here
66	the type of number formats to return. Must be one of the	71	the type of number formats to return. Must be one of the
67	<type>NumberFormat</type> constants.	72	<type>NumberFormat</type> constants.
68		73
69	@param nLanguage	74	@param nLocale
70	the language of number formats to return.	75	the locale of number formats to return.
71		76
72	@param bCreate	77	@param bCreate
73	<TRUE/>: create new entries if no formats for the selected language exist<BR>	78	<TRUE/>: create new entries if no formats for the selected language exist<BR>
Lines 80-85 Link Here
80	//-------------------------------------------------------------------------	85	//-------------------------------------------------------------------------
81		86
82	/** finds a number format by its format string and returns its key.	87	/** finds a number format by its format string and returns its key.
		88
		89	@returns
		90	the key for the format if found, otherwise -1.
		91
		92	@param aFormat
		93	the string representation of the number format
		94
		95	@param nLocale
		96	the locale for number formats to find
		97
		98	@param bScan
		99	reserved for future use and should be set to false
83	*/	100	*/
84	long queryKey( [in] string aFormat,	101	long queryKey( [in] string aFormat,
85	[in] com::sun::star::lang::Locale nLocale,	102	[in] com::sun::star::lang::Locale nLocale,
Lines 88-93 Link Here
88	//-------------------------------------------------------------------------	105	//-------------------------------------------------------------------------
89		106
90	/** adds a new number format to the list, using a format string.	107	/** adds a new number format to the list, using a format string.
		108
		109	@returns
		110	the key for new number format
		111
		112	@param aFormat
		113	the string representation of the number format
		114
		115	@param nLocale
		116	the locale for the number format
		117
		118	@throws com::sun::star::util::MalformedNumberFormatException
		119	if incorrect number format is specified
91	*/	120	*/
92	long addNew( [in] string aFormat,	121	long addNew( [in] string aFormat,
93	[in] com::sun::star::lang::Locale nLocale )	122	[in] com::sun::star::lang::Locale nLocale )
Lines 98-103 Link Here
98	/** adds a new number format to the list, using a format	127	/** adds a new number format to the list, using a format
99	string in a different locale than the desired locale of the	128	string in a different locale than the desired locale of the
100	resulting number format.	129	resulting number format.
		130
		131	@returns
		132	the key for added number format
		133
		134	@param aFormat
		135	the key for the number format
		136
		137	@param nLocale
		138	the original locale for the number format
		139
		140	@param nNewLocale
		141	the new locale for the number format to be converted
		142
		143	@throws com::sun::star::util::MalformedNumberFormatException
		144	if incorrect number format is specified
101	*/	145	*/
102	long addNewConverted( [in] string aFormat,	146	long addNewConverted( [in] string aFormat,
103	[in] com::sun::star::lang::Locale nLocale,	147	[in] com::sun::star::lang::Locale nLocale,
Lines 107-112 Link Here
107	//-------------------------------------------------------------------------	151	//-------------------------------------------------------------------------
108		152
109	/** removes a number format from the list.	153	/** removes a number format from the list.
		154
		155	@param nKey
		156	the key for the numberformat
110	*/	157	*/
111	void removeByKey( [in] long nKey );	158	void removeByKey( [in] long nKey );
112		159
Lines 114-119 Link Here
114		161
115	/** generates a format string from several parameters without	162	/** generates a format string from several parameters without
116	creating an actual number format.	163	creating an actual number format.
		164
		165	@returns
		166	the string representation for the number format
		167
		168	@param nBaseKey
		169	the key for the number format to be used as base format
		170
		171	@param nLocale
		172	the locale for the number format
		173
		174	@param bThousands
		175	the thousands separator is shown or not
		176
		177	@param bRed
		178	show negative number in red colored if <TRUE/>
		179
		180	@param nDecimals
		181	how many digits are shown after the decimal point
		182
		183	@param nLeading
		184	how many number of leading zeros are shown
117	*/	185	*/
118	string generateFormat( [in] long nBaseKey,	186	string generateFormat( [in] long nBaseKey,
119	[in] com::sun::star::lang::Locale nLocale,	187	[in] com::sun::star::lang::Locale nLocale,

Return to issue 53565