How to select a specific tab at opening in the QGIS options dialog?

Question

I want to open QGIS options dialog (menu Settings > Options) programmatically and focus a specific tab.
I saw the QgisInterface.showOptionsDialog class method description :

virtual void QgisInterface::showOptionsDialog     (   QWidget *   parent =
nullptr,      const QString &     currentPage = QString()     )
Opens the options dialog.
The currentPage argument can be used to force the dialog to open at a
specific page.

but I don't know which value enter for currentPage.

J. Monticolo · Accepted Answer

With QGIS code source investigation, the currentPage values are the Qt object names of the options dialog page widgets.
So, the QGIS options dialog can be opened at specific tabs with :
page_names = [
    "mOptionsPageGeneral",
    "mOptionsPageSystem",
    "mOptionsPageCRS",
    "mOptionsPageDataSources",
    "mOptionsPageRendering",
    "mOptionsPageMapCanvas",
    "mOptionsPageMapTools",
    "mOptionsPageColors",
    "mOptionsPageDigitizing",
    "mOptionsPageComposer",
    "mOptionsPageGDAL",
    "mOptionsPageVariables",
    "mOptionsPageAuth",
    "mOptionsPageNetwork",
    "mOptionsPageLocatorSettings",
    "mOptionsPagePageSettingsEditor",
    "mOptionsPageAcceleration",
]
# to open options dialog on the general tab
iface.showOptionsDialog(currentPage=page_names[0])

How to select a specific tab at opening in the QGIS options dialog?

One Answer

Add your own answers!

Ask a Question