interface/wx/cmndata.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        cmndata.h
   3 // Purpose:     interface of print wx*Data classes
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPageSetupDialogData
  11
  12     This class holds a variety of information related to wxPageSetupDialog.
  13
  14     It contains a wxPrintData member which is used to hold basic printer
  15     configuration data (as opposed to the user-interface configuration settings
  16     stored by wxPageSetupDialogData).
  17
  18     @library{wxcore}
  19     @category{printing,data}
  20
  21     @see @ref overview_printing, wxPageSetupDialog
  22 */
  23 class wxPageSetupDialogData : public wxObject
  24 {
  25 public:
  26     /**
  27         Default constructor.
  28     */
  29     wxPageSetupDialogData();
  30
  31     /**
  32         Copy constructor.
  33     */
  34     wxPageSetupDialogData(const wxPageSetupDialogData& data);
  35
  36     /**
  37         Construct an object from a print data object.
  38     */
  39     wxPageSetupDialogData(const wxPrintData& printData);
  40
  41     /**
  42         Destructor.
  43     */
  44     virtual ~wxPageSetupDialogData();
  45
  46     /**
  47         Enables or disables the "Help" button (Windows only).
  48     */
  49     void EnableHelp(bool flag);
  50
  51     /**
  52         Enables or disables the margin controls (Windows only).
  53     */
  54     void EnableMargins(bool flag);
  55
  56     /**
  57         Enables or disables the orientation control (Windows only).
  58     */
  59     void EnableOrientation(bool flag);
  60
  61     /**
  62         Enables or disables the paper size control (Windows only).
  63     */
  64     void EnablePaper(bool flag);
  65
  66     /**
  67         Enables or disables the "Printer" button, which invokes a printer setup
  68         dialog.
  69     */
  70     void EnablePrinter(bool flag);
  71
  72     /**
  73         Returns @true if the dialog will simply return default printer
  74         information (such as orientation) instead of showing a dialog (Windows
  75         only).
  76     */
  77     bool GetDefaultInfo() const;
  78
  79     /**
  80         Returns @true if the page setup dialog will take its minimum margin
  81         values from the currently selected printer properties (Windows only).
  82     */
  83     bool GetDefaultMinMargins() const;
  84
  85     /**
  86         Returns @true if the printer setup button is enabled.
  87     */
  88     bool GetEnableHelp() const;
  89
  90     /**
  91         Returns @true if the margin controls are enabled (Windows only).
  92     */
  93     bool GetEnableMargins() const;
  94
  95     /**
  96         Returns @true if the orientation control is enabled (Windows only).
  97     */
  98     bool GetEnableOrientation() const;
  99
 100     /**
 101         Returns @true if the paper size control is enabled (Windows only).
 102     */
 103     bool GetEnablePaper() const;
 104
 105     /**
 106         Returns @true if the printer setup button is enabled.
 107     */
 108     bool GetEnablePrinter() const;
 109
 110     /**
 111         Returns the right (x) and bottom (y) margins in millimetres.
 112     */
 113     wxPoint GetMarginBottomRight() const;
 114
 115     /**
 116         Returns the left (x) and top (y) margins in millimetres.
 117     */
 118     wxPoint GetMarginTopLeft() const;
 119
 120     /**
 121         Returns the right (x) and bottom (y) minimum margins the user can enter
 122         (Windows only). Units are in millimetres.
 123     */
 124     wxPoint GetMinMarginBottomRight() const;
 125
 126     /**
 127         Returns the left (x) and top (y) minimum margins the user can enter
 128         (Windows only). Units are in millimetres.
 129     */
 130     wxPoint GetMinMarginTopLeft() const;
 131
 132     /**
 133         Returns the paper id (stored in the internal wxPrintData object).
 134
 135         @see wxPrintData::SetPaperId()
 136     */
 137     wxPaperSize GetPaperId() const;
 138
 139     /**
 140         Returns the paper size in millimetres.
 141     */
 142     wxSize GetPaperSize() const;
 143
 144     /**
 145         Returns a reference to the print data associated with this object.
 146     */
 147     wxPrintData& GetPrintData();
 148     const wxPrintData& GetPrintData() const;
 149
 150     /**
 151         Returns @true if the print data associated with the dialog data is
 152         valid. This can return @false on Windows if the current printer is not
 153         set, for example. On all other platforms, it returns @true.
 154     */
 155     bool IsOk() const;
 156
 157     /**
 158         Pass @true if the dialog will simply return default printer information
 159         (such as orientation) instead of showing a dialog (Windows only).
 160     */
 161     void SetDefaultInfo(bool flag);
 162
 163     /**
 164         Pass @true if the page setup dialog will take its minimum margin values
 165         from the currently selected printer properties (Windows only). Units
 166         are in millimetres.
 167     */
 168     void SetDefaultMinMargins(bool flag);
 169
 170     /**
 171         Sets the right (x) and bottom (y) margins in millimetres.
 172     */
 173     void SetMarginBottomRight(const wxPoint& pt);
 174
 175     /**
 176         Sets the left (x) and top (y) margins in millimetres.
 177     */
 178     void SetMarginTopLeft(const wxPoint& pt);
 179
 180     /**
 181         Sets the right (x) and bottom (y) minimum margins the user can enter
 182         (Windows only). Units are in millimetres.
 183     */
 184     void SetMinMarginBottomRight(const wxPoint& pt);
 185
 186     /**
 187         Sets the left (x) and top (y) minimum margins the user can enter
 188         (Windows only). Units are in millimetres.
 189     */
 190     void SetMinMarginTopLeft(const wxPoint& pt);
 191
 192     /**
 193         Sets the paper size id. Calling this function overrides the explicit
 194         paper dimensions passed in SetPaperSize().
 195
 196         @see wxPrintData::SetPaperId()
 197     */
 198     void SetPaperId(wxPaperSize id);
 199
 200     /**
 201         Sets the paper size in millimetres. If a corresponding paper id is
 202         found, it will be set in the internal wxPrintData object, otherwise the
 203         paper size overrides the paper id.
 204     */
 205     void SetPaperSize(const wxSize& size);
 206
 207     /**
 208         Sets the print data associated with this object.
 209     */
 210     void SetPrintData(const wxPrintData& printData);
 211
 212     /**
 213         Assigns print data to this object.
 214     */
 215     wxPageSetupDialogData& operator =(const wxPrintData& data);
 216
 217     /**
 218         Assigns page setup data to this object.
 219     */
 220     wxPageSetupDialogData& operator =(const wxPageSetupDialogData& data);
 221 };
 222
 223 /**
 224     Enumeration of various printer bin sources.
 225
 226     @see wxPrintData::SetBin()
 227 */
 228 enum wxPrintBin
 229 {
 230     wxPRINTBIN_DEFAULT,
 231
 232     wxPRINTBIN_ONLYONE,
 233     wxPRINTBIN_LOWER,
 234     wxPRINTBIN_MIDDLE,
 235     wxPRINTBIN_MANUAL,
 236     wxPRINTBIN_ENVELOPE,
 237     wxPRINTBIN_ENVMANUAL,
 238     wxPRINTBIN_AUTO,
 239     wxPRINTBIN_TRACTOR,
 240     wxPRINTBIN_SMALLFMT,
 241     wxPRINTBIN_LARGEFMT,
 242     wxPRINTBIN_LARGECAPACITY,
 243     wxPRINTBIN_CASSETTE,
 244     wxPRINTBIN_FORMSOURCE,
 245
 246     wxPRINTBIN_USER,
 247 };
 248
 249 /**
 250     @class wxPrintData
 251
 252     This class holds a variety of information related to printers and printer
 253     device contexts. This class is used to create a wxPrinterDC and a
 254     wxPostScriptDC. It is also used as a data member of wxPrintDialogData and
 255     wxPageSetupDialogData, as part of the mechanism for transferring data
 256     between the print dialogs and the application.
 257
 258     @library{wxcore}
 259     @category{printing,data}
 260
 261     @see @ref overview_printing, wxPrintDialog, wxPageSetupDialog,
 262          wxPrintDialogData, wxPageSetupDialogData, @ref overview_cmndlg_print,
 263          wxPrinterDC, wxPostScriptDC
 264 */
 265 class wxPrintData : public wxObject
 266 {
 267 public:
 268     /**
 269         Default constructor.
 270     */
 271     wxPrintData();
 272
 273     /**
 274         Copy constructor.
 275     */
 276     wxPrintData(const wxPrintData& data);
 277
 278     /**
 279         Destructor.
 280     */
 281     virtual ~wxPrintData();
 282
 283     /**
 284         Returns the current bin (papersource). By default, the system is left
 285         to select the bin (@c wxPRINTBIN_DEFAULT is returned).
 286
 287         See SetBin() for the full list of bin values.
 288     */
 289     wxPrintBin GetBin() const;
 290
 291     /**
 292         Returns @true if collation is on.
 293     */
 294     bool GetCollate() const;
 295
 296     /**
 297         Returns @true if colour printing is on.
 298     */
 299     bool GetColour() const;
 300
 301     /**
 302         Returns the duplex mode. One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL,
 303         wxDUPLEX_VERTICAL.
 304     */
 305     wxDuplexMode GetDuplex() const;
 306
 307     /**
 308         Returns the number of copies requested by the user.
 309     */
 310     int GetNoCopies() const;
 311
 312     /**
 313         Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
 314     */
 315     wxPrintOrientation GetOrientation() const;
 316
 317     /**
 318         Returns the paper size id.
 319
 320         @see SetPaperId()
 321     */
 322     wxPaperSize GetPaperId() const;
 323
 324     /**
 325         Returns the printer name. If the printer name is the empty string, it
 326         indicates that the default printer should be used.
 327     */
 328     const wxString& GetPrinterName() const;
 329
 330     /**
 331         Returns the current print quality. This can be a positive integer,
 332         denoting the number of dots per inch, or  one of the following
 333         identifiers:
 334
 335         - wxPRINT_QUALITY_HIGH
 336         - wxPRINT_QUALITY_MEDIUM
 337         - wxPRINT_QUALITY_LOW
 338         - wxPRINT_QUALITY_DRAFT
 339
 340         On input you should pass one of these identifiers, but on return you
 341         may get back a positive integer indicating the current resolution
 342         setting.
 343     */
 344     wxPrintQuality GetQuality() const;
 345
 346     /**
 347         Returns @true if the print data is valid for using in print dialogs.
 348         This can return @false on Windows if the current printer is not set,
 349         for example. On all other platforms, it returns @true.
 350     */
 351     bool IsOk() const;
 352
 353     /**
 354         Sets the current bin.
 355     */
 356     void SetBin(wxPrintBin flag);
 357
 358     /**
 359         Sets collation to on or off.
 360     */
 361     void SetCollate(bool flag);
 362
 363     /**
 364         Sets colour printing on or off.
 365     */
 366     void SetColour(bool flag);
 367
 368     /**
 369         Returns the duplex mode. One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL,
 370         wxDUPLEX_VERTICAL.
 371     */
 372     void SetDuplex(wxDuplexMode mode);
 373
 374     /**
 375         Sets the default number of copies to be printed out.
 376     */
 377     void SetNoCopies(int n);
 378
 379     /**
 380         Sets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
 381     */
 382     void SetOrientation(wxPrintOrientation orientation);
 383
 384     /**
 385         Sets the paper id. This indicates the type of paper to be used. For a
 386         mapping between paper id, paper size and string name, see
 387         wxPrintPaperDatabase in @c "paper.h" (not yet documented).
 388     */
 389     void SetPaperId(wxPaperSize paperId);
 390
 391     /**
 392         Sets the printer name. This can be the empty string to indicate that
 393         the default printer should be used.
 394     */
 395     void SetPrinterName(const wxString& printerName);
 396
 397     /**
 398         Sets the desired print quality. This can be a positive integer,
 399         denoting the number of dots per inch, or one of the following
 400         identifiers:
 401
 402         - wxPRINT_QUALITY_HIGH
 403         - wxPRINT_QUALITY_MEDIUM
 404         - wxPRINT_QUALITY_LOW
 405         - wxPRINT_QUALITY_DRAFT
 406
 407         On input you should pass one of these identifiers, but on return you
 408         may get back a positive integer indicating the current resolution
 409         setting.
 410     */
 411     void SetQuality(wxPrintQuality quality);
 412
 413     /**
 414         Assigns print data to this object.
 415     */
 416     wxPrintData& operator =(const wxPrintData& data);
 417
 418
 419     wxString GetFilename() const;
 420     void SetFilename( const wxString &filename );
 421
 422     wxPrintMode GetPrintMode() const ;
 423     void SetPrintMode(wxPrintMode printMode) ;
 424 };
 425
 426
 427
 428 /**
 429     @class wxPrintDialogData
 430
 431     This class holds information related to the visual characteristics of
 432     wxPrintDialog. It contains a wxPrintData object with underlying printing
 433     settings.
 434
 435     @library{wxcore}
 436     @category{printing,cmndlg,data}
 437
 438     @see @ref overview_printing, wxPrintDialog, @ref overview_cmndlg_print
 439 */
 440 class wxPrintDialogData : public wxObject
 441 {
 442 public:
 443     /**
 444         Default constructor.
 445     */
 446     wxPrintDialogData();
 447
 448     /**
 449         Copy constructor.
 450     */
 451     wxPrintDialogData(const wxPrintDialogData& dialogData);
 452
 453     /**
 454         Construct an object from a print dialog data object.
 455     */
 456     wxPrintDialogData(const wxPrintData& printData);
 457
 458     /**
 459         Destructor.
 460     */
 461     virtual ~wxPrintDialogData();
 462
 463     /**
 464         Enables or disables the "Help" button.
 465     */
 466     void EnableHelp(bool flag);
 467
 468     /**
 469         Enables or disables the "Page numbers" controls.
 470     */
 471     void EnablePageNumbers(bool flag);
 472
 473     /**
 474         Enables or disables the "Print to file" checkbox.
 475     */
 476     void EnablePrintToFile(bool flag);
 477
 478     /**
 479         Enables or disables the "Selection" radio button.
 480     */
 481     void EnableSelection(bool flag);
 482
 483     /**
 484         Returns @true if the user requested that all pages be printed.
 485     */
 486     bool GetAllPages() const;
 487
 488     /**
 489         Returns @true if the user requested that the document(s) be collated.
 490     */
 491     bool GetCollate() const;
 492
 493     /**
 494         Returns the @e from page number, as entered by the user.
 495     */
 496     int GetFromPage() const;
 497
 498     /**
 499         Returns the @e maximum page number.
 500     */
 501     int GetMaxPage() const;
 502
 503     /**
 504         Returns the @e minimum page number.
 505     */
 506     int GetMinPage() const;
 507
 508     /**
 509         Returns the number of copies requested by the user.
 510     */
 511     int GetNoCopies() const;
 512
 513     /**
 514         Returns a reference to the internal wxPrintData object.
 515     */
 516     wxPrintData& GetPrintData();
 517
 518     /**
 519         Returns @true if the user has selected printing to a file.
 520     */
 521     bool GetPrintToFile() const;
 522
 523     /**
 524         Returns @true if the user requested that the selection be printed
 525         (where "selection" is a concept specific to the application).
 526     */
 527     bool GetSelection() const;
 528
 529     /**
 530         Returns the @e "print to" page number, as entered by the user.
 531     */
 532     int GetToPage() const;
 533
 534     /**
 535         Returns @true if the print data is valid for using in print dialogs.
 536         This can return @false on Windows if the current printer is not set,
 537         for example. On all other platforms, it returns @true.
 538     */
 539     bool IsOk() const;
 540
 541     /**
 542         Sets the "Collate" checkbox to @true or @false.
 543     */
 544     void SetCollate(bool flag);
 545
 546     /**
 547         Sets the @e from page number.
 548     */
 549     void SetFromPage(int page);
 550
 551     /**
 552         Sets the @e maximum page number.
 553     */
 554     void SetMaxPage(int page);
 555
 556     /**
 557         Sets the @e minimum page number.
 558     */
 559     void SetMinPage(int page);
 560
 561     /**
 562         Sets the default number of copies the user has requested to be printed
 563         out.
 564     */
 565     void SetNoCopies(int n);
 566
 567     /**
 568         Sets the internal wxPrintData.
 569     */
 570     void SetPrintData(const wxPrintData& printData);
 571
 572     /**
 573         Sets the "Print to file" checkbox to @true or @false.
 574     */
 575     void SetPrintToFile(bool flag);
 576
 577     /**
 578         Selects the "Selection" radio button. The effect of printing the
 579         selection depends on how the application implements this command, if at
 580         all.
 581     */
 582     void SetSelection(bool flag);
 583
 584     /**
 585         @deprecated This function has been deprecated since version 2.5.4.
 586
 587         Determines whether the dialog to be shown will be the Print dialog
 588         (pass @false) or Print Setup dialog (pass @true).
 589
 590     */
 591     void SetSetupDialog(bool flag);
 592
 593     /**
 594         Sets the @e "print to" page number.
 595     */
 596     void SetToPage(int page);
 597
 598     /**
 599         Assigns print data to this object.
 600     */
 601     void operator =(const wxPrintData& data);
 602
 603     /**
 604         Assigns another print dialog data object to this object.
 605     */
 606     void operator =(const wxPrintDialogData& data);
 607 };
 608