# -*- coding: utf-8 -*- """ *************************************************************************** HelpEditionDialog.py --------------------- Date : August 2012 Copyright : (C) 2012 by Victor Olaya Email : volayaf at gmail dot com *************************************************************************** * * * 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. * * * *************************************************************************** """ __author__ = 'Victor Olaya' __date__ = 'August 2012' __copyright__ = '(C) 2012, Victor Olaya' # This will get replaced with a git SHA1 when you do a git archive __revision__ = '$Format:%H$' import os import pickle from PyQt4.QtCore import * from PyQt4.QtGui import * from processing.ui.ui_DlgHelpEdition import Ui_DlgHelpEdition class HelpEditionDialog(QDialog, Ui_DlgHelpEdition): ALG_DESC = "ALG_DESC" ALG_CREATOR = "ALG_CREATOR" ALG_HELP_CREATOR = "ALG_HELP_CREATOR" def __init__(self, alg): QDialog.__init__(self) self.setupUi(self) self.alg = alg self.descriptions = {} if self.alg.descriptionFile is not None: helpfile = alg.descriptionFile + ".help" if os.path.exists(helpfile): f = open(helpfile, "rb") self.descriptions = pickle.load(f) self.currentName = self.ALG_DESC if self.ALG_DESC in self.descriptions: self.text.setText(self.descriptions[self.ALG_DESC]) self.tree.itemClicked.connect(self.changeItem) self.fillTree() self.updateHtmlView() def reject(self): self.descriptions = None QDialog.reject(self) def accept(self): self.descriptions[self.currentName] = unicode(self.text.toPlainText()) if self.alg.descriptionFile is not None: f = open(self.alg.descriptionFile + ".help", "wb") pickle.dump(self.descriptions, f) f.close() QDialog.accept(self) def getHtml(self): s = "
" + self.getDescription(self.ALG_DESC) + "
\n" s += "" + self.getDescription(param.name) + "
\n" s += "" + self.getDescription(out.name) + "
\n" return s def fillTree(self): item = TreeDescriptionItem("Algorithm description", self.ALG_DESC) self.tree.addTopLevelItem(item) parametersItem = TreeDescriptionItem("Input parameters", None) self.tree.addTopLevelItem(parametersItem) for param in self.alg.parameters: item = TreeDescriptionItem(param.description, param.name) parametersItem.addChild(item) outputsItem = TreeDescriptionItem(self.tr("Outputs"), None) self.tree.addTopLevelItem(outputsItem) for out in self.alg.outputs: item = TreeDescriptionItem(out.description, out.name) outputsItem.addChild(item) item = TreeDescriptionItem("Algorithm created by", self.ALG_CREATOR) self.tree.addTopLevelItem(item) item = TreeDescriptionItem("Algorithm help written by", self.ALG_HELP_CREATOR) self.tree.addTopLevelItem(item) def changeItem(self): item = self.tree.currentItem() if isinstance(item, TreeDescriptionItem): if self.currentName: self.descriptions[self.currentName] = unicode(self.text.toPlainText()) name = item.name if name: self.text.setEnabled(True) self.updateHtmlView() self.currentName = name if name in self.descriptions: self.text.setText(self.descriptions[name]) else: self.text.clear() else: self.currentName = None self.text.clear() self.text.setEnabled(False) self.updateHtmlView() def updateHtmlView(self): self.webView.setHtml(self.getHtml()) def getDescription(self, name): if name in self.descriptions: return self.descriptions[name] else: return "" class TreeDescriptionItem(QTreeWidgetItem): def __init__(self, description, name): QTreeWidgetItem.__init__(self) self.name = name self.description = description self.setText(0, description)