QPrintEngine 类
QPrintEngine 类定义了 QPrinter 与特定打印子系统的交互接口。 更多...
头文件 | #include <QPrintEngine> |
CMake | find_package(Qt6 REQUIRED COMPONENTS PrintSupport) target_link_libraries(mytarget PRIVATE Qt6::PrintSupport) |
qmake | QT += printsupport |
- 所有成员列表,包括继承的成员
- QPrintEngine 是打印机与打印 API 的一部分。
注意:此类中的所有函数都是可重入的。
公共类型
枚举 | PrintEnginePropertyKey { PPK_CollateCopies, PPK_ColorMode, PPK_Creator, PPK_Duplex, PPK_DocumentName, …, PPK_CustomBase } |
公共函数
虚拟 | ~QPrintEngine() |
虚拟 bool | abort() = 0 |
虚拟 int | metric(QPaintDevice::PaintDeviceMetric id) const = 0 |
虚拟 bool | newPage() = 0 |
虚拟 QPrinter::PrinterState | printerState() const = 0 |
虚拟 QVariant | property(QPrintEngine::PrintEnginePropertyKey key) const = 0 |
虚拟 void | setProperty(QPrintEngine::PrintEnginePropertyKey key, const QVariant &value) = 0 |
详细说明
创建自己的打印引擎时常见的做法是从 QPaintEngine 和 QPrintEngine 中派生。打印引擎的各种属性可以通过 property() 获取,并通过 setProperty() 设置。
另请参阅:QPaintEngine。
成员类型文档
enum QPrintEngine::PrintEnginePropertyKey
此枚举用于在打印引擎和 QPrinter 之间传递属性。给定的打印引擎可能支持或不支持某个属性。
常量 | 值 | 描述 |
---|---|---|
QPrintEngine::PPK_CollateCopies | 0 | 一个布尔值,表示是否应该对打印输出进行排序。 |
QPrintEngine::PPK_ColorMode | 1 | 指 QPrinter::ColorMode,可以是彩色或单色。 |
QPrintEngine::PPK_Creator | 2 | 一个描述文档创建者的字符串。 |
QPrintEngine::PPK_Duplex | 20 | 一个布尔值,表示是否应使用打印机纸张的两侧进行打印。 |
QPrintEngine::PPK_DocumentName | 3 | 一个描述打印队列中文档名称的字符串。 |
QPrintEngine::PPK_FontEmbedding | 19 | 一个布尔值,表示是否应将文档字体数据嵌入到发送给打印机的数据中。 |
QPrintEngine::PPK_FullPage | 4 | 一个布尔值,描述打印机是否应该打印整页。 |
QPrintEngine::PPK_NumberOfCopies | 5 | 已弃用。一个整数,用于指定打印副本数量。请使用PPK_CopyCount代替。 |
QPrintEngine::PPK_Orientation | 6 | 指定一个QPageLayout::Orientation值。 |
QPrintEngine::PPK_OutputFileName | 7 | 输出文件名,作为字符串。空文件名表示打印机不应该打印到文件。 |
QPrintEngine::PPK_PageOrder | 8 | 指定一个QPrinter::PageOrder值。 |
QPrintEngine::PPK_PageRect | 9 | 一个QRect,用于指定页面矩形。 |
QPrintEngine::PPK_PageSize | 10 | 已弃用。请使用PPK_PaperSize。 |
QPrintEngine::PPK_PaperRect | 11 | 一个QRect,用于指定纸张矩形。 |
QPrintEngine::PPK_PaperSource | 12 | 指定一个QPrinter::PaperSource值。 |
QPrintEngine::PPK_PaperSources | 21 | 指定多个QPrinter::PaperSource值。 |
QPrintEngine::PPK_PaperName | 26 | 一个字符串,指定纸张名称。 |
QPrintEngine::PPK_PaperSize | PPK_PageSize | 指定一个QPrinter::PaperSize值。 |
QPrintEngine::PPK_PrinterName | 13 | 一个字符串,指定打印机名称。 |
QPrintEngine::PPK_PrinterProgram | 14 | 一个字符串,指定用于打印的打印机程序名称。 |
QPrintEngine::PPK_Resolution | 15 | 一个整数,表示此打印机的每英寸点数。 |
QPrintEngine::PPK_SelectionOption | 16 | |
QPrintEngine::PPK_SupportedResolutions | 17 | 一个整数QVariants列表,描述打印机支持的分辨率集合。 |
QPrintEngine::PPK_WindowsPageSize | 18 | 一个整数,指定Windows上的DM_PAPER条目。 |
QPrintEngine::PPK_CustomPaperSize | 22 | 一个QSizeF,用于指定以QPrinter::Point单位定义的自定义纸张大小。 |
QPrintEngine::PPK_PageMargins | 23 | 一个QList<QVariant>,包含左、上、右和下页边距值,单位为QPrinter::Point。 |
QPrintEngine::PPK_CopyCount | 24 | 一个整数,指定要打印的副本数量。 |
QPrintEngine::PPK_SupportsMultipleCopies | 25 | 一个布尔值,指示打印机是否支持一次性打印多份。 |
QPrintEngine::PPK_QPageSize | 27 | 使用QPageSize对象设置页面大小。 |
QPrintEngine::PPK_QPageMargins | 28 | 使用QPair(QMarginsF和QPageLayout::Unit)设置页面边距。 |
QPrintEngine::PPK_QPageLayout | 29 | 使用QPageLayout对象设置页面布局。 |
QPrintEngine::PPK_CustomBase | 0xff00 | 扩展的基础。 |
成员函数文档
[virtual noexcept]
QPrintEngine::~QPrintEngine()
销毁打印引擎。
[pure virtual]
bool QPrintEngine::abort()
指示打印引擎终止打印过程。如果成功则返回true;否则返回false。
[pure virtual]
int QPrintEngine::metric(QPaintDevice::PaintDeviceMetric id) const
返回指定id的度量。
[pure virtual]
bool QPrintEngine::newPage()
指令打印引擎开始新的一页。如果打印机能够创建新页面,则返回true
,否则返回false
。
[纯虚函数]
QPrinter::PrinterState QPrintEngine::printerState() const
返回打印引擎正在使用的打印机的当前状态。
[纯虚函数]
QVariant QPrintEngine::property(QPrintEngine::PrintEnginePropertyKey key) const
返回由键指定的打印引擎属性。
另请参阅setProperty()。
[纯虚函数]
void QPrintEngine::setProperty(QPrintEngine::PrintEnginePropertyKey key, const QVariant &value)
将由键指定的打印引擎属性设置为给定的值。
另请参阅property()。
© 2024 Qt公司有限公司。本文件中包含的文档贡献是相应所有者的版权。本文件中提供的文档按照自由软件基金会发布的 GNU自由文档许可证版本1.3 的条款授权。Qt和相应的商标是芬兰及其它国家的Qt公司商标。所有其他商标均为其所有者财产。