offapi/com/sun/star/i18n/XCalendar3.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_XCalendar3_idl__
  31 #define __com_sun_star_i18n_XCalendar3_idl__
  32
  33 #include <com/sun/star/i18n/XExtendedCalendar.idl>
  34 #include <com/sun/star/i18n/Calendar2.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module i18n {
  39
  40 //=============================================================================
  41
  42
  43 /**
  44     This interface provides access to locale specific calendar
  45     systems.
  46
  47     <p> It is derived from
  48     <type scope="::com::sun::star::i18n">XExtendedCalendar</type> and
  49     provides additional methods to obtain <type>Calendar2</type> items
  50     that include the possessive genitive case month names and sequences
  51     of <type>CalendarItem2</type> items.. </p>
  52
  53     @since LibreOffice 3.5
  54  */
  55 published interface XCalendar3 : com::sun::star::i18n::XExtendedCalendar
  56 {
  57     //------------------------------------------------------------------------
  58     /// Get the currently loaded <type>Calendar2</type>.
  59     Calendar2   getLoadedCalendar2();
  60
  61     //------------------------------------------------------------------------
  62     /** returns a sequence of <type>CalendarItem2</type> describing the
  63         day names.
  64      */
  65     sequence< CalendarItem2 >    getDays2();
  66
  67     //------------------------------------------------------------------------
  68     /** returns a sequence of <type>CalendarItem2</type> describing the
  69         month names.
  70      */
  71     sequence< CalendarItem2 >    getMonths2();
  72
  73     //------------------------------------------------------------------------
  74     /** returns a sequence of <type>CalendarItem2</type> describing the
  75         genitive case month names.
  76      */
  77     sequence< CalendarItem2 >    getGenitiveMonths2();
  78
  79     //------------------------------------------------------------------------
  80     /** returns a sequence of <type>CalendarItem2</type> describing the
  81         partitive case month names.
  82      */
  83     sequence< CalendarItem2 >    getPartitiveMonths2();
  84
  85 };
  86
  87 //=============================================================================
  88 }; }; }; };
  89
  90 #endif
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */