/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_i18n_Calendar_idl__
#define __com_sun_star_i18n_Calendar_idl__

#include <com/sun/star/i18n/CalendarItem.idl>

//=============================================================================

module com { module sun { module star { module i18n {

//=============================================================================

/**
    A calendar as returned in a sequence by
    <member>XLocaleData::getAllCalendars()</member>.

    @see XLocaleData
        for links to DTD of XML locale data files.
 */

published struct Calendar
{
    /// the days of the week, see also <type>CalendarItem</type>.
    sequence< CalendarItem >    Days;
    /// the months of the year, see also <type>CalendarItem</type>.
    sequence< CalendarItem >    Months;
    /// the possible eras, see also <type>CalendarItem</type>.
    sequence< CalendarItem >    Eras;
    /// the ID of the day with which the week begins.
    string                      StartOfWeek;
    /// how many days must reside in the first week of a year.
    short                       MinimumNumberOfDaysForFirstWeek;
    /// if this is the default calendar for a given locale.
    boolean                     Default;
    /// the name of the calendar, for example, <b>Gregorian</b>.
    string                      Name;
};

//=============================================================================
}; }; }; };

#endif
