Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / generic / prntdlgg.h

diff --git a/include/wx/generic/prntdlgg.h b/include/wx/generic/prntdlgg.h
index 7793f07367c6093644d3560f0f7802346afbd64a..5271b3891eca24eb0d987024fda1d3a3904c47bd 100644 (file)
--- a/include/wx/generic/prntdlgg.h
+++ b/include/wx/generic/prntdlgg.h
@@ -1,22 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        prntdlgg.h
+// Name:        wx/generic/prntdlgg.h

 // Purpose:     wxGenericPrintDialog, wxGenericPrintSetupDialog,
 //              wxGenericPageSetupDialog
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxGenericPrintDialog, wxGenericPrintSetupDialog,
 //              wxGenericPageSetupDialog
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __PRINTDLGH_G_
 #define __PRINTDLGH_G_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __PRINTDLGH_G_
 #define __PRINTDLGH_G_
 

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

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


@@ -25,25 +21,27 @@
 #include "wx/cmndata.h"
 #include "wx/prntbase.h"
 #include "wx/printdlg.h"
 #include "wx/cmndata.h"
 #include "wx/prntbase.h"
 #include "wx/printdlg.h"

+#include "wx/listctrl.h"

 
 

+#include "wx/dc.h"

 #if wxUSE_POSTSCRIPT
     #include "wx/dcps.h"
 #endif
 
 #if wxUSE_POSTSCRIPT
     #include "wx/dcps.h"
 #endif
 

-class WXDLLEXPORT wxTextCtrl;
-class WXDLLEXPORT wxButton;
-class WXDLLEXPORT wxCheckBox;
-class WXDLLEXPORT wxComboBox;
-class WXDLLEXPORT wxStaticText;
-class WXDLLEXPORT wxRadioBox;
-class WXDLLEXPORT wxPrintSetupData;
-class WXDLLEXPORT wxPageSetupData;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
+class WXDLLIMPEXP_FWD_CORE wxButton;
+class WXDLLIMPEXP_FWD_CORE wxCheckBox;
+class WXDLLIMPEXP_FWD_CORE wxComboBox;
+class WXDLLIMPEXP_FWD_CORE wxStaticText;
+class WXDLLIMPEXP_FWD_CORE wxRadioBox;
+class WXDLLIMPEXP_FWD_CORE wxPageSetupDialogData;

 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 

-// FIXME why all these enums start with 10 or 30?
+// This is not clear why all these enums start with 10 or 30 but do not change it
+// without good reason to avoid some subtle backwards compatibility breakage

 
 enum
 {
 
 enum
 {


@@ -70,7 +68,8 @@ enum
     wxPRINTID_ORIENTATION,
     wxPRINTID_COMMAND,
     wxPRINTID_OPTIONS,
     wxPRINTID_ORIENTATION,
     wxPRINTID_COMMAND,
     wxPRINTID_OPTIONS,

-    wxPRINTID_PAPERSIZE
+    wxPRINTID_PAPERSIZE,
+    wxPRINTID_PRINTER

 };
 
 #if wxUSE_POSTSCRIPT
 };
 
 #if wxUSE_POSTSCRIPT


@@ -79,17 +78,18 @@ enum
 // wxPostScriptNativeData
 //----------------------------------------------------------------------------
 
 // wxPostScriptNativeData
 //----------------------------------------------------------------------------
 

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

 {
 public:
     wxPostScriptPrintNativeData();
     virtual ~wxPostScriptPrintNativeData();
 {
 public:
     wxPostScriptPrintNativeData();
     virtual ~wxPostScriptPrintNativeData();

-    
+

     virtual bool TransferTo( wxPrintData &data );
     virtual bool TransferFrom( const wxPrintData &data );
     virtual bool TransferTo( wxPrintData &data );
     virtual bool TransferFrom( const wxPrintData &data );

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

     const wxString& GetPrinterCommand() const { return m_printerCommand; }
     const wxString& GetPrinterOptions() const { return m_printerOptions; }
     const wxString& GetPreviewCommand() const { return m_previewCommand; }
     const wxString& GetPrinterCommand() const { return m_printerCommand; }
     const wxString& GetPrinterOptions() const { return m_printerOptions; }
     const wxString& GetPreviewCommand() const { return m_previewCommand; }


@@ -98,7 +98,6 @@ public:
     double GetPrinterScaleY() const { return m_printerScaleY; }
     long GetPrinterTranslateX() const { return m_printerTranslateX; }
     long GetPrinterTranslateY() const { return m_printerTranslateY; }
     double GetPrinterScaleY() const { return m_printerScaleY; }
     long GetPrinterTranslateX() const { return m_printerTranslateX; }
     long GetPrinterTranslateY() const { return m_printerTranslateY; }

-    wxPrintMode GetPrintMode() const { return m_printMode; }

 
     void SetPrinterCommand(const wxString& command) { m_printerCommand = command; }
     void SetPrinterOptions(const wxString& options) { m_printerOptions = options; }
 
     void SetPrinterCommand(const wxString& command) { m_printerCommand = command; }
     void SetPrinterOptions(const wxString& options) { m_printerOptions = options; }


@@ -110,7 +109,6 @@ public:
     void SetPrinterTranslateX(long x) { m_printerTranslateX = x; }
     void SetPrinterTranslateY(long y) { m_printerTranslateY = y; }
     void SetPrinterTranslation(long x, long y) { m_printerTranslateX = x; m_printerTranslateY = y; }
     void SetPrinterTranslateX(long x) { m_printerTranslateX = x; }
     void SetPrinterTranslateY(long y) { m_printerTranslateY = y; }
     void SetPrinterTranslation(long x, long y) { m_printerTranslateX = x; m_printerTranslateY = y; }

-    void SetPrintMode(wxPrintMode printMode) { m_printMode = printMode; }

 
 #if wxUSE_STREAMS
     wxOutputStream *GetOutputStream() { return m_outputStream; }
 
 #if wxUSE_STREAMS
     wxOutputStream *GetOutputStream() { return m_outputStream; }


@@ -126,25 +124,24 @@ private:
     double          m_printerScaleY;
     long            m_printerTranslateX;
     long            m_printerTranslateY;
     double          m_printerScaleY;
     long            m_printerTranslateX;
     long            m_printerTranslateY;

-    wxPrintMode     m_printMode;

 #if wxUSE_STREAMS
     wxOutputStream *m_outputStream;
 #endif
 #if wxUSE_STREAMS
     wxOutputStream *m_outputStream;
 #endif

-    
+

 private:
     DECLARE_DYNAMIC_CLASS(wxPostScriptPrintNativeData)
 };
 private:
     DECLARE_DYNAMIC_CLASS(wxPostScriptPrintNativeData)
 };

-    
+

 // ----------------------------------------------------------------------------
 // Simulated Print and Print Setup dialogs for non-Windows platforms (and
 // Windows using PostScript print/preview)
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Simulated Print and Print Setup dialogs for non-Windows platforms (and
 // Windows using PostScript print/preview)
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxGenericPrintDialog : public wxPrintDialogBase
+class WXDLLIMPEXP_CORE wxGenericPrintDialog : public wxPrintDialogBase

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

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

     wxGenericPrintDialog(wxWindow *parent, wxPrintData* data);
 
     virtual ~wxGenericPrintDialog();
     wxGenericPrintDialog(wxWindow *parent, wxPrintData* data);
 
     virtual ~wxGenericPrintDialog();


@@ -158,10 +155,8 @@ public:
 
     virtual int ShowModal();
 
 
     virtual int ShowModal();
 

-#if wxUSE_POSTSCRIPT

     wxPrintData& GetPrintData()
         { return m_printDialogData.GetPrintData(); }
     wxPrintData& GetPrintData()
         { return m_printDialogData.GetPrintData(); }

-#endif // wxUSE_POSTSCRIPT

 
     wxPrintDialogData& GetPrintDialogData() { return m_printDialogData; }
     wxDC *GetPrintDC();
 
     wxPrintDialogData& GetPrintDialogData() { return m_printDialogData; }
     wxDC *GetPrintDC();


@@ -187,54 +182,58 @@ private:
     DECLARE_DYNAMIC_CLASS(wxGenericPrintDialog)
 };
 
     DECLARE_DYNAMIC_CLASS(wxGenericPrintDialog)
 };
 

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

 {
 public:
     // There are no configuration options for the dialog, so we
     // just pass the wxPrintData object (no wxPrintSetupDialogData class needed)
     wxGenericPrintSetupDialog(wxWindow *parent, wxPrintData* data);
 {
 public:
     // There are no configuration options for the dialog, so we
     // just pass the wxPrintData object (no wxPrintSetupDialogData class needed)
     wxGenericPrintSetupDialog(wxWindow *parent, wxPrintData* data);

-    wxGenericPrintSetupDialog(wxWindow *parent, wxPrintSetupData* data);

     virtual ~wxGenericPrintSetupDialog();
 
     void Init(wxPrintData* data);
 
     virtual ~wxGenericPrintSetupDialog();
 
     void Init(wxPrintData* data);
 

+    void OnPrinter(wxListEvent& event);
+

     virtual bool TransferDataFromWindow();
     virtual bool TransferDataToWindow();
 
     virtual bool TransferDataFromWindow();
     virtual bool TransferDataToWindow();
 

-    wxComboBox *CreatePaperTypeChoice(int* x, int* y);
+    virtual wxComboBox *CreatePaperTypeChoice();

 
 public:
 
 public:

+    wxListCtrl*         m_printerListCtrl;

     wxRadioBox*         m_orientationRadioBox;
     wxTextCtrl*         m_printerCommandText;
     wxTextCtrl*         m_printerOptionsText;
     wxCheckBox*         m_colourCheckBox;
     wxRadioBox*         m_orientationRadioBox;
     wxTextCtrl*         m_printerCommandText;
     wxTextCtrl*         m_printerOptionsText;
     wxCheckBox*         m_colourCheckBox;

-    wxComboBox*           m_paperTypeChoice;
+    wxComboBox*         m_paperTypeChoice;

 
 

-#if wxUSE_POSTSCRIPT

     wxPrintData         m_printData;
     wxPrintData&        GetPrintData() { return m_printData; }
     wxPrintData         m_printData;
     wxPrintData&        GetPrintData() { return m_printData; }

-#endif // wxUSE_POSTSCRIPT
+
+    // After pressing OK, write data here.
+    wxPrintData*        m_targetData;

 
 private:
 
 private:

+    DECLARE_EVENT_TABLE()

     DECLARE_CLASS(wxGenericPrintSetupDialog)
 };
 #endif
     // wxUSE_POSTSCRIPT
 
     DECLARE_CLASS(wxGenericPrintSetupDialog)
 };
 #endif
     // wxUSE_POSTSCRIPT
 

-class WXDLLEXPORT wxGenericPageSetupDialog : public wxDialog
+class WXDLLIMPEXP_CORE wxGenericPageSetupDialog : public wxPageSetupDialogBase

 {
 public:
     wxGenericPageSetupDialog(wxWindow *parent = NULL,
 {
 public:
     wxGenericPageSetupDialog(wxWindow *parent = NULL,

-                             wxPageSetupData* data = NULL);
+                             wxPageSetupDialogData* data = NULL);

     virtual ~wxGenericPageSetupDialog();
 
     virtual bool TransferDataFromWindow();
     virtual bool TransferDataToWindow();
 
     virtual ~wxGenericPageSetupDialog();
 
     virtual bool TransferDataFromWindow();
     virtual bool TransferDataToWindow();
 

-    void OnPrinter(wxCommandEvent& event);
+    virtual wxPageSetupDialogData& GetPageSetupDialogData();

 
 

+    void OnPrinter(wxCommandEvent& event);

     wxComboBox *CreatePaperTypeChoice(int* x, int* y);
     wxComboBox *CreatePaperTypeChoice(int* x, int* y);

-    wxPageSetupData& GetPageSetupData() { return m_pageData; }

 
 public:
     wxButton*       m_printerButton;
 
 public:
     wxButton*       m_printerButton;


@@ -245,9 +244,7 @@ public:
     wxTextCtrl*     m_marginBottomText;
     wxComboBox*       m_paperTypeChoice;
 
     wxTextCtrl*     m_marginBottomText;
     wxComboBox*       m_paperTypeChoice;
 

-    static bool     m_pageSetupDialogCancelled;
-
-    wxPageSetupData m_pageData;
+    wxPageSetupDialogData m_pageData;

 
 private:
     DECLARE_EVENT_TABLE()
 
 private:
     DECLARE_EVENT_TABLE()


@@ -257,4 +254,4 @@ private:
 #endif
 
 #endif
 #endif
 
 #endif

-// __PRINTDLGH_G__
+// __PRINTDLGH_G_