QGIS Macro Plugin

Contents

  • Getting Started
    • Installation
      • From Release ZIP
    • Usage
      • Recording a Macro
      • Playing Back a Macro
      • Saving and Loading Macros
  • Core Library (qgis_macros)
    • Macro
      • WidgetSpec
      • WidgetPathNode
      • WidgetPath
      • MacroEvent
      • Position
      • BaseMacroEvent
      • MacroKeyEvent
      • MacroMouseMoveEvent
      • MacroMouseEvent
      • MacroWheelEvent
      • MacroMouseDoubleClickEvent
      • Macro
    • MacroRecorder
      • MacroRecorder
    • MacroPlayer
      • MacroPlaybackStatus
      • MacroPlaybackReport
      • MacroPlayer
    • Settings
      • WidgetType
      • SettingCategory
      • WidgetConfig
      • Setting
      • Settings
    • Exceptions
      • MacroPluginError
      • WidgetNotFoundError
      • MacroPlaybackEndedError
      • InvalidSettingValueError
    • Utilities
      • is_object_map_canvas()
      • get_widget_text()
      • get_sibling_index()
      • find_nearest_visible_children_of_type()
      • find_nearest_visible_children_with_threshold()
      • enum_value()
      • event_pos()
      • event_global_pos()
  • Plugin (macro_plugin)
    • MacroPlugin
      • MacroPlugin
    • MacroPanel
      • MacroPanel
      • MacroToolFactory
    • MacroModel
      • MacroTableModel
    • SettingsDialog
      • SettingsDialog
  • CHANGELOG
    • 0.1.0 (2026-04-07)
QGIS Macro Plugin
  • Core Library (qgis_macros)
  • View page source

Core Library (qgis_macros)

The core library provides the macro recording and playback engine. It can be used as a standalone dependency by any plugin using qgis-plugin-dev-tools runtime_requires.

Package: macro-qgis-core (PyPI) / qgis_macros (import)

  • Macro
    • WidgetSpec
    • WidgetPathNode
    • WidgetPath
    • MacroEvent
    • Position
    • BaseMacroEvent
    • MacroKeyEvent
    • MacroMouseMoveEvent
    • MacroMouseEvent
    • MacroWheelEvent
    • MacroMouseDoubleClickEvent
    • Macro
  • MacroRecorder
    • MacroRecorder
  • MacroPlayer
    • MacroPlaybackStatus
    • MacroPlaybackReport
    • MacroPlayer
  • Settings
    • WidgetType
    • SettingCategory
    • WidgetConfig
    • Setting
    • Settings
  • Exceptions
    • MacroPluginError
    • WidgetNotFoundError
    • MacroPlaybackEndedError
    • InvalidSettingValueError
  • Utilities
    • is_object_map_canvas()
    • get_widget_text()
    • get_sibling_index()
    • find_nearest_visible_children_of_type()
    • find_nearest_visible_children_with_threshold()
    • enum_value()
    • event_pos()
    • event_global_pos()
Previous Next

© Copyright 2025-2026, macro-qgis-plugin contributors.

Built with Sphinx using a theme provided by Read the Docs.