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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef __com_sun_star_i18n_Calendar2_idl__
  11 #define __com_sun_star_i18n_Calendar2_idl__
  12
  13 #include <com/sun/star/i18n/CalendarItem2.idl>
  14
  15
  16 module com { module sun { module star { module i18n {
  17
  18
  19 /**
  20     Calendar items as returned in a sequence by
  21     XLocaleData3::getAllCalendars2().
  22
  23     <p> Similar to
  24     ::com::sun::star::i18n::Calendar this provides
  25     additional members with a sequence of possessive (genitive case) and
  26     partitive case month names for locales that use them, for example
  27     Slavic locales. If a locale does not provide the possessive form in
  28     #GenitiveMonths, the names are identical to the
  29     nominative case nouns in Calendar::Months. If a
  30     locale does not provide the partitive case in
  31     #PartitiveMonths, the names are identical to
  32     #GenitiveMonths. </p>
  33
  34     <p> The sequences are of type
  35     com::sun::star::i18n::CalendarItem2 instead of
  36     com::sun::star::i18n::CalendarItem, with the
  37     additional NarrowName member.
  38
  39     @see XLocaleData
  40         for links to DTD of XML locale data files.
  41
  42     @since LibreOffice 3.5
  43  */
  44
  45 published struct Calendar2
  46 {
  47     /// The days of the week.
  48     sequence< CalendarItem2 >   Days;
  49
  50     /// The months of the year.
  51     sequence< CalendarItem2 >   Months;
  52
  53     /// The months of the year in possessive genitive case.
  54     sequence< CalendarItem2 >   GenitiveMonths;
  55
  56     /// The months of the year in partitive case.
  57     sequence< CalendarItem2 >   PartitiveMonths;
  58
  59     /// The possible eras.
  60     sequence< CalendarItem2 >   Eras;
  61
  62     /// The ID of the day with which the week begins.
  63     string                      StartOfWeek;
  64
  65     /// How many days must reside in the first week of a year.
  66     short                       MinimumNumberOfDaysForFirstWeek;
  67
  68     /// If this is the default calendar for a given locale.
  69     boolean                     Default;
  70
  71     /// The name of the calendar, for example, <b>Gregorian</b>.
  72     string                      Name;
  73 };
  74
  75 }; }; }; };
  76
  77 #endif