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