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 WXDLLEXPORT 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 #if WXWIN_COMPATIBILITY_2_4
 224     // PostScript-specific data
 225     wxString GetPrinterCommand() const;
 226     wxString GetPrinterOptions() const;
 227     wxString GetPreviewCommand() const;
 228     wxString GetFontMetricPath() const;
 229     double GetPrinterScaleX() const;
 230     double GetPrinterScaleY() const;
 231     long GetPrinterTranslateX() const;
 232     long GetPrinterTranslateY() const;
 233
 234     void SetPrinterCommand(const wxString& command);
 235     void SetPrinterOptions(const wxString& options);
 236     void SetPreviewCommand(const wxString& command);
 237     void SetFontMetricPath(const wxString& path);
 238     void SetPrinterScaleX(double x);
 239     void SetPrinterScaleY(double y);
 240     void SetPrinterScaling(double x, double y);
 241     void SetPrinterTranslateX(long x);
 242     void SetPrinterTranslateY(long y);
 243     void SetPrinterTranslation(long x, long y);
 244 #endif
 245
 246     // Convert between wxPrintData and native data
 247     void ConvertToNative();
 248     void ConvertFromNative();
 249     // Holds the native print data
 250     wxPrintNativeDataBase *GetNativeData() const { return m_nativeData; }
 251
 252 private:
 253     wxPrintBin      m_bin;
 254     int             m_media;
 255     wxPrintMode     m_printMode;
 256
 257     int             m_printNoCopies;
 258     int             m_printOrientation;
 259     bool            m_printOrientationReversed;
 260     bool            m_printCollate;
 261
 262     wxString        m_printerName;
 263     bool            m_colour;
 264     wxDuplexMode    m_duplexMode;
 265     wxPrintQuality  m_printQuality;
 266     wxPaperSize     m_paperId;
 267     wxSize          m_paperSize;
 268
 269     wxString        m_filename;
 270
 271     char* m_privData;
 272     int   m_privDataLen;
 273
 274     wxPrintNativeDataBase  *m_nativeData;
 275
 276 private:
 277     DECLARE_DYNAMIC_CLASS(wxPrintData)
 278 };
 279
 280 /*
 281  * wxPrintDialogData
 282  * Encapsulates information displayed and edited in the printer dialog box.
 283  * Contains a wxPrintData object which is filled in according to the values retrieved
 284  * from the dialog.
 285  */
 286
 287 class WXDLLEXPORT wxPrintDialogData: public wxObject
 288 {
 289 public:
 290     wxPrintDialogData();
 291     wxPrintDialogData(const wxPrintDialogData& dialogData);
 292     wxPrintDialogData(const wxPrintData& printData);
 293     virtual ~wxPrintDialogData();
 294
 295     int GetFromPage() const { return m_printFromPage; };
 296     int GetToPage() const { return m_printToPage; };
 297     int GetMinPage() const { return m_printMinPage; };
 298     int GetMaxPage() const { return m_printMaxPage; };
 299     int GetNoCopies() const { return m_printNoCopies; };
 300     bool GetAllPages() const { return m_printAllPages; };
 301     bool GetSelection() const { return m_printSelection; };
 302     bool GetCollate() const { return m_printCollate; };
 303     bool GetPrintToFile() const { return m_printToFile; };
 304 #if WXWIN_COMPATIBILITY_2_4
 305     bool GetSetupDialog() const { return m_printSetupDialog; };
 306 #endif
 307     void SetFromPage(int v) { m_printFromPage = v; };
 308     void SetToPage(int v) { m_printToPage = v; };
 309     void SetMinPage(int v) { m_printMinPage = v; };
 310     void SetMaxPage(int v) { m_printMaxPage = v; };
 311     void SetNoCopies(int v) { m_printNoCopies = v; };
 312     void SetAllPages(bool flag) { m_printAllPages = flag; };
 313     void SetSelection(bool flag) { m_printSelection = flag; };
 314     void SetCollate(bool flag) { m_printCollate = flag; };
 315     void SetPrintToFile(bool flag) { m_printToFile = flag; };
 316 #if WXWIN_COMPATIBILITY_2_4
 317     void SetSetupDialog(bool flag) { m_printSetupDialog = flag; };
 318 #endif
 319     void EnablePrintToFile(bool flag) { m_printEnablePrintToFile = flag; };
 320     void EnableSelection(bool flag) { m_printEnableSelection = flag; };
 321     void EnablePageNumbers(bool flag) { m_printEnablePageNumbers = flag; };
 322     void EnableHelp(bool flag) { m_printEnableHelp = flag; };
 323
 324     bool GetEnablePrintToFile() const { return m_printEnablePrintToFile; };
 325     bool GetEnableSelection() const { return m_printEnableSelection; };
 326     bool GetEnablePageNumbers() const { return m_printEnablePageNumbers; };
 327     bool GetEnableHelp() const { return m_printEnableHelp; };
 328
 329     // Is this data OK for showing the print dialog?
 330     bool Ok() const { return IsOk(); }
 331     bool IsOk() const { return m_printData.Ok() ; }
 332
 333     wxPrintData& GetPrintData() { return m_printData; }
 334     void SetPrintData(const wxPrintData& printData) { m_printData = printData; }
 335
 336     void operator=(const wxPrintDialogData& data);
 337     void operator=(const wxPrintData& data); // Sets internal m_printData member
 338
 339 private:
 340     int             m_printFromPage;
 341     int             m_printToPage;
 342     int             m_printMinPage;
 343     int             m_printMaxPage;
 344     int             m_printNoCopies;
 345     bool            m_printAllPages;
 346     bool            m_printCollate;
 347     bool            m_printToFile;
 348     bool            m_printSelection;
 349     bool            m_printEnableSelection;
 350     bool            m_printEnablePageNumbers;
 351     bool            m_printEnableHelp;
 352     bool            m_printEnablePrintToFile;
 353 #if WXWIN_COMPATIBILITY_2_4
 354     bool            m_printSetupDialog;
 355 #endif
 356     wxPrintData     m_printData;
 357
 358 private:
 359     DECLARE_DYNAMIC_CLASS(wxPrintDialogData)
 360 };
 361
 362 /*
 363 * This is the data used (and returned) by the wxPageSetupDialog.
 364 */
 365
 366 // Compatibility with old name
 367 #define wxPageSetupData wxPageSetupDialogData
 368
 369 class WXDLLEXPORT wxPageSetupDialogData: public wxObject
 370 {
 371 public:
 372     wxPageSetupDialogData();
 373     wxPageSetupDialogData(const wxPageSetupDialogData& dialogData);
 374     wxPageSetupDialogData(const wxPrintData& printData);
 375     virtual ~wxPageSetupDialogData();
 376
 377     wxSize GetPaperSize() const { return m_paperSize; };
 378     wxPaperSize GetPaperId() const { return m_printData.GetPaperId(); };
 379     wxPoint GetMinMarginTopLeft() const { return m_minMarginTopLeft; };
 380     wxPoint GetMinMarginBottomRight() const { return m_minMarginBottomRight; };
 381     wxPoint GetMarginTopLeft() const { return m_marginTopLeft; };
 382     wxPoint GetMarginBottomRight() const { return m_marginBottomRight; };
 383
 384     bool GetDefaultMinMargins() const { return m_defaultMinMargins; };
 385     bool GetEnableMargins() const { return m_enableMargins; };
 386     bool GetEnableOrientation() const { return m_enableOrientation; };
 387     bool GetEnablePaper() const { return m_enablePaper; };
 388     bool GetEnablePrinter() const { return m_enablePrinter; };
 389     bool GetDefaultInfo() const { return m_getDefaultInfo; };
 390     bool GetEnableHelp() const { return m_enableHelp; };
 391
 392     // Is this data OK for showing the page setup dialog?
 393     bool Ok() const { return IsOk(); }
 394     bool IsOk() const { return m_printData.Ok() ; }
 395
 396     // If a corresponding paper type is found in the paper database, will set the m_printData
 397     // paper size id member as well.
 398     void SetPaperSize(const wxSize& sz);
 399
 400     void SetPaperId(wxPaperSize id) { m_printData.SetPaperId(id); };
 401
 402     // Sets the wxPrintData id, plus the paper width/height if found in the paper database.
 403     void SetPaperSize(wxPaperSize id);
 404
 405     void SetMinMarginTopLeft(const wxPoint& pt) { m_minMarginTopLeft = pt; };
 406     void SetMinMarginBottomRight(const wxPoint& pt) { m_minMarginBottomRight = pt; };
 407     void SetMarginTopLeft(const wxPoint& pt) { m_marginTopLeft = pt; };
 408     void SetMarginBottomRight(const wxPoint& pt) { m_marginBottomRight = pt; };
 409     void SetDefaultMinMargins(bool flag) { m_defaultMinMargins = flag; };
 410     void SetDefaultInfo(bool flag) { m_getDefaultInfo = flag; };
 411
 412     void EnableMargins(bool flag) { m_enableMargins = flag; };
 413     void EnableOrientation(bool flag) { m_enableOrientation = flag; };
 414     void EnablePaper(bool flag) { m_enablePaper = flag; };
 415     void EnablePrinter(bool flag) { m_enablePrinter = flag; };
 416     void EnableHelp(bool flag) { m_enableHelp = flag; };
 417
 418     // Use paper size defined in this object to set the wxPrintData
 419     // paper id
 420     void CalculateIdFromPaperSize();
 421
 422     // Use paper id in wxPrintData to set this object's paper size
 423     void CalculatePaperSizeFromId();
 424
 425     wxPageSetupDialogData& operator=(const wxPageSetupData& data);
 426     wxPageSetupDialogData& operator=(const wxPrintData& data);
 427
 428     wxPrintData& GetPrintData() { return m_printData; }
 429     const wxPrintData& GetPrintData() const { return m_printData; }
 430     void SetPrintData(const wxPrintData& printData);
 431
 432 private:
 433     wxSize          m_paperSize; // The dimensions selected by the user (on return, same as in wxPrintData?)
 434     wxPoint         m_minMarginTopLeft;
 435     wxPoint         m_minMarginBottomRight;
 436     wxPoint         m_marginTopLeft;
 437     wxPoint         m_marginBottomRight;
 438     bool            m_defaultMinMargins;
 439     bool            m_enableMargins;
 440     bool            m_enableOrientation;
 441     bool            m_enablePaper;
 442     bool            m_enablePrinter;
 443     bool            m_getDefaultInfo; // Equiv. to PSD_RETURNDEFAULT
 444     bool            m_enableHelp;
 445     wxPrintData     m_printData;
 446
 447 private:
 448     DECLARE_DYNAMIC_CLASS(wxPageSetupDialogData)
 449 };
 450
 451 #endif // wxUSE_PRINTING_ARCHITECTURE
 452
 453 #endif
 454 // _WX_CMNDATA_H_BASE_