offapi/com/sun/star/i18n/XCalendar4.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
  10
  11 module com { module sun { module star { module i18n {
  12
  13
  14
  15 /** This interface provides access to locale specific calendar
  16     systems.
  17
  18     <p> It is derived from ::com::sun::star::i18n::XCalendar3 and
  19     provides additional methods to set and get the local time. </p>
  20
  21     @since LibreOffice 5.0
  22  */
  23 interface XCalendar4 : com::sun::star::i18n::XCalendar3
  24 {
  25     /** Set the local date/time as an offset to the start of the
  26         calendar at 1-Jan-1970 00:00. The integer part represents the
  27         number of days passed since start date. The fractional part
  28         represents fractions of a day, thus 0.5 means 12 hours.
  29
  30         The actual timezone and daylight saving time offsets effective
  31         at the given date and time are considered and subtracted before
  32         setting the UTC time at the calendar.
  33      */
  34     void    setLocalDateTime( [in] double TimeInDays );
  35
  36     /** Get the local date/time as an offset to the start of the
  37         calendar at 1-Jan-1970 00:00. The integer part represents the
  38         number of days passed since start date. The fractional part
  39         represents fractions of a day, thus 0.5 means 12 hours.
  40
  41         The actual timezone and daylight saving time offsets effective
  42         at the given date and time are considered and added to the UTC
  43         time at the calendar.
  44      */
  45     double  getLocalDateTime();
  46
  47     /** Load the default calendar for the given locale with a given time zone.
  48
  49         @param  rLocale
  50                 the locale for the calendar
  51         @param  TimeZone
  52                 If empty, the system's time zone is used.
  53                 Else specified as "Region/City" name like "Europe/Berlin",
  54                 or a custom time zone ID such as "UTC" or "GMT-8:00".
  55
  56         @since LibreOffice 6.3
  57      */
  58     void    loadDefaultCalendarTZ( [in] ::com::sun::star::lang::Locale rLocale, [in] string TimeZone );
  59
  60     /** Load a specific calendar for the given locale with a given time zone.
  61
  62         @param  uniqueID
  63                 the uniqueID for the calendar.
  64                 As of 2019-09-25, we can specify ROC, dangi, buddhist, gengou,
  65                 gregorian, hanja, hanja_yoil, hijri, jewish.
  66                 If the calendar for the specified uniqueID is not found,
  67                 gregorian is used.
  68         @param  rLocale
  69                 the locale for the calendar
  70         @param  TimeZone
  71                 If empty, the system's time zone is used.
  72                 Else specified as "Region/City" name like "Europe/Berlin",
  73                 or a custom time zone ID such as "UTC" or "GMT-8:00".
  74
  75         @since LibreOffice 6.3
  76      */
  77     void    loadCalendarTZ( [in] string uniqueID,
  78                             [in] ::com::sun::star::lang::Locale rLocale,
  79                             [in] string TimeZone );
  80
  81 };
  82
  83 }; }; }; };
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */