16.2. Blocchi di codice

Suggerimento

I frammenti di codice di questa pagina necessitano delle seguenti importazioni se sei è al di fuori della console pyqgis:

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

Questa sezione contiene frammenti di codice per facilitare lo sviluppo dei plugin.

16.2.1. Come richiamare un metodo con una scorciatoia da tastiera

Nel plug-in aggiungere a 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)

A unload() aggiungere

self.iface.unregisterMainWindowAction(self.key_action)

Il metodo che viene richiamato quando si preme CTRL+I

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

È anche possibile consentire agli utenti di personalizzare le scorciatoie da tastiera per le azioni fornite. Questo si ottiene aggiungendo:

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

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

16.2.2. Come riutilizzare le icone di QGIS

Poiché sono ben conosciute e trasmettono un messaggio chiaro agli utenti, a volte potresti voler riutilizzare le icone di QGIS nel tuo plugin, invece di disegnarne e impostarne una nuova. Utilizza il metodo getThemeIcon().

Ad esempio, per riutilizzare l’icona mActionFileOpen.svg disponibile nel repository del codice QGIS:

# 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() è un altro metodo per richiamare le icone di QGIS. Trovi esempi di richiami alle icone tematiche in QGIS embedded images - Cheatsheet.

16.2.3. Interfaccia per il plugin nella finestra di dialogo delle opzioni

Puoi aggiungere una scheda per le opzioni del plugin a Impostazioni ► Opzioni. Questa soluzione è preferibile all’aggiunta di una voce specifica del menu principale per le opzioni del plugin, in quanto consente di mantenere tutte le impostazioni dell’applicazione QGIS e del plugin in un unico punto, facile da scoprire e da navigare per gli utenti.

Il seguente frammento di codice aggiungerà una nuova scheda vuota per le impostazioni del plugin, pronta per essere popolata con tutte le opzioni e le impostazioni specifiche del plugin. Puoi dividere le classi seguenti in file diversi. In questo esempio, aggiungiamo due classi al file principale 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)

Infine, aggiungiamo le importazioni e modifichiamo la funzione __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)

Suggerimento

Aggiungere schede personalizzate alla finestra di dialogo delle proprietà dei layer

Puoi adottare una logica simile per aggiungere l’opzione personalizzata del plugin alla finestra di dialogo delle proprietà del layer, usando le classi QgsMapLayerConfigWidgetFactory e QgsMapLayerConfigWidget.

16.2.4. Incorporare widget personalizzati per i layer nell’albero dei layer

Oltre ai consueti elementi della simbologia dei layer visualizzati accanto o sotto la voce del layer nel pannello Layer, puoi aggiungere i tuoi widget, consentendo l’accesso rapido ad alcune azioni spesso utilizzate con un layer (impostazione di filtri, selezioni, stili, aggiornamento di un layer con un widget pulsante, creazione di un cursore temporale basato sul layer o semplicemente visualizzazione di informazioni extra sul layer in un’etichetta, o …). Questi cosiddetti Widget incorporati nell’albero dei layer sono resi disponibili per i singoli layer attraverso le proprietà Legenda del layer.

Il seguente frammento di codice crea un menu a tendina nella legenda che mostra gli stili di livello disponibili per il layer, consentendo di passare rapidamente tra i diversi stili di livello.

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)

Quindi, dalla scheda delle proprietà Legenda di un dato layer, trascina la Scelta stile layer da Widget disponibili alla Widget utilizzati` per abilitare il widget nell’albero del layer. I widget incorporati sono SEMPRE visualizzati in cima alle sottovoci dei nodi di livello associati.

Se vuoi utilizzare i widget dall’interno, ad esempio, di un plugin, puoi aggiungerli in questo modo:

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)