1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
#ifndef CONFIGMAPPER_H
#define CONFIGMAPPER_H
#include "common/bihash.h"
#include "guiSQLiteStudio_global.h"
#include <QObject>
class CfgMain;
class CfgEntry;
class CustomConfigWidgetPlugin;
class ConfigComboBox;
class GUI_API_EXPORT ConfigMapper : public QObject
{
Q_OBJECT
public:
explicit ConfigMapper(CfgMain* cfgMainList);
ConfigMapper(const QList<CfgMain*> cfgMainList);
void loadToWidget(QWidget* topLevelWidget);
void loadToWidget(CfgEntry* config, QWidget* widget);
void saveFromWidget(QWidget* widget, bool noTransaction = false);
void setInternalCustomConfigWidgets(const QList<CustomConfigWidgetPlugin*>& value);
/**
* @brief Scans widget and binds widgets to proper config objects.
* @param topLevelWidget Toplevel widget that contains all required configuration widgets.
*
* It goes through all widgets in given top level widget and looks for statusText property
* that matches any of config entries in CfgMain instance(s) passed in constructor.
*
* For each matched pair (QWidget::statusText() to CfgEntry::getFullKey()) it remembers
* pair of QWidget and CfgEntry and from now on when CfgEntry is modified, the QWidget
* gets updated with the value and vice versa - when QWidget gets new input, then CfgEntry
* is updated with that value. All these updates are done in real time.
*
* @note Binding mechanism can be used only against CfgMain that is not persistable.
* If you try to bind CfgMain that is persistable, it just won't work and it is intended
* that way, because having a QWidget bind to a persistable CfgEntry would cause lots
* of database updates to store changing value (like from QLineEdit). For persistable please
* use loadToWidget() and saveFromWidget() methods, as you can call them when necessary.
*/
void bindToConfig(QWidget* topLevelWidget);
/**
* @brief Releases any bingins against widgets.
*
* This simply revokes what was done with bindToConfig().
*/
void unbindFromConfig();
QWidget* getBindWidgetForConfig(CfgEntry* key) const;
CfgEntry* getBindConfigForWidget(QWidget* widget) const;
QList<QWidget *> getExtraWidgets() const;
/**
* @brief Sets list of extra widgets to load/save values to/from.
* @param value List of widgets.
*
* Extra widgets list can be provided to the mapper if it will be impossible to find those widgets
* just by looking for childrens of top widget recurrently. This is for example the case
* when widgets are embedded in QAbstractItemView::setIndexWidget(). Such widgets have to be
* provided as list of extra widgets to the mapper, so the mapper handles them when loading/saving
* values.
*/
void setExtraWidgets(const QList<QWidget *> &value);
void addExtraWidget(QWidget* w);
void addExtraWidgets(const QList<QWidget*>& list);
void clearExtraWidgets();
private:
void applyConfigToWidget(QWidget *widget, const QHash<QString, CfgEntry*>& allConfigEntries, const QHash<QString, QVariant> &config);
void applyConfigToWidget(QWidget *widget, CfgEntry* cfgEntry, const QVariant& configValue);
void handleSpecialWidgets(QWidget *widget, const QHash<QString, CfgEntry*>& allConfigEntries);
void handleConfigComboBox(QWidget *widget, const QHash<QString, CfgEntry*>& allConfigEntries);
void connectCommonNotifierToWidget(QWidget *widget, CfgEntry* key);
bool connectCustomNotifierToWidget(QWidget *widget, CfgEntry* cfgEntry);
void applyCommonConfigToWidget(QWidget *widget, const QVariant& value, CfgEntry* cfgEntry);
bool applyCustomConfigToWidget(CfgEntry* key, QWidget *widget, const QVariant& value);
void saveWidget(QWidget* widget, const QHash<QString, CfgEntry*>& allConfigEntries);
void saveFromWidget(QWidget* widget, CfgEntry* cfgEntry);
void saveCommonConfigFromWidget(QWidget *widget, CfgEntry* key);
bool saveCustomConfigFromWidget(QWidget *widget, CfgEntry* key);
QVariant getCommonConfigValueFromWidget(QWidget *widget, CfgEntry* key, bool& ok);
QVariant getCustomConfigValueFromWidget(QWidget *widget, CfgEntry* key, bool& ok);
QVariant getConfigValueFromWidget(QWidget *widget, CfgEntry* key);
CfgEntry* getConfigEntry(QWidget* widget, const QHash<QString, CfgEntry*>& allConfigEntries);
CfgEntry* getEntryForProperty(QWidget* widget, const char* propertyName, const QHash<QString, CfgEntry*>& allConfigEntries);
QHash<QString,CfgEntry*> getAllConfigEntries();
QList<QWidget*> getAllConfigWidgets(QWidget* parent);
bool isPersistant() const;
QList<CfgMain*> cfgMainList;
QList<CustomConfigWidgetPlugin*> internalCustomConfigWidgets;
bool realTimeUpdates = false;
QHash<QWidget*,CfgEntry*> widgetToConfigEntry;
QHash<CfgEntry*,QWidget*> configEntryToWidgets;
QHash<CfgEntry*,QWidget*> specialConfigEntryToWidgets;
bool updatingEntry = false;
QList<QWidget*> extraWidgets;
QHash<QString, CfgEntry*> allEntries;
static constexpr const char* CFG_MODEL_PROPERTY = "cfg";
static constexpr const char* CFG_NOTIFY_PROPERTY = "notify";
static constexpr const char* CFG_PREVIEW_PROPERTY = "preview";
private slots:
void handleModified();
void entryChanged(const QVariant& newValue);
void uiConfigEntryChanged();
void updateConfigComboModel(const QVariant& value);
void notifiableConfigKeyChanged();
signals:
void modified();
void notifyEnabledWidgetModified(QWidget* widget, CfgEntry* key, const QVariant& value);
};
#endif // CONFIGMAPPER_H
|
