viewmodel.h

Go to the documentation of this file.

#ifndef QTMVVM_VIEWMODEL_H
#define QTMVVM_VIEWMODEL_H

#include <type_traits>

#include <QtCore/qobject.h>
#include <QtCore/qscopedpointer.h>
#include <QtCore/qvariant.h>
#include <QtCore/qpointer.h>

#include "QtMvvmCore/qtmvvmcore_global.h"
#include "QtMvvmCore/injection.h"

namespace QtMvvm {

class CoreApp;
class CoreAppPrivate;

class ViewModelPrivate;
class Q_MVVMCORE_EXPORT ViewModel : public QObject
{
    Q_OBJECT

public:
    explicit ViewModel(QObject *parent = nullptr);
    ~ViewModel() override;

public Q_SLOTS:
    virtual void onInit(const QVariantHash &params);
    virtual void onResult(quint32 requestCode, const QVariant &result);

Q_SIGNALS:
    void resultReady(const QVariant &result);

    QTMVVM_REVISION_1 void instanceInvoked(const QVariantHash &params, QPrivateSignal);

protected:
    template <typename TViewModel>
    inline void show(const QVariantHash &params = {}) const;
    void show(const char *viewModelName, const QVariantHash &params = {}) const;
    void show(const QMetaObject *viewMetaObject, const QVariantHash &params = {}) const;
    template <typename TViewModel>
    inline void showForResult(quint32 requestCode, const QVariantHash &params = {}) const;
    void showForResult(quint32 requestCode, const char *viewModelName, const QVariantHash &params = {}) const;
    void showForResult(quint32 requestCode, const QMetaObject *viewMetaObject, const QVariantHash &params = {}) const;

private:
    friend class QtMvvm::CoreApp;
    friend class QtMvvm::CoreAppPrivate;

    QScopedPointer<ViewModelPrivate> d;

    static void showImp(const QMetaObject *metaObject, const QVariantHash &params, QPointer<ViewModel> parent, quint32 requestCode = 0);
};

#define QTMVVM_SINGLETON Q_CLASSINFO("qtmvvm_singleton", "true")

#define QTMVVM_CONTAINER_VM(x) Q_CLASSINFO("qtmvvm_container_viewmodel", #x)

// ------------- Generic Implementation -------------

template<typename TViewModel>
inline void ViewModel::show(const QVariantHash &params) const
{
    static_assert(std::is_base_of<ViewModel, TViewModel>::value, "TViewModel must extend QtMvvm::ViewModel");
    showImp(&TViewModel::staticMetaObject, params, const_cast<ViewModel*>(this));
}

template<typename TViewModel>
void ViewModel::showForResult(quint32 requestCode, const QVariantHash &params) const
{
    static_assert(std::is_base_of<ViewModel, TViewModel>::value, "TViewModel must extend QtMvvm::ViewModel");
    showImp(&TViewModel::staticMetaObject, params, const_cast<ViewModel*>(this), requestCode);
}

}

Q_DECLARE_METATYPE(QtMvvm::ViewModel*)

#endif // QTMVVM_VIEWMODEL_H