// Purpose: interface of wxPreviewControlBar
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
void OnPaint(wxPaintEvent& event);
};
+/**
+ Preview frame modality kind.
+
+ The elements of this enum can be used with wxPreviewFrame::Initialize() to
+ indicate how should the preview frame be shown.
+
+ @since 2.9.2
+*/
+enum wxPreviewFrameModalityKind
+{
+ /**
+ Disable all the other top level windows while the preview frame is shown.
+
+ This is the default behaviour.
+ */
+ wxPreviewFrame_AppModal,
+
+ /**
+ Disable only the parent window while the preview frame is shown.
+ */
+ wxPreviewFrame_WindowModal,
+ /**
+ Show the preview frame non-modally and don't disable any other windows.
+ */
+ wxPreviewFrame_NonModal
+};
/**
@class wxPreviewFrame
Pass a print preview object plus other normal frame arguments.
The print preview object will be destroyed by the frame when it closes.
*/
- wxPreviewFrame(wxPrintPreview* preview, wxWindow* parent,
- const wxString& title,
+ wxPreviewFrame(wxPrintPreviewBase* preview, wxWindow* parent,
+ const wxString& title = "Print Preview",
const wxPoint& pos = wxDefaultPosition,
- const wxSize& size size = wxDefaultSize,
+ const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = "frame");
+ const wxString& name = wxFrameNameStr);
/**
Destructor.
virtual void CreateControlBar();
/**
- Creates the preview canvas and control bar, and calls wxWindow::MakeModal(@true)
- to disable other top-level windows in the application.
+ Initializes the frame elements and prepares for showing it.
- This function should be called by the application prior to showing the frame.
- */
+ Calling this method is equivalent to calling InitializeWithModality()
+ 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.
+ */
virtual void Initialize();
/**
- Enables the other frames in the application, and deletes the print preview
+ 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 @a kind
+ parameter:
+ - If it is wxPreviewFrame_AppModal, all the other application
+ windows will be disabled when this frame is shown. This is the same
+ behaviour as that of simple Initialize().
+ - If it is wxPreviewFrame_WindowModal, only the parent window of
+ the preview frame will be disabled when it is shown.
+ - And if it is wxPreviewFrame_NonModal, no windows at all will be
+ disabled while the preview is shown.
+
+ Notice that this function (or Initialize()) must be called by the
+ application prior to showing the frame but you still must call @c
+ Show(true) to actually show it afterwards.
+
+ @param kind
+ The modality kind of preview frame.
+
+ @since 2.9.2
+ */
+ virtual void InitializeWithModality(wxPreviewFrameModalityKind kind);
+
+ /**
+ Enables any disabled frames in the application, and deletes the print preview
object, implicitly deleting any printout objects associated with the print
preview object.
*/
Use IsOk() to check whether the wxPrintPreview object was created correctly.
*/
wxPrintPreview(wxPrintout* printout,
- wxPrintout* printoutForPrinting,
- wxPrintData* data = NULL);
+ wxPrintout* printoutForPrinting = NULL,
+ wxPrintDialogData* data = NULL);
/**
Destructor.
The implementation simply blits the preview bitmap onto
the canvas, creating a new preview bitmap if none exists.
*/
- bool PaintPage(wxPreviewCanvas* canvas, wxDC dc);
+ virtual bool PaintPage(wxPreviewCanvas* canvas, wxDC& dc);
/**
Invokes the print process using the second wxPrintout object
/**
Sets the current page to be previewed.
*/
- void SetCurrentPage(int pageNum);
+ virtual bool SetCurrentPage(int pageNum);
/**
Sets the frame to be used for displaying the print preview canvas
/**
Creates the default printing abort window, with a cancel button.
*/
- void CreateAbortWindow(wxWindow* parent, wxPrintout* printout);
+ virtual wxWindow* CreateAbortWindow(wxWindow* parent, wxPrintout* printout);
/**
Returns @true if the user has aborted the print job.
context (current printer not set, for example) or the user cancelled printing.
Call GetLastError() to get detailed information about the kind of the error.
*/
- bool Print(wxWindow* parent, wxPrintout* printout,
- bool prompt = true);
+ virtual bool Print(wxWindow* parent, wxPrintout* printout,
+ bool prompt = true);
/**
Invokes the print dialog.
/**
Default error-reporting function.
*/
- void ReportError(wxWindow* parent, wxPrintout* printout,
- const wxString& message);
+ virtual void ReportError(wxWindow* parent, wxPrintout* printout,
+ const wxString& message);
/**
Invokes the print setup dialog.
@beginWxPythonOnly
This method returns the output-only parameters as a tuple.
@endWxPythonOnly
+
+ @beginWxPerlOnly
+ In wxPerl this method takes no arguments and returns a
+ 2-element list (w, h).
+ @endWxPerlOnly
*/
void GetPPIPrinter(int* w, int* h) const;
@beginWxPythonOnly
This method returns the output-only parameters as a tuple.
@endWxPythonOnly
+
+ @beginWxPerlOnly
+ In wxPerl this method takes no arguments and returns a
+ 2-element list (w, h).
+ @endWxPerlOnly
*/
void GetPPIScreen(int* w, int* h) const;
four integers.
@endWxPythonOnly
*/
- void GetPageInfo(int* minPage, int* maxPage, int* pageFrom,
- int* pageTo);
+ virtual void GetPageInfo(int* minPage, int* maxPage, int* pageFrom,
+ int* pageTo);
/**
Returns the size of the printer page in millimetres.
@beginWxPythonOnly
This method returns the output-only parameters as a tuple.
@endWxPythonOnly
+
+ @beginWxPerlOnly
+ In wxPerl this method takes no arguments and returns a
+ 2-element list (w, h).
+ @endWxPerlOnly
*/
void GetPageSizeMM(int* w, int* h) const;
@beginWxPythonOnly
This method returns the output-only parameters as a tuple.
@endWxPythonOnly
+
+ @beginWxPerlOnly
+ In wxPerl this method takes no arguments and returns a
+ 2-element list (w, h).
+ @endWxPerlOnly
*/
void GetPageSizePixels(int* w, int* h) const;
/**
Returns @true if the printout is currently being used for previewing.
+
+ @see GetPreview()
*/
virtual bool IsPreview() const;
+ /**
+ Returns the associated preview object if any.
+
+ If this printout object is used for previewing, returns the associated
+ wxPrintPreview. Otherwise returns @NULL.
+
+ The returned pointer is not owned by the printout and must not be
+ deleted.
+
+ @see IsPreview()
+
+ @since 2.9.1.
+ */
+ wxPrintPreview *GetPreview() const;
+
/**
Set the user scale and device origin of the wxDC associated with this wxPrintout
so that one screen pixel maps to one device pixel on the DC.
void MapScreenSizeToDevice();
/**
- This sets the user scale of the wxDC assocated with this wxPrintout to the same
+ This sets the user scale of the wxDC associated with this wxPrintout to the same
scale as MapScreenSizeToPaper() but sets the logical origin to the top left corner
of the page rectangle.
*/
void MapScreenSizeToPage();
/**
- This sets the user scale of the wxDC assocated with this wxPrintout to the same
+ This sets the user scale of the wxDC associated with this wxPrintout to the same
scale as MapScreenSizeToPageMargins() but sets the logical origin to the top left
corner of the page margins specified by the given wxPageSetupDialogData object.
*/
(It will, of course, be larger or smaller in the preview image, depending on the
zoom factor.)
- Use this if you want WYSIWYG behavior, e.g., in a text editor.
+ Use this if you want WYSIWYG behaviour, e.g., in a text editor.
*/
void MapScreenSizeToPaper();
Called by the framework when a page should be printed. Returning @false cancels
the print job.
*/
- bool OnPrintPage(int pageNum);
+ virtual bool OnPrintPage(int pageNum) = 0;
/**
Set the device origin of the associated wxDC so that the current logical point
projects / wxWidgets.git / blobdiff