slicer-convertHtmlToPdf-snippet.py

@staticmethod
def convertHtmlToPdf(htmlFilePath, pdfFilePath):
  """
  Convert HTML file to PDF.

  It returns the tuple ``(success, errorString)``.

  .. note::

    Conversion from HTML to PDF is performed using :func:`slicer.qSlicerWebWidget.printToPdf()`
    that internally leverage the corresponding API provided by the Qt class ``QWebEnginePage``.
  """
  webWidget = slicer.qSlicerWebWidget()
  printPdfLoop = qt.QEventLoop()
  errorString = None

  def loadFinished(ok):
    if not ok:
      nonlocal errorString
      errorString = 'Failed to load URL %s' % webWidget.url
      printPdfLoop.exit(slicer.util.EXIT_FAILURE)
      return
    layout = qt.QPageLayout(qt.QPageSize(qt.QPageSize.Letter), qt.QPageLayout.Portrait, qt.QMarginsF())
    webWidget.printToPdf(pdfFilePath, layout)

  def pdfPrintingFinished(filePath, success):
    if not success:
      nonlocal errorString
      errorString = f'Failed to print {filePath}'
    printPdfLoop.exit(slicer.util.EXIT_SUCCESS if success else slicer.util.EXIT_FAILURE)

  webWidget.connect('loadFinished(bool)', loadFinished)
  webWidget.connect('pdfPrintingFinished(QString,bool)', pdfPrintingFinished)
  webWidget.setUrl(qt.QUrl.fromLocalFile(htmlFilePath).toString())

  return printPdfLoop.exec() == slicer.util.EXIT_SUCCESS, errorString