AOO410/main/offapi/com/sun/star/i18n/Calendar.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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