]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/prntbase.h
wxGTK: Implemented wxTLW::RequestUserAttention()
[wxWidgets.git] / include / wx / prntbase.h
index 9e3cd730bcd07c982fb6b7beed21d3eaac78e6ec..290a10851fbef36bc0804f7e981ea8c80a6eb95d 100644 (file)
@@ -5,18 +5,21 @@
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PRNTBASEH__
 #define _WX_PRNTBASEH__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "prntbase.h"
 #endif
 
 #include "wx/defs.h"
+
+#if wxUSE_PRINTING_ARCHITECTURE
+
 #include "wx/event.h"
 #include "wx/cmndata.h"
 #include "wx/panel.h"
@@ -29,11 +32,132 @@ class WXDLLEXPORT wxButton;
 class WXDLLEXPORT wxChoice;
 class WXDLLEXPORT wxPrintout;
 class WXDLLEXPORT wxPrinterBase;
+class WXDLLEXPORT wxPrintDialogBase;
 class WXDLLEXPORT wxPrintDialog;
+class WXDLLEXPORT wxPageSetupDialogBase;
+class WXDLLEXPORT wxPageSetupDialog;
 class WXDLLEXPORT wxPrintPreviewBase;
 class WXDLLEXPORT wxPreviewCanvas;
 class WXDLLEXPORT wxPreviewControlBar;
 class WXDLLEXPORT wxPreviewFrame;
+class WXDLLEXPORT wxPrintFactory;
+class WXDLLEXPORT wxPrintNativeDataBase;
+
+//----------------------------------------------------------------------------
+// error consts
+//----------------------------------------------------------------------------
+
+enum wxPrinterError
+{
+    wxPRINTER_NO_ERROR = 0,
+    wxPRINTER_CANCELLED,
+    wxPRINTER_ERROR
+};
+
+//----------------------------------------------------------------------------
+// wxPrintFactory
+//----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxPrintFactory
+{
+public:
+    wxPrintFactory() {}
+    virtual ~wxPrintFactory() {}
+
+    virtual wxPrinterBase *CreatePrinter( wxPrintDialogData* data ) = 0;
+
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    wxPrintout *printout = NULL,
+                                                    wxPrintDialogData *data = NULL ) = 0;
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    wxPrintout *printout,
+                                                    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;
+
+    // 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 wxPrintFactory *m_factory;
+};
+
+class WXDLLEXPORT wxNativePrintFactory: public wxPrintFactory
+{
+public:
+    virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );
+
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    wxPrintout *printout = NULL,
+                                                    wxPrintDialogData *data = NULL );
+    virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
+                                                    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 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 = 0;
+
+    int  m_ref;
+
+private:
+    DECLARE_CLASS(wxPrintNativeDataBase)
+    DECLARE_NO_COPY_CLASS(wxPrintNativeDataBase)
+};
+
+//----------------------------------------------------------------------------
+// wxPrinterBase
+//----------------------------------------------------------------------------
 
 /*
  * Represents the printer: manages printing a wxPrintout object
@@ -41,37 +165,72 @@ class WXDLLEXPORT wxPreviewFrame;
 
 class WXDLLEXPORT wxPrinterBase: public wxObject
 {
-    DECLARE_CLASS(wxPrinterBase)
-
 public:
     wxPrinterBase(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
     virtual ~wxPrinterBase();
 
     virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
-    virtual void ReportError(wxWindow *parent, wxPrintout *printout, char *message);
+    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; }
+
     ///////////////////////////////////////////////////////////////////////////
     // OVERRIDES
 
     virtual bool Setup(wxWindow *parent) = 0;
-    virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = TRUE) = 0;
+    virtual bool Print(wxWindow *parent, wxPrintout *printout, bool prompt = true) = 0;
     virtual wxDC* PrintDialog(wxWindow *parent) = 0;
 
 protected:
     wxPrintDialogData     m_printDialogData;
     wxPrintout*           m_currentPrintout;
+
+    static wxPrinterError sm_lastError;
+
 public:
     static wxWindow*      sm_abortWindow;
     static bool           sm_abortIt;
 
+private:
+    DECLARE_CLASS(wxPrinterBase)
+    DECLARE_NO_COPY_CLASS(wxPrinterBase)
+};
+
+//----------------------------------------------------------------------------
+// wxPrinter
+//----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxPrinter: public wxPrinterBase
+{
+public:
+    wxPrinter(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+    virtual ~wxPrinter();
+
+    virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPrintout *printout);
+    virtual void ReportError(wxWindow *parent, wxPrintout *printout, const wxString& message);
+
+    virtual bool Setup(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;
+
+private:
+    DECLARE_CLASS(wxPrinter)
+    DECLARE_NO_COPY_CLASS(wxPrinter)
 };
 
+//----------------------------------------------------------------------------
+// wxPrintout
+//----------------------------------------------------------------------------
+
 /*
- * wxPrintout
  * Represents an object via which a document may be printed.
  * The programmer derives from this, overrides (at least) OnPrintPage,
  * and passes it to a wxPrinter object for printing, or a wxPrintPreview
@@ -80,10 +239,8 @@ public:
 
 class WXDLLEXPORT wxPrintout: public wxObject
 {
-DECLARE_ABSTRACT_CLASS(wxPrintout)
-
 public:
-    wxPrintout(const wxString& title = "Printout");
+    wxPrintout(const wxString& title = wxT("Printout"));
     virtual ~wxPrintout();
 
     virtual bool OnBeginDocument(int startPage, int endPage);
@@ -132,6 +289,10 @@ private:
     int              m_PPIPrinterY;
 
     bool             m_isPreview;
+
+private:
+    DECLARE_ABSTRACT_CLASS(wxPrintout)
+    DECLARE_NO_COPY_CLASS(wxPrintout)
 };
 
 /*
@@ -141,26 +302,30 @@ private:
 
 class WXDLLEXPORT wxPreviewCanvas: public wxScrolledWindow
 {
-    DECLARE_CLASS(wxPreviewCanvas)
-
 public:
     wxPreviewCanvas(wxPrintPreviewBase *preview,
                     wxWindow *parent,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = 0,
-                    const wxString& name = "canvas");
+                    const wxString& name = wxT("canvas"));
     ~wxPreviewCanvas();
 
     void OnPaint(wxPaintEvent& event);
-
+    void OnChar(wxKeyEvent &event);
     // 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)
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
 };
 
 /*
@@ -170,16 +335,14 @@ private:
 
 class WXDLLEXPORT wxPreviewFrame: public wxFrame
 {
-    DECLARE_CLASS(wxPreviewFrame)
-
 public:
     wxPreviewFrame(wxPrintPreviewBase *preview,
-                   wxFrame *parent,
-                   const wxString& title = "Print Preview",
+                   wxWindow *parent,
+                   const wxString& title = wxT("Print Preview"),
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = wxDEFAULT_FRAME_STYLE,
-                   const wxString& name = "frame");
+                   const wxString& name = wxT("frame"));
     ~wxPreviewFrame();
 
     void OnCloseWindow(wxCloseEvent& event);
@@ -187,13 +350,18 @@ public:
     virtual void CreateCanvas();
     virtual void CreateControlBar();
 
+    inline wxPreviewControlBar* GetControlBar() const { return m_controlBar; }
+
 protected:
-    wxWindow*             m_previewCanvas;
+    wxPreviewCanvas*      m_previewCanvas;
     wxPreviewControlBar*  m_controlBar;
     wxPrintPreviewBase*   m_printPreview;
+    wxWindowDisabler*     m_windowDisabler;
 
 private:
+    DECLARE_CLASS(wxPreviewFrame)
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxPreviewFrame)
 };
 
 /*
@@ -207,8 +375,12 @@ private:
 #define wxPREVIEW_PREVIOUS     2
 #define wxPREVIEW_NEXT         4
 #define wxPREVIEW_ZOOM         8
+#define wxPREVIEW_FIRST       16
+#define wxPREVIEW_LAST        32
+#define wxPREVIEW_GOTO        64
 
-#define wxPREVIEW_DEFAULT      wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM
+#define wxPREVIEW_DEFAULT  (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
+                            |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)
 
 // Ids for controls
 #define wxID_PREVIEW_CLOSE      1
@@ -216,6 +388,9 @@ private:
 #define wxID_PREVIEW_PREVIOUS   3
 #define wxID_PREVIEW_PRINT      4
 #define wxID_PREVIEW_ZOOM       5
+#define wxID_PREVIEW_FIRST      6
+#define wxID_PREVIEW_LAST       7
+#define wxID_PREVIEW_GOTO       8
 
 class WXDLLEXPORT wxPreviewControlBar: public wxPanel
 {
@@ -227,8 +402,8 @@ public:
                         wxWindow *parent,
                         const wxPoint& pos = wxDefaultPosition,
                         const wxSize& size = wxDefaultSize,
-                        long style = 0,
-                        const wxString& name = "panel");
+                        long style = wxTAB_TRAVERSAL,
+                        const wxString& name = wxT("panel"));
     ~wxPreviewControlBar();
 
     virtual void CreateButtons();
@@ -237,10 +412,19 @@ public:
     virtual wxPrintPreviewBase *GetPrintPreview() const
         { return m_printPreview; }
 
-    void OnPrint(wxCommandEvent& event);
     void OnWindowClose(wxCommandEvent& event);
-    void OnNext(wxCommandEvent& event);
-    void OnPrevious(wxCommandEvent& event);
+    void OnNext();
+    void OnPrevious();
+    void OnFirst();
+    void OnLast();
+    void OnGoto();
+    void OnPrint();
+    void OnPrintButton(wxCommandEvent& WXUNUSED(event)) { OnPrint(); }
+    void OnNextButton(wxCommandEvent & WXUNUSED(event)) { OnNext(); }
+    void OnPreviousButton(wxCommandEvent & WXUNUSED(event)) { OnPrevious(); }
+    void OnFirstButton(wxCommandEvent & WXUNUSED(event)) { OnFirst(); }
+    void OnLastButton(wxCommandEvent & WXUNUSED(event)) { OnLast(); }
+    void OnGotoButton(wxCommandEvent & WXUNUSED(event)) { OnGoto(); }
     void OnZoom(wxCommandEvent& event);
     void OnPaint(wxPaintEvent& event);
 
@@ -251,21 +435,26 @@ protected:
     wxButton*             m_previousPageButton;
     wxButton*             m_printButton;
     wxChoice*             m_zoomControl;
+    wxButton*             m_firstPageButton;
+    wxButton*             m_lastPageButton;
+    wxButton*             m_gotoPageButton;
     long                  m_buttonFlags;
 
 private:
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxPreviewControlBar)
 };
 
+//----------------------------------------------------------------------------
+// wxPrintPreviewBase
+//----------------------------------------------------------------------------
+
 /*
- * wxPrintPreview
  * Programmer creates an object of this class to preview a wxPrintout.
  */
 
 class WXDLLEXPORT wxPrintPreviewBase: public wxObject
 {
-    DECLARE_CLASS(wxPrintPreviewBase)
-
 public:
     wxPrintPreviewBase(wxPrintout *printout,
                        wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
@@ -276,37 +465,41 @@ public:
     virtual ~wxPrintPreviewBase();
 
     virtual bool SetCurrentPage(int pageNum);
-    int GetCurrentPage() const { return m_currentPage; };
+    virtual int GetCurrentPage() const;
 
-    void SetPrintout(wxPrintout *printout) { m_previewPrintout = printout; };
-    wxPrintout *GetPrintout() const { return m_previewPrintout; };
-    wxPrintout *GetPrintoutForPrinting() const { return m_printPrintout; };
+    virtual void SetPrintout(wxPrintout *printout);
+    virtual wxPrintout *GetPrintout() const;
+    virtual wxPrintout *GetPrintoutForPrinting() const;
 
-    void SetFrame(wxFrame *frame) { m_previewFrame = frame; };
-    void SetCanvas(wxWindow *canvas) { m_previewCanvas = canvas; };
+    virtual void SetFrame(wxFrame *frame);
+    virtual void SetCanvas(wxPreviewCanvas *canvas);
 
-    virtual wxFrame *GetFrame() const { return m_previewFrame; }
-    virtual wxWindow *GetCanvas() const { return m_previewCanvas; }
+    virtual wxFrame *GetFrame() const;
+    virtual wxPreviewCanvas *GetCanvas() const;
 
     // The preview canvas should call this from OnPaint
-    virtual bool PaintPage(wxWindow *canvas, wxDC& dc);
+    virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
 
     // This draws a blank page onto the preview canvas
-    virtual bool DrawBlankPage(wxWindow *canvas, wxDC& dc);
+    virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
+
+    // Adjusts the scrollbars for the current scale
+    virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
 
     // This is called by wxPrintPreview to render a page into a wxMemoryDC.
     virtual bool RenderPage(int pageNum);
 
-    wxPrintDialogData& GetPrintDialogData() { return m_printDialogData; }
 
     virtual void SetZoom(int percent);
-    int GetZoom() const { return m_currentZoom; };
+    virtual int GetZoom() const;
 
-    int GetMaxPage() const { return m_maxPage; }
-    int GetMinPage() const { return m_minPage; }
+    virtual wxPrintDialogData& GetPrintDialogData();
 
-    bool Ok() const { return m_isOk; }
-    void SetOk(bool ok) { m_isOk = ok; }
+    virtual int GetMaxPage() const;
+    virtual int GetMinPage() const;
+
+    virtual bool Ok() const;
+    virtual void SetOk(bool ok);
 
     ///////////////////////////////////////////////////////////////////////////
     // OVERRIDES
@@ -323,7 +516,7 @@ public:
 
 protected:
     wxPrintDialogData m_printDialogData;
-    wxWindow*         m_previewCanvas;
+    wxPreviewCanvas*  m_previewCanvas;
     wxFrame*          m_previewFrame;
     wxBitmap*         m_previewBitmap;
     wxPrintout*       m_previewPrintout;
@@ -339,14 +532,68 @@ protected:
     int               m_maxPage;
 
     bool              m_isOk;
+    bool              m_printingPrepared; // Called OnPreparePrinting?
 
 private:
     void Init(wxPrintout *printout, wxPrintout *printoutForPrinting);
+
+    DECLARE_NO_COPY_CLASS(wxPrintPreviewBase)
+    DECLARE_CLASS(wxPrintPreviewBase)
 };
 
-/*
- * Abort dialog
- */
+//----------------------------------------------------------------------------
+// wxPrintPreview
+//----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxPrintPreview: public wxPrintPreviewBase
+{
+public:
+    wxPrintPreview(wxPrintout *printout,
+                   wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
+                   wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+    wxPrintPreview(wxPrintout *printout,
+                   wxPrintout *printoutForPrinting,
+                   wxPrintData *data);
+    virtual ~wxPrintPreview();
+
+    virtual bool SetCurrentPage(int pageNum);
+    virtual int GetCurrentPage() const;
+    virtual void SetPrintout(wxPrintout *printout);
+    virtual wxPrintout *GetPrintout() const;
+    virtual wxPrintout *GetPrintoutForPrinting() const;
+    virtual void SetFrame(wxFrame *frame);
+    virtual void SetCanvas(wxPreviewCanvas *canvas);
+
+    virtual wxFrame *GetFrame() const;
+    virtual wxPreviewCanvas *GetCanvas() const;
+    virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
+    virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
+    virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
+    virtual bool RenderPage(int pageNum);
+    virtual void SetZoom(int percent);
+
+    virtual bool Print(bool interactive);
+    virtual void DetermineScaling();
+
+    virtual wxPrintDialogData& GetPrintDialogData();
+
+    virtual int GetMaxPage() const;
+    virtual int GetMinPage() const;
+
+    virtual bool Ok() const;
+    virtual void SetOk(bool ok);
+
+private:
+    wxPrintPreviewBase *m_pimpl;
+
+private:
+    DECLARE_CLASS(wxPrintPreview)
+    DECLARE_NO_COPY_CLASS(wxPrintPreview)
+};
+
+//----------------------------------------------------------------------------
+// wxPrintAbortDialog
+//----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxPrintAbortDialog: public wxDialog
 {
@@ -356,8 +603,8 @@ public:
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,
                        long style = 0,
-                       const wxString& name = "dialog")
-        : wxDialog(parent, -1, title, pos, size, style, name)
+                       const wxString& name = wxT("dialog"))
+        : wxDialog(parent, wxID_ANY, title, pos, size, style, name)
         {
         }
 
@@ -365,7 +612,10 @@ public:
 
 private:
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxPrintAbortDialog)
 };
 
+#endif // wxUSE_PRINTING_ARCHITECTURE
+
 #endif
     // _WX_PRNTBASEH__