]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/cmndata.h
just a change in comment for wxUSE_MS_HTML_HELP
[wxWidgets.git] / include / wx / cmndata.h
index 61f5a204bdae31d108061fd2c7acd4c98248c89d..2af5f9e2e3d52c5afb37d7414e89c5a7c941d1d8 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        cmndata.h
+// Name:        wx/cmndata.h
 // Purpose:     Common GDI data classes
 // Author:      Julian Smart and others
 // Modified by:
 #ifndef _WX_CMNDATA_H_BASE_
 #define _WX_CMNDATA_H_BASE_
 
-#ifdef __GNUG__
-#pragma interface "cmndata.h"
-#endif
-
 #include "wx/window.h"
 #include "wx/font.h"
+#include "wx/encinfo.h"
 #include "wx/colour.h"
 #include "wx/gdicmn.h"
 
+#if wxUSE_STREAMS
+#include "wx/stream.h"
+#endif
+
+
+class WXDLLEXPORT wxPrintNativeDataBase;
+
+
 class WXDLLEXPORT wxColourData: public wxObject
 {
 public:
     wxColourData();
     wxColourData(const wxColourData& data);
-    ~wxColourData();
+    virtual ~wxColourData();
 
-    void SetChooseFull(bool flag) { chooseFull = flag; }
-    bool GetChooseFull() const { return chooseFull; }
-    void SetColour(const wxColour& colour) { dataColour = colour; }
-    const wxColour& GetColour() const { return dataColour; }
-    wxColour& GetColour() { return dataColour; }
+    void SetChooseFull(bool flag) { m_chooseFull = flag; }
+    bool GetChooseFull() const { return m_chooseFull; }
+    void SetColour(const wxColour& colour) { m_dataColour = colour; }
+    const wxColour& GetColour() const { return m_dataColour; }
+    wxColour& GetColour() { return m_dataColour; }
 
     // Array of 16 custom colours
     void SetCustomColour(int i, const wxColour& colour);
@@ -41,70 +46,70 @@ public:
     void operator=(const wxColourData& data);
 
 public:
-    wxColour        dataColour;
-    wxColour        custColours[16];
-    bool            chooseFull;
-    
+    wxColour        m_dataColour;
+    wxColour        m_custColours[16];
+    bool            m_chooseFull;
+
 private:
     DECLARE_DYNAMIC_CLASS(wxColourData)
 };
 
-class WXDLLEXPORT wxFontData: public wxObject
+class WXDLLEXPORT wxFontData : public wxObject
 {
 public:
     wxFontData();
-    ~wxFontData();
+    virtual ~wxFontData();
 
     wxFontData(const wxFontData& data)
-        : wxObject()
-        , fontColour(data.fontColour)
-        , showHelp(data.showHelp)
-        , allowSymbols(data.allowSymbols)
-        , enableEffects(data.enableEffects)
-        , initialFont(data.initialFont)
-        , chosenFont(data.chosenFont)
-        , minSize(data.minSize)
-        , maxSize(data.maxSize)
-        , m_encoding(data.m_encoding)
-        , m_encodingInfo(data.m_encodingInfo)
+        : wxObject(),
+          m_fontColour(data.m_fontColour),
+          m_showHelp(data.m_showHelp),
+          m_allowSymbols(data.m_allowSymbols),
+          m_enableEffects(data.m_enableEffects),
+          m_initialFont(data.m_initialFont),
+          m_chosenFont(data.m_chosenFont),
+          m_minSize(data.m_minSize),
+          m_maxSize(data.m_maxSize),
+          m_encoding(data.m_encoding),
+          m_encodingInfo(data.m_encodingInfo)
     {
     }
 
     wxFontData& operator=(const wxFontData& data)
     {
         wxObject::operator=(data);
-        fontColour     = data.fontColour;
-        showHelp       = data.showHelp;
-        allowSymbols   = data.allowSymbols;
-        enableEffects  = data.enableEffects;
-        initialFont    = data.initialFont;
-        chosenFont     = data.chosenFont;
-        minSize        = data.minSize;
-        maxSize        = data.maxSize;
-        m_encoding     = data.m_encoding;
-        m_encodingInfo = data.m_encodingInfo;
+        m_fontColour     = data.m_fontColour;
+        m_showHelp       = data.m_showHelp;
+        m_allowSymbols   = data.m_allowSymbols;
+        m_enableEffects  = data.m_enableEffects;
+        m_initialFont    = data.m_initialFont;
+        m_chosenFont     = data.m_chosenFont;
+        m_minSize        = data.m_minSize;
+        m_maxSize        = data.m_maxSize;
+        m_encoding       = data.m_encoding;
+        m_encodingInfo   = data.m_encodingInfo;
         return *this;
     }
-                          
-    void SetAllowSymbols(bool flag) { allowSymbols = flag; }
-    bool GetAllowSymbols() const { return allowSymbols; }
 
-    void SetColour(const wxColour& colour) { fontColour = colour; }
-    wxColour &GetColour() { return fontColour; }
+    void SetAllowSymbols(bool flag) { m_allowSymbols = flag; }
+    bool GetAllowSymbols() const { return m_allowSymbols; }
+
+    void SetColour(const wxColour& colour) { m_fontColour = colour; }
+    const wxColour& GetColour() const { return m_fontColour; }
 
-    void SetShowHelp(bool flag) { showHelp = flag; }
-    bool GetShowHelp() const { return showHelp; }
+    void SetShowHelp(bool flag) { m_showHelp = flag; }
+    bool GetShowHelp() const { return m_showHelp; }
 
-    void EnableEffects(bool flag) { enableEffects = flag; }
-    bool GetEnableEffects() const { return enableEffects; }
+    void EnableEffects(bool flag) { m_enableEffects = flag; }
+    bool GetEnableEffects() const { return m_enableEffects; }
 
-    void SetInitialFont(const wxFont& font) { initialFont = font; }
-    wxFont GetInitialFont() const { return initialFont; }
+    void SetInitialFont(const wxFont& font) { m_initialFont = font; }
+    wxFont GetInitialFont() const { return m_initialFont; }
 
-    void SetChosenFont(const wxFont& font) { chosenFont = font; }
-    wxFont GetChosenFont() const { return chosenFont; }
+    void SetChosenFont(const wxFont& font) { m_chosenFont = font; }
+    wxFont GetChosenFont() const { return m_chosenFont; }
 
-    void SetRange(int minRange, int maxRange) { minSize = minRange; maxSize = maxRange; }
+    void SetRange(int minRange, int maxRange) { m_minSize = minRange; m_maxSize = maxRange; }
 
     // encoding info is split into 2 parts: the logical wxWin encoding
     // (wxFontEncoding) and a structure containing the native parameters for
@@ -114,20 +119,22 @@ public:
 
     wxNativeEncodingInfo& EncodingInfo() { return m_encodingInfo; }
 
+
+    // public for backwards compatibility only: don't use directly
 public:
-    wxColour        fontColour;
-    bool            showHelp;
-    bool            allowSymbols;
-    bool            enableEffects;
-    wxFont          initialFont;
-    wxFont          chosenFont;
-    int             minSize;
-    int             maxSize;
+    wxColour        m_fontColour;
+    bool            m_showHelp;
+    bool            m_allowSymbols;
+    bool            m_enableEffects;
+    wxFont          m_initialFont;
+    wxFont          m_chosenFont;
+    int             m_minSize;
+    int             m_maxSize;
 
 private:
     wxFontEncoding       m_encoding;
     wxNativeEncodingInfo m_encodingInfo;
-    
+
 private:
     DECLARE_DYNAMIC_CLASS(wxFontData)
 };
@@ -138,19 +145,43 @@ private:
  * Encapsulates printer information (not printer dialog information)
  */
 
+enum wxPrintBin
+{
+    wxPRINTBIN_DEFAULT,
+
+    wxPRINTBIN_ONLYONE,
+    wxPRINTBIN_LOWER,
+    wxPRINTBIN_MIDDLE,
+    wxPRINTBIN_MANUAL,
+    wxPRINTBIN_ENVELOPE,
+    wxPRINTBIN_ENVMANUAL,
+    wxPRINTBIN_AUTO,
+    wxPRINTBIN_TRACTOR,
+    wxPRINTBIN_SMALLFMT,
+    wxPRINTBIN_LARGEFMT,
+    wxPRINTBIN_LARGECAPACITY,
+    wxPRINTBIN_CASSETTE,
+    wxPRINTBIN_FORMSOURCE,
+
+    wxPRINTBIN_USER
+};
+
+const int wxPRINTMEDIA_DEFAULT = 0;
+
 class WXDLLEXPORT wxPrintData: public wxObject
 {
 public:
     wxPrintData();
     wxPrintData(const wxPrintData& printData);
-    ~wxPrintData();
+    virtual ~wxPrintData();
 
-    int GetNoCopies() const { return m_printNoCopies; };
-    bool GetCollate() const { return m_printCollate; };
-    int  GetOrientation() const { return m_printOrientation; };
+    int GetNoCopies() const { return m_printNoCopies; }
+    bool GetCollate() const { return m_printCollate; }
+    int  GetOrientation() const { return m_printOrientation; }
 
     // Is this data OK for showing the print dialog?
-    bool Ok() const ;
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const ;
 
     const wxString& GetPrinterName() const { return m_printerName; }
     bool GetColour() const { return m_colour; }
@@ -159,10 +190,13 @@ public:
     const wxSize& GetPaperSize() const { return m_paperSize; } // Not used yet: confusable with paper size
                                                                       // in wxPageSetupDialogData
     wxPrintQuality GetQuality() const { return m_printQuality; }
+    wxPrintBin GetBin() const { return m_bin; }
+    wxPrintMode GetPrintMode() const { return m_printMode; }
+    int GetMedia() const { return m_media; }
 
-    void SetNoCopies(int v) { m_printNoCopies = v; };
-    void SetCollate(bool flag) { m_printCollate = flag; };
-    void SetOrientation(int orient) { m_printOrientation = orient; };
+    void SetNoCopies(int v) { m_printNoCopies = v; }
+    void SetCollate(bool flag) { m_printCollate = flag; }
+    void SetOrientation(int orient) { m_printOrientation = orient; }
 
     void SetPrinterName(const wxString& name) { m_printerName = name; }
     void SetColour(bool colour) { m_colour = colour; }
@@ -170,62 +204,58 @@ public:
     void SetPaperId(wxPaperSize sizeId) { m_paperId = sizeId; }
     void SetPaperSize(const wxSize& sz) { m_paperSize = sz; }
     void SetQuality(wxPrintQuality quality) { m_printQuality = quality; }
-
-    // PostScript-specific data
-    const wxString& GetPrinterCommand() const { return m_printerCommand; }
-    const wxString& GetPrinterOptions() const { return m_printerOptions; }
-    const wxString& GetPreviewCommand() const { return m_previewCommand; }
-    const wxString& GetFilename() const { return m_filename; }
-    const wxString& GetFontMetricPath() const { return m_afmPath; }
-    double GetPrinterScaleX() const { return m_printerScaleX; }
-    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 SetPreviewCommand(const wxString& command) { m_previewCommand = command; }
-    void SetFilename(const wxString& filename) { m_filename = filename; }
-    void SetFontMetricPath(const wxString& path) { m_afmPath = path; }
-    void SetPrinterScaleX(double x) { m_printerScaleX = x; }
-    void SetPrinterScaleY(double y) { m_printerScaleY = y; }
-    void SetPrinterScaling(double x, double y) { m_printerScaleX = x; m_printerScaleY = 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 SetBin(wxPrintBin bin) { m_bin = bin; }
+    void SetMedia(int media) { m_media = media; }
     void SetPrintMode(wxPrintMode printMode) { m_printMode = printMode; }
 
+    wxString GetFilename() const { return m_filename; }
+    void SetFilename( const wxString &filename ) { m_filename = filename; }
+
     void operator=(const wxPrintData& data);
 
-#if defined(__WXMSW__)
-    // Convert to/from the DEVMODE structure
-    void ConvertToNative();
-    void ConvertFromNative();
-    void* GetNativeData() const { return m_devMode; }
-    void SetNativeData(void* data) { m_devMode = data; }
-    void* GetNativeDataDevNames() const { return m_devNames; }
-    void SetNativeDataDevNames(void* data) { m_devNames = data; }
-#elif defined(__WXMAC__)
-  void ConvertToNative();
-  void ConvertFromNative();
-#endif
+    char* GetPrivData() const { return m_privData; }
+    int GetPrivDataLen() const { return m_privDataLen; }
+    void SetPrivData( char *privData, int len );
 
-public:
-#if defined(__WXMSW__)
-    void*           m_devMode;
-    void*           m_devNames;
-#elif defined(__WXMAC__)
-    void*           m_macPageFormat ;
-    void*           m_macPrintSettings ;
+
+#if WXWIN_COMPATIBILITY_2_4
+    // PostScript-specific data
+    wxString GetPrinterCommand() const;
+    wxString GetPrinterOptions() const;
+    wxString GetPreviewCommand() const;
+    wxString GetFontMetricPath() const;
+    double GetPrinterScaleX() const;
+    double GetPrinterScaleY() const;
+    long GetPrinterTranslateX() const;
+    long GetPrinterTranslateY() const;
+
+    void SetPrinterCommand(const wxString& command);
+    void SetPrinterOptions(const wxString& options);
+    void SetPreviewCommand(const wxString& command);
+    void SetFontMetricPath(const wxString& path);
+    void SetPrinterScaleX(double x);
+    void SetPrinterScaleY(double y);
+    void SetPrinterScaling(double x, double y);
+    void SetPrinterTranslateX(long x);
+    void SetPrinterTranslateY(long y);
+    void SetPrinterTranslation(long x, long y);
 #endif
 
+    // Convert between wxPrintData and native data
+    void ConvertToNative();
+    void ConvertFromNative();
+    // Holds the native print data
+    wxPrintNativeDataBase *GetNativeData() const { return m_nativeData; }
+
 private:
+    wxPrintBin      m_bin;
+    int             m_media;
+    wxPrintMode     m_printMode;
+
     int             m_printNoCopies;
     int             m_printOrientation;
     bool            m_printCollate;
 
-    // New members, 24/3/99
     wxString        m_printerName;
     bool            m_colour;
     wxDuplexMode    m_duplexMode;
@@ -233,18 +263,13 @@ private:
     wxPaperSize     m_paperId;
     wxSize          m_paperSize;
 
-    // PostScript-specific data
-    wxString        m_printerCommand;
-    wxString        m_previewCommand;
-    wxString        m_printerOptions;
     wxString        m_filename;
-    wxString        m_afmPath;
-    double          m_printerScaleX;
-    double          m_printerScaleY;
-    long            m_printerTranslateX;
-    long            m_printerTranslateY;
-    wxPrintMode     m_printMode;
-    
+
+    char* m_privData;
+    int   m_privDataLen;
+
+    wxPrintNativeDataBase  *m_nativeData;
+
 private:
     DECLARE_DYNAMIC_CLASS(wxPrintData)
 };
@@ -262,7 +287,7 @@ public:
     wxPrintDialogData();
     wxPrintDialogData(const wxPrintDialogData& dialogData);
     wxPrintDialogData(const wxPrintData& printData);
-    ~wxPrintDialogData();
+    virtual ~wxPrintDialogData();
 
     int GetFromPage() const { return m_printFromPage; };
     int GetToPage() const { return m_printToPage; };
@@ -273,8 +298,9 @@ public:
     bool GetSelection() const { return m_printSelection; };
     bool GetCollate() const { return m_printCollate; };
     bool GetPrintToFile() const { return m_printToFile; };
+#if WXWIN_COMPATIBILITY_2_4
     bool GetSetupDialog() const { return m_printSetupDialog; };
-
+#endif
     void SetFromPage(int v) { m_printFromPage = v; };
     void SetToPage(int v) { m_printToPage = v; };
     void SetMinPage(int v) { m_printMinPage = v; };
@@ -284,8 +310,9 @@ public:
     void SetSelection(bool flag) { m_printSelection = flag; };
     void SetCollate(bool flag) { m_printCollate = flag; };
     void SetPrintToFile(bool flag) { m_printToFile = flag; };
+#if WXWIN_COMPATIBILITY_2_4
     void SetSetupDialog(bool flag) { m_printSetupDialog = flag; };
-
+#endif
     void EnablePrintToFile(bool flag) { m_printEnablePrintToFile = flag; };
     void EnableSelection(bool flag) { m_printEnableSelection = flag; };
     void EnablePageNumbers(bool flag) { m_printEnablePageNumbers = flag; };
@@ -297,7 +324,8 @@ public:
     bool GetEnableHelp() const { return m_printEnableHelp; };
 
     // Is this data OK for showing the print dialog?
-    bool Ok() const { return m_printData.Ok() ; }
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const { return m_printData.Ok() ; }
 
     wxPrintData& GetPrintData() { return m_printData; }
     void SetPrintData(const wxPrintData& printData) { m_printData = printData; }
@@ -305,21 +333,6 @@ public:
     void operator=(const wxPrintDialogData& data);
     void operator=(const wxPrintData& data); // Sets internal m_printData member
 
-#ifdef __WXMSW__
-    // Convert to/from the PRINTDLG structure
-    void ConvertToNative();
-    void ConvertFromNative();
-    void SetOwnerWindow(wxWindow* win);
-    void* GetNativeData() const { return m_printDlgData; }
-#elif defined(__WXMAC__)
-    void ConvertToNative();
-    void ConvertFromNative();
-#endif
-
-#ifdef __WXMSW__
-    void*           m_printDlgData;
-#endif
-
 private:
     int             m_printFromPage;
     int             m_printToPage;
@@ -334,10 +347,12 @@ private:
     bool            m_printEnablePageNumbers;
     bool            m_printEnableHelp;
     bool            m_printEnablePrintToFile;
+#if WXWIN_COMPATIBILITY_2_4
     bool            m_printSetupDialog;
+#endif
     wxPrintData     m_printData;
 
-private:    
+private:
     DECLARE_DYNAMIC_CLASS(wxPrintDialogData)
 };
 
@@ -354,7 +369,7 @@ public:
     wxPageSetupDialogData();
     wxPageSetupDialogData(const wxPageSetupDialogData& dialogData);
     wxPageSetupDialogData(const wxPrintData& printData);
-    ~wxPageSetupDialogData();
+    virtual ~wxPageSetupDialogData();
 
     wxSize GetPaperSize() const { return m_paperSize; };
     wxPaperSize GetPaperId() const { return m_printData.GetPaperId(); };
@@ -372,7 +387,8 @@ public:
     bool GetEnableHelp() const { return m_enableHelp; };
 
     // Is this data OK for showing the page setup dialog?
-    bool Ok() const { return m_printData.Ok() ; }
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const { return m_printData.Ok() ; }
 
     // If a corresponding paper type is found in the paper database, will set the m_printData
     // paper size id member as well.
@@ -396,17 +412,6 @@ public:
     void EnablePrinter(bool flag) { m_enablePrinter = flag; };
     void EnableHelp(bool flag) { m_enableHelp = flag; };
 
-#if defined(__WIN95__)
-    // Convert to/from the PAGESETUPDLG structure
-    void ConvertToNative();
-    void ConvertFromNative();
-    void SetOwnerWindow(wxWindow* win);
-    void* GetNativeData() const { return m_pageSetupData; }
-#elif defined(__WXMAC__)
-    void ConvertToNative();
-    void ConvertFromNative();
-#endif
-
     // Use paper size defined in this object to set the wxPrintData
     // paper id
     void CalculateIdFromPaperSize();
@@ -418,11 +423,8 @@ public:
     wxPageSetupDialogData& operator=(const wxPrintData& data);
 
     wxPrintData& GetPrintData() { return m_printData; }
-    void SetPrintData(const wxPrintData& printData) { m_printData = printData; }
-
-#if defined(__WIN95__)
-    void*           m_pageSetupData;
-#endif
+    const wxPrintData& GetPrintData() const { return m_printData; }
+    void SetPrintData(const wxPrintData& printData);
 
 private:
     wxSize          m_paperSize; // The dimensions selected by the user (on return, same as in wxPrintData?)
@@ -438,7 +440,7 @@ private:
     bool            m_getDefaultInfo; // Equiv. to PSD_RETURNDEFAULT
     bool            m_enableHelp;
     wxPrintData     m_printData;
-    
+
 private:
     DECLARE_DYNAMIC_CLASS(wxPageSetupDialogData)
 };