icon.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_ICON_H
#define SWIFT_MISC_ICON_H
 
#include <QIcon>
#include <QMetaType>
#include <QPixmap>
#include <QString>
 
#include "misc/icons.h"
#include "misc/metaclass.h"
#include "misc/mixin/mixincompare.h"
#include "misc/mixin/mixindatastream.h"
#include "misc/mixin/mixindbus.h"
#include "misc/mixin/mixinhash.h"
#include "misc/mixin/mixinjson.h"
#include "misc/mixin/mixinmetatype.h"
#include "misc/mixin/mixinstring.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc
{
    class SWIFT_MISC_EXPORT CIcon :
        public mixin::MetaType<CIcon>,
        public mixin::HashByMetaClass<CIcon>,
        public mixin::DBusByMetaClass<CIcon>,
        public mixin::DataStreamByMetaClass<CIcon>,
        public mixin::JsonByMetaClass<CIcon>,
        public mixin::EqualsByMetaClass<CIcon>,
        public mixin::LessThanByMetaClass<CIcon>,
        public mixin::CompareByMetaClass<CIcon>,
        public mixin::String<CIcon>
    {
    public:
        CIcon() {}
 
        CIcon(CIcons::IconIndex index);
 
        // CIcon(const QPixmap &pixmap, const QString &descriptiveText);
 
        // CIcon(const QString &resourceFilePath, const QString &descriptiveText);
 
        const QString &getDescriptiveText() const { return m_descriptiveText; }
 
        const QString &getFileResourcePath() const { return m_fileResourcePath; }
 
        bool hasFileResourcePath() const { return !m_fileResourcePath.isEmpty(); }
 
        CIcons::IconIndex getIndex() const;
 
        bool isIndexBased() const;
 
        bool isGenerated() const;
 
        bool isFileBased() const;
 
        bool isSet() const;
 
        QPixmap toPixmap() const;
 
        CIcons::IconIndex toIcon() const { return m_index; }
 
        QIcon toQIcon() const;
 
        void setRotation(int degrees) { m_rotateDegrees = degrees; }
 
        void setDescriptiveText(const QString &text) { m_descriptiveText = text; }
 
        operator QPixmap() const { return this->toPixmap(); }
 
        QString convertToQString(bool i18n = false) const;
 
        static const CIcon &iconByIndex(CIcons::IconIndex index);
 
        static const CIcon &iconByIndex(int index);
 
        static const CSequence<CIcon> &allIcons();
 
    private:
        CIcon(CIcons::IconIndex index, const QString &descriptiveText);
 
        CIcons::IconIndex m_index = CIcons::NotSet;
        int m_rotateDegrees = 0; 
        QString m_descriptiveText; 
        QString m_fileResourcePath; 
        QPixmap m_pixmap; 
 
        SWIFT_METACLASS(
            CIcon,
            SWIFT_METAMEMBER(index),
            SWIFT_METAMEMBER(rotateDegrees, 0, DisabledForComparison | DisabledForHashing),
            SWIFT_METAMEMBER(descriptiveText),
            SWIFT_METAMEMBER(fileResourcePath));
    };
} // namespace swift::misc
 
Q_DECLARE_METATYPE(swift::misc::CIcon)
 
#endif // SWIFT_MISC_ICON_H