Made wxAny::IsNull() doc string a bit clearer

[wxWidgets.git] / include / wx / prntbase.h

diff --git a/include/wx/prntbase.h b/include/wx/prntbase.h
index 011edd1f23d89c3039115d081bf761b142907bb8..8d6f7d246bbc99055c2783a34a5bb80a8ce36344 100644 (file)
--- a/include/wx/prntbase.h
+++ b/include/wx/prntbase.h
@@ -39,6 +39,7 @@ class WXDLLIMPEXP_FWD_CORE wxPreviewControlBar;
 class WXDLLIMPEXP_FWD_CORE wxPreviewFrame;
 class WXDLLIMPEXP_FWD_CORE wxPrintFactory;
 class WXDLLIMPEXP_FWD_CORE wxPrintNativeDataBase;
 class WXDLLIMPEXP_FWD_CORE wxPreviewFrame;
 class WXDLLIMPEXP_FWD_CORE wxPrintFactory;
 class WXDLLIMPEXP_FWD_CORE wxPrintNativeDataBase;

+class WXDLLIMPEXP_FWD_CORE wxPrintPreview;

 
 //----------------------------------------------------------------------------
 // error consts
 
 //----------------------------------------------------------------------------
 // error consts


@@ -155,7 +156,7 @@ public:
 
 private:
     DECLARE_CLASS(wxPrintNativeDataBase)
 
 private:
     DECLARE_CLASS(wxPrintNativeDataBase)

-    DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase)
+    wxDECLARE_NO_COPY_CLASS(wxPrintNativeDataBase);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -169,7 +170,7 @@ private:
 class WXDLLIMPEXP_CORE wxPrinterBase: public wxObject
 {
 public:
 class WXDLLIMPEXP_CORE wxPrinterBase: public wxObject
 {
 public:

-    wxPrinterBase(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+    wxPrinterBase(wxPrintDialogData *data = NULL);

     virtual ~wxPrinterBase();
 
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
     virtual ~wxPrinterBase();
 
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);


@@ -199,7 +200,7 @@ public:
 
 private:
     DECLARE_CLASS(wxPrinterBase)
 
 private:
     DECLARE_CLASS(wxPrinterBase)

-    DECLARE_NO_COPY_CLASS(wxPrinterBase)
+    wxDECLARE_NO_COPY_CLASS(wxPrinterBase);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -209,7 +210,7 @@ private:
 class WXDLLIMPEXP_CORE wxPrinter: public wxPrinterBase
 {
 public:
 class WXDLLIMPEXP_CORE wxPrinter: public wxPrinterBase
 {
 public:

-    wxPrinter(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+    wxPrinter(wxPrintDialogData *data = NULL);

     virtual ~wxPrinter();
 
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
     virtual ~wxPrinter();
 
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);


@@ -226,7 +227,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxPrinter)
 
 private:
     DECLARE_CLASS(wxPrinter)

-    DECLARE_NO_COPY_CLASS(wxPrinter)
+    wxDECLARE_NO_COPY_CLASS(wxPrinter);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -243,7 +244,7 @@ private:
 class WXDLLIMPEXP_CORE wxPrintout: public wxObject
 {
 public:
 class WXDLLIMPEXP_CORE wxPrintout: public wxObject
 {
 public:

-    wxPrintout(const wxString& title = wxT("Printout"));
+    wxPrintout(const wxString& title = _("Printout"));

     virtual ~wxPrintout();
 
     virtual bool OnBeginDocument(int startPage, int endPage);
     virtual ~wxPrintout();
 
     virtual bool OnBeginDocument(int startPage, int endPage);


@@ -284,20 +285,26 @@ public:
     void GetPageSizeMM(int *w, int  *h) const { *w = m_pageWidthMM; *h = m_pageHeightMM; }
 
     void SetPPIScreen(int x, int y) { m_PPIScreenX = x; m_PPIScreenY = y; }
     void GetPageSizeMM(int *w, int  *h) const { *w = m_pageWidthMM; *h = m_pageHeightMM; }
 
     void SetPPIScreen(int x, int y) { m_PPIScreenX = x; m_PPIScreenY = y; }

+    void SetPPIScreen(const wxSize& ppi) { SetPPIScreen(ppi.x, ppi.y); }

     void GetPPIScreen(int *x, int *y) const { *x = m_PPIScreenX; *y = m_PPIScreenY; }
     void SetPPIPrinter(int x, int y) { m_PPIPrinterX = x; m_PPIPrinterY = y; }
     void GetPPIScreen(int *x, int *y) const { *x = m_PPIScreenX; *y = m_PPIScreenY; }
     void SetPPIPrinter(int x, int y) { m_PPIPrinterX = x; m_PPIPrinterY = y; }

+    void SetPPIPrinter(const wxSize& ppi) { SetPPIPrinter(ppi.x, ppi.y); }

     void GetPPIPrinter(int *x, int *y) const { *x = m_PPIPrinterX; *y = m_PPIPrinterY; }
 
     void SetPaperRectPixels(const wxRect& paperRectPixels) { m_paperRectPixels = paperRectPixels; }
     wxRect GetPaperRectPixels() const { return m_paperRectPixels; }
 
     void GetPPIPrinter(int *x, int *y) const { *x = m_PPIPrinterX; *y = m_PPIPrinterY; }
 
     void SetPaperRectPixels(const wxRect& paperRectPixels) { m_paperRectPixels = paperRectPixels; }
     wxRect GetPaperRectPixels() const { return m_paperRectPixels; }
 

-    virtual bool IsPreview() const { return m_isPreview; }
+    // This must be called by wxPrintPreview to associate itself with the
+    // printout it uses.
+    virtual void SetPreview(wxPrintPreview *preview) { m_preview = preview; }

 
 

-    virtual void SetIsPreview(bool p) { m_isPreview = p; }
+    wxPrintPreview *GetPreview() const { return m_preview; }
+    virtual bool IsPreview() const { return GetPreview() != NULL; }

 
 private:
     wxString         m_printoutTitle;
     wxDC*            m_printoutDC;
 
 private:
     wxString         m_printoutTitle;
     wxDC*            m_printoutDC;

+    wxPrintPreview  *m_preview;

 
     int              m_pageWidthPixels;
     int              m_pageHeightPixels;
 
     int              m_pageWidthPixels;
     int              m_pageHeightPixels;


@@ -312,11 +319,9 @@ private:
 
     wxRect           m_paperRectPixels;
 
 
     wxRect           m_paperRectPixels;
 

-    bool             m_isPreview;
-

 private:
     DECLARE_ABSTRACT_CLASS(wxPrintout)
 private:
     DECLARE_ABSTRACT_CLASS(wxPrintout)

-    DECLARE_NO_COPY_CLASS(wxPrintout)
+    wxDECLARE_NO_COPY_CLASS(wxPrintout);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -355,7 +360,7 @@ private:
 
     DECLARE_CLASS(wxPreviewCanvas)
     DECLARE_EVENT_TABLE()
 
     DECLARE_CLASS(wxPreviewCanvas)
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
+    wxDECLARE_NO_COPY_CLASS(wxPreviewCanvas);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -371,11 +376,11 @@ class WXDLLIMPEXP_CORE wxPreviewFrame: public wxFrame
 public:
     wxPreviewFrame(wxPrintPreviewBase *preview,
                    wxWindow *parent,
 public:
     wxPreviewFrame(wxPrintPreviewBase *preview,
                    wxWindow *parent,

-                   const wxString& title = wxT("Print Preview"),
+                   const wxString& title = _("Print Preview"),

                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,

-                   long style = wxDEFAULT_FRAME_STYLE,
-                   const wxString& name = wxT("frame"));
+                   long style = wxDEFAULT_FRAME_STYLE | wxFRAME_FLOAT_ON_PARENT,
+                   const wxString& name = wxFrameNameStr);

     virtual ~wxPreviewFrame();
 
     void OnCloseWindow(wxCloseEvent& event);
     virtual ~wxPreviewFrame();
 
     void OnCloseWindow(wxCloseEvent& event);


@@ -396,7 +401,7 @@ private:
 
     DECLARE_EVENT_TABLE()
     DECLARE_CLASS(wxPreviewFrame)
 
     DECLARE_EVENT_TABLE()
     DECLARE_CLASS(wxPreviewFrame)

-    DECLARE_NO_COPY_CLASS(wxPreviewFrame)
+    wxDECLARE_NO_COPY_CLASS(wxPreviewFrame);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -480,7 +485,7 @@ protected:
 
 private:
     DECLARE_EVENT_TABLE()
 
 private:
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxPreviewControlBar)
+    wxDECLARE_NO_COPY_CLASS(wxPreviewControlBar);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -495,8 +500,8 @@ class WXDLLIMPEXP_CORE wxPrintPreviewBase: public wxObject
 {
 public:
     wxPrintPreviewBase(wxPrintout *printout,
 {
 public:
     wxPrintPreviewBase(wxPrintout *printout,

-                       wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
-                       wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+                       wxPrintout *printoutForPrinting = NULL,
+                       wxPrintDialogData *data = NULL);

     wxPrintPreviewBase(wxPrintout *printout,
                        wxPrintout *printoutForPrinting,
                        wxPrintData *data);
     wxPrintPreviewBase(wxPrintout *printout,
                        wxPrintout *printoutForPrinting,
                        wxPrintData *data);


@@ -561,11 +566,20 @@ public:
     // the currently selected printer.
     virtual void DetermineScaling() = 0;
 
     // the currently selected printer.
     virtual void DetermineScaling() = 0;
 

+protected:
+    // helpers for RenderPage():
+    virtual bool RenderPageIntoDC(wxDC& dc, int pageNum);
+    // renders preview into m_previewBitmap
+    virtual bool RenderPageIntoBitmap(wxBitmap& bmp, int pageNum);
+
+    void InvalidatePreviewBitmap();
+

 protected:
     wxPrintDialogData m_printDialogData;
     wxPreviewCanvas*  m_previewCanvas;
     wxFrame*          m_previewFrame;
     wxBitmap*         m_previewBitmap;
 protected:
     wxPrintDialogData m_printDialogData;
     wxPreviewCanvas*  m_previewCanvas;
     wxFrame*          m_previewFrame;
     wxBitmap*         m_previewBitmap;

+    bool              m_previewFailed;

     wxPrintout*       m_previewPrintout;
     wxPrintout*       m_printPrintout;
     int               m_currentPage;
     wxPrintout*       m_previewPrintout;
     wxPrintout*       m_printPrintout;
     int               m_currentPage;


@@ -585,7 +599,7 @@ protected:
 private:
     void Init(wxPrintout *printout, wxPrintout *printoutForPrinting);
 
 private:
     void Init(wxPrintout *printout, wxPrintout *printoutForPrinting);
 

-    DECLARE_NO_COPY_CLASS(wxPrintPreviewBase)
+    wxDECLARE_NO_COPY_CLASS(wxPrintPreviewBase);

     DECLARE_CLASS(wxPrintPreviewBase)
 };
 
     DECLARE_CLASS(wxPrintPreviewBase)
 };
 


@@ -597,8 +611,8 @@ class WXDLLIMPEXP_CORE wxPrintPreview: public wxPrintPreviewBase
 {
 public:
     wxPrintPreview(wxPrintout *printout,
 {
 public:
     wxPrintPreview(wxPrintout *printout,

-                   wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
-                   wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+                   wxPrintout *printoutForPrinting = NULL,
+                   wxPrintDialogData *data = NULL);

     wxPrintPreview(wxPrintout *printout,
                    wxPrintout *printoutForPrinting,
                    wxPrintData *data);
     wxPrintPreview(wxPrintout *printout,
                    wxPrintout *printoutForPrinting,
                    wxPrintData *data);


@@ -639,7 +653,7 @@ private:
 
 private:
     DECLARE_CLASS(wxPrintPreview)
 
 private:
     DECLARE_CLASS(wxPrintPreview)

-    DECLARE_NO_COPY_CLASS(wxPrintPreview)
+    wxDECLARE_NO_COPY_CLASS(wxPrintPreview);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -663,7 +677,7 @@ public:
 
 private:
     DECLARE_EVENT_TABLE()
 
 private:
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxPrintAbortDialog)
+    wxDECLARE_NO_COPY_CLASS(wxPrintAbortDialog);

 };
 
 #endif // wxUSE_PRINTING_ARCHITECTURE
 };
 
 #endif // wxUSE_PRINTING_ARCHITECTURE