Skip to content
Permalink
Browse files

Correctly render qgsMapRendererJob use case steps in docs

  • Loading branch information
DelazJ authored and nyalldawson committed Sep 1, 2020
1 parent 97b56fe commit a7bf2203948e7417502453149a247a865e8ab231
Showing with 10 additions and 10 deletions.
  1. +5 −5 python/core/auto_generated/qgsmaprendererjob.sip.in
  2. +5 −5 src/core/qgsmaprendererjob.h
@@ -25,11 +25,11 @@ amount of time.

Common use case:

# prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
# create QgsMapRendererJob subclass with QgsMapSettings instance
# connect to job's :py:func:`~finished` signal
# call :py:func:`~start`. Map rendering will start in background, the function immediately returns
# at some point, slot connected to :py:func:`~finished` signal is called, map rendering is done
1. Prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
2. Create QgsMapRendererJob subclass with QgsMapSettings instance
3. Connect to job's :py:func:`~finished` signal
4. Call :py:func:`~start`. Map rendering will start in background, the function immediately returns
5. At some point, slot connected to :py:func:`~finished` signal is called, map rendering is done

It is possible to cancel the rendering job while it is active by calling :py:func:`~cancel` function.

@@ -167,11 +167,11 @@ struct LabelRenderJob
*
* Common use case:
*
* # prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
* # create QgsMapRendererJob subclass with QgsMapSettings instance
* # connect to job's finished() signal
* # call start(). Map rendering will start in background, the function immediately returns
* # at some point, slot connected to finished() signal is called, map rendering is done
* 1. Prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
* 2. Create QgsMapRendererJob subclass with QgsMapSettings instance
* 3. Connect to job's finished() signal
* 4. Call start(). Map rendering will start in background, the function immediately returns
* 5. At some point, slot connected to finished() signal is called, map rendering is done
*
* It is possible to cancel the rendering job while it is active by calling cancel() function.
*

0 comments on commit a7bf220

Please sign in to comment.
You can’t perform that action at this time.