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.

See also

wx.PreviewCanvas, wx.PreviewControlBar, wx.PrintPreview

Class Hierarchy

Inheritance diagram for class PreviewFrame:

Methods Summary

__init__	Constructor.
CreateCanvas	Creates a wx.PreviewCanvas.
CreateControlBar	Creates a wx.PreviewControlBar.
GetClassDefaultAttributes
Initialize	Initializes the frame elements and prepares for showing it.
InitializeWithModality	Initializes the frame elements and prepares for showing it with the given modality kind.
OnCloseWindow	Enables any disabled frames in the application, and deletes the print preview object, implicitly deleting any printout objects associated with the print preview object.

Class API

class wx.PreviewFrame(Frame)

Possible constructors:

PreviewFrame(preview : PrintPreview, parent : Window, title:
             str="PrintPreview", pos: Point=DefaultPosition, size: Size=DefaultSize,
             style: int=DEFAULT_FRAME_STYLE, name: str=FrameNameStr) -> None

This class provides the default method of managing the print preview interface.

Methods

__init__(self, preview : PrintPreview, parent : Window, title: str="PrintPreview", pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=DEFAULT_FRAME_STYLE, name: str=FrameNameStr)

Constructor.

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

Note that size typically should not be specified explicitly to let the frame use its default size, adapted to its contents.

Parameters:

• preview (wx.PrintPreview) –

• parent (wx.Window) –

• title (string) –

• pos (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

Return type:

None

---

CreateCanvas(self)

Creates a wx.PreviewCanvas.

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

Return type:

None

---

CreateControlBar(self)

Creates a wx.PreviewControlBar.

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

Return type:

None

---

static GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)

Parameters:

variant (WindowVariant) –

Return type:

wx.VisualAttributes

---

Initialize(self)

Initializes the frame elements and prepares for showing it.

Calling this method is equivalent to calling InitializeWithModality with PreviewFrame_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.

Return type:

None

---

InitializeWithModality(self, kind : PreviewFrameModalityKind)

Initializes the frame elements and prepares for showing it with the given modality kind.

This method creates the frame elements by calling CreateCanvas and CreateControlBar methods (which may be overridden to customize them) and prepares to show the frame according to the value of kind parameter:

• If it is PreviewFrame_AppModal, all the other application windows will be disabled when this frame is shown. This is the same behaviour as that of simple wx.Initialize .

• If it is PreviewFrame_WindowModal, only the parent window of the preview frame will be disabled when it is shown.

• And if it is PreviewFrame_NonModal, no windows at all will be disabled while the preview is shown.

Notice that this function (or wx.Initialize ) must be called by the application prior to showing the frame but you still must call Show(true) to actually show it afterwards.

Parameters:

kind (PreviewFrameModalityKind) – The modality kind of preview frame.

Return type:

None

New in version 2.9.2.

---

OnCloseWindow(self, event : CloseEvent)

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

Parameters:

event (wx.CloseEvent) –

Return type:

None