Viktigt

Översättning är en gemenskapsinsats du kan gå med i. Den här sidan är för närvarande översatt till 100.00%.

16.2. Kodsnuttar

Råd

Kodsnuttarna på den här sidan behöver följande import om du befinner dig utanför pyqgis-konsolen:

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

Detta avsnitt innehåller kodavsnitt som underlättar plugin-utveckling.

16.2.1. Hur man anropar en metod med en kortkommando

I tillägget lägger du till initGui()

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)

Till unload() lägg till

self.iface.unregisterMainWindowAction(self.key_action)

Den metod som anropas när CTRL+I trycks in

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

Det är också möjligt att låta användare anpassa kortkommandon för de åtgärder som tillhandahålls. Detta görs genom att lägga till:

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

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

16.2.2. Hur man återanvänder QGIS-ikoner

Eftersom de är välkända och förmedlar ett tydligt budskap till användarna kanske du ibland vill återanvända QGIS-ikoner i ditt plugin istället för att rita och ställa in en ny. Använd metoden getThemeIcon().

Till exempel för att återanvända ikonen mActionFileOpen.svg som finns i QGIS kodarkiv:

# 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() är en annan metod för att anropa QGIS-ikoner. Du hittar exempel på anrop till temaikoner på QGIS embedded images - Cheatsheet.

16.2.3. Gränssnitt för plugin i dialogrutan för alternativ

Du kan lägga till en anpassad flik för tilläggets alternativ i Inställningar ► Alternativ. Detta är att föredra framför att lägga till en specifik huvudmenypost för ditt tilläggs alternativ, eftersom det håller alla QGIS-applikationens inställningar och tilläggets inställningar på ett enda ställe som är lätt för användare att upptäcka och navigera.

Följande snippet kommer bara att lägga till en ny tom flik för plugin-inställningarna, redo för dig att fylla i alla alternativ och inställningar som är specifika för ditt plugin. Du kan dela upp följande klasser i olika filer. I det här exemplet lägger vi till två klasser i huvudfilen 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)

Slutligen lägger vi till importen och modifierar funktionen __init__:

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)

Tips

Lägg till anpassade flikar i dialogen för lageregenskaper

Du kan tillämpa en liknande logik för att lägga till det anpassade alternativet för tillägget i dialogen med lageregenskaper med hjälp av klasserna QgsMapLayerConfigWidgetFactory och QgsMapLayerConfigWidget.

16.2.4. Bädda in anpassade widgetar för lager i lagerträdet

Förutom de vanliga lagersymbologielementen som visas bredvid eller under lagerposten i panelen Layers kan du lägga till egna widgetar som ger snabb åtkomst till vissa åtgärder som ofta används med ett lager (konfigurationsfiltrering, urval, stil, uppdatering av ett lager med en knappwidget, skapa en lagerbaserad tidsregulator eller bara visa extra lagerinformation i en etikett där, eller …). Dessa så kallade Layer tree embedded widgets görs tillgängliga via lagrets egenskaper Legend-fliken för enskilda lager.

Följande kodsnutt skapar en rullgardinsmeny i förklaringen som visar de lager-stilar som finns tillgängliga för lagret, så att du snabbt kan växla mellan de olika lager-stilarna.

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)

Dra sedan Layer style chooser från Available widgets till Used widgets från ett visst lagers egenskapsflik Legend för att aktivera widgeten i lagerträdet. Inbäddade widgetar visas ALLTID högst upp i underobjekten i den tillhörande lagernoden.

Om du vill använda widgetarna från t.ex. ett plugin kan du lägga till dem så här:

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)