xref: /AOO41X/main/offapi/com/sun/star/util/NumberFormatProperties.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_util_NumberFormatProperties_idl__
24#define __com_sun_star_util_NumberFormatProperties_idl__
25
26#ifndef __com_sun_star_lang_Locale_idl__
27#include <com/sun/star/lang/Locale.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module util {
34
35//=============================================================================
36
37/** contains properties specifying the behavior of a <type>NumberFormatter</type>.
38
39    @see NumberFormatter
40 */
41published service NumberFormatProperties
42{
43    //-------------------------------------------------------------------------
44
45    /** contains the format string of the number format.
46     */
47    [readonly, property] string FormatString;
48
49    //-------------------------------------------------------------------------
50
51    /** contains the locale of the number format.
52     */
53    [readonly, property] com::sun::star::lang::Locale Locale;
54
55    //-------------------------------------------------------------------------
56
57    /** contains the type of the number format.
58
59        @see NumberFormat
60     */
61    [readonly, property] short Type;
62
63    //-------------------------------------------------------------------------
64
65    /** contains a comment regarding the number format for
66        display to the user.
67     */
68    [property] string Comment;
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77
78