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