wizard/BWizardPage.py

   1 #!/usr/bin/env python
   2 # encoding: utf-8
   3 #
   4 # This file is part of BeRTOS.
   5 #
   6 # Bertos is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19 #
  20 # As a special exception, you may use this file as part of a free software
  21 # library without restriction.  Specifically, if other files instantiate
  22 # templates or use macros or inline functions from this file, or you compile
  23 # this file and link it with other files to produce an executable, this
  24 # file does not by itself cause the resulting executable to be covered by
  25 # the GNU General Public License.  This exception does not however
  26 # invalidate any other reasons why the executable file might be covered by
  27 # the GNU General Public License.
  28 #
  29 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30 #
  31 # $Id$
  32 #
  33 # Author: Lorenzo Berni <duplo@develer.com>
  34 #
  35
  36 from PyQt4.QtCore import *
  37 from PyQt4.QtGui import *
  38 from PyQt4 import uic
  39
  40 import qvariant_converter
  41
  42 class BWizardPage(QWizardPage):
  43     """
  44     Base class for all the wizard pages. It has the utility method used in all
  45     the pages. A wizard page class need to extend this class.
  46     """
  47
  48     def __init__(self, wizardGui, parent = None):
  49         QWizardPage.__init__(self, parent)
  50         self.pageContent = uic.loadUi(wizardGui, None)
  51         layout = QVBoxLayout()
  52         layout.addWidget(self.pageContent)
  53         self.setLayout(layout)
  54         self.setupUi()
  55         self.connectSignals()
  56
  57     def exceptionOccurred(self, message):
  58         """
  59         Simple message box showing method.
  60         """
  61         QMessageBox.critical(self, self.tr("Error occurred"), message, QMessageBox.Ok, QMessageBox.NoButton)
  62
  63     def showMessage(self, title, message):
  64         """
  65         Show an information message box with title and message.
  66         """
  67         QMessageBox.information(self, title, message)
  68
  69     ## BProject interaction methods ##
  70
  71     def setProjectInfo(self, key, value):
  72         """
  73         Stores the given value in the BProject class associating it with the given
  74         key.
  75         """
  76         QApplication.instance().project.setInfo(key, value)
  77
  78     def projectInfo(self, key):
  79         """
  80         Retrieves the information associated with the given key.
  81         """
  82         return QApplication.instance().project.info(key)
  83
  84     def project(self):
  85         """
  86         Returns the BProject instance.
  87         """
  88         return QApplication.instance().project
  89
  90     ####
  91
  92     ## QSettings interaction methods ##
  93
  94     def settingsStore(self, key, value):
  95         """
  96         Stores the given value in the QSettings associated with the given key.
  97         """
  98         QApplication.instance().settings.setValue(QString(key), value)
  99
 100     def settingsRetrieve(self, key):
 101         """
 102         Retrieves the value associated to key in the QSettings. Note that this
 103         Value is a QVariant and neet to be converted in a standard type.
 104         """
 105         return QApplication.instance().settings.value(QString(key), QVariant())
 106
 107     def versions(self):
 108         """
 109         Returns the version list from the QSettings.
 110         """
 111         return qvariant_converter.getStringList(self.settingsRetrieve("versions"))
 112
 113     def setVersions(self, versions):
 114         """
 115         Stores the given versions in the QSettings.
 116         """
 117         self.settingsStore("versions", qvariant_converter.convertStringList(versions))
 118
 119     def searchDirList(self):
 120         """
 121         Returns the search dir list from the QSettings.
 122         """
 123         return qvariant_converter.getStringList(self.settingsRetrieve("search_dir_list"))
 124
 125     def setSearchDirList(self, search_dir_list):
 126         """
 127         Stores the search dir list in the QSettings.
 128         """
 129         self.settingsStore("search_dir_list", qvariant_converter.convertStringList(search_dir_list))
 130
 131     def pathSearch(self):
 132         """
 133         Returns the value of path search from the QSettings.
 134         """
 135         return qvariant_converter.getBool(self.settingsRetrieve("path_search"))
 136
 137     def setPathSearch(self, path_search):
 138         """
 139         Stores the path search value in the QSettings.
 140         """
 141         self.settingsStore("path_search", qvariant_converter.convertBool(path_search))
 142
 143     def toolchains(self):
 144         """
 145         Returns the toolchains stored in the QSettings.
 146         """
 147         return qvariant_converter.getBoolDict(self.settingsRetrieve("toolchains"))
 148
 149     def setToolchains(self, toolchains):
 150         """
 151         Stores the toolchains in the QSettings.
 152         """
 153         self.settingsStore("toolchains", qvariant_converter.convertBoolDict(toolchains))
 154
 155     def defaultFolder(self):
 156         """
 157         Returns the default save folder stored in the QSettings.
 158         """
 159         return qvariant_converter.getString(self.settingsRetrieve("folder"))
 160
 161     def setDefaultFolder(self, folder):
 162         """
 163         Stores the default save folder in the QSettings.
 164         """
 165         self.settingsStore("folder", qvariant_converter.convertString(folder))
 166
 167     ####
 168
 169     ## Methodo to be implemented in child classes when needed ##
 170
 171     def reloadData(self):
 172         """
 173         Method called before the page is loaded. The pages that need to use this
 174         method have to implement it.
 175         """
 176         pass
 177
 178     def setupUi(self):
 179         """
 180         Method called automatically during the initialization of the wizard page.
 181         It set up the interface. Pages that need to use this method have to
 182         implement it.
 183         """
 184         pass
 185
 186     def connectSignals(self):
 187         """
 188         Method called automatically during the initialization of the wizard page.
 189         It connects the signals and the slots. The pages that need to use this
 190         method have to implement it.
 191         """
 192         pass
 193
 194     ####