16.2. Codesnippers

Hint

De codesnippers op deze pagina hebben de volgende import nodig als u buiten de console van PyQGIS bent:

from qgis.core import (
    QgsProject,
    QgsApplication,
    QgsMapLayer,
)

from qgis.gui import (
    QgsGui,
    QgsOptionsWidgetFactory,
    QgsOptionsPageWidget,
    QgsLayerTreeEmbeddedWidgetProvider,
    QgsLayerTreeEmbeddedWidgetRegistry,
)

from qgis.PyQt.QtCore import Qt
from qgis.PyQt.QtWidgets import (
    QMessageBox,
    QAction,
    QHBoxLayout,
    QComboBox,
)
from qgis.PyQt.QtGui import QIcon

Dit gedeelte behandelt codesnippers om de ontwikkeling van plug-ins te faciliteren.

16.2.1. Hoe een methode aan te roepen met een sneltoets

Voeg in de plug-in aan de initGui() toe

self.key_action = QAction("Test Plugin", self.iface.mainWindow())
self.iface.registerMainWindowAction(self.key_action, "Ctrl+I")  # action triggered by Ctrl+I
self.iface.addPluginToMenu("&Test plugins", self.key_action)
self.key_action.triggered.connect(self.key_action_triggered)

Voeg aan unload() toe

self.iface.unregisterMainWindowAction(self.key_action)

De methode die wordt aangeroepen wanneer op CTRL+I wordt gedrukt

def key_action_triggered(self):
  QMessageBox.information(self.iface.mainWindow(),"Ok", "You pressed Ctrl+I")

Het is ook mogelijk om gebruikers toe te staan sneltoetsen voor het toetsenbord te laten aanpassen voor de verschafte acties. Dit wordt gedaan door toe te voegen:

# in the initGui() function
QgsGui.shortcutsManager().registerAction(self.key_action)

# and in the unload() function
QgsGui.shortcutsManager().unregisterAction(self.key_action)

16.2.2. Hoe pictogrammen van QGIS opnieuw te gebruiken

Omdat zij goed bekend zijn en een heldere boodschap overbrengen naar de gebruikers, wilt u misschien soms pictogrammen van QGIS opnieuw in uw plug-in gebruiken in plaats van een nieuwe te tekenen en in te stellen. Gebruik de methode getThemeIcon().

Bijvoorbeeld om het pictogram mActionFileOpen.svg, beschikbaar in de QGIS opslagplaats voor code, opnieuw te gebruiken:

# e.g. somewhere in the initGui
self.file_open_action = QAction(
    QgsApplication.getThemeIcon("/mActionFileOpen.svg"),
    self.tr("Select a File..."),
    self.iface.mainWindow()
)
self.iface.addPluginToMenu("MyPlugin", self.file_open_action)

iconPath() is een andere methode om pictogrammen van QGIS aan te roepen. Voorbeelden van het aanroepen van thema-pictogrammen zijn te vinden op QGIS embedded images - Cheatsheet.

16.2.3. Interface voor plug-in in het dialoogvenster Opties

U kunt een aangepaste tab voor plug-ins Opties toevoegen aan Extra ► Opties. Dit heeft de voorkeur boven het toevoegen van een specifiek item voor het hoofdmenu voor opties van uw plug-in, omdat het alle instellingen voor de toepassing QGIS behoudt en instellingen voor de plug-in op één enkele plaats staan, wat gemakkelijk is voor gebruikers om te ontdekken en te navigeren.

De volgende snipper zal slechts een blanco tab voor de instellingen voor de plug-in toevoegen, die u kunt vullen met alle opties en instellingen, specifiek voor uw plug-in. U kunt de volgende klassen splitsen in verschillende bestanden. In dit voorbeeld voegen we twee klassen toe aan het hoofdbestand mainPlugin.py.

class MyPluginOptionsFactory(QgsOptionsWidgetFactory):

    def __init__(self):
        super().__init__()

    def icon(self):
        return QIcon('icons/my_plugin_icon.svg')

    def createWidget(self, parent):
        return ConfigOptionsPage(parent)


class ConfigOptionsPage(QgsOptionsPageWidget):

    def __init__(self, parent):
        super().__init__(parent)
        layout = QHBoxLayout()
        layout.setContentsMargins(0, 0, 0, 0)
        self.setLayout(layout)

Tenslotte voegen we de imports toe en passen de functie __init__ aan:

from qgis.PyQt.QtWidgets import QHBoxLayout
from qgis.gui import QgsOptionsWidgetFactory, QgsOptionsPageWidget


class MyPlugin:
    """QGIS Plugin Implementation."""

    def __init__(self, iface):
        """Constructor.

        :param iface: An interface instance that will be passed to this class
            which provides the hook by which you can manipulate the QGIS
            application at run time.
        :type iface: QgsInterface
        """
        # Save reference to the QGIS interface
        self.iface = iface


    def initGui(self):
        self.options_factory = MyPluginOptionsFactory()
        self.options_factory.setTitle(self.tr('My Plugin'))
        iface.registerOptionsWidgetFactory(self.options_factory)

    def unload(self):
        iface.unregisterOptionsWidgetFactory(self.options_factory)

Tip

Aangepaste tabs toevoegen aan een dialoogvenster voor laag-eigenschappen

U kunt een soortgelijke logica toepassen om de aangepaste optie voor de plug-in toe te voegen aan het dialoogvenster voor de laageigenschappen met de klassen QgsMapLayerConfigWidgetFactory en QgsMapLayerConfigWidget.

16.2.4. Aangepaste widgets voor lagen inbedden in de boom van lagen

Naast de normale elementen voor symbologie van lagen, weergegeven naast of onder het item van de laag in het paneel Lagen, kunt u uw eigen widgets toevoegen, wat het mogelijk maakt snelle toegang te enkele acties die vaak gebruikt worden met een laag (instellen van filteren, selectie, stijl, vernieuwen van een laag met een widget voor een knop, een op een laag gebaseerd schuifbalk voor tijd maken of eenvoudigweg extra informatie over de laag weergeven in een Label daar, of …). Deze zogenaamde In boom van lagen ingebedde widgets worden voor individuele lagen beschikbaar gemaakt op de tab Legenda van de laageigenschappen.

De volgende codesnipper maakt een keuzemenu in de legenda die u de beschikbare laagstijlen voor de laag laat zien, wat het mogelijk maakt snel te schakelen tussen de verschillende laagstijlen.

class LayerStyleComboBox(QComboBox):
    def __init__(self, layer):
        QComboBox.__init__(self)
        self.layer = layer
        for style_name in layer.styleManager().styles():
            self.addItem(style_name)

        idx = self.findText(layer.styleManager().currentStyle())
        if idx != -1:
          self.setCurrentIndex(idx)

        self.currentIndexChanged.connect(self.on_current_changed)

    def on_current_changed(self, index):
        self.layer.styleManager().setCurrentStyle(self.itemText(index))

class LayerStyleWidgetProvider(QgsLayerTreeEmbeddedWidgetProvider):
    def __init__(self):
        QgsLayerTreeEmbeddedWidgetProvider.__init__(self)

    def id(self):
        return "style"

    def name(self):
        return "Layer style chooser"

    def createWidget(self, layer, widgetIndex):
        return LayerStyleComboBox(layer)

    def supportsLayer(self, layer):
        return True   # any layer is fine

provider = LayerStyleWidgetProvider()
QgsGui.layerTreeEmbeddedWidgetRegistry().addProvider(provider)

Sleep dan, vanaf de tab met eigenschappen voor de Legenda voor een bepaalde laag, de Laagstijl kiezen vanuit de Beschikbare widgets naar Gebruikte widgets om de widget in de boom met lagen in te schakelen. Ingebedde worden ALTIJD weergegeven aan de bovenzijde van hun geassocieerde sub-item van de knoop van de laag.

Als u de widgets wilt gebruiken vanuit bijvoorbeeld een plug-in, kunt u ze als volgt toevoegen:

layer = iface.activeLayer()
counter = int(layer.customProperty("embeddedWidgets/count", 0))
layer.setCustomProperty("embeddedWidgets/count", counter+1)
layer.setCustomProperty("embeddedWidgets/{}/id".format(counter), "style")
view = self.iface.layerTreeView()
view.layerTreeModel().refreshLayerLegend(view.currentLegendNode())
view.currentNode().setExpanded(True)