1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_i18n_XExtendedCalendar_idl__
25#define __com_sun_star_i18n_XExtendedCalendar_idl__
26
27#include <com/sun/star/i18n/XCalendar.idl>
28
29//=============================================================================
30
31module com { module sun { module star { module i18n {
32
33//=============================================================================
34
35
36/**
37    This interface provides access to locale specific calendar
38    systems.
39
40    <p> It is derived from
41    <type scope="::com::sun::star::i18n">XCalendar</type> and provides
42    additional functionality to display parts of the date currently
43    set at the calendar. </p>
44
45	 @since OOo 1.1.2
46 */
47published interface XExtendedCalendar : ::com::sun::star::i18n::XCalendar
48{
49    //-------------------------------------------------------------------------
50    /**
51        Returns a string (number or name to display) matching the
52        given code constant.
53
54        <p> Note that the string returned depends completely on the
55        locale's calendar. It is not predictable if the string will be
56        numeric or a name, or if in case it retuns a numeric string
57        how many digits that will have. For example, a short year
58        display string will normally be two digits with a Gregorian
59        calendar, but with a Jewish calendar it will have three
60        digits. <p/>
61
62        @param nCalendarDisplayCode
63            One of <type>CalendarDisplayCode</type>
64
65        @param nNativeNumberMode
66            One of <type>NativeNumberMode</type>. <br/>
67            This argument designates the basic transliteration mode as
68            if specified for the year representation. However, depending
69            on the locale, different conversions for year and month, for
70            example, may be chosen internally. This is beyond the user's
71            control and depends on locale specific conventions of how a
72            date is assembled.
73     */
74    string  getDisplayString( [in] long nCalendarDisplayCode, [in] short nNativeNumberMode );
75
76};
77
78//=============================================================================
79}; }; }; };
80
81#endif
82