Updated translations manual page with latest status given by the website translations...

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

diff --git a/include/wx/prntbase.h b/include/wx/prntbase.h
index 23b60fca7d581bbf81b90136e573d7a24e062cbc..b1aaee1b2f0bfeccc364f0f9cff11d66d6ffe4a9 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:


@@ -22,22 +22,23 @@
 #include "wx/scrolwin.h"
 #include "wx/dialog.h"
 #include "wx/frame.h"
 #include "wx/scrolwin.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 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;
+#include "wx/dc.h"
+
+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


@@ -54,7 +55,7 @@ enum wxPrinterError
 // wxPrintFactory
 //----------------------------------------------------------------------------
 
 // wxPrintFactory
 //----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPrintFactory
+class WXDLLIMPEXP_CORE wxPrintFactory

 {
 public:
     wxPrintFactory() {}
 {
 public:
     wxPrintFactory() {}


@@ -77,6 +78,8 @@ public:
     virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
                                                           wxPageSetupDialogData * data = NULL ) = 0;
 
     virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
                                                           wxPageSetupDialogData * data = NULL ) = 0;
 

+    virtual wxDCImpl* CreatePrinterDCImpl( wxPrinterDC *owner, 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;
     // 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;


@@ -99,7 +102,7 @@ private:
     static wxPrintFactory *m_factory;
 };
 
     static wxPrintFactory *m_factory;
 };
 

-class WXDLLEXPORT wxNativePrintFactory: public wxPrintFactory
+class WXDLLIMPEXP_CORE wxNativePrintFactory: public wxPrintFactory

 {
 public:
     virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );
 {
 public:
     virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );


@@ -119,6 +122,8 @@ public:
     virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
                                                           wxPageSetupDialogData * data = NULL );
 
     virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
                                                           wxPageSetupDialogData * data = NULL );
 

+    virtual wxDCImpl* CreatePrinterDCImpl( wxPrinterDC *owner, const wxPrintData& data );
+

     virtual bool HasPrintSetupDialog();
     virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data );
     virtual bool HasOwnPrintToFile();
     virtual bool HasPrintSetupDialog();
     virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data );
     virtual bool HasOwnPrintToFile();


@@ -134,7 +139,7 @@ public:
 // wxPrintNativeDataBase
 //----------------------------------------------------------------------------
 
 // wxPrintNativeDataBase
 //----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPrintNativeDataBase: public wxObject
+class WXDLLIMPEXP_CORE wxPrintNativeDataBase: public wxObject

 {
 public:
     wxPrintNativeDataBase();
 {
 public:
     wxPrintNativeDataBase();


@@ -143,7 +148,8 @@ public:
     virtual bool TransferTo( wxPrintData &data ) = 0;
     virtual bool TransferFrom( const wxPrintData &data ) = 0;
 
     virtual bool TransferTo( wxPrintData &data ) = 0;
     virtual bool TransferFrom( const wxPrintData &data ) = 0;
 

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

 
     int  m_ref;
 
 
     int  m_ref;
 


@@ -160,7 +166,7 @@ private:
  * Represents the printer: manages printing a wxPrintout object
  */
 
  * Represents the printer: manages printing a wxPrintout object
  */
 

-class WXDLLEXPORT wxPrinterBase: public wxObject
+class WXDLLIMPEXP_CORE wxPrinterBase: public wxObject

 {
 public:
     wxPrinterBase(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
 {
 public:
     wxPrinterBase(wxPrintDialogData *data = (wxPrintDialogData *) NULL);


@@ -200,7 +206,7 @@ private:
 // wxPrinter
 //----------------------------------------------------------------------------
 
 // wxPrinter
 //----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPrinter: public wxPrinterBase
+class WXDLLIMPEXP_CORE wxPrinter: public wxPrinterBase

 {
 public:
     wxPrinter(wxPrintDialogData *data = (wxPrintDialogData *) NULL);
 {
 public:
     wxPrinter(wxPrintDialogData *data = (wxPrintDialogData *) NULL);


@@ -234,7 +240,7 @@ private:
  * object for previewing.
  */
 
  * object for previewing.
  */
 

-class WXDLLEXPORT wxPrintout: public wxObject
+class WXDLLIMPEXP_CORE wxPrintout: public wxObject

 {
 public:
     wxPrintout(const wxString& title = wxT("Printout"));
 {
 public:
     wxPrintout(const wxString& title = wxT("Printout"));


@@ -256,16 +262,37 @@ 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 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 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 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 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; }


@@ -285,6 +312,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:


@@ -292,12 +321,15 @@ 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.
  */
 

-class WXDLLEXPORT wxPreviewCanvas: public wxScrolledWindow
+class WXDLLIMPEXP_CORE wxPreviewCanvas: public wxScrolledWindow

 {
 public:
     wxPreviewCanvas(wxPrintPreviewBase *preview,
 {
 public:
     wxPreviewCanvas(wxPrintPreviewBase *preview,


@@ -306,7 +338,9 @@ 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 SetPreview(wxPrintPreviewBase *preview) { m_printPreview = preview; }

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


@@ -317,6 +351,7 @@ private:
 #if wxUSE_MOUSEWHEEL
     void OnMouseWheel(wxMouseEvent& event);
 #endif // wxUSE_MOUSEWHEEL
 #if wxUSE_MOUSEWHEEL
     void OnMouseWheel(wxMouseEvent& event);
 #endif // wxUSE_MOUSEWHEEL

+    void OnIdle(wxIdleEvent& event);

 
     wxPrintPreviewBase* m_printPreview;
 
 
     wxPrintPreviewBase* m_printPreview;
 


@@ -325,12 +360,15 @@ private:
     DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
 };
 
     DECLARE_NO_COPY_CLASS(wxPreviewCanvas)
 };
 

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

 /*
 /*

- * wxPreviewFrame

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

-class WXDLLEXPORT wxPreviewFrame: public wxFrame
+class WXDLLIMPEXP_CORE wxPreviewFrame: public wxFrame

 {
 public:
     wxPreviewFrame(wxPrintPreviewBase *preview,
 {
 public:
     wxPreviewFrame(wxPrintPreviewBase *preview,


@@ -339,8 +377,8 @@ public:
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = wxDEFAULT_FRAME_STYLE,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = wxDEFAULT_FRAME_STYLE,

-                   const wxString& name = wxT("frame"));
-    ~wxPreviewFrame();
+                   const wxString& name = wxFrameNameStr);
+    virtual ~wxPreviewFrame();

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


@@ -356,13 +394,18 @@ protected:
     wxWindowDisabler*     m_windowDisabler;
 
 private:
     wxWindowDisabler*     m_windowDisabler;
 
 private:

-    DECLARE_CLASS(wxPreviewFrame)
+    void OnChar(wxKeyEvent& event);
+

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+    DECLARE_CLASS(wxPreviewFrame)

     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.


@@ -389,7 +432,7 @@ private:
 #define wxID_PREVIEW_LAST       7
 #define wxID_PREVIEW_GOTO       8
 
 #define wxID_PREVIEW_LAST       7
 #define wxID_PREVIEW_GOTO       8
 

-class WXDLLEXPORT wxPreviewControlBar: public wxPanel
+class WXDLLIMPEXP_CORE wxPreviewControlBar: public wxPanel

 {
     DECLARE_CLASS(wxPreviewControlBar)
 
 {
     DECLARE_CLASS(wxPreviewControlBar)
 


@@ -401,7 +444,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);


@@ -450,7 +493,7 @@ private:
  * Programmer creates an object of this class to preview a wxPrintout.
  */
 
  * Programmer creates an object of this class to preview a wxPrintout.
  */
 

-class WXDLLEXPORT wxPrintPreviewBase: public wxObject
+class WXDLLIMPEXP_CORE wxPrintPreviewBase: public wxObject

 {
 public:
     wxPrintPreviewBase(wxPrintout *printout,
 {
 public:
     wxPrintPreviewBase(wxPrintout *printout,


@@ -474,9 +517,17 @@ 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);
 

+    // Updates rendered page by calling RenderPage() if needed, returns true
+    // if there was some change. Preview canvas should call it at idle time
+    virtual bool UpdatePageRendering();
+

     // This draws a blank page onto the preview canvas
     virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
 
     // This draws a blank page onto the preview canvas
     virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
 


@@ -495,7 +546,8 @@ public:
     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);
 
     ///////////////////////////////////////////////////////////////////////////


@@ -511,16 +563,26 @@ 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;
     int               m_currentZoom;
     wxPrintout*       m_previewPrintout;
     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;


@@ -542,7 +604,7 @@ private:
 // wxPrintPreview
 //----------------------------------------------------------------------------
 
 // wxPrintPreview
 //----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPrintPreview: public wxPrintPreviewBase
+class WXDLLIMPEXP_CORE wxPrintPreview: public wxPrintPreviewBase

 {
 public:
     wxPrintPreview(wxPrintout *printout,
 {
 public:
     wxPrintPreview(wxPrintout *printout,


@@ -564,10 +626,12 @@ public:
     virtual wxFrame *GetFrame() const;
     virtual wxPreviewCanvas *GetCanvas() const;
     virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
     virtual wxFrame *GetFrame() const;
     virtual wxPreviewCanvas *GetCanvas() const;
     virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);

+    virtual bool UpdatePageRendering();

     virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
     virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
     virtual bool RenderPage(int pageNum);
     virtual void SetZoom(int percent);
     virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
     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();


@@ -577,7 +641,8 @@ public:
     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);
 
 private:
     virtual void SetOk(bool ok);
 
 private:


@@ -592,7 +657,7 @@ private:
 // wxPrintAbortDialog
 //----------------------------------------------------------------------------
 
 // wxPrintAbortDialog
 //----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPrintAbortDialog: public wxDialog
+class WXDLLIMPEXP_CORE wxPrintAbortDialog: public wxDialog

 {
 public:
     wxPrintAbortDialog(wxWindow *parent,
 {
 public:
     wxPrintAbortDialog(wxWindow *parent,