xref: /aoo41x/main/offapi/com/sun/star/i18n/Calendar.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_i18n_Calendar_idl__
29#define __com_sun_star_i18n_Calendar_idl__
30
31#include <com/sun/star/i18n/CalendarItem.idl>
32
33//=============================================================================
34
35module com { module sun { module star { module i18n {
36
37//=============================================================================
38
39/**
40    A calendar as returned in a sequence by
41    <member>XLocaleData::getAllCalendars()</member>.
42
43    @see XLocaleData
44        for links to DTD of XML locale data files.
45 */
46
47published struct Calendar
48{
49    /// the days of the week, see also <type>CalendarItem</type>.
50    sequence< CalendarItem >    Days;
51    /// the months of the year, see also <type>CalendarItem</type>.
52    sequence< CalendarItem >    Months;
53    /// the possible eras, see also <type>CalendarItem</type>.
54    sequence< CalendarItem >    Eras;
55    /// the ID of the day with which the week begins.
56    string                      StartOfWeek;
57    /// how many days must reside in the first week of a year.
58    short                       MinimumNumberOfDaysForFirstWeek;
59    /// if this is the default calendar for a given locale.
60    boolean                     Default;
61    /// the name of the calendar, for example, <b>gregorian</b>.
62    string                      Name;
63};
64
65//=============================================================================
66}; }; }; };
67
68#endif
69