setting_dialog.py

# -----------------------------------------------------------
#
# QGIS setting manager is a python module to easily manage read/write
# settings and set/get corresponding widgets.
#
# Copyright    : (C) 2013 Denis Rouzaud
# Email        : denis.rouzaud@gmail.com
#
# -----------------------------------------------------------
#
# licensed under the terms of GNU GPL 2
#
# 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.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this progsram; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# ---------------------------------------------------------------------

from PyQt5.QtWidgets import QDialog, QWidget, QButtonGroup

from .setting_manager import Debug
from enum import Enum


class UpdateMode(Enum):
    NoUpdate = 'no_update'
    DialogAccept = 'dialog_accept'
    WidgetUpdate = 'widget_update'


class SettingDialog:

    def __init__(self, setting_manager, mode=UpdateMode.DialogAccept):

        if isinstance(self, QDialog) and mode == UpdateMode.DialogAccept:
            self.accepted.connect(self.accept_dialog)

        self.mode = mode
        self.setting_manager = setting_manager
        self.__settings = {}

    def init_widgets(self):
        if self.__settings.keys():
            raise NameError('init_widgets was already run.')

        self.__settings.clear()

        for setting_name in self.setting_manager.settings_list():
            for objectClass in (QWidget, QButtonGroup):
                widget = self.findChild(objectClass, setting_name)
                if widget is not None:
                    if Debug:
                        print("Widget found: {}".format(setting_name))

                    # configure the widget
                    setting_widget = self.setting_manager.setting(setting_name).config_widget(widget)
                    if setting_widget is None:
                        raise NameError('Widget could not be set for setting {}'.format(setting_name))

                    if Debug:
                        setting_widget.DEBUG = True

                    # TODO
                    # setting_widget.widgetDestroyed.connect(self.widgetDestroyed)

                    if self.mode == UpdateMode.WidgetUpdate:
                        setting_widget.connect_widget_auto_update()

                    self.__settings[setting_name] = setting_widget
                    break

        # in case the widget has no showEvent
        self.set_widgets_from_values()

    def showEvent(self, e):
        self.set_widgets_from_values()

    def before_accept_dialog(self):
        """
        you can override this method in the PluginSettings subclass
        """
        return True

    def widget_list(self):
        """
        returns the list of widgets related to settings
        """
        return list(self.__settings.keys())

    def setting_widget(self, name):
        if name not in self.__settings:
            return None
        return self.__settings[name]

    def accept_dialog(self):
        if self.before_accept_dialog():
            self.set_values_from_widgets()

    def set_values_from_widgets(self):
        for setting_widget in list(self.__settings.values()):
            setting_widget.set_value_from_widget()

    def set_widgets_from_values(self):
        for setting_widget in list(self.__settings.values()):
            setting_widget.set_widget_from_value()