def createWidget(self, layout_param=None):
self._layout_param = layout_param
self._layout_name = None
self._combo = QgsLayoutItemComboBox()
self._combo.setItemType(QgsLayoutItemRegistry.LayoutMap)
# TODO -- overwrite layout item mode, hiding selected status, sort by name (not z-order)
self._combo.currentIndexChanged.connect(
lambda: self.widgetValueHasChanged.emit(self))
return self._combo
def testCombo(self):
project = QgsProject()
layout = QgsPrintLayout(project)
combo = QgsLayoutItemComboBox(None)
spy = QSignalSpy(combo.itemChanged)
self.assertEqual(combo.count(), 0)
self.assertIsNone(combo.currentLayout())
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(combo.currentIndex(), -1)
self.assertEqual(len(spy), 0)
combo.setCurrentLayout(layout)
self.assertEqual(combo.currentIndex(), -1)
self.assertEqual(len(spy), 0)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.count(), 0)
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 0)
combo.setAllowEmptyItem(True)
self.assertEqual(combo.currentIndex(), 0)
self.assertEqual(combo.count(), 1)
self.assertEqual(len(spy), 2)
self.assertEqual(combo.currentLayout(), layout)
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 2)
self.assertEqual(combo.currentIndex(), 0)
self.assertEqual(combo.itemText(0), '')
combo.setAllowEmptyItem(False)
self.assertEqual(combo.currentIndex(), -1)
self.assertEqual(combo.count(), 0)
self.assertEqual(len(spy), 4)
self.assertEqual(combo.currentLayout(), layout)
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 4)
self.assertEqual(combo.currentIndex(), -1)
label1 = QgsLayoutItemLabel(layout)
label1.setId('llll')
# don't add to layout yet!
combo.setItem(label1)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 4)
self.assertEqual(combo.currentIndex(), -1)
combo.setAllowEmptyItem(True)
combo.setItem(label1)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 6)
self.assertEqual(combo.currentIndex(), 0)
combo.setAllowEmptyItem(False)
layout.addLayoutItem(label1)
self.assertEqual(combo.currentIndex(), 0)
self.assertEqual(combo.count(), 1)
self.assertEqual(combo.itemText(0), 'llll')
self.assertEqual(len(spy), 10)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(combo.item(0), label1)
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 11)
self.assertEqual(combo.currentIndex(), -1)
combo.setItem(label1)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(len(spy), 12)
self.assertEqual(combo.currentIndex(), 0)
combo.setAllowEmptyItem(True)
self.assertEqual(combo.currentIndex(), 1)
self.assertEqual(combo.count(), 2)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'llll')
self.assertEqual(len(spy), 13)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.currentItem(), label1)
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label1)
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(2))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 14)
self.assertEqual(combo.currentIndex(), 0)
combo.setItem(label1)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(len(spy), 15)
self.assertEqual(combo.currentIndex(), 1)
label2 = QgsLayoutItemLabel(layout)
label2.setId('mmmm')
layout.addLayoutItem(label2)
self.assertEqual(combo.currentIndex(), 1)
self.assertEqual(combo.count(), 3)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'llll')
self.assertEqual(combo.itemText(2), 'mmmm')
self.assertEqual(len(spy), 15)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.currentItem(), label1)
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label1)
self.assertEqual(combo.item(2), label2)
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(3))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 16)
self.assertEqual(combo.currentIndex(), 0)
combo.setItem(label1)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(len(spy), 17)
self.assertEqual(combo.currentIndex(), 1)
label1.setId('nnnn')
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'mmmm')
self.assertEqual(combo.itemText(2), 'nnnn')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.item(2), label1)
self.assertEqual(combo.currentItem(), label1)
combo.setAllowEmptyItem(False)
self.assertEqual(combo.itemText(0), 'mmmm')
self.assertEqual(combo.itemText(1), 'nnnn')
self.assertEqual(combo.item(0), label2)
self.assertEqual(combo.item(1), label1)
self.assertEqual(combo.currentItem(), label1)
combo.setItem(label2)
label2.setId('oooo')
self.assertEqual(combo.itemText(0), 'nnnn')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertEqual(combo.item(0), label1)
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.currentItem(), label2)
combo.setAllowEmptyItem(True)
layout.removeLayoutItem(label1)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.currentItem(), label2)
map = QgsLayoutItemMap(layout)
layout.addLayoutItem(map)
map.setId('pppp')
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertEqual(combo.itemText(2), 'pppp')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.item(2), map)
self.assertEqual(combo.currentItem(), label2)
combo.setItemType(QgsLayoutItemRegistry.LayoutMap)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'pppp')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), map)
self.assertIsNone(combo.currentItem())
combo.setItemType(QgsLayoutItemRegistry.LayoutLabel)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertIsNone(combo.currentItem())
combo.setItemType(QgsLayoutItemRegistry.LayoutAttributeTable)
self.assertEqual(combo.itemText(0), '')
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.currentItem())
combo.setAllowEmptyItem(False)
self.assertEqual(combo.count(), 0)
self.assertIsNone(combo.currentItem())
self.assertEqual(combo.currentIndex(), -1)
def testCombo(self):
project = QgsProject()
layout = QgsPrintLayout(project)
combo = QgsLayoutItemComboBox(None)
spy = QSignalSpy(combo.itemChanged)
self.assertEqual(combo.count(), 0)
self.assertIsNone(combo.currentLayout())
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(combo.currentIndex(), -1)
self.assertEqual(len(spy), 0)
combo.setCurrentLayout(layout)
self.assertEqual(combo.currentIndex(), -1)
self.assertEqual(len(spy), 0)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.count(), 0)
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 0)
combo.setAllowEmptyItem(True)
self.assertEqual(combo.currentIndex(), 0)
self.assertEqual(combo.count(), 1)
self.assertEqual(len(spy), 2)
self.assertEqual(combo.currentLayout(), layout)
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 2)
self.assertEqual(combo.currentIndex(), 0)
self.assertEqual(combo.itemText(0), '')
combo.setAllowEmptyItem(False)
self.assertEqual(combo.currentIndex(), -1)
self.assertEqual(combo.count(), 0)
self.assertEqual(len(spy), 4)
self.assertEqual(combo.currentLayout(), layout)
self.assertIsNone(combo.currentItem())
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 4)
self.assertEqual(combo.currentIndex(), -1)
label1 = QgsLayoutItemLabel(layout)
label1.setId('llll')
# don't add to layout yet!
combo.setItem(label1)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 4)
self.assertEqual(combo.currentIndex(), -1)
combo.setAllowEmptyItem(True)
combo.setItem(label1)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 6)
self.assertEqual(combo.currentIndex(), 0)
combo.setAllowEmptyItem(False)
layout.addLayoutItem(label1)
self.assertEqual(combo.currentIndex(), 0)
self.assertEqual(combo.count(), 1)
self.assertEqual(combo.itemText(0), 'llll')
self.assertEqual(len(spy), 10)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(combo.item(0), label1)
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(1))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 11)
self.assertEqual(combo.currentIndex(), -1)
combo.setItem(label1)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(len(spy), 12)
self.assertEqual(combo.currentIndex(), 0)
combo.setAllowEmptyItem(True)
self.assertEqual(combo.currentIndex(), 1)
self.assertEqual(combo.count(), 2)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'llll')
self.assertEqual(len(spy), 13)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.currentItem(), label1)
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label1)
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(2))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 14)
self.assertEqual(combo.currentIndex(), 0)
combo.setItem(label1)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(len(spy), 15)
self.assertEqual(combo.currentIndex(), 1)
label2 = QgsLayoutItemLabel(layout)
label2.setId('mmmm')
layout.addLayoutItem(label2)
self.assertEqual(combo.currentIndex(), 1)
self.assertEqual(combo.count(), 3)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'llll')
self.assertEqual(combo.itemText(2), 'mmmm')
self.assertEqual(len(spy), 15)
self.assertEqual(combo.currentLayout(), layout)
self.assertEqual(combo.currentItem(), label1)
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label1)
self.assertEqual(combo.item(2), label2)
self.assertIsNone(combo.item(-1))
self.assertIsNone(combo.item(3))
combo.setItem(None)
self.assertIsNone(combo.currentItem())
self.assertEqual(len(spy), 16)
self.assertEqual(combo.currentIndex(), 0)
combo.setItem(label1)
self.assertEqual(combo.currentItem(), label1)
self.assertEqual(len(spy), 17)
self.assertEqual(combo.currentIndex(), 1)
label1.setId('nnnn')
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'mmmm')
self.assertEqual(combo.itemText(2), 'nnnn')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.item(2), label1)
self.assertEqual(combo.currentItem(), label1)
combo.setAllowEmptyItem(False)
self.assertEqual(combo.itemText(0), 'mmmm')
self.assertEqual(combo.itemText(1), 'nnnn')
self.assertEqual(combo.item(0), label2)
self.assertEqual(combo.item(1), label1)
self.assertEqual(combo.currentItem(), label1)
combo.setItem(label2)
label2.setId('oooo')
self.assertEqual(combo.itemText(0), 'nnnn')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertEqual(combo.item(0), label1)
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.currentItem(), label2)
combo.setAllowEmptyItem(True)
layout.removeLayoutItem(label1)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.currentItem(), label2)
map = QgsLayoutItemMap(layout)
layout.addLayoutItem(map)
map.setId('pppp')
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertEqual(combo.itemText(2), 'pppp')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertEqual(combo.item(2), map)
self.assertEqual(combo.currentItem(), label2)
combo.setItemType(QgsLayoutItemRegistry.LayoutMap)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'pppp')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), map)
self.assertIsNone(combo.currentItem())
combo.setItemType(QgsLayoutItemRegistry.LayoutLabel)
self.assertEqual(combo.itemText(0), '')
self.assertEqual(combo.itemText(1), 'oooo')
self.assertIsNone(combo.item(0))
self.assertEqual(combo.item(1), label2)
self.assertIsNone(combo.currentItem())
combo.setItemType(QgsLayoutItemRegistry.LayoutAttributeTable)
self.assertEqual(combo.itemText(0), '')
self.assertIsNone(combo.item(0))
self.assertIsNone(combo.currentItem())
combo.setAllowEmptyItem(False)
self.assertEqual(combo.count(), 0)
self.assertIsNone(combo.currentItem())
self.assertEqual(combo.currentIndex(), -1)
class PrintLayoutMapWidgetWrapper(WidgetWrapper):
def createWidget(self, layout_param=None):
self._layout_param = layout_param
self._layout_name = None
self._combo = QgsLayoutItemComboBox()
self._combo.setItemType(QgsLayoutItemRegistry.LayoutMap)
# TODO -- overwrite layout item mode, hiding selected status, sort by name (not z-order)
self._combo.currentIndexChanged.connect(
lambda: self.widgetValueHasChanged.emit(self))
return self._combo
def postInitialize(self, wrappers):
for wrapper in wrappers:
if wrapper.param.name() == self._layout_param:
self.layout_wrapper = wrapper
self.set_layout_name(wrapper.value())
wrapper.widgetValueHasChanged.connect(self.layoutChanged)
def layoutChanged(self, wrapper):
layout_name = wrapper.value()
if layout_name == self._layout_name:
return
self.set_layout_name(layout_name)
def set_layout_name(self, layout_name):
self._layout_name = layout_name
self.refreshItems()
self.widgetValueHasChanged.emit(self)
def refreshItems(self):
value = self.comboValue(combobox=self._combo)
if self._layout_name:
layout = QgsProject.instance().layoutManager().layoutByName(
self._layout_name)
self._combo.setCurrentLayout(layout)
else:
self._combo.setCurrentLayout(None)
# TODO - modeler
# if self.dialogType == DIALOG_MODELER:
# strings = self.dialog.getAvailableValuesOfType(
# [QgsProcessingParameterString, QgsProcessingParameterNumber, QgsProcessingParameterFile,
# QgsProcessingParameterField, QgsProcessingParameterExpression], QgsProcessingOutputString)
# for text, data in [(self.dialog.resolveValueDescription(s), s) for s in strings]:
# self._combo.addItem(text, data)
self.setComboValue(value, self._combo)
def setValue(self, value):
self.setComboValue(value, self._combo)
self.widgetValueHasChanged.emit(self)
def value(self):
item = self._combo.currentItem()
if item is None:
return None
return item.uuid()