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