查看源代码 wxPrinter (wx v2.4.3)

此类表示 Windows 或 PostScript 打印机,并且是应用程序启动打印的媒介。

也可以通过使用较低级别的函数和类来实现打印,但此类及相关类提供了更方便和通用的打印方法。

参见

wxWidgets 文档: wxPrinter

概要

函数

创建带有取消按钮的默认打印中止窗口。

销毁对象

如果用户已中止打印作业,则返回 true。

返回上次错误。

返回与打印机对象关联的打印数据。

等同于 new([])

构造函数。

启动打印过程。

调用打印对话框。

默认的错误报告函数。

调用打印设置对话框。

类型

-type wxPrinter() :: wx:wx_object().

函数

链接到此函数

createAbortWindow(This, Parent, Printout)

查看源代码
-spec createAbortWindow(This, Parent, Printout) -> wxDialog:wxDialog()
                           when
                               This :: wxPrinter(),
                               Parent :: wxWindow:wxWindow(),
                               Printout :: wxPrintout:wxPrintout().

创建带有取消按钮的默认打印中止窗口。

-spec destroy(This :: wxPrinter()) -> ok.

销毁对象

-spec getAbort(This) -> boolean() when This :: wxPrinter().

如果用户已中止打印作业,则返回 true。

-spec getLastError() -> wx:wx_enum().

返回上次错误。

在调用 print/4printDialog/2wxPrintPreview:print/2 后有效。

如果未发生错误,这些函数会将上次错误设置为 wxPRINTER_NO_ERROR

返回值是以下之一

链接到此函数

getPrintDialogData(This)

查看源代码
-spec getPrintDialogData(This) -> wxPrintDialogData:wxPrintDialogData() when This :: wxPrinter().

返回与打印机对象关联的打印数据。

-spec new() -> wxPrinter().

等同于 new([])

-spec new([Option]) -> wxPrinter() when Option :: {data, wxPrintDialogData:wxPrintDialogData()}.

构造函数。

传递一个指向打印对话框数据块的可选指针,该指针将复制到打印机对象的本地数据中。

参见

链接到此函数

print(This, Parent, Printout)

查看源代码
-spec print(This, Parent, Printout) -> boolean()
               when
                   This :: wxPrinter(),
                   Parent :: wxWindow:wxWindow(),
                   Printout :: wxPrintout:wxPrintout().

等同于 print(This, Parent, Printout, [])

-spec print(This, Parent, Printout, [Option]) -> boolean()
               when
                   This :: wxPrinter(),
                   Parent :: wxWindow:wxWindow(),
                   Printout :: wxPrintout:wxPrintout(),
                   Option :: {prompt, boolean()}.

启动打印过程。

提供父窗口、一个用户定义的 wxPrintout 对象(用于控制文档打印)以及是否应首先调用打印对话框。

如果初始化打印机设备上下文时出现问题(例如,未设置当前打印机)或用户取消了打印,则 print/4 可能会返回 false。调用 getLastError/0 以获取有关错误类型的详细信息。

链接到此函数

printDialog(This, Parent)

查看源代码
-spec printDialog(This, Parent) -> wxDC:wxDC() when This :: wxPrinter(), Parent :: wxWindow:wxWindow().

调用打印对话框。

如果成功(用户未按下“取消”且未发生错误),则将返回合适的设备上下文;否则返回 NULL;调用 getLastError/0 以获取有关错误类型的详细信息。

备注:应用程序必须删除此设备上下文以避免内存泄漏。

链接到此函数

reportError(This, Parent, Printout, Message)

查看源代码
-spec reportError(This, Parent, Printout, Message) -> ok
                     when
                         This :: wxPrinter(),
                         Parent :: wxWindow:wxWindow(),
                         Printout :: wxPrintout:wxPrintout(),
                         Message :: unicode:chardata().

默认的错误报告函数。

-spec setup(This, Parent) -> boolean() when This :: wxPrinter(), Parent :: wxWindow:wxWindow().

调用打印设置对话框。

已弃用

设置对话框已过时,但为了向后兼容而保留。