xref: /aoo41x/main/offapi/com/sun/star/i18n/Calendar.idl (revision d1766043)
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
24#ifndef __com_sun_star_i18n_Calendar_idl__
25#define __com_sun_star_i18n_Calendar_idl__
26
27#include <com/sun/star/i18n/CalendarItem.idl>
28
29//=============================================================================
30
31module com { module sun { module star { module i18n {
32
33//=============================================================================
34
35/**
36    A calendar as returned in a sequence by
37    <member>XLocaleData::getAllCalendars()</member>.
38
39    @see XLocaleData
40        for links to DTD of XML locale data files.
41 */
42
43published struct Calendar
44{
45    /// the days of the week, see also <type>CalendarItem</type>.
46    sequence< CalendarItem >    Days;
47    /// the months of the year, see also <type>CalendarItem</type>.
48    sequence< CalendarItem >    Months;
49    /// the possible eras, see also <type>CalendarItem</type>.
50    sequence< CalendarItem >    Eras;
51    /// the ID of the day with which the week begins.
52    string                      StartOfWeek;
53    /// how many days must reside in the first week of a year.
54    short                       MinimumNumberOfDaysForFirstWeek;
55    /// if this is the default calendar for a given locale.
56    boolean                     Default;
57    /// the name of the calendar, for example, <b>gregorian</b>.
58    string                      Name;
59};
60
61//=============================================================================
62}; }; }; };
63
64#endif
65