|
| 1 | +#include <QObject> |
| 2 | + |
| 3 | +/*! @brief A QML class to create a local mvvm multiway binding |
| 4 | + * |
| 5 | + * It is basically a wrapper around the QtMvvm::bind method. The parameters are set via the |
| 6 | + * properties, and once the binding component is completed, it will create the binding. It is |
| 7 | + * possible to modify the properties while running. This will recreate the binding, discarding |
| 8 | + * the previous one |
| 9 | + * |
| 10 | + * @sa QtMvvm::bind |
| 11 | + */ |
| 12 | +class MvvmBinding : public QObject |
| 13 | +{ |
| 14 | + /*! @brief The object in the role of a viewmodel |
| 15 | + * |
| 16 | + * @default{`null`} |
| 17 | + * @accessors{ |
| 18 | + * @memberAc{viewModel} |
| 19 | + * @notifyAc{viewModelChanged()} |
| 20 | + * } |
| 21 | + * @sa QtMvvm::bind |
| 22 | + */ |
| 23 | + Q_PROPERTY(QObject* viewModel MEMBER viewModel NOTIFY viewModelChanged) |
| 24 | + /*! @brief The property of the viewmodel to use in the binding |
| 25 | + * |
| 26 | + * @default{<i>Empty</i>} |
| 27 | + * @accessors{ |
| 28 | + * @memberAc{viewModelProperty} |
| 29 | + * @notifyAc{viewModelPropertyChanged()} |
| 30 | + * } |
| 31 | + * @sa QtMvvm::bind |
| 32 | + */ |
| 33 | + Q_PROPERTY(QString viewModelProperty MEMBER viewModelProperty NOTIFY viewModelPropertyChanged) |
| 34 | + /*! @brief The object in the role of a view |
| 35 | + * |
| 36 | + * @default{`parent()`} |
| 37 | + * @accessors{ |
| 38 | + * @memberAc{view} |
| 39 | + * @notifyAc{viewChanged()} |
| 40 | + * } |
| 41 | + * @sa QtMvvm::bind |
| 42 | + */ |
| 43 | + Q_PROPERTY(QObject* view MEMBER view NOTIFY viewChanged) |
| 44 | + /*! @brief The property of the view to use in the binding |
| 45 | + * |
| 46 | + * @default{<i>Empty</i>} |
| 47 | + * @accessors{ |
| 48 | + * @memberAc{viewProperty} |
| 49 | + * @notifyAc{viewPropertyChanged()} |
| 50 | + * } |
| 51 | + * @sa QtMvvm::bind |
| 52 | + */ |
| 53 | + Q_PROPERTY(QString viewProperty MEMBER viewProperty NOTIFY viewPropertyChanged) |
| 54 | + /*! @brief An alternative signal to be used instead of the viewModelProperty notify signal |
| 55 | + * to detect property changes |
| 56 | + * |
| 57 | + * @default{<i>Empty</i>} |
| 58 | + * @accessors{ |
| 59 | + * @memberAc{viewModelChangeSignal} |
| 60 | + * @notifyAc{viewModelChangeSignalChanged()} |
| 61 | + * } |
| 62 | + * @sa QtMvvm::bind |
| 63 | + */ |
| 64 | + Q_PROPERTY(QString viewModelChangeSignal MEMBER viewModelChangeSignal NOTIFY viewModelChangeSignalChanged) |
| 65 | + /*! @brief An alternative signal to be used instead of the viewProperty notify signal to |
| 66 | + * detect property changes |
| 67 | + * |
| 68 | + * @default{<i>Empty</i>} |
| 69 | + * @accessors{ |
| 70 | + * @memberAc{viewChangeSignal} |
| 71 | + * @notifyAc{viewChangeSignalChanged()} |
| 72 | + * } |
| 73 | + * @sa QtMvvm::bind |
| 74 | + */ |
| 75 | + Q_PROPERTY(QString viewChangeSignal MEMBER viewChangeSignal NOTIFY viewChangeSignalChanged) |
| 76 | + /*! @brief The type/direction of binding to create |
| 77 | + * |
| 78 | + * @default{`MvvmBinding::TwoWay`} |
| 79 | + * @accessors{ |
| 80 | + * @readAc{type} |
| 81 | + * @writeAc{setType()} |
| 82 | + * @notifyAc{typeChanged()} |
| 83 | + * } |
| 84 | + * @sa QtMvvm::bind |
| 85 | + */ |
| 86 | + Q_PROPERTY(BindingDirection type READ type WRITE setType NOTIFY typeChanged) |
| 87 | + |
| 88 | +public: |
| 89 | + //! @copydoc QtMvvm::Binding::BindingDirectionFlag |
| 90 | + enum BindingDirection { |
| 91 | + SingleInit = 1, //!< @copydoc QtMvvm::Binding::SingleInit |
| 92 | + OneWayToView = 3, //!< @copydoc QtMvvm::Binding::OneWayToView |
| 93 | + OneWayToViewModel = 4, //!< @copydoc QtMvvm::Binding::OneWayToViewModel |
| 94 | + TwoWay = 7 //!< @copydoc QtMvvm::Binding::TwoWay |
| 95 | + }; |
| 96 | + |
| 97 | + //! @copydoc QtMvvm::Binding::unbind |
| 98 | + void unbind(); |
| 99 | + //! @copydoc QtMvvm::Binding::isValid |
| 100 | + bool isValid(); |
| 101 | + //! @writeAcFn{MvvmBinding::type} |
| 102 | + void setType(BindingDirection type); |
| 103 | + |
| 104 | +signals: |
| 105 | + //! @notifyAcFn{MvvmBinding::viewModel} |
| 106 | + void viewModelChanged(); |
| 107 | + //! @notifyAcFn{MvvmBinding::viewModelProperty} |
| 108 | + void viewModelPropertyChanged(); |
| 109 | + //! @notifyAcFn{MvvmBinding::view} |
| 110 | + void viewChanged(); |
| 111 | + //! @notifyAcFn{MvvmBinding::viewProperty} |
| 112 | + void viewPropertyChanged(); |
| 113 | + //! @notifyAcFn{MvvmBinding::viewModelChangeSignal} |
| 114 | + void viewModelChangeSignalChanged(); |
| 115 | + //! @notifyAcFn{MvvmBinding::viewChangeSignal} |
| 116 | + void viewChangeSignalChanged(); |
| 117 | + //! @notifyAcFn{MvvmBinding::type} |
| 118 | + void typeChanged(); |
| 119 | +}; |
0 commit comments