-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Python implementation of enum settings editor widget wrapper
- Loading branch information
Showing
4 changed files
with
184 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
88 changes: 88 additions & 0 deletions
88
python/PyQt6/gui/additions/qgssettingsenumflageditorwrapper.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| """ | ||
| *************************************************************************** | ||
| qgssettingsenumflageditorwrapper.py | ||
| --------------------- | ||
| Date : October 2024 | ||
| Copyright : (C) 2021 by Denis Rouzaud | ||
| Email : denis@opengis.ch | ||
| *************************************************************************** | ||
| * * | ||
| * This program is free software; you can redistribute it and/or modify * | ||
| * it under the terms of the GNU General Public License as published by * | ||
| * the Free Software Foundation; either version 2 of the License, or * | ||
| * (at your option) any later version. * | ||
| * * | ||
| *************************************************************************** | ||
| """ | ||
|
|
||
| from qgis.PyQt.QtWidgets import QWidget, QComboBox | ||
|
|
||
| from qgis.core import QgsSettingsEntryBase, QgsSettingsEditorWidgetWrapper | ||
|
|
||
|
|
||
| class PyQgsSettingsEnumEditorWidgetWrapper(QgsSettingsEditorWidgetWrapper): | ||
| """ | ||
| A settings editor widget wrapper for enum settings as PyQgsSettingsEntryEnumFlag | ||
| """ | ||
| def __init__(self, parent=None, editor=None, setting=None, displayStrings: dict=None): | ||
| self.setting = editor | ||
| self.editor = setting | ||
| self.displayStrings = {} | ||
| super().__init__(parent) | ||
| if editor is not None and setting is not None: | ||
| if displayStrings: | ||
| self.displayStrings = displayStrings | ||
| self.configureEditor(editor, setting) | ||
|
|
||
| def id(self): | ||
| return 'py-enum' | ||
|
|
||
| def createWrapper(self, parent=None): | ||
| return PyQgsSettingsEnumFlagWrapper(parent) | ||
|
|
||
| def setWidgetFromSetting(self): | ||
| if self.setting: | ||
| return self.setWidgetFromVariant(self.setting.value(self.dynamicKeyPartList())) | ||
| return False | ||
|
|
||
| def setSettingFromWidget(self): | ||
| if self.editor: | ||
| self.setting.setValue(self.variantValueFromWidget(), self.dynamicKeyPartList()) | ||
| return True | ||
| else: | ||
| return False | ||
|
|
||
| def variantValueFromWidget(self): | ||
| if self.editor: | ||
| return self.setting.defaultValue().__class__(self.editor.currentData()) | ||
| return None | ||
|
|
||
| def setWidgetFromVariant(self, value): | ||
| if self.editor: | ||
| idx = self.editor.findData(value) | ||
| self.editor.setCurrentIndex(idx) | ||
| return idx >= 0 | ||
| return False | ||
|
|
||
| def createEditorPrivate(self, parent=None): | ||
| return QComboBox(parent) | ||
|
|
||
| def configureEditorPrivate(self, editor: QWidget, setting: QgsSettingsEntryBase): | ||
| self.setting = setting | ||
| self.editor = editor | ||
| if editor is not None: | ||
| for i in range(self.setting.metaEnum().keyCount()): | ||
| value = self.setting.metaEnum().value(i) | ||
| key = self.setting.metaEnum().key(i) | ||
| text = self.displayStrings.get(value, key) | ||
| self.editor.addItem(text, value) | ||
| return True | ||
| else: | ||
| return False | ||
|
|
||
| def enableAutomaticUpdatePrivate(self): | ||
| self.editor.currentIndexChanged.connect( | ||
| lambda: self.setting.setValue(self.editor.currentData(), self.dynamicKeyPartList())) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| """ | ||
| *************************************************************************** | ||
| qgssettingsenumflageditorwrapper.py | ||
| --------------------- | ||
| Date : October 2024 | ||
| Copyright : (C) 2021 by Denis Rouzaud | ||
| Email : denis@opengis.ch | ||
| *************************************************************************** | ||
| * * | ||
| * This program is free software; you can redistribute it and/or modify * | ||
| * it under the terms of the GNU General Public License as published by * | ||
| * the Free Software Foundation; either version 2 of the License, or * | ||
| * (at your option) any later version. * | ||
| * * | ||
| *************************************************************************** | ||
| """ | ||
|
|
||
| from qgis.PyQt.QtWidgets import QWidget, QComboBox | ||
|
|
||
| from qgis.core import QgsSettingsEntryBase, QgsSettingsEditorWidgetWrapper | ||
|
|
||
|
|
||
| class PyQgsSettingsEnumEditorWidgetWrapper(QgsSettingsEditorWidgetWrapper): | ||
| """ | ||
| A settings editor widget wrapper for enum settings as PyQgsSettingsEntryEnumFlag | ||
| """ | ||
| def __init__(self, parent=None, editor=None, setting=None, displayStrings: dict=None): | ||
| self.setting = editor | ||
| self.editor = setting | ||
| self.displayStrings = {} | ||
| super().__init__(parent) | ||
| if editor is not None and setting is not None: | ||
| if displayStrings: | ||
| self.displayStrings = displayStrings | ||
| self.configureEditor(editor, setting) | ||
|
|
||
| def id(self): | ||
| return 'py-enum' | ||
|
|
||
| def createWrapper(self, parent=None): | ||
| return PyQgsSettingsEnumFlagWrapper(parent) | ||
|
|
||
| def setWidgetFromSetting(self): | ||
| if self.setting: | ||
| return self.setWidgetFromVariant(self.setting.value(self.dynamicKeyPartList())) | ||
| return False | ||
|
|
||
| def setSettingFromWidget(self): | ||
| if self.editor: | ||
| self.setting.setValue(self.variantValueFromWidget(), self.dynamicKeyPartList()) | ||
| return True | ||
| else: | ||
| return False | ||
|
|
||
| def variantValueFromWidget(self): | ||
| if self.editor: | ||
| return self.setting.defaultValue().__class__(self.editor.currentData()) | ||
| return None | ||
|
|
||
| def setWidgetFromVariant(self, value): | ||
| if self.editor: | ||
| idx = self.editor.findData(value) | ||
| self.editor.setCurrentIndex(idx) | ||
| return idx >= 0 | ||
| return False | ||
|
|
||
| def createEditorPrivate(self, parent=None): | ||
| return QComboBox(parent) | ||
|
|
||
| def configureEditorPrivate(self, editor: QWidget, setting: QgsSettingsEntryBase): | ||
| self.setting = setting | ||
| self.editor = editor | ||
| if editor is not None: | ||
| for i in range(self.setting.metaEnum().keyCount()): | ||
| value = self.setting.metaEnum().value(i) | ||
| key = self.setting.metaEnum().key(i) | ||
| text = self.displayStrings.get(value, key) | ||
| self.editor.addItem(text, value) | ||
| return True | ||
| else: | ||
| return False | ||
|
|
||
| def enableAutomaticUpdatePrivate(self): | ||
| self.editor.currentIndexChanged.connect( | ||
| lambda: self.setting.setValue(self.editor.currentData(), self.dynamicKeyPartList())) | ||
|
|