interface/dcps.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcps.h
   3 // Purpose:     documentation for wxPostScriptDC class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPostScriptDC
  11     @wxheader{dcps.h}
  12
  13     This defines the wxWidgets Encapsulated PostScript device context,
  14     which can write PostScript files on any platform. See wxDC for
  15     descriptions of the member functions.
  16
  17     @library{wxbase}
  18     @category{dc}
  19 */
  20 class wxPostScriptDC : public wxDC
  21 {
  22 public:
  23     //@{
  24     /**
  25         Constructor. @a output is an optional file for printing to, and if
  26         @a interactive is @true a dialog box will be displayed for adjusting
  27         various parameters. @a parent is the parent of the printer dialog box.
  28         Use the @e Ok member to test whether the constructor was successful
  29         in creating a usable device context.
  30         See @ref overview_printersettings "Printer settings" for functions to set and
  31         get PostScript printing settings.
  32         This constructor and the global printer settings are now deprecated;
  33         use the wxPrintData constructor instead.
  34     */
  35     wxPostScriptDC(const wxPrintData& printData);
  36     wxPostScriptDC(const wxString& output,
  37                    bool interactive = true,
  38                    wxWindow* parent);
  39     //@}
  40
  41     /**
  42         Return resolution used in PostScript output. See
  43         SetResolution().
  44     */
  45     static int GetResolution();
  46
  47     /**
  48         Set resolution (in pixels per inch) that will be used in PostScript
  49         output. Default is 720ppi.
  50     */
  51     static void SetResolution(int ppi);
  52 };
  53
  54
  55 // ============================================================================
  56 // Global functions/macros
  57 // ============================================================================
  58
  59 /**
  60     Gets the printer command used to print a file. The default is @c lpr.
  61 */
  62 wxString wxGetPrinterCommand();
  63
  64 /**
  65     Sets the printer command used to print a file. The default is @c lpr.
  66 */
  67 void wxSetPrinterCommand(const wxString& command);
  68
  69 /**
  70     Gets the orientation (PS_PORTRAIT or PS_LANDSCAPE). The default is PS_PORTRAIT.
  71 */
  72 int wxGetPrinterOrientation();
  73
  74 /**
  75     Sets the additional options for the print command (e.g. specific printer). The
  76     default is nothing.
  77 */
  78 void wxSetPrinterOptions(const wxString& options);
  79
  80 /**
  81     Gets the translation (from the top left corner) for PostScript output. The
  82     default is 0.0, 0.0.
  83 */
  84 void wxGetPrinterTranslation(float* x, float* y);
  85
  86 /**
  87     Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
  88 */
  89 void wxSetPrinterScaling(float x, float y);
  90
  91 /**
  92     Sets the orientation (PS_PORTRAIT or PS_LANDSCAPE). The default is PS_PORTRAIT.
  93 */
  94 void wxSetPrinterOrientation(int orientation);
  95
  96 /**
  97     Sets the printing mode controlling where output is sent (PS_PREVIEW, PS_FILE or
  98     PS_PRINTER).
  99     The default is PS_PREVIEW.
 100 */
 101 void wxSetPrinterMode(int mode);
 102
 103 /**
 104     Sets the PostScript output filename.
 105 */
 106 void wxSetPrinterFile(const wxString& filename);
 107
 108 /**
 109     Gets the PostScript output filename.
 110 */
 111 wxString wxGetPrinterFile();
 112
 113 /**
 114     Gets the additional options for the print command (e.g. specific printer). The
 115     default is nothing.
 116 */
 117 wxString wxGetPrinterOptions();
 118
 119 /**
 120     Gets the command used to view a PostScript file. The default depends on the
 121     platform.
 122 */
 123 wxString wxGetPrinterPreviewCommand();
 124
 125 /**
 126     Gets the printing mode controlling where output is sent (PS_PREVIEW, PS_FILE or
 127     PS_PRINTER).
 128     The default is PS_PREVIEW.
 129 */
 130 int wxGetPrinterMode();
 131
 132 /**
 133     Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
 134 */
 135 void wxGetPrinterScaling(float* x, float* y);
 136
 137 /**
 138     Sets the command used to view a PostScript file. The default depends on the
 139     platform.
 140 */
 141 void wxSetPrinterPreviewCommand(const wxString& command);
 142