d67e9ccb73
This commit includes all fixes from branch-1.3 (svn r 11243) and additional
fixes for warnings that crept in during the porting efforts, particularly
C++ ("//") comments in C and included header files, and some more.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11246 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
248 lines
8.3 KiB
C++
248 lines
8.3 KiB
C++
//
|
|
// "$Id$"
|
|
//
|
|
// Printing support for the Fast Light Tool Kit (FLTK).
|
|
//
|
|
// Copyright 2010-2016 by Bill Spitzak and others.
|
|
//
|
|
// This library is free software. Distribution and use rights are outlined in
|
|
// the file "COPYING" which should have been included with this file. If this
|
|
// file is missing or damaged, see the license at:
|
|
//
|
|
// http://www.fltk.org/COPYING.php
|
|
//
|
|
// Please report all bugs and problems on the following page:
|
|
//
|
|
// http://www.fltk.org/str.php
|
|
//
|
|
|
|
/** \file Fl_Printer.H
|
|
\brief declaration of classes Fl_Printer, Fl_System_Printer and Fl_PostScript_Printer.
|
|
*/
|
|
|
|
#ifndef Fl_Printer_H
|
|
#define Fl_Printer_H
|
|
|
|
#include <FL/x.H>
|
|
#include <FL/Fl_Paged_Device.H>
|
|
#include <FL/fl_draw.H>
|
|
#include <FL/Fl_Pixmap.H>
|
|
#include <FL/Fl_RGB_Image.H>
|
|
#include <FL/Fl_Bitmap.H>
|
|
#include <stdio.h>
|
|
#ifdef WIN32
|
|
#include <commdlg.h>
|
|
#elif defined(__APPLE__) // PORTME: Fl_Surface_Driver ? - platform printer driver
|
|
// not needed
|
|
#elif defined(FL_PORTING)
|
|
# pragma message "FL_PORTING: include files needed for printing support"
|
|
#else // X11
|
|
#include <FL/Fl_PostScript.H>
|
|
#endif
|
|
|
|
#if defined(__APPLE__) || defined(WIN32) || defined(FL_DOXYGEN) // PORTME: Fl_Surface_Driver ? - platform printer driver
|
|
/**
|
|
Print support under MSWindows and Mac OS.
|
|
|
|
Class Fl_System_Printer is implemented only on the MSWindows and Mac OS platforms.
|
|
It has no public constructor.
|
|
Use Fl_Printer instead that is cross-platform and has the same API.
|
|
*/
|
|
class Fl_System_Printer : public Fl_Paged_Device {
|
|
friend class Fl_Printer;
|
|
private:
|
|
#ifdef __APPLE__ // PORTME: Fl_Surface_Driver ? - platform printer driver
|
|
float scale_x;
|
|
float scale_y;
|
|
float angle; // rotation angle in radians
|
|
PMPrintSession printSession;
|
|
PMPageFormat pageFormat;
|
|
PMPrintSettings printSettings;
|
|
#elif defined(WIN32)
|
|
int abortPrint;
|
|
PRINTDLG pd;
|
|
HDC hPr;
|
|
int prerr;
|
|
int left_margin;
|
|
int top_margin;
|
|
void absolute_printable_rect(int *x, int *y, int *w, int *h);
|
|
#endif
|
|
protected:
|
|
/** \brief The constructor */
|
|
Fl_System_Printer(void);
|
|
public:
|
|
int start_job(int pagecount, int *frompage = NULL, int *topage = NULL);
|
|
int start_page (void);
|
|
int printable_rect(int *w, int *h);
|
|
void margins(int *left, int *top, int *right, int *bottom);
|
|
void origin(int *x, int *y);
|
|
void origin(int x, int y);
|
|
void scale (float scale_x, float scale_y = 0.);
|
|
void rotate(float angle);
|
|
void translate(int x, int y);
|
|
void untranslate(void);
|
|
int end_page (void);
|
|
void end_job (void);
|
|
#ifdef __APPLE__ // PORTME: Fl_Surface_Driver ? - platform printer driver
|
|
void draw_decorated_window(Fl_Window *win, int x_offset, int y_offset);
|
|
void print_window_part(Fl_Window *win, int x, int y, int w, int h, int delta_x, int delta_y);
|
|
#endif
|
|
/** \brief The destructor */
|
|
~Fl_System_Printer(void);
|
|
}; // class Fl_System_Printer
|
|
#endif
|
|
|
|
#if defined(FL_PORTING)
|
|
|
|
# pragma message "FL_PORTING: define your own Fl_xxx_Printer class"
|
|
class Fl_XXX_Printer : public Fl_Paged_Device {
|
|
friend class Fl_Printer;
|
|
protected:
|
|
Fl_XXX_Printer(void) { }
|
|
};
|
|
|
|
#endif
|
|
|
|
#if defined(FL_DOXYGEN) || !(defined(__APPLE__) || defined(WIN32) || defined(FL_PORTING))
|
|
|
|
/**
|
|
Print support under Unix/Linux.
|
|
|
|
Class Fl_PostScript_Printer is implemented only on the Unix/Linux platform.
|
|
It has no public constructor.
|
|
Use Fl_Printer instead that is cross-platform and has the same API.
|
|
*/
|
|
class Fl_PostScript_Printer : public Fl_PostScript_File_Device {
|
|
friend class Fl_Printer;
|
|
protected:
|
|
/** The constructor */
|
|
Fl_PostScript_Printer(void) {};
|
|
public:
|
|
int start_job(int pages, int *firstpage = NULL, int *lastpage = NULL);
|
|
};
|
|
|
|
#endif
|
|
|
|
/**
|
|
* \brief OS-independent print support.
|
|
*
|
|
Fl_Printer allows to use all drawing, color, text, image, and clip FLTK functions, and to have them operate
|
|
on printed page(s). There are two main, non exclusive, ways to use it.
|
|
<ul><li>Print any widget (standard, custom, Fl_Window, Fl_Gl_Window) as it appears
|
|
on screen, with optional translation, scaling and rotation. This is done by calling print_widget(),
|
|
print_window() or print_window_part().
|
|
<li>Use a series of FLTK graphics commands (e.g., font, text, lines, colors, clip, image) to
|
|
compose a page appropriately shaped for printing.
|
|
</ul>
|
|
In both cases, begin by start_job(), start_page(), printable_rect() and origin() calls
|
|
and finish by end_page() and end_job() calls.
|
|
<p>Example of use: print a widget centered in a page
|
|
\code
|
|
#include <FL/Fl_Printer.H>
|
|
#include <FL/fl_draw.H>
|
|
int width, height;
|
|
Fl_Widget *widget = ... // a widget we want printed
|
|
Fl_Printer *printer = new Fl_Printer();
|
|
if (printer->start_job(1) == 0) {
|
|
printer->start_page();
|
|
printer->printable_rect(&width, &height);
|
|
fl_color(FL_BLACK);
|
|
fl_line_style(FL_SOLID, 2);
|
|
fl_rect(0, 0, width, height);
|
|
fl_font(FL_COURIER, 12);
|
|
time_t now; time(&now); fl_draw(ctime(&now), 0, fl_height());
|
|
printer->origin(width/2, height/2);
|
|
printer->print_widget(widget, -widget->w()/2, -widget->h()/2);
|
|
printer->end_page();
|
|
printer->end_job();
|
|
}
|
|
delete printer;
|
|
\endcode
|
|
<b>Platform specifics</b>
|
|
<ul>
|
|
<li>Unix/Linux platforms:
|
|
Unless it has been previously changed, the default paper size is A4.
|
|
To change that, press the "Properties" button of the "Print" dialog window
|
|
opened by an Fl_Printer::start_job() call. This opens a "Printer Properties" window where it's
|
|
possible to select the adequate paper size. Finally press the "Save" button therein to assign
|
|
the chosen paper size to the chosen printer for this and all further print operations.
|
|
<br>Class Fl_RGB_Image prints but loses its transparency if it has one.
|
|
See class Fl_PostScript_Graphics_Driver for a description of how UTF-8 strings appear in print.
|
|
Use the static public attributes of this class to set the print dialog to other languages
|
|
than English. For example, the "Printer:" dialog item Fl_Printer::dialog_printer can be set to French with:
|
|
\code
|
|
Fl_Printer::dialog_printer = "Imprimante:";
|
|
\endcode
|
|
before creation of the Fl_Printer object.
|
|
Use Fl_PostScript_File_Device::file_chooser_title to customize the title of the file chooser dialog that opens
|
|
when using the "Print To File" option of the print dialog.
|
|
<li>MSWindows platform: Transparent Fl_RGB_Image 's don't print with exact transparency on most printers.
|
|
Fl_RGB_Image 's don't rotate() well.
|
|
A workaround is to use the print_window_part() call.
|
|
<li>Mac OS X platform: all graphics requests print as on display.
|
|
</ul>
|
|
*/
|
|
class FL_EXPORT Fl_Printer : public Fl_Paged_Device {
|
|
public:
|
|
/** \brief The constructor */
|
|
Fl_Printer(void);
|
|
int start_job(int pagecount, int *frompage = NULL, int *topage = NULL);
|
|
int start_page(void);
|
|
int printable_rect(int *w, int *h);
|
|
void margins(int *left, int *top, int *right, int *bottom);
|
|
void origin(int *x, int *y);
|
|
void origin(int x, int y);
|
|
void scale(float scale_x, float scale_y = 0.);
|
|
void rotate(float angle);
|
|
void translate(int x, int y);
|
|
void untranslate(void);
|
|
int end_page (void);
|
|
void end_job (void);
|
|
void print_widget(Fl_Widget* widget, int delta_x=0, int delta_y=0);
|
|
void print_window_part(Fl_Window *win, int x, int y, int w, int h, int delta_x=0, int delta_y=0);
|
|
void draw_decorated_window(Fl_Window *win, int x_offset, int y_offset);
|
|
void set_current(void);
|
|
|
|
/** \name These attributes are effective under the Xlib platform only.
|
|
\{
|
|
*/
|
|
static const char *dialog_title;
|
|
static const char *dialog_printer;
|
|
static const char *dialog_range;
|
|
static const char *dialog_copies;
|
|
static const char *dialog_all;
|
|
static const char *dialog_pages;
|
|
static const char *dialog_from;
|
|
static const char *dialog_to;
|
|
static const char *dialog_properties;
|
|
static const char *dialog_copyNo;
|
|
static const char *dialog_print_button;
|
|
static const char *dialog_cancel_button;
|
|
static const char *dialog_print_to_file;
|
|
static const char *property_title;
|
|
static const char *property_pagesize;
|
|
static const char *property_mode;
|
|
static const char *property_use;
|
|
static const char *property_save;
|
|
static const char *property_cancel;
|
|
/** \} */
|
|
/** \brief The destructor */
|
|
~Fl_Printer(void);
|
|
|
|
private:
|
|
#if defined(WIN32) || defined(__APPLE__) // PORTME: Fl_Surface_Driver ? - system printer driver
|
|
Fl_System_Printer *printer;
|
|
#elif defined(FL_PORTING)
|
|
# pragma message "FL_PORTING: instantiate your own Fl_xxx_Printer here"
|
|
Fl_XXX_Printer *printer;
|
|
#else
|
|
Fl_PostScript_Printer *printer;
|
|
#endif
|
|
};
|
|
|
|
#endif // Fl_Printer_H
|
|
|
|
//
|
|
// End of "$Id$"
|
|
//
|