wxPreviewFrame — wx v2.5.4

Search documentation of wx

# wxPreviewFrame (wx v2.5.4)

View Source

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.

See:

- `wxPreviewCanvas`

- `wxPreviewControlBar`

- `wxPrintPreview`

This class is derived, and can use functions, from:

- `wxFrame`

- `wxTopLevelWindow`

- `wxWindow`

- `wxEvtHandler`

wxWidgets docs: wxPreviewFrame

# Summary

## Types

wxPreviewFrame()

## Functions

createCanvas(This)

Creates a `wxPreviewCanvas`.

createControlBar(This)

Creates a `wxPreviewControlBar`.

destroy(This)

Destroys the object

initialize(This)

Initializes the frame elements and prepares for showing it.

new(Preview, Parent)

Equivalent to `new(Preview, Parent, [])`.

new/3

Constructor.

onCloseWindow(This, Event)

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

# Types

# wxPreviewFrame()

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

# Functions

# createCanvas(This)

    -spec createCanvas(This) -> ok when This :: wxPreviewFrame().

Creates a `wxPreviewCanvas`.

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

# createControlBar(This)

    -spec createControlBar(This) -> ok when This :: wxPreviewFrame().

Creates a `wxPreviewControlBar`.

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

# destroy(This)

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

Destroys the object

# initialize(This)

    -spec initialize(This) -> ok when This :: wxPreviewFrame().

Initializes the frame elements and prepares for showing it.

Calling this method is equivalent to calling `InitializeWithModality()` (not implemented in wx) with wxPreviewFrame_AppModal argument, please see its documentation for more details.

Please notice that this function is virtual mostly for backwards compatibility only, there is no real need to override it as it's never called by wxWidgets itself.

# new(Preview, Parent)

    -spec new(Preview, Parent) -> wxPreviewFrame()
                 when Preview :: wxPrintPreview:wxPrintPreview(), Parent :: wxWindow:wxWindow().

Equivalent to `new(Preview, Parent, [])`.

# new/3

    -spec new(Preview, Parent, [Option]) -> wxPreviewFrame()
                 when
                     Preview :: wxPrintPreview:wxPrintPreview(),
                     Parent :: wxWindow:wxWindow(),
                     Option ::
                         {title, unicode:chardata()} |
                         {pos, {X :: integer(), Y :: integer()}} |
                         {size, {W :: integer(), H :: integer()}} |
                         {style, integer()}.

Constructor.

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

# onCloseWindow(This, Event)

    -spec onCloseWindow(This, Event) -> ok
                           when This :: wxPreviewFrame(), Event :: wxCloseEvent:wxCloseEvent().

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