kcurrencycode.h

Go to the documentation of this file.

/*
    Copyright (c) 2009 John Layt <john@layt.net>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KCURRENCYCODE_H
#define KCURRENCYCODE_H

#include <kdecore_export.h>

#include <QtCore/QSharedDataPointer>
#include <QtCore/QString>

class QDate;
class QStringList;
class QFileInfo;

class KCurrencyCodePrivate;

class KDECORE_EXPORT KCurrencyCode
{
public:
    enum CurrencyStatus {
        ActiveCurrency     = 0x01, 
        SuspendedCurrency  = 0x02, 
        ObsoleteCurrency   = 0x04  
    };
    Q_DECLARE_FLAGS( CurrencyStatusFlags, CurrencyStatus )

    
    explicit KCurrencyCode( const QString &isoCurrencyCode, const QString &language = QString() );

    explicit KCurrencyCode( const QFileInfo &currencyCodeFile, const QString &language = QString() );

    KCurrencyCode( const KCurrencyCode &rhs );

    virtual ~KCurrencyCode();

    KCurrencyCode& operator=( const KCurrencyCode &rhs );

    QString isoCurrencyCode() const;

    QString isoCurrencyCodeNumeric() const;

    QString name() const;

    QString isoName() const;

    CurrencyStatus status() const;

    QDate dateIntroduced() const;

    QDate dateSuspended() const;

    QDate dateWithdrawn() const;

    QStringList symbolList() const;

    QString defaultSymbol() const;

    QString unambiguousSymbol() const;

    bool hasSubunits() const;

    bool hasSubunitsInCirculation() const;

    QString subunitSymbol() const;

    int subunitsPerUnit() const;

    int decimalPlaces() const;

    QStringList countriesUsingCurrency() const;

    bool isValid() const;

    static bool isValid( const QString &currencyCode, CurrencyStatusFlags currencyStatus =
                                                      CurrencyStatusFlags( ActiveCurrency |
                                                                           SuspendedCurrency |
                                                                           ObsoleteCurrency ) );

    static QStringList allCurrencyCodesList( CurrencyStatusFlags currencyStatus =
                                             CurrencyStatusFlags( ActiveCurrency |
                                                                  SuspendedCurrency |
                                                                  ObsoleteCurrency ) );

    static QString currencyCodeToName( const QString &currencyCode, const QString &language = QString() );


private:
    QSharedDataPointer<KCurrencyCodePrivate> d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS( KCurrencyCode::CurrencyStatusFlags )


#endif // KCURRENCYCODE_H