QtPrintSupport.pyi 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. # Copyright (C) 2022 The Qt Company Ltd.
  2. # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
  3. """
  4. This file contains the exact signatures for all functions in module
  5. PySide6.QtPrintSupport, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtPrintSupport`
  9. import PySide6.QtPrintSupport
  10. import PySide6.QtCore
  11. import PySide6.QtGui
  12. import PySide6.QtWidgets
  13. import enum
  14. import typing
  15. import collections.abc
  16. from PySide6.QtCore import Signal
  17. from shiboken6 import Shiboken
  18. class QAbstractPrintDialog(PySide6.QtWidgets.QDialog):
  19. class PrintDialogOption(enum.Flag):
  20. PrintToFile = 0x1
  21. PrintSelection = 0x2
  22. PrintPageRange = 0x4
  23. PrintShowPageSize = 0x8
  24. PrintCollateCopies = 0x10
  25. PrintCurrentPage = 0x40
  26. class PrintRange(enum.Enum):
  27. AllPages = 0x0
  28. Selection = 0x1
  29. PageRange = 0x2
  30. CurrentPage = 0x3
  31. def __init__(self, printer: PySide6.QtPrintSupport.QPrinter, /, parent: PySide6.QtWidgets.QWidget | None = ...) -> None: ...
  32. def fromPage(self, /) -> int: ...
  33. def maxPage(self, /) -> int: ...
  34. def minPage(self, /) -> int: ...
  35. def printRange(self, /) -> PySide6.QtPrintSupport.QAbstractPrintDialog.PrintRange: ...
  36. def printer(self, /) -> PySide6.QtPrintSupport.QPrinter: ...
  37. def setFromTo(self, fromPage: int, toPage: int, /) -> None: ...
  38. def setMinMax(self, min: int, max: int, /) -> None: ...
  39. def setOptionTabs(self, tabs: collections.abc.Sequence[PySide6.QtWidgets.QWidget], /) -> None: ...
  40. def setPrintRange(self, range: PySide6.QtPrintSupport.QAbstractPrintDialog.PrintRange, /) -> None: ...
  41. def toPage(self, /) -> int: ...
  42. class QIntList: ...
  43. class QPageSetupDialog(PySide6.QtWidgets.QDialog):
  44. @typing.overload
  45. def __init__(self, printer: PySide6.QtPrintSupport.QPrinter, /, parent: PySide6.QtWidgets.QWidget | None = ...) -> None: ...
  46. @typing.overload
  47. def __init__(self, /, parent: PySide6.QtWidgets.QWidget | None = ...) -> None: ...
  48. def done(self, result: int, /) -> None: ...
  49. def exec(self, /) -> int: ...
  50. def exec_(self, /) -> int: ...
  51. @typing.overload
  52. def open(self, /) -> None: ...
  53. @typing.overload
  54. def open(self, receiver: PySide6.QtCore.QObject, member: bytes | bytearray | memoryview, /) -> None: ...
  55. def printer(self, /) -> PySide6.QtPrintSupport.QPrinter: ...
  56. def setVisible(self, visible: bool, /) -> None: ...
  57. class QPrintDialog(PySide6.QtPrintSupport.QAbstractPrintDialog):
  58. accepted : typing.ClassVar[Signal] = ... # accepted(QPrinter*)
  59. @typing.overload
  60. def __init__(self, printer: PySide6.QtPrintSupport.QPrinter, /, parent: PySide6.QtWidgets.QWidget | None = ..., *, options: PySide6.QtPrintSupport.QAbstractPrintDialog.PrintDialogOption | None = ...) -> None: ...
  61. @typing.overload
  62. def __init__(self, /, parent: PySide6.QtWidgets.QWidget | None = ..., *, options: PySide6.QtPrintSupport.QAbstractPrintDialog.PrintDialogOption | None = ...) -> None: ...
  63. def done(self, result: int, /) -> None: ...
  64. def exec(self, /) -> int: ...
  65. def exec_(self, /) -> int: ...
  66. def open(self, receiver: PySide6.QtCore.QObject, member: bytes | bytearray | memoryview, /) -> None: ...
  67. def options(self, /) -> PySide6.QtPrintSupport.QAbstractPrintDialog.PrintDialogOption: ...
  68. def setOption(self, option: PySide6.QtPrintSupport.QAbstractPrintDialog.PrintDialogOption, /, on: bool = ...) -> None: ...
  69. def setOptions(self, options: PySide6.QtPrintSupport.QAbstractPrintDialog.PrintDialogOption, /) -> None: ...
  70. def setVisible(self, visible: bool, /) -> None: ...
  71. def testOption(self, option: PySide6.QtPrintSupport.QAbstractPrintDialog.PrintDialogOption, /) -> bool: ...
  72. class QPrintEngine(Shiboken.Object):
  73. class PrintEnginePropertyKey(enum.Enum):
  74. PPK_CollateCopies = 0x0
  75. PPK_ColorMode = 0x1
  76. PPK_Creator = 0x2
  77. PPK_DocumentName = 0x3
  78. PPK_FullPage = 0x4
  79. PPK_NumberOfCopies = 0x5
  80. PPK_Orientation = 0x6
  81. PPK_OutputFileName = 0x7
  82. PPK_PageOrder = 0x8
  83. PPK_PageRect = 0x9
  84. PPK_PageSize = 0xa
  85. PPK_PaperSize = 0xa
  86. PPK_PaperRect = 0xb
  87. PPK_PaperSource = 0xc
  88. PPK_PrinterName = 0xd
  89. PPK_PrinterProgram = 0xe
  90. PPK_Resolution = 0xf
  91. PPK_SelectionOption = 0x10
  92. PPK_SupportedResolutions = 0x11
  93. PPK_WindowsPageSize = 0x12
  94. PPK_FontEmbedding = 0x13
  95. PPK_Duplex = 0x14
  96. PPK_PaperSources = 0x15
  97. PPK_CustomPaperSize = 0x16
  98. PPK_PageMargins = 0x17
  99. PPK_CopyCount = 0x18
  100. PPK_SupportsMultipleCopies = 0x19
  101. PPK_PaperName = 0x1a
  102. PPK_QPageSize = 0x1b
  103. PPK_QPageMargins = 0x1c
  104. PPK_QPageLayout = 0x1d
  105. PPK_CustomBase = 0xff00
  106. def __init__(self, /) -> None: ...
  107. def abort(self, /) -> bool: ...
  108. def metric(self, arg__1: PySide6.QtGui.QPaintDevice.PaintDeviceMetric, /) -> int: ...
  109. def newPage(self, /) -> bool: ...
  110. def printerState(self, /) -> PySide6.QtPrintSupport.QPrinter.PrinterState: ...
  111. def property(self, key: PySide6.QtPrintSupport.QPrintEngine.PrintEnginePropertyKey, /) -> typing.Any: ...
  112. def setProperty(self, key: PySide6.QtPrintSupport.QPrintEngine.PrintEnginePropertyKey, value: typing.Any, /) -> None: ...
  113. class QPrintPreviewDialog(PySide6.QtWidgets.QDialog):
  114. paintRequested : typing.ClassVar[Signal] = ... # paintRequested(QPrinter*)
  115. @typing.overload
  116. def __init__(self, printer: PySide6.QtPrintSupport.QPrinter, /, parent: PySide6.QtWidgets.QWidget | None = ..., flags: PySide6.QtCore.Qt.WindowType = ...) -> None: ...
  117. @typing.overload
  118. def __init__(self, /, parent: PySide6.QtWidgets.QWidget | None = ..., flags: PySide6.QtCore.Qt.WindowType = ...) -> None: ...
  119. def done(self, result: int, /) -> None: ...
  120. @typing.overload
  121. def open(self, /) -> None: ...
  122. @typing.overload
  123. def open(self, receiver: PySide6.QtCore.QObject, member: bytes | bytearray | memoryview, /) -> None: ...
  124. def printer(self, /) -> PySide6.QtPrintSupport.QPrinter: ...
  125. def setVisible(self, visible: bool, /) -> None: ...
  126. class QPrintPreviewWidget(PySide6.QtWidgets.QWidget):
  127. paintRequested : typing.ClassVar[Signal] = ... # paintRequested(QPrinter*)
  128. previewChanged : typing.ClassVar[Signal] = ... # previewChanged()
  129. class ViewMode(enum.Enum):
  130. SinglePageView = 0x0
  131. FacingPagesView = 0x1
  132. AllPagesView = 0x2
  133. class ZoomMode(enum.Enum):
  134. CustomZoom = 0x0
  135. FitToWidth = 0x1
  136. FitInView = 0x2
  137. @typing.overload
  138. def __init__(self, printer: PySide6.QtPrintSupport.QPrinter, /, parent: PySide6.QtWidgets.QWidget | None = ..., flags: PySide6.QtCore.Qt.WindowType = ...) -> None: ...
  139. @typing.overload
  140. def __init__(self, /, parent: PySide6.QtWidgets.QWidget | None = ..., flags: PySide6.QtCore.Qt.WindowType = ...) -> None: ...
  141. def currentPage(self, /) -> int: ...
  142. def fitInView(self, /) -> None: ...
  143. def fitToWidth(self, /) -> None: ...
  144. def orientation(self, /) -> PySide6.QtGui.QPageLayout.Orientation: ...
  145. def pageCount(self, /) -> int: ...
  146. def print_(self, /) -> None: ...
  147. def setAllPagesViewMode(self, /) -> None: ...
  148. def setCurrentPage(self, pageNumber: int, /) -> None: ...
  149. def setFacingPagesViewMode(self, /) -> None: ...
  150. def setLandscapeOrientation(self, /) -> None: ...
  151. def setOrientation(self, orientation: PySide6.QtGui.QPageLayout.Orientation, /) -> None: ...
  152. def setPortraitOrientation(self, /) -> None: ...
  153. def setSinglePageViewMode(self, /) -> None: ...
  154. def setViewMode(self, viewMode: PySide6.QtPrintSupport.QPrintPreviewWidget.ViewMode, /) -> None: ...
  155. def setVisible(self, visible: bool, /) -> None: ...
  156. def setZoomFactor(self, zoomFactor: float, /) -> None: ...
  157. def setZoomMode(self, zoomMode: PySide6.QtPrintSupport.QPrintPreviewWidget.ZoomMode, /) -> None: ...
  158. def updatePreview(self, /) -> None: ...
  159. def viewMode(self, /) -> PySide6.QtPrintSupport.QPrintPreviewWidget.ViewMode: ...
  160. def zoomFactor(self, /) -> float: ...
  161. def zoomIn(self, /, zoom: float = ...) -> None: ...
  162. def zoomMode(self, /) -> PySide6.QtPrintSupport.QPrintPreviewWidget.ZoomMode: ...
  163. def zoomOut(self, /, zoom: float = ...) -> None: ...
  164. class QPrinter(PySide6.QtGui.QPagedPaintDevice):
  165. class ColorMode(enum.Enum):
  166. GrayScale = 0x0
  167. Color = 0x1
  168. class DuplexMode(enum.Enum):
  169. DuplexNone = 0x0
  170. DuplexAuto = 0x1
  171. DuplexLongSide = 0x2
  172. DuplexShortSide = 0x3
  173. class OutputFormat(enum.Enum):
  174. NativeFormat = 0x0
  175. PdfFormat = 0x1
  176. class PageOrder(enum.Enum):
  177. FirstPageFirst = 0x0
  178. LastPageFirst = 0x1
  179. class PaperSource(enum.Enum):
  180. OnlyOne = 0x0
  181. Upper = 0x0
  182. Lower = 0x1
  183. Middle = 0x2
  184. Manual = 0x3
  185. Envelope = 0x4
  186. EnvelopeManual = 0x5
  187. Auto = 0x6
  188. Tractor = 0x7
  189. SmallFormat = 0x8
  190. LargeFormat = 0x9
  191. LargeCapacity = 0xa
  192. Cassette = 0xb
  193. FormSource = 0xc
  194. MaxPageSource = 0xd
  195. CustomSource = 0xe
  196. LastPaperSource = 0xe
  197. class PrintRange(enum.Enum):
  198. AllPages = 0x0
  199. Selection = 0x1
  200. PageRange = 0x2
  201. CurrentPage = 0x3
  202. class PrinterMode(enum.Enum):
  203. ScreenResolution = 0x0
  204. PrinterResolution = 0x1
  205. HighResolution = 0x2
  206. class PrinterState(enum.Enum):
  207. Idle = 0x0
  208. Active = 0x1
  209. Aborted = 0x2
  210. Error = 0x3
  211. class Unit(enum.Enum):
  212. Millimeter = 0x0
  213. Point = 0x1
  214. Inch = 0x2
  215. Pica = 0x3
  216. Didot = 0x4
  217. Cicero = 0x5
  218. DevicePixel = 0x6
  219. @typing.overload
  220. def __init__(self, /, mode: PySide6.QtPrintSupport.QPrinter.PrinterMode = ...) -> None: ...
  221. @typing.overload
  222. def __init__(self, printer: PySide6.QtPrintSupport.QPrinterInfo, /, mode: PySide6.QtPrintSupport.QPrinter.PrinterMode = ...) -> None: ...
  223. def abort(self, /) -> bool: ...
  224. def collateCopies(self, /) -> bool: ...
  225. def colorMode(self, /) -> PySide6.QtPrintSupport.QPrinter.ColorMode: ...
  226. def copyCount(self, /) -> int: ...
  227. def creator(self, /) -> str: ...
  228. def devType(self, /) -> int: ...
  229. def docName(self, /) -> str: ...
  230. def duplex(self, /) -> PySide6.QtPrintSupport.QPrinter.DuplexMode: ...
  231. def fontEmbeddingEnabled(self, /) -> bool: ...
  232. def fromPage(self, /) -> int: ...
  233. def fullPage(self, /) -> bool: ...
  234. def isValid(self, /) -> bool: ...
  235. def metric(self, arg__1: PySide6.QtGui.QPaintDevice.PaintDeviceMetric, /) -> int: ...
  236. def newPage(self, /) -> bool: ...
  237. def outputFileName(self, /) -> str: ...
  238. def outputFormat(self, /) -> PySide6.QtPrintSupport.QPrinter.OutputFormat: ...
  239. def pageOrder(self, /) -> PySide6.QtPrintSupport.QPrinter.PageOrder: ...
  240. def pageRect(self, arg__1: PySide6.QtPrintSupport.QPrinter.Unit, /) -> PySide6.QtCore.QRectF: ...
  241. def paintEngine(self, /) -> PySide6.QtGui.QPaintEngine: ...
  242. def paperRect(self, arg__1: PySide6.QtPrintSupport.QPrinter.Unit, /) -> PySide6.QtCore.QRectF: ...
  243. def paperSource(self, /) -> PySide6.QtPrintSupport.QPrinter.PaperSource: ...
  244. def pdfVersion(self, /) -> PySide6.QtGui.QPagedPaintDevice.PdfVersion: ...
  245. def printEngine(self, /) -> PySide6.QtPrintSupport.QPrintEngine: ...
  246. def printProgram(self, /) -> str: ...
  247. def printRange(self, /) -> PySide6.QtPrintSupport.QPrinter.PrintRange: ...
  248. def printerName(self, /) -> str: ...
  249. def printerSelectionOption(self, /) -> str: ...
  250. def printerState(self, /) -> PySide6.QtPrintSupport.QPrinter.PrinterState: ...
  251. def resolution(self, /) -> int: ...
  252. def setCollateCopies(self, collate: bool, /) -> None: ...
  253. def setColorMode(self, arg__1: PySide6.QtPrintSupport.QPrinter.ColorMode, /) -> None: ...
  254. def setCopyCount(self, arg__1: int, /) -> None: ...
  255. def setCreator(self, arg__1: str, /) -> None: ...
  256. def setDocName(self, arg__1: str, /) -> None: ...
  257. def setDuplex(self, duplex: PySide6.QtPrintSupport.QPrinter.DuplexMode, /) -> None: ...
  258. def setEngines(self, printEngine: PySide6.QtPrintSupport.QPrintEngine, paintEngine: PySide6.QtGui.QPaintEngine, /) -> None: ...
  259. def setFontEmbeddingEnabled(self, enable: bool, /) -> None: ...
  260. def setFromTo(self, fromPage: int, toPage: int, /) -> None: ...
  261. def setFullPage(self, arg__1: bool, /) -> None: ...
  262. def setOutputFileName(self, arg__1: str, /) -> None: ...
  263. def setOutputFormat(self, format: PySide6.QtPrintSupport.QPrinter.OutputFormat, /) -> None: ...
  264. def setPageOrder(self, arg__1: PySide6.QtPrintSupport.QPrinter.PageOrder, /) -> None: ...
  265. def setPageSize(self, size: PySide6.QtGui.QPageSize | PySide6.QtGui.QPageSize.PageSizeId | PySide6.QtCore.QSize, /) -> bool: ...
  266. def setPaperSource(self, arg__1: PySide6.QtPrintSupport.QPrinter.PaperSource, /) -> None: ...
  267. def setPdfVersion(self, version: PySide6.QtGui.QPagedPaintDevice.PdfVersion, /) -> None: ...
  268. def setPrintProgram(self, arg__1: str, /) -> None: ...
  269. def setPrintRange(self, range: PySide6.QtPrintSupport.QPrinter.PrintRange, /) -> None: ...
  270. def setPrinterName(self, arg__1: str, /) -> None: ...
  271. def setPrinterSelectionOption(self, arg__1: str, /) -> None: ...
  272. def setResolution(self, arg__1: int, /) -> None: ...
  273. def supportedPaperSources(self, /) -> typing.List[PySide6.QtPrintSupport.QPrinter.PaperSource]: ...
  274. def supportedResolutions(self, /) -> typing.List[int]: ...
  275. def supportsMultipleCopies(self, /) -> bool: ...
  276. def toPage(self, /) -> int: ...
  277. class QPrinterInfo(Shiboken.Object):
  278. @typing.overload
  279. def __init__(self, /) -> None: ...
  280. @typing.overload
  281. def __init__(self, printer: PySide6.QtPrintSupport.QPrinter, /) -> None: ...
  282. @typing.overload
  283. def __init__(self, other: PySide6.QtPrintSupport.QPrinterInfo, /) -> None: ...
  284. def __copy__(self, /) -> typing.Self: ...
  285. @staticmethod
  286. def availablePrinterNames() -> typing.List[str]: ...
  287. @staticmethod
  288. def availablePrinters() -> typing.List[PySide6.QtPrintSupport.QPrinterInfo]: ...
  289. def defaultColorMode(self, /) -> PySide6.QtPrintSupport.QPrinter.ColorMode: ...
  290. def defaultDuplexMode(self, /) -> PySide6.QtPrintSupport.QPrinter.DuplexMode: ...
  291. def defaultPageSize(self, /) -> PySide6.QtGui.QPageSize: ...
  292. @staticmethod
  293. def defaultPrinter() -> PySide6.QtPrintSupport.QPrinterInfo: ...
  294. @staticmethod
  295. def defaultPrinterName() -> str: ...
  296. def description(self, /) -> str: ...
  297. def isDefault(self, /) -> bool: ...
  298. def isNull(self, /) -> bool: ...
  299. def isRemote(self, /) -> bool: ...
  300. def location(self, /) -> str: ...
  301. def makeAndModel(self, /) -> str: ...
  302. def maximumPhysicalPageSize(self, /) -> PySide6.QtGui.QPageSize: ...
  303. def minimumPhysicalPageSize(self, /) -> PySide6.QtGui.QPageSize: ...
  304. @staticmethod
  305. def printerInfo(printerName: str, /) -> PySide6.QtPrintSupport.QPrinterInfo: ...
  306. def printerName(self, /) -> str: ...
  307. def state(self, /) -> PySide6.QtPrintSupport.QPrinter.PrinterState: ...
  308. def supportedColorModes(self, /) -> typing.List[PySide6.QtPrintSupport.QPrinter.ColorMode]: ...
  309. def supportedDuplexModes(self, /) -> typing.List[PySide6.QtPrintSupport.QPrinter.DuplexMode]: ...
  310. def supportedPageSizes(self, /) -> typing.List[PySide6.QtGui.QPageSize]: ...
  311. def supportedResolutions(self, /) -> typing.List[int]: ...
  312. def supportsCustomPageSizes(self, /) -> bool: ...
  313. # eof