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

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