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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * Version: MPL 1.1 / GPLv3+ / LGPLv3+
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License or as specified alternatively below. You may obtain a copy of
   8  * the License at http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * Major Contributor(s):
  16  * Copyright (C) 2011 Red Hat, Inc., Eike Rathke <erack@redhat.com>
  17  *  (initial developer)
  18  *
  19  * All Rights Reserved.
  20  *
  21  * For minor contributions see the git repository.
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
  25  * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
  26  * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
  27  * instead of those above.
  28  */
  29
  30 #ifndef __com_sun_star_i18n_Calendar2_idl__
  31 #define __com_sun_star_i18n_Calendar2_idl__
  32
  33 #include <com/sun/star/i18n/CalendarItem2.idl>
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module i18n {
  38
  39 //=============================================================================
  40
  41 /**
  42     Calendar items as returned in a sequence by
  43     <member>XLocaleData3::getAllCalendars2()</member>.
  44
  45     <p> Similar to
  46     <type scope="::com::sun::star::i18n">Calendar</type> this provides
  47     additional members with a sequence of possessive (genitive case) and
  48     partitive case month names for locales that use them, for example
  49     Slavic locales. If a locale does not provide the possessive form in
  50     <member>GenitiveMonths</member>, the names are identical to the
  51     nominative case nouns in <member>Calendar::Months</member>. If a
  52     locale does not provide the partitive case in
  53     <member>PartitiveMonths</member>, the names are identical to
  54     <member>GenititiveMonths</member>. </p>
  55
  56     <p> The sequences are of type
  57     <type scope="com::sun::star::i18n">CalendarItem2</type> instead of
  58     <type scope="com::sun::star::i18n">CalendarItem</type>, with the
  59     additional <member>NarrowName</member> member.
  60
  61     @see XLocaleData
  62         for links to DTD of XML locale data files.
  63
  64     @since LibreOffice 3.5
  65  */
  66
  67 published struct Calendar2
  68 {
  69     /// The days of the week.
  70     sequence< CalendarItem2 >   Days;
  71
  72     /// The months of the year.
  73     sequence< CalendarItem2 >   Months;
  74
  75     /// The months of the year in possessive genitive case.
  76     sequence< CalendarItem2 >   GenitiveMonths;
  77
  78     /// The months of the year in partitive case.
  79     sequence< CalendarItem2 >   PartitiveMonths;
  80
  81     /// The possible eras.
  82     sequence< CalendarItem2 >   Eras;
  83
  84     /// The ID of the day with which the week begins.
  85     string                      StartOfWeek;
  86
  87     /// How many days must reside in the first week of a year.
  88     short                       MinimumNumberOfDaysForFirstWeek;
  89
  90     /// If this is the default calendar for a given locale.
  91     boolean                     Default;
  92
  93     /// The name of the calendar, for example, <b>Gregorian</b>.
  94     string                      Name;
  95 };
  96
  97 //=============================================================================
  98 }; }; }; };
  99
 100 #endif