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