include/wx/cmndata.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/cmndata.h
   3 // Purpose:     Common GDI data classes
   4 // Author:      Julian Smart and others
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CMNDATA_H_BASE_
  13 #define _WX_CMNDATA_H_BASE_
  14
  15 #include "wx/window.h"
  16 #include "wx/font.h"
  17 #include "wx/encinfo.h"
  18 #include "wx/colour.h"
  19 #include "wx/gdicmn.h"
  20
  21 #if wxUSE_STREAMS
  22 #include "wx/stream.h"
  23 #endif
  24
  25
  26 class WXDLLIMPEXP_FWD_CORE wxPrintNativeDataBase;
  27
  28
  29 class WXDLLIMPEXP_CORE wxColourData : public wxObject
  30 {
  31 public:
  32     // number of custom colours we store
  33     enum
  34     {
  35         NUM_CUSTOM = 16
  36     };
  37
  38     wxColourData();
  39     wxColourData(const wxColourData& data);
  40     wxColourData& operator=(const wxColourData& data);
  41     virtual ~wxColourData();
  42
  43     void SetChooseFull(bool flag) { m_chooseFull = flag; }
  44     bool GetChooseFull() const { return m_chooseFull; }
  45     void SetColour(const wxColour& colour) { m_dataColour = colour; }
  46     const wxColour& GetColour() const { return m_dataColour; }
  47     wxColour& GetColour() { return m_dataColour; }
  48
  49     // SetCustomColour() modifies colours in an internal array of NUM_CUSTOM
  50     // custom colours;
  51     void SetCustomColour(int i, const wxColour& colour);
  52     wxColour GetCustomColour(int i) const;
  53
  54     // Serialize the object to a string and restore it from it
  55     wxString ToString() const;
  56     bool FromString(const wxString& str);
  57
  58
  59     // public for backwards compatibility only: don't use directly
  60 public:
  61     wxColour        m_dataColour;
  62     wxColour        m_custColours[NUM_CUSTOM];
  63     bool            m_chooseFull;
  64
  65 private:
  66     DECLARE_DYNAMIC_CLASS(wxColourData)
  67 };
  68
  69 class WXDLLIMPEXP_CORE wxFontData : public wxObject
  70 {
  71 public:
  72     wxFontData();
  73     virtual ~wxFontData();
  74
  75     wxFontData(const wxFontData& data)
  76         : wxObject(),
  77           m_fontColour(data.m_fontColour),
  78           m_showHelp(data.m_showHelp),
  79           m_allowSymbols(data.m_allowSymbols),
  80           m_enableEffects(data.m_enableEffects),
  81           m_initialFont(data.m_initialFont),
  82           m_chosenFont(data.m_chosenFont),
  83           m_minSize(data.m_minSize),
  84           m_maxSize(data.m_maxSize),
  85           m_encoding(data.m_encoding),
  86           m_encodingInfo(data.m_encodingInfo)
  87     {
  88     }
  89
  90     wxFontData& operator=(const wxFontData& data)
  91     {
  92         if (&data != this)
  93         {
  94             wxObject::operator=(data);
  95             m_fontColour     = data.m_fontColour;
  96             m_showHelp       = data.m_showHelp;
  97             m_allowSymbols   = data.m_allowSymbols;
  98             m_enableEffects  = data.m_enableEffects;
  99             m_initialFont    = data.m_initialFont;
 100             m_chosenFont     = data.m_chosenFont;
 101             m_minSize        = data.m_minSize;
 102             m_maxSize        = data.m_maxSize;
 103             m_encoding       = data.m_encoding;
 104             m_encodingInfo   = data.m_encodingInfo;
 105         }
 106         return *this;
 107     }
 108
 109     void SetAllowSymbols(bool flag) { m_allowSymbols = flag; }
 110     bool GetAllowSymbols() const { return m_allowSymbols; }
 111
 112     void SetColour(const wxColour& colour) { m_fontColour = colour; }
 113     const wxColour& GetColour() const { return m_fontColour; }
 114
 115     void SetShowHelp(bool flag) { m_showHelp = flag; }
 116     bool GetShowHelp() const { return m_showHelp; }
 117
 118     void EnableEffects(bool flag) { m_enableEffects = flag; }
 119     bool GetEnableEffects() const { return m_enableEffects; }
 120
 121     void SetInitialFont(const wxFont& font) { m_initialFont = font; }
 122     wxFont GetInitialFont() const { return m_initialFont; }
 123
 124     void SetChosenFont(const wxFont& font) { m_chosenFont = font; }
 125     wxFont GetChosenFont() const { return m_chosenFont; }
 126
 127     void SetRange(int minRange, int maxRange) { m_minSize = minRange; m_maxSize = maxRange; }
 128
 129     // encoding info is split into 2 parts: the logical wxWin encoding
 130     // (wxFontEncoding) and a structure containing the native parameters for
 131     // it (wxNativeEncodingInfo)
 132     wxFontEncoding GetEncoding() const { return m_encoding; }
 133     void SetEncoding(wxFontEncoding encoding) { m_encoding = encoding; }
 134
 135     wxNativeEncodingInfo& EncodingInfo() { return m_encodingInfo; }
 136
 137
 138     // public for backwards compatibility only: don't use directly
 139 public:
 140     wxColour        m_fontColour;
 141     bool            m_showHelp;
 142     bool            m_allowSymbols;
 143     bool            m_enableEffects;
 144     wxFont          m_initialFont;
 145     wxFont          m_chosenFont;
 146     int             m_minSize;
 147     int             m_maxSize;
 148
 149 private:
 150     wxFontEncoding       m_encoding;
 151     wxNativeEncodingInfo m_encodingInfo;
 152
 153 private:
 154     DECLARE_DYNAMIC_CLASS(wxFontData)
 155 };
 156
 157 #if wxUSE_PRINTING_ARCHITECTURE
 158 /*
 159  * wxPrintData
 160  * Encapsulates printer information (not printer dialog information)
 161  */
 162
 163 enum wxPrintBin
 164 {
 165     wxPRINTBIN_DEFAULT,
 166
 167     wxPRINTBIN_ONLYONE,
 168     wxPRINTBIN_LOWER,
 169     wxPRINTBIN_MIDDLE,
 170     wxPRINTBIN_MANUAL,
 171     wxPRINTBIN_ENVELOPE,
 172     wxPRINTBIN_ENVMANUAL,
 173     wxPRINTBIN_AUTO,
 174     wxPRINTBIN_TRACTOR,
 175     wxPRINTBIN_SMALLFMT,
 176     wxPRINTBIN_LARGEFMT,
 177     wxPRINTBIN_LARGECAPACITY,
 178     wxPRINTBIN_CASSETTE,
 179     wxPRINTBIN_FORMSOURCE,
 180
 181     wxPRINTBIN_USER
 182 };
 183
 184 const int wxPRINTMEDIA_DEFAULT = 0;
 185
 186 class WXDLLIMPEXP_CORE wxPrintData: public wxObject
 187 {
 188 public:
 189     wxPrintData();
 190     wxPrintData(const wxPrintData& printData);
 191     virtual ~wxPrintData();
 192
 193     int GetNoCopies() const { return m_printNoCopies; }
 194     bool GetCollate() const { return m_printCollate; }
 195     wxPrintOrientation GetOrientation() const { return m_printOrientation; }
 196     bool IsOrientationReversed() const { return m_printOrientationReversed; }
 197
 198     // Is this data OK for showing the print dialog?
 199     bool Ok() const { return IsOk(); }
 200     bool IsOk() const ;
 201
 202     const wxString& GetPrinterName() const { return m_printerName; }
 203     bool GetColour() const { return m_colour; }
 204     wxDuplexMode GetDuplex() const { return m_duplexMode; }
 205     wxPaperSize GetPaperId() const { return m_paperId; }
 206     const wxSize& GetPaperSize() const { return m_paperSize; } // Not used yet: confusable with paper size
 207                                                                       // in wxPageSetupDialogData
 208     wxPrintQuality GetQuality() const { return m_printQuality; }
 209     wxPrintBin GetBin() const { return m_bin; }
 210     wxPrintMode GetPrintMode() const { return m_printMode; }
 211     int GetMedia() const { return m_media; }
 212
 213     void SetNoCopies(int v) { m_printNoCopies = v; }
 214     void SetCollate(bool flag) { m_printCollate = flag; }
 215
 216     // Please use the overloaded method below
 217     wxDEPRECATED_INLINE(void SetOrientation(int orient),
 218                         m_printOrientation = (wxPrintOrientation)orient; )
 219     void SetOrientation(wxPrintOrientation orient) { m_printOrientation = orient; }
 220     void SetOrientationReversed(bool reversed) { m_printOrientationReversed = reversed; }
 221
 222     void SetPrinterName(const wxString& name) { m_printerName = name; }
 223     void SetColour(bool colour) { m_colour = colour; }
 224     void SetDuplex(wxDuplexMode duplex) { m_duplexMode = duplex; }
 225     void SetPaperId(wxPaperSize sizeId) { m_paperId = sizeId; }
 226     void SetPaperSize(const wxSize& sz) { m_paperSize = sz; }
 227     void SetQuality(wxPrintQuality quality) { m_printQuality = quality; }
 228     void SetBin(wxPrintBin bin) { m_bin = bin; }
 229     void SetMedia(int media) { m_media = media; }
 230     void SetPrintMode(wxPrintMode printMode) { m_printMode = printMode; }
 231
 232     wxString GetFilename() const { return m_filename; }
 233     void SetFilename( const wxString &filename ) { m_filename = filename; }
 234
 235     wxPrintData& operator=(const wxPrintData& data);
 236
 237     char* GetPrivData() const { return m_privData; }
 238     int GetPrivDataLen() const { return m_privDataLen; }
 239     void SetPrivData( char *privData, int len );
 240
 241
 242     // Convert between wxPrintData and native data
 243     void ConvertToNative();
 244     void ConvertFromNative();
 245     // Holds the native print data
 246     wxPrintNativeDataBase *GetNativeData() const { return m_nativeData; }
 247
 248 private:
 249     wxPrintBin      m_bin;
 250     int             m_media;
 251     wxPrintMode     m_printMode;
 252
 253     int             m_printNoCopies;
 254     wxPrintOrientation m_printOrientation;
 255     bool            m_printOrientationReversed;
 256     bool            m_printCollate;
 257
 258     wxString        m_printerName;
 259     bool            m_colour;
 260     wxDuplexMode    m_duplexMode;
 261     wxPrintQuality  m_printQuality;
 262     wxPaperSize     m_paperId;
 263     wxSize          m_paperSize;
 264
 265     wxString        m_filename;
 266
 267     char* m_privData;
 268     int   m_privDataLen;
 269
 270     wxPrintNativeDataBase  *m_nativeData;
 271
 272 private:
 273     DECLARE_DYNAMIC_CLASS(wxPrintData)
 274 };
 275
 276 /*
 277  * wxPrintDialogData
 278  * Encapsulates information displayed and edited in the printer dialog box.
 279  * Contains a wxPrintData object which is filled in according to the values retrieved
 280  * from the dialog.
 281  */
 282
 283 class WXDLLIMPEXP_CORE wxPrintDialogData: public wxObject
 284 {
 285 public:
 286     wxPrintDialogData();
 287     wxPrintDialogData(const wxPrintDialogData& dialogData);
 288     wxPrintDialogData(const wxPrintData& printData);
 289     virtual ~wxPrintDialogData();
 290
 291     int GetFromPage() const { return m_printFromPage; }
 292     int GetToPage() const { return m_printToPage; }
 293     int GetMinPage() const { return m_printMinPage; }
 294     int GetMaxPage() const { return m_printMaxPage; }
 295     int GetNoCopies() const { return m_printNoCopies; }
 296     bool GetAllPages() const { return m_printAllPages; }
 297     bool GetSelection() const { return m_printSelection; }
 298     bool GetCollate() const { return m_printCollate; }
 299     bool GetPrintToFile() const { return m_printToFile; }
 300
 301     void SetFromPage(int v) { m_printFromPage = v; }
 302     void SetToPage(int v) { m_printToPage = v; }
 303     void SetMinPage(int v) { m_printMinPage = v; }
 304     void SetMaxPage(int v) { m_printMaxPage = v; }
 305     void SetNoCopies(int v) { m_printNoCopies = v; }
 306     void SetAllPages(bool flag) { m_printAllPages = flag; }
 307     void SetSelection(bool flag) { m_printSelection = flag; }
 308     void SetCollate(bool flag) { m_printCollate = flag; }
 309     void SetPrintToFile(bool flag) { m_printToFile = flag; }
 310
 311     void EnablePrintToFile(bool flag) { m_printEnablePrintToFile = flag; }
 312     void EnableSelection(bool flag) { m_printEnableSelection = flag; }
 313     void EnablePageNumbers(bool flag) { m_printEnablePageNumbers = flag; }
 314     void EnableHelp(bool flag) { m_printEnableHelp = flag; }
 315
 316     bool GetEnablePrintToFile() const { return m_printEnablePrintToFile; }
 317     bool GetEnableSelection() const { return m_printEnableSelection; }
 318     bool GetEnablePageNumbers() const { return m_printEnablePageNumbers; }
 319     bool GetEnableHelp() const { return m_printEnableHelp; }
 320
 321     // Is this data OK for showing the print dialog?
 322     bool Ok() const { return IsOk(); }
 323     bool IsOk() const { return m_printData.Ok() ; }
 324
 325     wxPrintData& GetPrintData() { return m_printData; }
 326     void SetPrintData(const wxPrintData& printData) { m_printData = printData; }
 327
 328     void operator=(const wxPrintDialogData& data);
 329     void operator=(const wxPrintData& data); // Sets internal m_printData member
 330
 331 private:
 332     int             m_printFromPage;
 333     int             m_printToPage;
 334     int             m_printMinPage;
 335     int             m_printMaxPage;
 336     int             m_printNoCopies;
 337     bool            m_printAllPages;
 338     bool            m_printCollate;
 339     bool            m_printToFile;
 340     bool            m_printSelection;
 341     bool            m_printEnableSelection;
 342     bool            m_printEnablePageNumbers;
 343     bool            m_printEnableHelp;
 344     bool            m_printEnablePrintToFile;
 345     wxPrintData     m_printData;
 346
 347 private:
 348     DECLARE_DYNAMIC_CLASS(wxPrintDialogData)
 349 };
 350
 351 /*
 352 * This is the data used (and returned) by the wxPageSetupDialog.
 353 */
 354
 355 // Compatibility with old name
 356 #define wxPageSetupData wxPageSetupDialogData
 357
 358 class WXDLLIMPEXP_CORE wxPageSetupDialogData: public wxObject
 359 {
 360 public:
 361     wxPageSetupDialogData();
 362     wxPageSetupDialogData(const wxPageSetupDialogData& dialogData);
 363     wxPageSetupDialogData(const wxPrintData& printData);
 364     virtual ~wxPageSetupDialogData();
 365
 366     wxSize GetPaperSize() const { return m_paperSize; }
 367     wxPaperSize GetPaperId() const { return m_printData.GetPaperId(); }
 368     wxPoint GetMinMarginTopLeft() const { return m_minMarginTopLeft; }
 369     wxPoint GetMinMarginBottomRight() const { return m_minMarginBottomRight; }
 370     wxPoint GetMarginTopLeft() const { return m_marginTopLeft; }
 371     wxPoint GetMarginBottomRight() const { return m_marginBottomRight; }
 372
 373     bool GetDefaultMinMargins() const { return m_defaultMinMargins; }
 374     bool GetEnableMargins() const { return m_enableMargins; }
 375     bool GetEnableOrientation() const { return m_enableOrientation; }
 376     bool GetEnablePaper() const { return m_enablePaper; }
 377     bool GetEnablePrinter() const { return m_enablePrinter; }
 378     bool GetDefaultInfo() const { return m_getDefaultInfo; }
 379     bool GetEnableHelp() const { return m_enableHelp; }
 380
 381     // Is this data OK for showing the page setup dialog?
 382     bool Ok() const { return IsOk(); }
 383     bool IsOk() const { return m_printData.Ok() ; }
 384
 385     // If a corresponding paper type is found in the paper database, will set the m_printData
 386     // paper size id member as well.
 387     void SetPaperSize(const wxSize& sz);
 388
 389     void SetPaperId(wxPaperSize id) { m_printData.SetPaperId(id); }
 390
 391     // Sets the wxPrintData id, plus the paper width/height if found in the paper database.
 392     void SetPaperSize(wxPaperSize id);
 393
 394     void SetMinMarginTopLeft(const wxPoint& pt) { m_minMarginTopLeft = pt; }
 395     void SetMinMarginBottomRight(const wxPoint& pt) { m_minMarginBottomRight = pt; }
 396     void SetMarginTopLeft(const wxPoint& pt) { m_marginTopLeft = pt; }
 397     void SetMarginBottomRight(const wxPoint& pt) { m_marginBottomRight = pt; }
 398     void SetDefaultMinMargins(bool flag) { m_defaultMinMargins = flag; }
 399     void SetDefaultInfo(bool flag) { m_getDefaultInfo = flag; }
 400
 401     void EnableMargins(bool flag) { m_enableMargins = flag; }
 402     void EnableOrientation(bool flag) { m_enableOrientation = flag; }
 403     void EnablePaper(bool flag) { m_enablePaper = flag; }
 404     void EnablePrinter(bool flag) { m_enablePrinter = flag; }
 405     void EnableHelp(bool flag) { m_enableHelp = flag; }
 406
 407     // Use paper size defined in this object to set the wxPrintData
 408     // paper id
 409     void CalculateIdFromPaperSize();
 410
 411     // Use paper id in wxPrintData to set this object's paper size
 412     void CalculatePaperSizeFromId();
 413
 414     wxPageSetupDialogData& operator=(const wxPageSetupData& data);
 415     wxPageSetupDialogData& operator=(const wxPrintData& data);
 416
 417     wxPrintData& GetPrintData() { return m_printData; }
 418     const wxPrintData& GetPrintData() const { return m_printData; }
 419     void SetPrintData(const wxPrintData& printData);
 420
 421 private:
 422     wxSize          m_paperSize; // The dimensions selected by the user (on return, same as in wxPrintData?)
 423     wxPoint         m_minMarginTopLeft;
 424     wxPoint         m_minMarginBottomRight;
 425     wxPoint         m_marginTopLeft;
 426     wxPoint         m_marginBottomRight;
 427     bool            m_defaultMinMargins;
 428     bool            m_enableMargins;
 429     bool            m_enableOrientation;
 430     bool            m_enablePaper;
 431     bool            m_enablePrinter;
 432     bool            m_getDefaultInfo; // Equiv. to PSD_RETURNDEFAULT
 433     bool            m_enableHelp;
 434     wxPrintData     m_printData;
 435
 436 private:
 437     DECLARE_DYNAMIC_CLASS(wxPageSetupDialogData)
 438 };
 439
 440 #endif // wxUSE_PRINTING_ARCHITECTURE
 441
 442 #endif
 443 // _WX_CMNDATA_H_BASE_