🔍 Debug Mode

Hidden developer tools for troubleshooting and diagnostics

Overview

Debug Mode is a hidden feature designed for advanced users and developers to assist with troubleshooting and development. When enabled, it reveals additional diagnostic tools and information that are normally hidden from the standard user interface.

Note: Debug Mode is intended for troubleshooting purposes. Regular users typically do not need to enable this feature during normal operation.

How to Activate

Debug Mode can be toggled using a keyboard shortcut:

Keyboard Shortcut

Press Ctrl + Alt + Shift + D

This shortcut works in both:

  • The main plugin window
  • The layer preview window

Toggle Behavior

  • First press: Enables Debug Mode - debug elements become visible
  • Second press: Disables Debug Mode - debug elements are hidden again

When Debug Mode is active, a blue "Debug Mode On" label will appear at the top of the window.

Debug Features

Debug Mode reveals several diagnostic tools and information panels:

What Debug Mode Does

  • Toggles the visibility of debugging-related UI elements
  • Displays a visual indicator when active
  • Provides access to diagnostic tools for WebEngine and path testing
  • Shows detailed loading status information

Main Window Elements

When Debug Mode is enabled in the main plugin window, the following elements become visible:

Mini WebEngine Test Button

  • Location: Bottom area near the "Preview Layers" button
  • Purpose: Opens a minimal WebEngine test dialog to diagnose QtWebEngine issues
  • Use case: Testing if PyQt6-WebEngine is properly installed and functioning

Test (Debug Paths) Button

  • Location: In the "Others" section
  • Purpose: Shows diagnostic information about file paths and plugin directories
  • Use case: Verifying that the plugin can locate its resources correctly

Preview Window Elements

When Debug Mode is enabled in the layer preview window, the following elements become visible:

Debug Button

  • Location: Right-side panel, below the "Reload Map and Layers" button
  • Purpose: Runs comprehensive QtWebEngine diagnostic tests
  • Use case: Troubleshooting map rendering and WebEngine issues

Loading Status Panel

  • Location: Right-side panel, at the bottom
  • Purpose: Shows detailed WebEngine loading stages and status messages
  • Use case: Monitoring the map loading process and identifying where issues occur

Clear Status Button

  • Location: Below the Loading Status panel
  • Purpose: Clears the loading status log

State Persistence

The Debug Mode state is saved in QGIS settings and will persist across sessions:

  • If you enable Debug Mode and close QGIS, it will remain enabled when you restart
  • To disable Debug Mode, simply press the keyboard shortcut again
  • The setting is stored per-user in the QGIS configuration
Tip: Remember to disable Debug Mode when you're done troubleshooting to keep the interface clean.

Next Steps

↑