hiExportImageDialog

hiExportImageDialog(
[ w_window ]
)
=> t / nil

Description

Displays the Export Image dialog box, which lets you take a screen capture of the design contained in the specified window and save it to a standard image format. This function can only be called for graphics windows.

Screen captures taken with this dialog box also capture halos.

Here, the shadow mode—in which unselected objects are dimmed and selected objects are displayed at full brightness in their original layer color instead of the selection color—is ignored. Objects are displayed in their normal colors and brightness in the exported image.

You can save images in any of the formats supported by Qt: BMP, JPG, PNG, PPM, XBM, and XPM. To specify the format, use the appropriate suffix with the filename. Note, however, that PNG is the recommended format; not all features are supported by the other formats.

Argument

w_window

The window containing the design that you want to capture. w_window must be a graphics window.

Value Returned

t	Returns t when the dialog is displayed.
nil	Returns nil if the dialog cannot be displayed. For example, if you specify an invalid window, an error is displayed and the function returns nil.

Example

hiExportImageDialog(window(3))

Related Topics

Screen Capture Functions

hiExportImage

hiWindowSaveImage

Return to top