16.2. Extraits de code

Indication

Les extraits de code de cette page nécessitent les imports suivants si vous êtes en dehors de la console pyqgis :

from qgis.core import (
    QgsProject,
)

from qgis.gui import (
    QgsOptionsWidgetFactory,
    QgsOptionsPageWidget
)

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

Cette section contient des extraits de code pour faciliter le développement de plugins.

16.2.1. Comment appeler une méthode par un raccourci clavier

Dans le plug-in, ajoutez à la fonction 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)

À unload() ajouter

self.iface.unregisterMainWindowAction(self.key_action)

La méthode qui est appelée lorsque l’on appuie sur CTRL+I

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

16.2.2. Interface pour le plugin dans le dialogue des options

Vous pouvez ajouter un onglet d’options de plugin personnalisé à Settings ► Options. Ceci est préférable à l’ajout d’une entrée spécifique dans le menu principal pour les options de votre plugin, car cela permet de garder tous les paramètres de l’application QGIS et les paramètres du plugin dans un seul endroit, ce qui est facile à découvrir et à naviguer pour les utilisateurs.

L’extrait suivant ajoute un nouvel onglet vierge pour les paramètres du plugin, prêt à être rempli avec toutes les options et paramètres spécifiques à votre plugin. Vous pouvez diviser les classes suivantes en différents fichiers. Dans cet exemple, nous ajoutons deux classes dans le fichier main 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)

Enfin, nous ajoutons les importations et modifions la fonction __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)

Astuce

Ajouter des onglets personnalisés à la boîte de dialogue des propriétés d’une couche vecteur.

Vous pouvez appliquer une logique similaire pour ajouter l’option personnalisée du plugin au dialogue des propriétés de la couche en utilisant les classes QgsMapLayerConfigWidgetFactory et QgsMapLayerConfigWidget.