mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
385 lines
17 KiB
Python
385 lines
17 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ParametersPanel.py
|
|
---------------------
|
|
Date : August 2012
|
|
Copyright : (C) 2012 by Victor Olaya
|
|
(C) 2013 by CS Systemes d'information (CS SI)
|
|
Email : volayaf at gmail dot com
|
|
otb at c-s dot fr (CS SI)
|
|
Contributors : Victor Olaya
|
|
Alexia Mondot (CS SI) - managing the new parameter ParameterMultipleExternalInput
|
|
***************************************************************************
|
|
* *
|
|
* 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 locale
|
|
|
|
from PyQt4 import QtCore, QtGui
|
|
|
|
from processing.tools import dataobjects
|
|
from processing.core.ProcessingConfig import ProcessingConfig
|
|
|
|
from processing.gui.OutputSelectionPanel import OutputSelectionPanel
|
|
from processing.gui.InputLayerSelectorPanel import InputLayerSelectorPanel
|
|
from processing.gui.FixedTablePanel import FixedTablePanel
|
|
from processing.gui.RangePanel import RangePanel
|
|
from processing.gui.MultipleInputPanel import MultipleInputPanel
|
|
from processing.gui.NumberInputPanel import NumberInputPanel
|
|
from processing.gui.ExtentSelectionPanel import ExtentSelectionPanel
|
|
from processing.gui.FileSelectionPanel import FileSelectionPanel
|
|
from processing.gui.CrsSelectionPanel import CrsSelectionPanel
|
|
from processing.gui.MultipleFileInputPanel import MultipleFileInputPanel
|
|
from processing.parameters.ParameterRaster import ParameterRaster
|
|
from processing.parameters.ParameterVector import ParameterVector
|
|
from processing.parameters.ParameterTable import ParameterTable
|
|
from processing.parameters.ParameterBoolean import ParameterBoolean
|
|
from processing.parameters.ParameterTableField import ParameterTableField
|
|
from processing.parameters.ParameterSelection import ParameterSelection
|
|
from processing.parameters.ParameterFixedTable import ParameterFixedTable
|
|
from processing.parameters.ParameterRange import ParameterRange
|
|
from processing.parameters.ParameterMultipleInput import ParameterMultipleInput
|
|
from processing.parameters.ParameterNumber import ParameterNumber
|
|
from processing.parameters.ParameterExtent import ParameterExtent
|
|
from processing.parameters.ParameterFile import ParameterFile
|
|
from processing.parameters.ParameterCrs import ParameterCrs
|
|
from processing.parameters.ParameterString import ParameterString
|
|
from processing.outputs.OutputRaster import OutputRaster
|
|
from processing.outputs.OutputTable import OutputTable
|
|
from processing.outputs.OutputVector import OutputVector
|
|
|
|
|
|
class ParametersPanel(QtGui.QWidget):
|
|
|
|
NOT_SELECTED = '[Not selected]'
|
|
|
|
def __init__(self, parent, alg):
|
|
super(ParametersPanel, self).__init__(None)
|
|
self.parent = parent
|
|
self.alg = alg
|
|
self.valueItems = {}
|
|
self.labels = {}
|
|
self.widgets = {}
|
|
self.checkBoxes = {}
|
|
self.dependentItems = {}
|
|
self.iterateButtons = {}
|
|
self.showAdvanced = False
|
|
self.initGUI()
|
|
|
|
def initGUI(self):
|
|
tooltips = self.alg.getParameterDescriptions()
|
|
self.setSizePolicy(QtGui.QSizePolicy.Expanding,
|
|
QtGui.QSizePolicy.Expanding)
|
|
self.verticalLayout = QtGui.QVBoxLayout()
|
|
self.verticalLayout.setSpacing(5)
|
|
self.verticalLayout.setMargin(20)
|
|
for param in self.alg.parameters:
|
|
if param.isAdvanced:
|
|
self.advancedButton = QtGui.QPushButton()
|
|
self.advancedButton.setText('Show advanced parameters')
|
|
self.advancedButton.setMaximumWidth(250)
|
|
QtCore.QObject.connect(self.advancedButton,
|
|
QtCore.SIGNAL('clicked()'),
|
|
self.showAdvancedParametersClicked)
|
|
self.verticalLayout.addWidget(self.advancedButton)
|
|
break
|
|
for param in self.alg.parameters:
|
|
if param.hidden:
|
|
continue
|
|
desc = param.description
|
|
if isinstance(param, ParameterExtent):
|
|
desc += ' (xmin, xmax, ymin, ymax)'
|
|
try:
|
|
if param.optional:
|
|
desc += ' [optional]'
|
|
except:
|
|
pass
|
|
label = QtGui.QLabel(desc)
|
|
self.labels[param.name] = label
|
|
widget = self.getWidgetFromParameter(param)
|
|
self.valueItems[param.name] = widget
|
|
if isinstance(param, ParameterVector) \
|
|
and not self.alg.allowOnlyOpenedLayers:
|
|
layout = QtGui.QHBoxLayout()
|
|
layout.setSpacing(2)
|
|
layout.setMargin(0)
|
|
layout.addWidget(widget)
|
|
button = QtGui.QToolButton()
|
|
icon = QtGui.QIcon(os.path.dirname(__file__)
|
|
+ '/../images/iterate.png')
|
|
button.setIcon(icon)
|
|
button.setToolTip('Iterate over this layer')
|
|
button.setCheckable(True)
|
|
button.setMaximumWidth(30)
|
|
button.setMaximumHeight(30)
|
|
layout.addWidget(button)
|
|
self.iterateButtons[param.name] = button
|
|
QtCore.QObject.connect(button, QtCore.SIGNAL('toggled(bool)'),
|
|
self.buttonToggled)
|
|
widget = QtGui.QWidget()
|
|
widget.setLayout(layout)
|
|
if param.name in tooltips.keys():
|
|
tooltip = tooltips[param.name]
|
|
else:
|
|
tooltip = param.description
|
|
label.setToolTip(tooltip)
|
|
widget.setToolTip(tooltip)
|
|
if param.isAdvanced:
|
|
label.setVisible(self.showAdvanced)
|
|
widget.setVisible(self.showAdvanced)
|
|
self.widgets[param.name] = widget
|
|
self.verticalLayout.addWidget(label)
|
|
self.verticalLayout.addWidget(widget)
|
|
|
|
for output in self.alg.outputs:
|
|
if output.hidden:
|
|
continue
|
|
label = QtGui.QLabel(output.description)
|
|
widget = OutputSelectionPanel(output, self.alg)
|
|
self.verticalLayout.addWidget(label)
|
|
self.verticalLayout.addWidget(widget)
|
|
if isinstance(output, (OutputRaster, OutputVector, OutputTable)):
|
|
check = QtGui.QCheckBox()
|
|
check.setText('Open output file after running algorithm')
|
|
check.setChecked(True)
|
|
self.verticalLayout.addWidget(check)
|
|
self.checkBoxes[output.name] = check
|
|
self.valueItems[output.name] = widget
|
|
|
|
self.verticalLayout.addStretch(1000)
|
|
self.setLayout(self.verticalLayout)
|
|
|
|
def showAdvancedParametersClicked(self):
|
|
self.showAdvanced = not self.showAdvanced
|
|
if self.showAdvanced:
|
|
self.advancedButton.setText('Hide advanced parameters')
|
|
else:
|
|
self.advancedButton.setText('Show advanced parameters')
|
|
for param in self.alg.parameters:
|
|
if param.isAdvanced:
|
|
self.labels[param.name].setVisible(self.showAdvanced)
|
|
self.widgets[param.name].setVisible(self.showAdvanced)
|
|
|
|
def buttonToggled(self, value):
|
|
if value:
|
|
sender = self.sender()
|
|
for button in self.iterateButtons.values():
|
|
if button is not sender:
|
|
button.setChecked(False)
|
|
|
|
def getExtendedLayerName(self, layer):
|
|
authid = layer.crs().authid()
|
|
if ProcessingConfig.getSetting(ProcessingConfig.SHOW_CRS_DEF) \
|
|
and authid is not None:
|
|
return layer.name() + ' [' + str(authid) + ']'
|
|
else:
|
|
return layer.name()
|
|
|
|
def getWidgetFromParameter(self, param):
|
|
# TODO Create Parameter widget class that holds the logic
|
|
# for creating a widget that belongs to the parameter.
|
|
if isinstance(param, ParameterRaster):
|
|
layers = dataobjects.getRasterLayers()
|
|
items = []
|
|
if param.optional:
|
|
items.append((self.NOT_SELECTED, None))
|
|
for layer in layers:
|
|
items.append((self.getExtendedLayerName(layer), layer))
|
|
item = InputLayerSelectorPanel(items, param)
|
|
elif isinstance(param, ParameterVector):
|
|
if self.somethingDependsOnThisParameter(param) or self.alg.allowOnlyOpenedLayers:
|
|
item = QtGui.QComboBox()
|
|
layers = dataobjects.getVectorLayers(param.shapetype)
|
|
if param.optional:
|
|
item.addItem(self.NOT_SELECTED, None)
|
|
for layer in layers:
|
|
item.addItem(self.getExtendedLayerName(layer), layer)
|
|
item.currentIndexChanged.connect(self.updateDependentFields)
|
|
item.name = param.name
|
|
else:
|
|
layers = dataobjects.getVectorLayers(param.shapetype)
|
|
items = []
|
|
if param.optional:
|
|
items.append((self.NOT_SELECTED, None))
|
|
for layer in layers:
|
|
items.append((self.getExtendedLayerName(layer), layer))
|
|
# if already set, put first in list
|
|
for i,(name,layer) in enumerate(items):
|
|
if layer and layer.source() == param.value:
|
|
items.insert(0, items.pop(i))
|
|
item = InputLayerSelectorPanel(items, param)
|
|
elif isinstance(param, ParameterTable):
|
|
if self.somethingDependsOnThisParameter(param):
|
|
item = QtGui.QComboBox()
|
|
layers = dataobjects.getTables()
|
|
if param.optional:
|
|
item.addItem(self.NOT_SELECTED, None)
|
|
for layer in layers:
|
|
item.addItem(layer.name(), layer)
|
|
item.currentIndexChanged.connect(self.updateDependentFields)
|
|
item.name = param.name
|
|
else:
|
|
layers = dataobjects.getTables()
|
|
items = []
|
|
if param.optional:
|
|
items.append((self.NOT_SELECTED, None))
|
|
for layer in layers:
|
|
items.append((layer.name(), layer))
|
|
# if already set, put first in list
|
|
for i,(name,layer) in enumerate(items):
|
|
if layer and layer.source() == param.value:
|
|
items.insert(0, items.pop(i))
|
|
item = InputLayerSelectorPanel(items, param)
|
|
elif isinstance(param, ParameterBoolean):
|
|
item = QtGui.QComboBox()
|
|
item.addItem('Yes')
|
|
item.addItem('No')
|
|
if param.default:
|
|
item.setCurrentIndex(0)
|
|
else:
|
|
item.setCurrentIndex(1)
|
|
elif isinstance(param, ParameterTableField):
|
|
item = QtGui.QComboBox()
|
|
if param.parent in self.dependentItems:
|
|
items = self.dependentItems[param.parent]
|
|
else:
|
|
items = []
|
|
self.dependentItems[param.parent] = items
|
|
items.append(param.name)
|
|
parent = self.alg.getParameterFromName(param.parent)
|
|
if isinstance(parent, ParameterVector):
|
|
layers = dataobjects.getVectorLayers(parent.shapetype)
|
|
else:
|
|
layers = dataobjects.getTables()
|
|
if len(layers) > 0:
|
|
if param.optional:
|
|
item.addItem("[not set]")
|
|
item.addItems(self.getFields(layers[0], param.datatype))
|
|
elif isinstance(param, ParameterSelection):
|
|
item = QtGui.QComboBox()
|
|
item.addItems(param.options)
|
|
item.setCurrentIndex(param.default)
|
|
elif isinstance(param, ParameterFixedTable):
|
|
item = FixedTablePanel(param)
|
|
elif isinstance(param, ParameterRange):
|
|
item = RangePanel(param)
|
|
elif isinstance(param, ParameterFile):
|
|
item = FileSelectionPanel(param.isFolder, param.ext)
|
|
elif isinstance(param, ParameterMultipleInput):
|
|
if param.datatype == ParameterMultipleInput.TYPE_FILE:
|
|
item = MultipleFileInputPanel()
|
|
else:
|
|
if param.datatype == ParameterMultipleInput.TYPE_RASTER:
|
|
options = dataobjects.getRasterLayers()
|
|
elif param.datatype == ParameterMultipleInput.TYPE_VECTOR_ANY:
|
|
options = dataobjects.getVectorLayers()
|
|
else:
|
|
options = dataobjects.getVectorLayers([param.datatype])
|
|
opts = []
|
|
for opt in options:
|
|
opts.append(self.getExtendedLayerName(opt))
|
|
item = MultipleInputPanel(opts)
|
|
elif isinstance(param, ParameterNumber):
|
|
item = NumberInputPanel(param.default, param.min, param.max,
|
|
param.isInteger)
|
|
elif isinstance(param, ParameterExtent):
|
|
item = ExtentSelectionPanel(self.parent, self.alg, param.default)
|
|
elif isinstance(param, ParameterCrs):
|
|
item = CrsSelectionPanel(param.default)
|
|
elif isinstance(param, ParameterString):
|
|
if param.multiline:
|
|
verticalLayout = QtGui.QVBoxLayout()
|
|
verticalLayout.setSizeConstraint(
|
|
QtGui.QLayout.SetDefaultConstraint)
|
|
textEdit = QtGui.QPlainTextEdit()
|
|
textEdit.setPlainText(param.default)
|
|
verticalLayout.addWidget(textEdit)
|
|
item = textEdit
|
|
else:
|
|
item = QtGui.QLineEdit()
|
|
item.setText(str(param.default))
|
|
else:
|
|
item = QtGui.QLineEdit()
|
|
item.setText(str(param.default))
|
|
|
|
return item
|
|
|
|
def updateDependentFields(self):
|
|
sender = self.sender()
|
|
if not isinstance(sender, QtGui.QComboBox):
|
|
return
|
|
if not sender.name in self.dependentItems:
|
|
return
|
|
layer = sender.itemData(sender.currentIndex())
|
|
children = self.dependentItems[sender.name]
|
|
for child in children:
|
|
widget = self.valueItems[child]
|
|
widget.clear()
|
|
if self.alg.getParameterFromName(child).optional:
|
|
widget.addItem("[not set]")
|
|
widget.addItems(self.getFields(layer,
|
|
self.alg.getParameterFromName(child).datatype))
|
|
|
|
def getFields(self, layer, datatype):
|
|
fieldTypes = []
|
|
if datatype == ParameterTableField.DATA_TYPE_STRING:
|
|
fieldTypes = [QtCore.QVariant.String]
|
|
elif datatype == ParameterTableField.DATA_TYPE_NUMBER:
|
|
fieldTypes = [QtCore.QVariant.Int, QtCore.QVariant.Double]
|
|
|
|
fieldNames = set()
|
|
for field in layer.pendingFields():
|
|
if not fieldTypes or field.type() in fieldTypes:
|
|
fieldNames.add(unicode(field.name()))
|
|
return sorted(list(fieldNames), cmp=locale.strcoll)
|
|
|
|
def somethingDependsOnThisParameter(self, parent):
|
|
for param in self.alg.parameters:
|
|
if isinstance(param, ParameterTableField):
|
|
if param.parent == parent.name:
|
|
return True
|
|
return False
|
|
|
|
def setTableContent(self):
|
|
params = [parm for parm in self.alg.parameters if not parm.hidden]
|
|
outputs = [output for output in self.alg.outputs if not output.hidden]
|
|
numParams = len(params)
|
|
numOutputs = len(outputs)
|
|
self.tableWidget.setRowCount(numParams + numOutputs)
|
|
|
|
for i, param in enumerate(params):
|
|
item = QtGui.QTableWidgetItem(param.description)
|
|
item.setFlags(QtCore.Qt.ItemIsEnabled)
|
|
self.tableWidget.setItem(i, 0, item)
|
|
item = self.getWidgetFromParameter(param)
|
|
self.valueItems[param.name] = item
|
|
self.tableWidget.setCellWidget(i, 1, item)
|
|
self.tableWidget.setRowHeight(i, 22)
|
|
|
|
for i, output in enumerate(outputs):
|
|
item = QtGui.QTableWidgetItem(output.description + '<'
|
|
+ output.__module__.split('.')[-1] + '>')
|
|
item.setFlags(QtCore.Qt.ItemIsEnabled)
|
|
self.tableWidget.setItem(i, 0, item)
|
|
item = OutputSelectionPanel(output, self.alg)
|
|
self.valueItems[output.name] = item
|
|
self.tableWidget.setCellWidget(i, 1, item)
|
|
self.tableWidget.setRowHeight(i, 22)
|