include/unotools/calendarwrapper.hxx

   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 INCLUDED_UNOTOOLS_CALENDARWRAPPER_HXX
  21 #define INCLUDED_UNOTOOLS_CALENDARWRAPPER_HXX
  22
  23 #include <tools/datetime.hxx>
  24 #include <com/sun/star/uno/Reference.hxx>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include <com/sun/star/i18n/Calendar2.hpp>
  27 #include <unotools/unotoolsdllapi.h>
  28
  29 namespace com { namespace sun { namespace star {
  30     namespace uno {
  31         class XComponentContext;
  32     }
  33 }}}
  34
  35 namespace com { namespace sun { namespace star {
  36     namespace i18n {
  37         class XCalendar4;
  38     }
  39 }}}
  40
  41 namespace com { namespace sun { namespace star { namespace lang { struct Locale; } } } }
  42
  43 class UNOTOOLS_DLLPUBLIC CalendarWrapper
  44 {
  45     css::uno::Reference< css::i18n::XCalendar4 >   xC;
  46
  47     const DateTime aEpochStart;        // 1Jan1970
  48
  49 public:
  50                                 CalendarWrapper(
  51                                     const css::uno::Reference< css::uno::XComponentContext > & rxContext
  52                                     );
  53                                 ~CalendarWrapper();
  54
  55     // wrapper implementations of XCalendar
  56
  57     void loadDefaultCalendar( const css::lang::Locale& rLocale );
  58     void loadCalendar( const OUString& rUniqueID, const css::lang::Locale& rLocale );
  59     css::uno::Sequence< OUString > getAllCalendars( const css::lang::Locale& rLocale ) const;
  60     OUString getUniqueID() const;
  61     /// set UTC date/time
  62     void setDateTime( double fTimeInDays );
  63     /// get UTC date/time
  64     double getDateTime() const;
  65
  66     // For local setDateTime() and getDateTime() see further down at wrapper
  67     // implementations of XCalendar4.
  68
  69     // wrapper implementations of XCalendar
  70
  71     void setValue( sal_Int16 nFieldIndex, sal_Int16 nValue );
  72     bool isValid() const;
  73     sal_Int16 getValue( sal_Int16 nFieldIndex ) const;
  74     sal_Int16 getFirstDayOfWeek() const;
  75     sal_Int16 getNumberOfMonthsInYear() const;
  76     sal_Int16 getNumberOfDaysInWeek() const;
  77     OUString getDisplayName( sal_Int16 nCalendarDisplayIndex, sal_Int16 nIdx, sal_Int16 nNameType ) const;
  78
  79     // wrapper implementations of XExtendedCalendar
  80
  81     OUString getDisplayString( sal_Int32 nCalendarDisplayCode, sal_Int16 nNativeNumberMode ) const;
  82
  83     // wrapper implementations of XCalendar3
  84
  85     css::i18n::Calendar2 getLoadedCalendar() const;
  86     css::uno::Sequence< css::i18n::CalendarItem2 > getDays() const;
  87     css::uno::Sequence< css::i18n::CalendarItem2 > getMonths() const;
  88     css::uno::Sequence< css::i18n::CalendarItem2 > getGenitiveMonths() const;
  89     css::uno::Sequence< css::i18n::CalendarItem2 > getPartitiveMonths() const;
  90
  91     // wrapper implementations of XCalendar4
  92
  93     /// set local date/time
  94     void setLocalDateTime( double fTimeInDays );
  95     /// get local date/time
  96     double getLocalDateTime() const;
  97
  98     // convenience methods
  99
 100     /// get epoch start (should be 01Jan1970)
 101     const DateTime&     getEpochStart() const
 102                                     { return aEpochStart; }
 103
 104     /// set a local (!) Gregorian DateTime
 105     void                setGregorianDateTime( const DateTime& rDateTime )
 106                                     { setLocalDateTime( rDateTime - aEpochStart ); }
 107
 108 };
 109
 110 #endif
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */