do platform-specific checks after ensuring that the symbols we use are defined; extra...

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

diff --git a/include/wx/prntbase.h b/include/wx/prntbase.h
index 05a2284cf34cde56577b08ba61ba529589306c80..fbeeca80908c3fc4f021f30b4c3ba024bdec3d1c 100644 (file)
--- a/include/wx/prntbase.h
+++ b/include/wx/prntbase.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        prntbase.h
+// Name:        wx/prntbase.h

 // Purpose:     Base classes for printing framework
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     Base classes for printing framework
 // Author:      Julian Smart
 // Modified by:


@@ -12,10 +12,6 @@
 #ifndef _WX_PRNTBASEH__
 #define _WX_PRNTBASEH__
 
 #ifndef _WX_PRNTBASEH__
 #define _WX_PRNTBASEH__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "prntbase.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_PRINTING_ARCHITECTURE
 #include "wx/defs.h"
 
 #if wxUSE_PRINTING_ARCHITECTURE


@@ -27,17 +23,21 @@
 #include "wx/dialog.h"
 #include "wx/frame.h"
 
 #include "wx/dialog.h"
 #include "wx/frame.h"
 

-class WXDLLEXPORT wxDC;
-class WXDLLEXPORT wxButton;
-class WXDLLEXPORT wxChoice;
-class WXDLLEXPORT wxPrintout;
-class WXDLLEXPORT wxPrinterBase;
-class WXDLLEXPORT wxPrintDialog;
-class WXDLLEXPORT wxPrintPreviewBase;
-class WXDLLEXPORT wxPreviewCanvas;
-class WXDLLEXPORT wxPreviewControlBar;
-class WXDLLEXPORT wxPreviewFrame;
-class WXDLLEXPORT wxPrintFactory;
+class WXDLLIMPEXP_FWD_CORE wxDC;
+class WXDLLIMPEXP_FWD_CORE wxButton;
+class WXDLLIMPEXP_FWD_CORE wxChoice;
+class WXDLLIMPEXP_FWD_CORE wxPrintout;
+class WXDLLIMPEXP_FWD_CORE wxPrinterBase;
+class WXDLLIMPEXP_FWD_CORE wxPrintDialogBase;
+class WXDLLIMPEXP_FWD_CORE wxPrintDialog;
+class WXDLLIMPEXP_FWD_CORE wxPageSetupDialogBase;
+class WXDLLIMPEXP_FWD_CORE wxPageSetupDialog;
+class WXDLLIMPEXP_FWD_CORE wxPrintPreviewBase;
+class WXDLLIMPEXP_FWD_CORE wxPreviewCanvas;
+class WXDLLIMPEXP_FWD_CORE wxPreviewControlBar;
+class WXDLLIMPEXP_FWD_CORE wxPreviewFrame;
+class WXDLLIMPEXP_FWD_CORE wxPrintFactory;
+class WXDLLIMPEXP_FWD_CORE wxPrintNativeDataBase;

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


@@ -59,38 +59,102 @@ class WXDLLEXPORT wxPrintFactory
 public:
     wxPrintFactory() {}
     virtual ~wxPrintFactory() {}
 public:
     wxPrintFactory() {}
     virtual ~wxPrintFactory() {}

-    
-    virtual bool HasPageSetupDialog() = 0;
-    virtual bool HasPrintSetupDialog() = 0;
-    
+

     virtual wxPrinterBase *CreatePrinter( wxPrintDialogData* data ) = 0;
     virtual wxPrinterBase *CreatePrinter( wxPrintDialogData* data ) = 0;

-    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview, 
-                                                    wxPrintout *printout = NULL, 
+
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    wxPrintout *printout = NULL,

                                                     wxPrintDialogData *data = NULL ) = 0;
                                                     wxPrintDialogData *data = NULL ) = 0;

-    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview, 
-                                                    wxPrintout *printout, 
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    wxPrintout *printout,

                                                     wxPrintData *data ) = 0;
                                                     wxPrintData *data ) = 0;

-    
+
+    virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
+                                                  wxPrintDialogData *data = NULL ) = 0;
+    virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
+                                                  wxPrintData *data ) = 0;
+
+    virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
+                                                          wxPageSetupDialogData * data = NULL ) = 0;
+
+    virtual wxDC* CreatePrinterDC( const wxPrintData& data ) = 0;
+
+    // What to do and what to show in the wxPrintDialog
+    // a) Use the generic print setup dialog or a native one?
+    virtual bool HasPrintSetupDialog() = 0;
+    virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data ) = 0;
+    // b) Provide the "print to file" option ourselves or via print setup?
+    virtual bool HasOwnPrintToFile() = 0;
+    // c) Show current printer
+    virtual bool HasPrinterLine() = 0;
+    virtual wxString CreatePrinterLine() = 0;
+    // d) Show Status line for current printer?
+    virtual bool HasStatusLine() = 0;
+    virtual wxString CreateStatusLine() = 0;
+
+
+    virtual wxPrintNativeDataBase *CreatePrintNativeData() = 0;
+

     static void SetPrintFactory( wxPrintFactory *factory );
     static wxPrintFactory *GetFactory();
     static void SetPrintFactory( wxPrintFactory *factory );
     static wxPrintFactory *GetFactory();

+private:

     static wxPrintFactory *m_factory;
 };
 
 class WXDLLEXPORT wxNativePrintFactory: public wxPrintFactory
 {
 public:
     static wxPrintFactory *m_factory;
 };
 
 class WXDLLEXPORT wxNativePrintFactory: public wxPrintFactory
 {
 public:

-    virtual bool HasPageSetupDialog() 
-        { return true; }
-    virtual bool HasPrintSetupDialog() 
-        { return true; }
-    

     virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );
     virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );

-    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview, 
-                                                    wxPrintout *printout = NULL, 
+
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    wxPrintout *printout = NULL,

                                                     wxPrintDialogData *data = NULL );
                                                     wxPrintDialogData *data = NULL );

-    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview, 
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,

                                                     wxPrintout *printout,
                                                     wxPrintData *data );
                                                     wxPrintout *printout,
                                                     wxPrintData *data );

+
+    virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
+                                                  wxPrintDialogData *data = NULL );
+    virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
+                                                  wxPrintData *data );
+
+    virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
+                                                          wxPageSetupDialogData * data = NULL );
+
+    virtual wxDC* CreatePrinterDC( const wxPrintData& data );
+
+    virtual bool HasPrintSetupDialog();
+    virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data );
+    virtual bool HasOwnPrintToFile();
+    virtual bool HasPrinterLine();
+    virtual wxString CreatePrinterLine();
+    virtual bool HasStatusLine();
+    virtual wxString CreateStatusLine();
+
+    virtual wxPrintNativeDataBase *CreatePrintNativeData();
+};
+
+//----------------------------------------------------------------------------
+// wxPrintNativeDataBase
+//----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxPrintNativeDataBase: public wxObject
+{
+public:
+    wxPrintNativeDataBase();
+    virtual ~wxPrintNativeDataBase() {}
+
+    virtual bool TransferTo( wxPrintData &data ) = 0;
+    virtual bool TransferFrom( const wxPrintData &data ) = 0;
+
+    virtual bool Ok() const { return IsOk(); }
+    virtual bool IsOk() const = 0;
+
+    int  m_ref;
+
+private:
+    DECLARE_CLASS(wxPrintNativeDataBase)
+    DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase)

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


@@ -110,8 +174,7 @@ public:
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
     virtual void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message);
 
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
     virtual void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message);
 

-    wxPrintDialogData& GetPrintDialogData() const
-        { return (wxPrintDialogData&) m_printDialogData; }
+    virtual wxPrintDialogData& GetPrintDialogData() const;

     bool GetAbort() const { return sm_abortIt; }
 
     static wxPrinterError GetLastError() { return sm_lastError; }
     bool GetAbort() const { return sm_abortIt; }
 
     static wxPrinterError GetLastError() { return sm_lastError; }


@@ -155,9 +218,11 @@ public:
     virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = true);
     virtual wxDC* PrintDialog(wxWindow *parent);
 
     virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = true);
     virtual wxDC* PrintDialog(wxWindow *parent);
 

+    virtual wxPrintDialogData& GetPrintDialogData() const;
+

 protected:
     wxPrinterBase    *m_pimpl;
 protected:
     wxPrinterBase    *m_pimpl;

-    
+

 private:
     DECLARE_CLASS(wxPrinter)
     DECLARE_NO_COPY_CLASS(wxPrinter)
 private:
     DECLARE_CLASS(wxPrinter)
     DECLARE_NO_COPY_CLASS(wxPrinter)


@@ -196,6 +261,22 @@ public:
 
     wxDC *GetDC() const { return m_printoutDC; }
     void SetDC(wxDC *dc) { m_printoutDC = dc; }
 
     wxDC *GetDC() const { return m_printoutDC; }
     void SetDC(wxDC *dc) { m_printoutDC = dc; }

+
+    void FitThisSizeToPaper(const wxSize& imageSize);
+    void FitThisSizeToPage(const wxSize& imageSize);
+    void FitThisSizeToPageMargins(const wxSize& imageSize, const wxPageSetupDialogData& pageSetupData);
+    void MapScreenSizeToPaper();
+    void MapScreenSizeToPage();
+    void MapScreenSizeToPageMargins(const wxPageSetupDialogData& pageSetupData);
+    void MapScreenSizeToDevice();
+
+    wxRect GetLogicalPaperRect() const;
+    wxRect GetLogicalPageRect() const;
+    wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData) const;
+
+    void SetLogicalOrigin(wxCoord x, wxCoord y);
+    void OffsetLogicalOrigin(wxCoord xoff, wxCoord yoff);
+

     void SetPageSizePixels(int w, int  h) { m_pageWidthPixels = w; m_pageHeightPixels = h; }
     void GetPageSizePixels(int *w, int  *h) const { *w = m_pageWidthPixels; *h = m_pageHeightPixels; }
     void SetPageSizeMM(int w, int  h) { m_pageWidthMM = w; m_pageHeightMM = h; }
     void SetPageSizePixels(int w, int  h) { m_pageWidthPixels = w; m_pageHeightPixels = h; }
     void GetPageSizePixels(int *w, int  *h) const { *w = m_pageWidthPixels; *h = m_pageHeightPixels; }
     void SetPageSizeMM(int w, int  h) { m_pageWidthMM = w; m_pageHeightMM = h; }


@@ -206,6 +287,9 @@ public:
     void SetPPIPrinter(int x, int y) { m_PPIPrinterX = x; m_PPIPrinterY = y; }
     void GetPPIPrinter(int *x, int *y) const { *x = m_PPIPrinterX; *y = m_PPIPrinterY; }
 
     void SetPPIPrinter(int x, int y) { m_PPIPrinterX = x; m_PPIPrinterY = 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; }
+

     virtual bool IsPreview() const { return m_isPreview; }
 
     virtual void SetIsPreview(bool p) { m_isPreview = p; }
     virtual bool IsPreview() const { return m_isPreview; }
 
     virtual void SetIsPreview(bool p) { m_isPreview = p; }


@@ -225,6 +309,8 @@ private:
     int              m_PPIPrinterX;
     int              m_PPIPrinterY;
 
     int              m_PPIPrinterX;
     int              m_PPIPrinterY;
 

+    wxRect           m_paperRectPixels;
+

     bool             m_isPreview;
 
 private:
     bool             m_isPreview;
 
 private:


@@ -232,8 +318,11 @@ private:
     DECLARE_NO_COPY_CLASS(wxPrintout)
 };
 
     DECLARE_NO_COPY_CLASS(wxPrintout)
 };
 

+//----------------------------------------------------------------------------
+// wxPreviewCanvas
+//----------------------------------------------------------------------------
+

 /*
 /*

- * wxPreviewCanvas

  * Canvas upon which a preview is drawn.
  */
 
  * Canvas upon which a preview is drawn.
  */
 


@@ -246,15 +335,18 @@ public:
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
                     const wxString& name = wxT("canvas"));
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
                     const wxString& name = wxT("canvas"));

-    ~wxPreviewCanvas();
+    virtual ~wxPreviewCanvas();

 
     void OnPaint(wxPaintEvent& event);
     void OnChar(wxKeyEvent &event);
 
     void OnPaint(wxPaintEvent& event);
     void OnChar(wxKeyEvent &event);

-

     // Responds to colour changes
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
 private:
     // Responds to colour changes
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
 private:

+#if wxUSE_MOUSEWHEEL
+    void OnMouseWheel(wxMouseEvent& event);
+#endif // wxUSE_MOUSEWHEEL
+

     wxPrintPreviewBase* m_printPreview;
 
     DECLARE_CLASS(wxPreviewCanvas)
     wxPrintPreviewBase* m_printPreview;
 
     DECLARE_CLASS(wxPreviewCanvas)


@@ -262,8 +354,11 @@ private:
     DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
 };
 
     DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
 };
 

+//----------------------------------------------------------------------------
+// wxPreviewFrame
+//----------------------------------------------------------------------------
+

 /*
 /*

- * wxPreviewFrame

  * Default frame for showing preview.
  */
 
  * Default frame for showing preview.
  */
 


@@ -277,7 +372,7 @@ public:
                    const wxSize& size = wxDefaultSize,
                    long style = wxDEFAULT_FRAME_STYLE,
                    const wxString& name = wxT("frame"));
                    const wxSize& size = wxDefaultSize,
                    long style = wxDEFAULT_FRAME_STYLE,
                    const wxString& name = wxT("frame"));

-    ~wxPreviewFrame();
+    virtual ~wxPreviewFrame();

 
     void OnCloseWindow(wxCloseEvent& event);
     virtual void Initialize();
 
     void OnCloseWindow(wxCloseEvent& event);
     virtual void Initialize();


@@ -298,8 +393,11 @@ private:
     DECLARE_NO_COPY_CLASS(wxPreviewFrame)
 };
 
     DECLARE_NO_COPY_CLASS(wxPreviewFrame)
 };
 

+//----------------------------------------------------------------------------
+// wxPreviewControlBar
+//----------------------------------------------------------------------------
+

 /*
 /*

- * wxPreviewControlBar

  * A panel with buttons for controlling a print preview.
  * The programmer may wish to use other means for controlling
  * the print preview.
  * A panel with buttons for controlling a print preview.
  * The programmer may wish to use other means for controlling
  * the print preview.


@@ -313,8 +411,8 @@ private:
 #define wxPREVIEW_LAST        32
 #define wxPREVIEW_GOTO        64
 
 #define wxPREVIEW_LAST        32
 #define wxPREVIEW_GOTO        64
 

-#define wxPREVIEW_DEFAULT  wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
-                          |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST
+#define wxPREVIEW_DEFAULT  (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
+                            |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)

 
 // Ids for controls
 #define wxID_PREVIEW_CLOSE      1
 
 // Ids for controls
 #define wxID_PREVIEW_CLOSE      1


@@ -338,7 +436,7 @@ public:
                         const wxSize& size = wxDefaultSize,
                         long style = wxTAB_TRAVERSAL,
                         const wxString& name = wxT("panel"));
                         const wxSize& size = wxDefaultSize,
                         long style = wxTAB_TRAVERSAL,
                         const wxString& name = wxT("panel"));

-    ~wxPreviewControlBar();
+    virtual ~wxPreviewControlBar();

 
     virtual void CreateButtons();
     virtual void SetZoomControl(int zoom);
 
     virtual void CreateButtons();
     virtual void SetZoomControl(int zoom);


@@ -411,6 +509,10 @@ public:
     virtual wxFrame *GetFrame() const;
     virtual wxPreviewCanvas *GetCanvas() const;
 
     virtual wxFrame *GetFrame() const;
     virtual wxPreviewCanvas *GetCanvas() const;
 

+    // This is a helper routine, used by the next 4 routines.
+
+    virtual void CalcRects(wxPreviewCanvas *canvas, wxRect& printableAreaRect, wxRect& paperRect);
+

     // The preview canvas should call this from OnPaint
     virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
 
     // The preview canvas should call this from OnPaint
     virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
 


@@ -428,11 +530,12 @@ public:
     virtual int GetZoom() const;
 
     virtual wxPrintDialogData& GetPrintDialogData();
     virtual int GetZoom() const;
 
     virtual wxPrintDialogData& GetPrintDialogData();

-    
+

     virtual int GetMaxPage() const;
     virtual int GetMinPage() const;
 
     virtual int GetMaxPage() const;
     virtual int GetMinPage() const;
 

-    virtual bool Ok() const;
+    virtual bool Ok() const { return IsOk(); }
+    virtual bool IsOk() const;

     virtual void SetOk(bool ok);
 
     ///////////////////////////////////////////////////////////////////////////
     virtual void SetOk(bool ok);
 
     ///////////////////////////////////////////////////////////////////////////


@@ -457,7 +560,8 @@ protected:
     wxPrintout*       m_printPrintout;
     int               m_currentPage;
     int               m_currentZoom;
     wxPrintout*       m_printPrintout;
     int               m_currentPage;
     int               m_currentZoom;

-    float             m_previewScale;
+    float             m_previewScaleX;
+    float             m_previewScaleY;

     int               m_topMargin;
     int               m_leftMargin;
     int               m_pageWidth;
     int               m_topMargin;
     int               m_leftMargin;
     int               m_pageWidth;


@@ -505,18 +609,20 @@ public:
     virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
     virtual bool RenderPage(int pageNum);
     virtual void SetZoom(int percent);
     virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
     virtual bool RenderPage(int pageNum);
     virtual void SetZoom(int percent);

+    virtual int GetZoom() const;

 
     virtual bool Print(bool interactive);
     virtual void DetermineScaling();
 
     virtual bool Print(bool interactive);
     virtual void DetermineScaling();

-    
+

     virtual wxPrintDialogData& GetPrintDialogData();
     virtual wxPrintDialogData& GetPrintDialogData();

-    
+

     virtual int GetMaxPage() const;
     virtual int GetMinPage() const;
 
     virtual int GetMaxPage() const;
     virtual int GetMinPage() const;
 

-    virtual bool Ok() const;
+    virtual bool Ok() const { return IsOk(); }
+    virtual bool IsOk() const;

     virtual void SetOk(bool ok);
     virtual void SetOk(bool ok);

-    
+

 private:
     wxPrintPreviewBase *m_pimpl;
 
 private:
     wxPrintPreviewBase *m_pimpl;