MacroRecorder

Event filter-based macro recorder that captures user interactions.

class qgis_macros.macro_recorder.MacroRecorder(filter_out_mouse_movements=True)

Bases: _QObjectStub

Manages recording of user actions like mouse and keyboard events.

Tracks and collects events during a recording session, allowing filtered or unfiltered playback of these events for automation.

Parameters:

filter_out_mouse_movements (bool)

add_widget_to_filter_events_out(widget)

Add a widget to filter events out from the recorded events.

Parameters:

widget (_QWidgetStub)

Return type:

None

is_recording()

Check if the recorder is currently recording.

Return type:

bool

start_recording()

Start recording user actions.

Return type:

None

stop_recording()

Stop recording user actions.

Returns:

New Macro object with recorded events

Return type:

Macro

eventFilter(obj, event)

Event filter to record keyboard and mouse events.

Parameters:

• obj (_QObjectStub)

• event (QEvent)

Return type:

bool