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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_i18n_XExtendedCalendar_idl__
  29 #define __com_sun_star_i18n_XExtendedCalendar_idl__
  30
  31 #include <com/sun/star/i18n/XCalendar.idl>
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module i18n {
  36
  37 //=============================================================================
  38
  39
  40 /**
  41     This interface provides access to locale specific calendar
  42     systems.
  43
  44     <p> It is derived from
  45     <type scope="::com::sun::star::i18n">XCalendar</type> and provides
  46     additional functionality to display parts of the date currently
  47     set at the calendar. </p>
  48
  49      @since OOo 1.1.2
  50  */
  51 published interface XExtendedCalendar : ::com::sun::star::i18n::XCalendar
  52 {
  53     //-------------------------------------------------------------------------
  54     /**
  55         Returns a string (number or name to display) matching the
  56         given code constant.
  57
  58         <p> Note that the string returned depends completely on the
  59         locale's calendar. It is not predictable if the string will be
  60         numeric or a name, or if in case it retuns a numeric string
  61         how many digits that will have. For example, a short year
  62         display string will normally be two digits with a Gregorian
  63         calendar, but with a Jewish calendar it will have three
  64         digits. <p/>
  65
  66         @param nCalendarDisplayCode
  67             One of <type>CalendarDisplayCode</type>
  68
  69         @param nNativeNumberMode
  70             One of <type>NativeNumberMode</type>. <br/>
  71             This argument designates the basic transliteration mode as
  72             if specified for the year representation. However, depending
  73             on the locale, different conversions for year and month, for
  74             example, may be chosen internally. This is beyond the user's
  75             control and depends on locale specific conventions of how a
  76             date is assembled.
  77      */
  78     string  getDisplayString( [in] long nCalendarDisplayCode, [in] short nNativeNumberMode );
  79
  80 };
  81
  82 //=============================================================================
  83 }; }; }; };
  84
  85 #endif