office-gobmx/include/unotools/calendarwrapper.hxx
Eike Rathke ba54ce4c65 Use DateTime::Sub() instead of operator-()
Commit this central place use early.

Change-Id: Ib2e40ae7fbe9dc219ba0a7ec4e0f12a82d7b37b1
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/153378
Reviewed-by: Eike Rathke <erack@redhat.com>
Tested-by: Jenkins
2023-06-21 12:48:37 +02:00

124 lines
5.1 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_UNOTOOLS_CALENDARWRAPPER_HXX
#define INCLUDED_UNOTOOLS_CALENDARWRAPPER_HXX
#include <tools/datetime.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/i18n/Calendar2.hpp>
#include <unotools/unotoolsdllapi.h>
namespace com::sun::star::uno { class XComponentContext; }
namespace com::sun::star::i18n { class XCalendar4; }
namespace com::sun::star::lang { struct Locale; }
class UNOTOOLS_DLLPUBLIC CalendarWrapper
{
css::uno::Reference< css::i18n::XCalendar4 > xC;
const DateTime aEpochStart; // 1Jan1970
public:
CalendarWrapper(
const css::uno::Reference< css::uno::XComponentContext > & rxContext
);
~CalendarWrapper();
// wrapper implementations of XCalendar
/** Load the default calendar of a locale.
This adds a bool bTimeZoneUTC parameter which is not part of the UNO API to
facilitate handling of non time zone aware data.
@param bTimeZoneUTC
Default <TRUE/>. If <FALSE/>, the system's timezone is assigned
to the calendar, including all DST quirks like not existing
times on DST transition dates when switching to/from DST. As
current implementations and number parser/formatter don't store
or convert or calculate with time zones it is safer to use UTC,
which is not DST afflicted, otherwise surprises are lurking
(for example tdf#92503).
*/
void loadDefaultCalendar( const css::lang::Locale& rLocale, bool bTimeZoneUTC = true );
/// This adds a bTimeZoneUTC parameter which is not part of the API.
void loadCalendar( const OUString& rUniqueID, const css::lang::Locale& rLocale, bool bTimeZoneUTC = true );
/* XXX NOTE: the time zone taking UNO API functions are not implemented as
* wrapper interface as they are not necessary/used so far. These are:
void loadDefaultCalendarTZ( const css::lang::Locale& rLocale, const OUString& rTimeZone );
void loadCalendarTZ( const OUString& rUniqueID, const css::lang::Locale& rLocale, const OUString& rTimeZone );
*/
css::uno::Sequence< OUString > getAllCalendars( const css::lang::Locale& rLocale ) const;
OUString getUniqueID() const;
/// set UTC date/time
void setDateTime( double fTimeInDays );
/// get UTC date/time
double getDateTime() const;
// For local setDateTime() and getDateTime() see further down at wrapper
// implementations of XCalendar4.
// wrapper implementations of XCalendar
void setValue( sal_Int16 nFieldIndex, sal_Int16 nValue );
bool isValid() const;
sal_Int16 getValue( sal_Int16 nFieldIndex ) const;
sal_Int16 getFirstDayOfWeek() const;
sal_Int16 getNumberOfMonthsInYear() const;
sal_Int16 getNumberOfDaysInWeek() const;
OUString getDisplayName( sal_Int16 nCalendarDisplayIndex, sal_Int16 nIdx, sal_Int16 nNameType ) const;
// wrapper implementations of XExtendedCalendar
OUString getDisplayString( sal_Int32 nCalendarDisplayCode, sal_Int16 nNativeNumberMode ) const;
// wrapper implementations of XCalendar3
css::i18n::Calendar2 getLoadedCalendar() const;
css::uno::Sequence< css::i18n::CalendarItem2 > getDays() const;
css::uno::Sequence< css::i18n::CalendarItem2 > getMonths() const;
css::uno::Sequence< css::i18n::CalendarItem2 > getGenitiveMonths() const;
css::uno::Sequence< css::i18n::CalendarItem2 > getPartitiveMonths() const;
// wrapper implementations of XCalendar4
/// set local date/time
void setLocalDateTime( double fTimeInDays );
/// get local date/time
double getLocalDateTime() const;
// convenience methods
/// get epoch start (should be 01Jan1970)
const DateTime& getEpochStart() const
{ return aEpochStart; }
/// set a local (!) Gregorian DateTime
void setGregorianDateTime( const DateTime& rDateTime )
{ setLocalDateTime( DateTime::Sub( rDateTime, aEpochStart)); }
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */