wxRuby Documentation Home

# Wx::PreviewFrame

This class provides the default method of managing the print preview interface.
Member functions may be overridden to replace functionality, or the
class may be used without derivation.

## Derived from

Frame

Window

EvtHandler

Object

## See also

PreviewCanvas, PreviewControlBar, PrintPreview

## Methods

- PreviewFrame.new
- PreviewFrame#create_control_bar
- PreviewFrame#create_canvas
- PreviewFrame#init
- PreviewFrame#on_close_window

### PreviewFrame.new

PreviewFrame.new(%(arg-type)PrintPreview% preview, Window parent, String title, Point pos = DEFAULT_POSITION, Size size size = DEFAULT_SIZE, Integer style = DEFAULT_FRAME_STYLE, String name = “frame”)

Constructor. Pass a print preview object plus other normal frame arguments.
The print preview object will be destroyed by the frame when it closes.

destructor()

Destructor.

### PreviewFrame#create_control_bar

create_control_bar()

Creates a PreviewControlBar. Override this function to allow
a user-defined preview control bar object to be created.

### PreviewFrame#create_canvas

create_canvas()

Creates a PreviewCanvas. Override this function to allow
a user-defined preview canvas object to be created.

### PreviewFrame#init

init()

Creates the preview canvas and control bar, and calls
Window::make_modal(true) to disable other top-level windows
in the application.

This function should be called by the application prior to
showing the frame.

#### Remarks

This method is called initialize() in the C++ implementation of wxWidgets in wxRuby
this had to be changed to init() because of the conflict with Ruby’s built in initialize().

### PreviewFrame#on_close_window

on_close_window(%(arg-type)CloseEvent% event)

Enables the other frames in the application, and deletes the print preview
object, implicitly deleting any printout objects associated with the print
preview object.

[This page automatically generated from the Textile source at 2023-06-09 00:45:35 +0000]