File indexing completed on 2024-05-19 05:07:25

 /*
     SPDX-FileCopyrightText: 2002-2003 Michael Edwardes <mte@users.sourceforge.net>
     SPDX-FileCopyrightText: 2002-2016 Thomas Baumgart <tbaumgart@kde.org>
     SPDX-FileCopyrightText: 2002 Kevin Tambascio <ktambascio@users.sourceforge.net>
     SPDX-FileCopyrightText: 2017 Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef MYMONEYUTILS_H
 #define MYMONEYUTILS_H
 
 #include "kmm_mymoney_export.h"
 
 // ----------------------------------------------------------------------------
 // QT Includes
 
 #include <QLocale>
 #include <QString>
 class QDate;
 class QProcess;
 
 // ----------------------------------------------------------------------------
 // KDE Includes
 
 // ----------------------------------------------------------------------------
 // Project Includes
 
 #include "mymoneyenums.h"
 
 class MyMoneyAccount;
 class MyMoneyMoney;
 class MyMoneySecurity;
 class MyMoneySplit;
 class MyMoneyTransaction;
 
 typedef enum {
     NoWarning = 0,
     OneSplitReconciled,
     OneSplitFrozen,
     OneAccountClosed,
 } modifyTransactionWarnLevel_t;
 
 namespace MyMoneyUtils
 {
 KMM_MYMONEY_EXPORT QString getFileExtension(QString strFileName);
 
 /**
  * This is a convenience method. It behaves exactly as
  * MyMoneyMoney::formatMoney, but takes the information
  * about currency symbol and precision out of the MyMoneySecurity
  * and MyMoneyAccount objects @a acc and @a sec. The value to be
  * formatted is passed as @a val.
  */
 KMM_MYMONEY_EXPORT QString formatMoney(const MyMoneyMoney& val,
                                        const MyMoneyAccount& acc,
                                        const MyMoneySecurity& sec,
                                        bool showThousandSeparator = true);
 
 /**
  * This is a convenience method. It behaves exactly as the above one,
  * but takes the information about currency symbol and precision out
  * of the MyMoneySecurity object @a sec.  The value to be
  * formatted is passed as @a val.
  */
 KMM_MYMONEY_EXPORT QString formatMoney(const MyMoneyMoney& val,
                                        const MyMoneySecurity& sec,
                                        bool showThousandSeparator = true);
 
 /**
  * This function returns a date in the form specified by Qt::ISODate.
  * If the @p date is invalid an empty string will be returned.
  *
  * @param date const reference to date to be converted
  * @return QString containing the converted date
  */
 KMM_MYMONEY_EXPORT QString dateToString(const QDate& date);
 
 /**
  * This function returns a date as QDate object as specified by
  * the parameter @p str. @p str must be in Qt::ISODate format.
  * If @p str is empty or contains an invalid date, QDate() is
  * returned.
  *
  * @param str date in Qt::ISODate format
  * @return QDate object
  */
 KMM_MYMONEY_EXPORT QDate stringToDate(const QString& str);
 
 /**
  * This function returns a timestamp in the form specified by IS08601.
  * If the @p date is invalid an empty string will be returned.
  *
  * @param date const reference to date to be converted
  * @return QString containing the converted date
  */
 KMM_MYMONEY_EXPORT QString dateTimeToString(const QDateTime& dateTime);
 
 /**
  * This function returns date and time as QDateTime object as specified by
  * the parameter @a str. @a str must be in Qt::ISODate format. If @a str
  * only contains a date, the time will be set to 00:00:00 and the timezone
  * is localtime.
  *
  * If @a str is empty or contains an invalid date, QDateTime() is
  * returned.
  *
  * @param str date in Qt::ISODate format
  * @return QDateTime object
  */
 KMM_MYMONEY_EXPORT QDateTime stringToDateTime(const QString& str);
 
 KMM_MYMONEY_EXPORT QString QStringEmpty(const QString&);
 
 KMM_MYMONEY_EXPORT unsigned long extractId(const QString& txt);
 
 KMM_MYMONEY_EXPORT void dissectTransaction(const MyMoneyTransaction& transaction, const MyMoneySplit& split, MyMoneySplit& assetAccountSplit, QList<MyMoneySplit>& feeSplits, QList<MyMoneySplit>& interestSplits, MyMoneySecurity& security, MyMoneySecurity& currency, eMyMoney::Split::InvestmentTransactionType& transactionType);
 
 KMM_MYMONEY_EXPORT void clearFormatCaches();
 KMM_MYMONEY_EXPORT QString formatDate(const QDate& date, QLocale::FormatType formatType = QLocale::ShortFormat);
 KMM_MYMONEY_EXPORT QString formatTime(const QTime& date);
 KMM_MYMONEY_EXPORT QString formatDateTime(const QDateTime& date);
 
 /**
  * This method is used to convert the payment type from its
  * internal representation into a human readable format.
  *
  * @param paymentType numerical representation of the MyMoneySchedule
  *                  payment type
  *
  * @return QString representing the human readable format translated according to the language catalog
  *
  * @sa MyMoneySchedule::paymentMethodToString()
  */
 KMM_MYMONEY_EXPORT QString paymentMethodToString(eMyMoney::Schedule::PaymentType paymentType);
 
 KMM_MYMONEY_EXPORT QString convertWildcardToRegularExpression(const QString& pattern);
 KMM_MYMONEY_EXPORT QString convertRegularExpressionToWildcard(const QString& pattern);
 
 KMM_MYMONEY_EXPORT modifyTransactionWarnLevel_t transactionWarnLevel(const QString& transactionId);
 KMM_MYMONEY_EXPORT modifyTransactionWarnLevel_t transactionWarnLevel(const QStringList& transactionIds);
 }
 
 #endif