include/wx/cmndata.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __GNUG__
  16 #pragma interface "cmndata.h"
  17 #endif
  18
  19 #include "wx/window.h"
  20 #include "wx/font.h"
  21 #include "wx/colour.h"
  22 #include "wx/gdicmn.h"
  23
  24 #if (defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMAC__)) && wxUSE_POSTSCRIPT
  25 class WXDLLEXPORT wxPrintSetupData;
  26 #endif
  27
  28 class WXDLLEXPORT wxColourData: public wxObject
  29 {
  30     DECLARE_DYNAMIC_CLASS(wxColourData)
  31 public:
  32     wxColourData();
  33     wxColourData(const wxColourData& data);
  34     ~wxColourData();
  35
  36     void SetChooseFull(bool flag) { chooseFull = flag; }
  37     bool GetChooseFull() const { return chooseFull; }
  38     void SetColour(const wxColour& colour) { dataColour = colour; }
  39     const wxColour& GetColour() const { return dataColour; }
  40     wxColour& GetColour() { return 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        dataColour;
  50     wxColour        custColours[16];
  51     bool            chooseFull;
  52 };
  53
  54 class WXDLLEXPORT wxFontData: public wxObject
  55 {
  56     DECLARE_DYNAMIC_CLASS(wxFontData)
  57 public:
  58     wxFontData();
  59     ~wxFontData();
  60
  61     void SetAllowSymbols(bool flag) { allowSymbols = flag; }
  62     bool GetAllowSymbols() const { return allowSymbols; }
  63
  64     void SetColour(const wxColour& colour) { fontColour = colour; }
  65     wxColour &GetColour() { return fontColour; }
  66
  67     void SetShowHelp(bool flag) { showHelp = flag; }
  68     bool GetShowHelp() const { return showHelp; }
  69
  70     void EnableEffects(bool flag) { enableEffects = flag; }
  71     bool GetEnableEffects() const { return enableEffects; }
  72
  73     void SetInitialFont(const wxFont& font) { initialFont = font; }
  74     wxFont GetInitialFont() const { return initialFont; }
  75
  76     void SetChosenFont(const wxFont& font) { chosenFont = font; }
  77     wxFont GetChosenFont() const { return chosenFont; }
  78
  79     void SetRange(int minRange, int maxRange) { minSize = minRange; maxSize = maxRange; }
  80
  81     // encoding info is split into 2 parts: the logical wxWin encoding
  82     // (wxFontEncoding) and a structure containing the native parameters for
  83     // it (wxNativeEncodingInfo)
  84     wxFontEncoding GetEncoding() const { return m_encoding; }
  85     void SetEncoding(wxFontEncoding encoding) { m_encoding = encoding; }
  86
  87     wxNativeEncodingInfo& EncodingInfo() { return m_encodingInfo; }
  88
  89 public:
  90     wxColour        fontColour;
  91     bool            showHelp;
  92     bool            allowSymbols;
  93     bool            enableEffects;
  94     wxFont          initialFont;
  95     wxFont          chosenFont;
  96     int             minSize;
  97     int             maxSize;
  98
  99 private:
 100     wxFontEncoding       m_encoding;
 101     wxNativeEncodingInfo m_encodingInfo;
 102 };
 103
 104 #if wxUSE_PRINTING_ARCHITECTURE
 105 /*
 106  * wxPrintData
 107  * Encapsulates printer information (not printer dialog information)
 108  */
 109
 110 class WXDLLEXPORT wxPrintData: public wxObject
 111 {
 112     DECLARE_DYNAMIC_CLASS(wxPrintData)
 113
 114     wxPrintData();
 115     wxPrintData(const wxPrintData& printData);
 116     ~wxPrintData();
 117
 118     int GetNoCopies() const { return m_printNoCopies; };
 119     bool GetCollate() const { return m_printCollate; };
 120     int  GetOrientation() const { return m_printOrientation; };
 121
 122     const wxString& GetPrinterName() const { return m_printerName; }
 123     bool GetColour() const { return m_colour; }
 124     wxDuplexMode GetDuplex() const { return m_duplexMode; }
 125     wxPaperSize GetPaperId() const { return m_paperId; }
 126     const wxSize& GetPaperSize() const { return m_paperSize; } // Not used yet: confusable with paper size
 127                                                                       // in wxPageSetupDialogData
 128     wxPrintQuality GetQuality() const { return m_printQuality; }
 129
 130     void SetNoCopies(int v) { m_printNoCopies = v; };
 131     void SetCollate(bool flag) { m_printCollate = flag; };
 132     void SetOrientation(int orient) { m_printOrientation = orient; };
 133
 134     void SetPrinterName(const wxString& name) { m_printerName = name; }
 135     void SetColour(bool colour) { m_colour = colour; }
 136     void SetDuplex(wxDuplexMode duplex) { m_duplexMode = duplex; }
 137     void SetPaperId(wxPaperSize sizeId) { m_paperId = sizeId; }
 138     void SetPaperSize(const wxSize& sz) { m_paperSize = sz; }
 139     void SetQuality(wxPrintQuality quality) { m_printQuality = quality; }
 140
 141     // PostScript-specific data
 142     const wxString& GetPrinterCommand() const { return m_printerCommand; }
 143     const wxString& GetPrinterOptions() const { return m_printerOptions; }
 144     const wxString& GetPreviewCommand() const { return m_previewCommand; }
 145     const wxString& GetFilename() const { return m_filename; }
 146     const wxString& GetFontMetricPath() const { return m_afmPath; }
 147     double GetPrinterScaleX() const { return m_printerScaleX; }
 148     double GetPrinterScaleY() const { return m_printerScaleY; }
 149     long GetPrinterTranslateX() const { return m_printerTranslateX; }
 150     long GetPrinterTranslateY() const { return m_printerTranslateY; }
 151     wxPrintMode GetPrintMode() const { return m_printMode; }
 152
 153     void SetPrinterCommand(const wxString& command) { m_printerCommand = command; }
 154     void SetPrinterOptions(const wxString& options) { m_printerOptions = options; }
 155     void SetPreviewCommand(const wxString& command) { m_previewCommand = command; }
 156     void SetFilename(const wxString& filename) { m_filename = filename; }
 157     void SetFontMetricPath(const wxString& path) { m_afmPath = path; }
 158     void SetPrinterScaleX(double x) { m_printerScaleX = x; }
 159     void SetPrinterScaleY(double y) { m_printerScaleY = y; }
 160     void SetPrinterScaling(double x, double y) { m_printerScaleX = x; m_printerScaleY = y; }
 161     void SetPrinterTranslateX(long x) { m_printerTranslateX = x; }
 162     void SetPrinterTranslateY(long y) { m_printerTranslateY = y; }
 163     void SetPrinterTranslation(long x, long y) { m_printerTranslateX = x; m_printerTranslateY = y; }
 164     void SetPrintMode(wxPrintMode printMode) { m_printMode = printMode; }
 165
 166     void operator=(const wxPrintData& data);
 167
 168     // For compatibility
 169 #if (defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMAC__)) && wxUSE_POSTSCRIPT
 170     void operator=(const wxPrintSetupData& setupData);
 171 #endif
 172
 173 #if defined(__WXMSW__)
 174     // Convert to/from the DEVMODE structure
 175     void ConvertToNative();
 176     void ConvertFromNative();
 177     void* GetNativeData() const { return m_devMode; }
 178     void SetNativeData(void* data) { m_devMode = data; }
 179     void* GetNativeDataDevNames() const { return m_devNames; }
 180     void SetNativeDataDevNames(void* data) { m_devNames = data; }
 181 #elif defined(__WXMAC__)
 182   void ConvertToNative();
 183   void ConvertFromNative();
 184 #endif
 185
 186 public:
 187 #if defined(__WXMSW__)
 188     void*           m_devMode;
 189     void*           m_devNames;
 190 #elif defined(__WXMAC__)
 191     void*           m_macPageFormat ;
 192     void*           m_macPrintSettings ;
 193 #endif
 194
 195 private:
 196
 197     int             m_printNoCopies;
 198     int             m_printOrientation;
 199     bool            m_printCollate;
 200
 201     // New members, 24/3/99
 202     wxString        m_printerName;
 203     bool            m_colour;
 204     wxDuplexMode    m_duplexMode;
 205     wxPrintQuality  m_printQuality;
 206     wxPaperSize     m_paperId;
 207     wxSize          m_paperSize;
 208
 209     // PostScript-specific data
 210     wxString        m_printerCommand;
 211     wxString        m_previewCommand;
 212     wxString        m_printerOptions;
 213     wxString        m_filename;
 214     wxString        m_afmPath;
 215     double          m_printerScaleX;
 216     double          m_printerScaleY;
 217     long            m_printerTranslateX;
 218     long            m_printerTranslateY;
 219     wxPrintMode     m_printMode;
 220 };
 221
 222 /*
 223  * wxPrintDialogData
 224  * Encapsulates information displayed and edited in the printer dialog box.
 225  * Contains a wxPrintData object which is filled in according to the values retrieved
 226  * from the dialog.
 227  */
 228
 229 class WXDLLEXPORT wxPrintDialogData: public wxObject
 230 {
 231     DECLARE_DYNAMIC_CLASS(wxPrintDialogData)
 232
 233     wxPrintDialogData();
 234     wxPrintDialogData(const wxPrintDialogData& dialogData);
 235     wxPrintDialogData(const wxPrintData& printData);
 236     ~wxPrintDialogData();
 237
 238     int GetFromPage() const { return m_printFromPage; };
 239     int GetToPage() const { return m_printToPage; };
 240     int GetMinPage() const { return m_printMinPage; };
 241     int GetMaxPage() const { return m_printMaxPage; };
 242     int GetNoCopies() const { return m_printNoCopies; };
 243     bool GetAllPages() const { return m_printAllPages; };
 244     bool GetSelection() const { return m_printSelection; };
 245     bool GetCollate() const { return m_printCollate; };
 246     bool GetPrintToFile() const { return m_printToFile; };
 247     bool GetSetupDialog() const { return m_printSetupDialog; };
 248
 249     void SetFromPage(int v) { m_printFromPage = v; };
 250     void SetToPage(int v) { m_printToPage = v; };
 251     void SetMinPage(int v) { m_printMinPage = v; };
 252     void SetMaxPage(int v) { m_printMaxPage = v; };
 253     void SetNoCopies(int v) { m_printNoCopies = v; };
 254     void SetAllPages(bool flag) { m_printAllPages = flag; };
 255     void SetSelection(bool flag) { m_printSelection = flag; };
 256     void SetCollate(bool flag) { m_printCollate = flag; };
 257     void SetPrintToFile(bool flag) { m_printToFile = flag; };
 258     void SetSetupDialog(bool flag) { m_printSetupDialog = flag; };
 259
 260     void EnablePrintToFile(bool flag) { m_printEnablePrintToFile = flag; };
 261     void EnableSelection(bool flag) { m_printEnableSelection = flag; };
 262     void EnablePageNumbers(bool flag) { m_printEnablePageNumbers = flag; };
 263     void EnableHelp(bool flag) { m_printEnableHelp = flag; };
 264
 265     bool GetEnablePrintToFile() const { return m_printEnablePrintToFile; };
 266     bool GetEnableSelection() const { return m_printEnableSelection; };
 267     bool GetEnablePageNumbers() const { return m_printEnablePageNumbers; };
 268     bool GetEnableHelp() const { return m_printEnableHelp; };
 269
 270     wxPrintData& GetPrintData() { return m_printData; }
 271     void SetPrintData(const wxPrintData& printData) { m_printData = printData; }
 272
 273     void operator=(const wxPrintDialogData& data);
 274     void operator=(const wxPrintData& data); // Sets internal m_printData member
 275
 276 #ifdef __WXMSW__
 277     // Convert to/from the PRINTDLG structure
 278     void ConvertToNative();
 279     void ConvertFromNative();
 280     void SetOwnerWindow(wxWindow* win);
 281     void* GetNativeData() const { return m_printDlgData; }
 282 #elif defined(__WXMAC__)
 283   void ConvertToNative();
 284   void ConvertFromNative();
 285 #endif
 286
 287 #ifdef __WXMSW__
 288     void*           m_printDlgData;
 289 #endif
 290
 291 private:
 292
 293     int             m_printFromPage;
 294     int             m_printToPage;
 295     int             m_printMinPage;
 296     int             m_printMaxPage;
 297     int             m_printNoCopies;
 298     bool            m_printAllPages;
 299     bool            m_printCollate;
 300     bool            m_printToFile;
 301     bool            m_printSelection;
 302     bool            m_printEnableSelection;
 303     bool            m_printEnablePageNumbers;
 304     bool            m_printEnableHelp;
 305     bool            m_printEnablePrintToFile;
 306     bool            m_printSetupDialog;
 307
 308     wxPrintData     m_printData;
 309 };
 310
 311 /*
 312 * This is the data used (and returned) by the wxPageSetupDialog.
 313 */
 314
 315 // Compatibility with old name
 316 #define wxPageSetupData wxPageSetupDialogData
 317
 318 class WXDLLEXPORT wxPageSetupDialogData: public wxObject
 319 {
 320     DECLARE_DYNAMIC_CLASS(wxPageSetupDialogData)
 321
 322 public:
 323     wxPageSetupDialogData();
 324     wxPageSetupDialogData(const wxPageSetupDialogData& dialogData);
 325     wxPageSetupDialogData(const wxPrintData& printData);
 326     ~wxPageSetupDialogData();
 327
 328     wxSize GetPaperSize() const { return m_paperSize; };
 329     wxPaperSize GetPaperId() const { return m_printData.GetPaperId(); };
 330     wxPoint GetMinMarginTopLeft() const { return m_minMarginTopLeft; };
 331     wxPoint GetMinMarginBottomRight() const { return m_minMarginBottomRight; };
 332     wxPoint GetMarginTopLeft() const { return m_marginTopLeft; };
 333     wxPoint GetMarginBottomRight() const { return m_marginBottomRight; };
 334
 335     bool GetDefaultMinMargins() const { return m_defaultMinMargins; };
 336     bool GetEnableMargins() const { return m_enableMargins; };
 337     bool GetEnableOrientation() const { return m_enableOrientation; };
 338     bool GetEnablePaper() const { return m_enablePaper; };
 339     bool GetEnablePrinter() const { return m_enablePrinter; };
 340     bool GetDefaultInfo() const { return m_getDefaultInfo; };
 341     bool GetEnableHelp() const { return m_enableHelp; };
 342
 343     // If a corresponding paper type is found in the paper database, will set the m_printData
 344     // paper size id member as well.
 345     void SetPaperSize(const wxSize& sz);
 346
 347     void SetPaperId(wxPaperSize id) { m_printData.SetPaperId(id); };
 348
 349     // Sets the wxPrintData id, plus the paper width/height if found in the paper database.
 350     void SetPaperSize(wxPaperSize id);
 351
 352     void SetMinMarginTopLeft(const wxPoint& pt) { m_minMarginTopLeft = pt; };
 353     void SetMinMarginBottomRight(const wxPoint& pt) { m_minMarginBottomRight = pt; };
 354     void SetMarginTopLeft(const wxPoint& pt) { m_marginTopLeft = pt; };
 355     void SetMarginBottomRight(const wxPoint& pt) { m_marginBottomRight = pt; };
 356     void SetDefaultMinMargins(bool flag) { m_defaultMinMargins = flag; };
 357     void SetDefaultInfo(bool flag) { m_getDefaultInfo = flag; };
 358
 359     void EnableMargins(bool flag) { m_enableMargins = flag; };
 360     void EnableOrientation(bool flag) { m_enableOrientation = flag; };
 361     void EnablePaper(bool flag) { m_enablePaper = flag; };
 362     void EnablePrinter(bool flag) { m_enablePrinter = flag; };
 363     void EnableHelp(bool flag) { m_enableHelp = flag; };
 364
 365 #if defined(__WIN95__)
 366     // Convert to/from the PAGESETUPDLG structure
 367     void ConvertToNative();
 368     void ConvertFromNative();
 369     void SetOwnerWindow(wxWindow* win);
 370     void* GetNativeData() const { return m_pageSetupData; }
 371 #elif defined(__WXMAC__)
 372   void ConvertToNative();
 373   void ConvertFromNative();
 374 #endif
 375
 376     // Use paper size defined in this object to set the wxPrintData
 377     // paper id
 378     void CalculateIdFromPaperSize();
 379
 380     // Use paper id in wxPrintData to set this object's paper size
 381     void CalculatePaperSizeFromId();
 382
 383     void operator=(const wxPageSetupData& data);
 384     void operator=(const wxPrintData& data);
 385
 386     wxPrintData& GetPrintData() { return m_printData; }
 387     void SetPrintData(const wxPrintData& printData) { m_printData = printData; }
 388
 389 #if defined(__WIN95__)
 390     void*           m_pageSetupData;
 391 #endif
 392
 393 private:
 394
 395     wxSize          m_paperSize; // The dimensions selected by the user (on return, same as in wxPrintData?)
 396     wxPoint         m_minMarginTopLeft;
 397     wxPoint         m_minMarginBottomRight;
 398     wxPoint         m_marginTopLeft;
 399     wxPoint         m_marginBottomRight;
 400
 401     // Flags
 402     bool            m_defaultMinMargins;
 403     bool            m_enableMargins;
 404     bool            m_enableOrientation;
 405     bool            m_enablePaper;
 406     bool            m_enablePrinter;
 407     bool            m_getDefaultInfo; // Equiv. to PSD_RETURNDEFAULT
 408     bool            m_enableHelp;
 409
 410     wxPrintData     m_printData;
 411 };
 412
 413 #endif // wxUSE_PRINTING_ARCHITECTURE
 414
 415 #endif
 416 // _WX_CMNDATA_H_BASE_