/////////////////////////////////////////////////////////////////////////////
-// Name: prntbase.h
+// Name: wx/prntbase.h
// Purpose: Base classes for printing framework
// Author: Julian Smart
// 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__
-#if defined(__GNUG__) && !defined(__APPLE__)
- #pragma interface "prntbase.h"
-#endif
-
#include "wx/defs.h"
#if wxUSE_PRINTING_ARCHITECTURE
#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 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
+//----------------------------------------------------------------------------
enum wxPrinterError
{
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;
+
+ 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();
+private:
+ 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 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)
+};
+
+//----------------------------------------------------------------------------
+// wxPrinterBase
+//----------------------------------------------------------------------------
/*
* Represents the printer: manages printing a wxPrintout object
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; }
///////////////////////////////////////////////////////////////////////////
// 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
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 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; }
int m_PPIPrinterX;
int m_PPIPrinterY;
+ wxRect m_paperRectPixels;
+
bool m_isPreview;
private:
DECLARE_ABSTRACT_CLASS(wxPrintout)
+ DECLARE_NO_COPY_CLASS(wxPrintout)
};
+//----------------------------------------------------------------------------
+// wxPreviewCanvas
+//----------------------------------------------------------------------------
+
/*
- * wxPreviewCanvas
* Canvas upon which a preview is drawn.
*/
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxT("canvas"));
- ~wxPreviewCanvas();
+ virtual ~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)
};
+//----------------------------------------------------------------------------
+// wxPreviewFrame
+//----------------------------------------------------------------------------
+
/*
- * wxPreviewFrame
* Default frame for showing preview.
*/
{
public:
wxPreviewFrame(wxPrintPreviewBase *preview,
- wxFrame *parent,
+ wxWindow *parent,
const wxString& title = wxT("Print Preview"),
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
const wxString& name = wxT("frame"));
- ~wxPreviewFrame();
+ virtual ~wxPreviewFrame();
void OnCloseWindow(wxCloseEvent& event);
virtual void Initialize();
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)
};
+//----------------------------------------------------------------------------
+// wxPreviewControlBar
+//----------------------------------------------------------------------------
+
/*
- * wxPreviewControlBar
* A panel with buttons for controlling a print preview.
* The programmer may wish to use other means for controlling
* the print preview.
#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
wxWindow *parent,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = 0,
+ long style = wxTAB_TRAVERSAL,
const wxString& name = wxT("panel"));
- ~wxPreviewControlBar();
+ virtual ~wxPreviewControlBar();
virtual void CreateButtons();
virtual void SetZoomControl(int zoom);
virtual wxPrintPreviewBase *GetPrintPreview() const
{ return m_printPreview; }
- void OnPrint(wxCommandEvent& event);
void OnWindowClose(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 OnChar(wxKeyEvent &event);
void OnZoom(wxCommandEvent& event);
void OnPaint(wxPaintEvent& event);
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,
virtual ~wxPrintPreviewBase();
virtual bool SetCurrentPage(int pageNum);
- int GetCurrentPage() const { return m_currentPage; };
+ 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);
- void SetPrintout(wxPrintout *printout) { m_previewPrintout = printout; };
- wxPrintout *GetPrintout() const { return m_previewPrintout; };
- wxPrintout *GetPrintoutForPrinting() const { return m_printPrintout; };
+ virtual wxFrame *GetFrame() const;
+ virtual wxPreviewCanvas *GetCanvas() const;
- void SetFrame(wxFrame *frame) { m_previewFrame = frame; };
- void SetCanvas(wxWindow *canvas) { m_previewCanvas = canvas; };
+ // This is a helper routine, used by the next 4 routines.
- virtual wxFrame *GetFrame() const { return m_previewFrame; }
- virtual wxWindow *GetCanvas() const { return m_previewCanvas; }
+ virtual void CalcRects(wxPreviewCanvas *canvas, wxRect& printableAreaRect, wxRect& paperRect);
// 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;
+
+ virtual wxPrintDialogData& GetPrintDialogData();
- int GetMaxPage() const { return m_maxPage; }
- int GetMinPage() const { return m_minPage; }
+ virtual int GetMaxPage() const;
+ virtual int GetMinPage() const;
- bool Ok() const { return m_isOk; }
- void SetOk(bool ok) { m_isOk = ok; }
+ virtual bool Ok() const { return IsOk(); }
+ virtual bool IsOk() const;
+ virtual void SetOk(bool ok);
///////////////////////////////////////////////////////////////////////////
// OVERRIDES
protected:
wxPrintDialogData m_printDialogData;
- wxWindow* m_previewCanvas;
+ wxPreviewCanvas* m_previewCanvas;
wxFrame* m_previewFrame;
wxBitmap* m_previewBitmap;
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;
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 int GetZoom() const;
+
+ virtual bool Print(bool interactive);
+ virtual void DetermineScaling();
+
+ virtual wxPrintDialogData& GetPrintDialogData();
+
+ virtual int GetMaxPage() const;
+ virtual int GetMinPage() const;
+
+ virtual bool Ok() const { return IsOk(); }
+ virtual bool IsOk() 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
{
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxT("dialog"))
- : wxDialog(parent, -1, title, pos, size, style, name)
+ : wxDialog(parent, wxID_ANY, title, pos, size, style, name)
{
}
private:
DECLARE_EVENT_TABLE()
+ DECLARE_NO_COPY_CLASS(wxPrintAbortDialog)
};
#endif // wxUSE_PRINTING_ARCHITECTURE
projects / wxWidgets.git / blobdiff