scaddins/idl/com/sun/star/sheet/addin/XDateFunctions.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_sheet_addin_XDateFunctions_idl
  21 #define com_sun_star_sheet_addin_XDateFunctions_idl
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26 module com
  27 {
  28 module sun
  29 {
  30 module star
  31 {
  32 module sheet
  33 {
  34 module addin
  35 {
  36     /**
  37      * Interface with date functions.
  38      */
  39     interface XDateFunctions : com::sun::star::uno::XInterface
  40     {
  41         /// calculates the number of weeks between two dates.
  42         long getDiffWeeks(
  43                     [in] com::sun::star::beans::XPropertySet xOptions,
  44                     [in] long nStartDate, [in] long nEndDate, [in] long nMode )
  45             raises( com::sun::star::lang::IllegalArgumentException );
  46
  47         /// calculates the number of months between two dates.
  48         long getDiffMonths(
  49                     [in] com::sun::star::beans::XPropertySet xOptions,
  50                     [in] long nStartDate, [in] long nEndDate, [in] long nMode )
  51             raises( com::sun::star::lang::IllegalArgumentException );
  52
  53         /// calculates the number of years between two dates.
  54         long getDiffYears(
  55                     [in] com::sun::star::beans::XPropertySet xOptions,
  56                     [in] long nStartDate, [in] long nEndDate, [in] long nMode )
  57             raises( com::sun::star::lang::IllegalArgumentException );
  58
  59         /// checks if a date is in a leap year.
  60         long getIsLeapYear(
  61                     [in] com::sun::star::beans::XPropertySet xOptions,
  62                     [in] long nDate )
  63             raises( com::sun::star::lang::IllegalArgumentException );
  64
  65         /// calculates the number of days in a month.
  66         long getDaysInMonth(
  67                     [in] com::sun::star::beans::XPropertySet xOptions,
  68                     [in] long nDate )
  69             raises( com::sun::star::lang::IllegalArgumentException );
  70
  71         /// calculates the number of days in a year.
  72         long getDaysInYear(
  73                     [in] com::sun::star::beans::XPropertySet xOptions,
  74                     [in] long nDate )
  75             raises( com::sun::star::lang::IllegalArgumentException );
  76
  77         /// calculates the number of weeks in a year.
  78         long getWeeksInYear(
  79                     [in] com::sun::star::beans::XPropertySet xOptions,
  80                     [in] long nDate )
  81             raises( com::sun::star::lang::IllegalArgumentException );
  82     };
  83 };
  84 };
  85 };
  86 };
  87 };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */