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_i18n_FormatElement_idl__
24#define __com_sun_star_i18n_FormatElement_idl__
25
26//============================================================================
27
28module com {  module sun {  module star {  module i18n {
29
30//============================================================================
31
32/**
33    One number format code and its attributes, returned in a sequence by
34    <member>XLocaleData::getAllFormats()</member>.
35
36    <p> Contains raw data defined in the XML locale data files. </p>
37
38    @see XLocaleData
39        for links to DTD of XML locale data files.
40 */
41
42published struct FormatElement
43{
44    /** The format code, for example, "YYYY-MM-DD". */
45    string  formatCode;
46
47    /** A name or description that is displayed in the number formatter
48        dialog. */
49    string  formatName;
50
51    /** A unique (within one locale) identifier. */
52    string  formatKey;
53
54    /** Type may be one of "short", "medium", "long". */
55    string  formatType;
56
57    /** Usage category, for example, "DATE" or "FIXED_NUMBER",
58        corresponding with <type>KNumberFormatUsage</type> values. */
59    string  formatUsage;
60
61    /** The index used by the number formatter, predefined values
62        corresponding with <type>NumberFormatIndex</type> values. */
63    short   formatIndex;
64
65    /** If a format code is the default code of a <em>formatType</em>
66        group. */
67    boolean isDefault;
68};
69
70//============================================================================
71}; }; }; };
72
73#endif
74