FLTK 1.4.0
Fl_PostScript_File_Device Class Reference

To send graphical output to a PostScript file. More...

#include <Fl_PostScript.H>

Inheritance diagram for Fl_PostScript_File_Device:
Fl_Paged_Device Fl_Widget_Surface Fl_Surface_Device

Public Member Functions

int begin_job (int pagecount, int *from, int *to, char **perr_message)
 Don't use with this class. More...
 
int begin_job (int pagecount=0, enum Fl_Paged_Device::Page_Format format=Fl_Paged_Device::A4, enum Fl_Paged_Device::Page_Layout layout=Fl_Paged_Device::PORTRAIT)
 Begins the session where all graphics requests will go to a local PostScript file. More...
 
int begin_job (FILE *ps_output, int pagecount=0, enum Fl_Paged_Device::Page_Format format=Fl_Paged_Device::A4, enum Fl_Paged_Device::Page_Layout layout=Fl_Paged_Device::PORTRAIT)
 Begins the session where all graphics requests will go to FILE pointer. More...
 
int begin_page (void)
 Begins a new printed page. More...
 
void end_job (void)
 To be called at the end of a print job.
 
int end_page (void)
 To be called at the end of each page. More...
 
FILE * file ()
 Returns the underlying FILE* receiving all PostScript data.
 
 Fl_PostScript_File_Device ()
 The constructor.
 
void margins (int *left, int *top, int *right, int *bottom)
 Computes the dimensions of margins that lie between the printable page area and the full page. More...
 
void origin (int *x, int *y)
 Computes the coordinates of the current origin of graphics functions. More...
 
void origin (int x, int y)
 Sets the position of the origin of graphics in the drawable part of the drawing surface. More...
 
int printable_rect (int *w, int *h)
 Computes the width and height of the drawable area of the drawing surface. More...
 
void rotate (float angle)
 Rotates the graphics operations relatively to paper. More...
 
void scale (float scale_x, float scale_y=0.)
 Changes the scaling of page coordinates. More...
 
int start_job (int pagecount=0, enum Fl_Paged_Device::Page_Format format=Fl_Paged_Device::A4, enum Fl_Paged_Device::Page_Layout layout=Fl_Paged_Device::PORTRAIT)
 Synonym of begin_job(). More...
 
int start_job (FILE *ps_output, int pagecount=0, enum Fl_Paged_Device::Page_Format format=Fl_Paged_Device::A4, enum Fl_Paged_Device::Page_Layout layout=Fl_Paged_Device::PORTRAIT)
 Synonym of begin_job(). More...
 
void translate (int x, int y)
 Translates the current graphics origin accounting for the current rotation. More...
 
void untranslate (void)
 Undoes the effect of a previous translate() call.
 
 ~Fl_PostScript_File_Device ()
 The destructor.
 
- Public Member Functions inherited from Fl_Paged_Device
void print_widget (Fl_Widget *widget, int delta_x=0, int delta_y=0)
 Synonym of draw(Fl_Widget*, int, int)
 
void print_window (Fl_Window *win, int x_offset=0, int y_offset=0)
 Synonym of draw_decorated_window(Fl_Window*, int, int)
 
int start_job (int pagecount=0, int *frompage=NULL, int *topage=NULL, char **perr_message=NULL)
 Synonym of begin_job(int pagecount, int *frompage, int *topage, char **perr_message). More...
 
int start_page ()
 Synonym of begin_page(). More...
 
virtual ~Fl_Paged_Device ()
 The destructor.
 
- Public Member Functions inherited from Fl_Widget_Surface
void draw (Fl_Widget *widget, int delta_x=0, int delta_y=0)
 Draws the widget on the drawing surface. More...
 
virtual void draw_decorated_window (Fl_Window *win, int x_offset=0, int y_offset=0)
 Draws a window with its title bar and frame if any. More...
 
void print_window_part (Fl_Window *win, int x, int y, int w, int h, int delta_x=0, int delta_y=0)
 Draws a rectangular part of an on-screen window. More...
 
- Public Member Functions inherited from Fl_Surface_Device
Fl_Graphics_Driver * driver ()
 Returns the graphics driver of this drawing surface. More...
 
virtual bool is_current ()
 Is this surface the current drawing surface?
 
virtual void set_current (void)
 Make this surface the current drawing surface. More...
 
virtual ~Fl_Surface_Device ()
 The destructor. More...
 

Static Public Attributes

static const char * file_chooser_title
 Label of the PostScript file chooser window.
 
- Static Public Attributes inherited from Fl_Paged_Device
static const page_format page_formats [NO_PAGE_FORMATS]
 width, height and name of all elements of the enum Page_Format.
 

Protected Member Functions

Fl_PostScript_Graphics_Driver * driver ()
 Returns the PostScript driver of this drawing surface.
 
- Protected Member Functions inherited from Fl_Paged_Device
 Fl_Paged_Device ()
 The constructor.
 
- Protected Member Functions inherited from Fl_Widget_Surface
 Fl_Widget_Surface (Fl_Graphics_Driver *d)
 The constructor. More...
 
- Protected Member Functions inherited from Fl_Surface_Device
void driver (Fl_Graphics_Driver *graphics_driver)
 Sets the graphics driver of this drawing surface. More...
 
virtual void end_current ()
 
 Fl_Surface_Device (Fl_Graphics_Driver *graphics_driver)
 Constructor that sets the graphics driver to use for the created surface. More...
 

Additional Inherited Members

- Public Types inherited from Fl_Paged_Device
enum  Page_Format {
  A0 = 0, A1, A2, A3,
  A4, A5, A6, A7,
  A8, A9, B0, B1,
  B2, B3, B4, B5,
  B6, B7, B8, B9,
  B10, C5E, DLE, EXECUTIVE,
  FOLIO, LEDGER, LEGAL, LETTER,
  TABLOID, ENVELOPE, MEDIA = 0x1000
}
 Possible page formats. More...
 
enum  Page_Layout { PORTRAIT = 0, LANDSCAPE = 0x100, REVERSED = 0x200, ORIENTATION = 0x300 }
 Possible page layouts. More...
 
- Static Public Member Functions inherited from Fl_Surface_Device
static Fl_Surface_Devicepop_current ()
 Removes the top element from the current drawing surface stack, and makes the new top element current. More...
 
static void push_current (Fl_Surface_Device *new_current)
 Pushes new_current on top of the stack of current drawing surfaces, and makes it current. More...
 
static Fl_Surface_Devicesurface ()
 The current drawing surface. More...
 
- Protected Attributes inherited from Fl_Widget_Surface
int x_offset
 horizontal offset to the origin of graphics coordinates
 
int y_offset
 vertical offset to the origin of graphics coordinates
 

Detailed Description

To send graphical output to a PostScript file.

This class is used exactly as the Fl_Printer class except for the begin_job() call, two variants of which are usable and allow to specify what page format and layout are desired.

PostScript text uses vectorial fonts when using the FLTK standard fonts and the latin alphabet or a few other characters listed in the following table. The latin alphabet means all unicode characters between U+0020 and U+017F, or, in other words, the ASCII, Latin-1 Supplement and Latin Extended-A charts.

CharCodepointName CharCodepointName CharCodepointName
ƒU+0192florinU+201AquotesinglbaseU+2122trademark
ˆU+02C6circumflexU+201CquotedblleftU+2202partialdiff
ˇU+02C7caronU+201DquotedblrightΔU+2206Delta
˘U+02D8breveU+201EquotedblbaseU+2211summation
˙U+02D9dotaccentU+2020daggerU+221Aradical
˚U+02DAringU+2021daggerdblU+221Einfinity
˛U+02DBogonekU+2022bulletU+2260notequal
˜U+02DCtildeU+2026ellipsisU+2264lessequal
˝U+02DDhungarumlautU+2030perthousandU+2265greaterequal
U+2013endashU+2039guilsinglleftU+25CAlozenge
U+2014emdashU+203AguilsinglrightU+FB01fi
U+2018quoteleft/U+2044fractionU+FB02fl
U+2019quoterightU+20ACEuroU+F8FFapple (Mac OS only)


All other unicode characters or all other fonts (FL_FREE_FONT and above) are output as a bitmap.
FLTK standard fonts are output using the corresponding PostScript standard fonts.

Member Function Documentation

◆ begin_job() [1/3]

int Fl_PostScript_File_Device::begin_job ( int  pagecount,
int *  from,
int *  to,
char **  perr_message 
)
virtual

Don't use with this class.

Reimplemented from Fl_Paged_Device.

◆ begin_job() [2/3]

int Fl_PostScript_File_Device::begin_job ( int  pagecount = 0,
enum Fl_Paged_Device::Page_Format  format = Fl_Paged_Device::A4,
enum Fl_Paged_Device::Page_Layout  layout = Fl_Paged_Device::PORTRAIT 
)

Begins the session where all graphics requests will go to a local PostScript file.

Opens a file dialog entitled with Fl_PostScript_File_Device::file_chooser_title to select an output PostScript file.

Parameters
pagecountThe total number of pages to be created. Use 0 if this number is unknown when this function is called.
formatDesired page format.
layoutDesired page layout.
Returns
0 if OK, 1 if user cancelled the file dialog, 2 if fopen failed on user-selected output file.

◆ begin_job() [3/3]

int Fl_PostScript_File_Device::begin_job ( FILE *  ps_output,
int  pagecount = 0,
enum Fl_Paged_Device::Page_Format  format = Fl_Paged_Device::A4,
enum Fl_Paged_Device::Page_Layout  layout = Fl_Paged_Device::PORTRAIT 
)

Begins the session where all graphics requests will go to FILE pointer.

Parameters
ps_outputA writable FILE pointer that will receive PostScript output and that should not be closed until after end_job() has been called.
pagecountThe total number of pages to be created. Use 0 if this number is unknown when this function is called.
formatDesired page format.
layoutDesired page layout.
Returns
always 0.

◆ begin_page()

int Fl_PostScript_File_Device::begin_page ( void  )
virtual

Begins a new printed page.

The page coordinates are initially in points, i.e., 1/72 inch, and with origin at the top left of the printable page area.

Returns
0 if OK, non-zero if any error

Reimplemented from Fl_Paged_Device.

◆ end_page()

int Fl_PostScript_File_Device::end_page ( void  )
virtual

To be called at the end of each page.

Returns
0 if OK, non-zero if any error.

Reimplemented from Fl_Paged_Device.

◆ margins()

void Fl_PostScript_File_Device::margins ( int *  left,
int *  top,
int *  right,
int *  bottom 
)
virtual

Computes the dimensions of margins that lie between the printable page area and the full page.

Values are in the same unit as that used by FLTK drawing functions. They are changed by scale() calls.

Parameters
[out]leftIf non-null, *left is set to the left margin size.
[out]topIf non-null, *top is set to the top margin size.
[out]rightIf non-null, *right is set to the right margin size.
[out]bottomIf non-null, *bottom is set to the bottom margin size.

Reimplemented from Fl_Paged_Device.

◆ origin() [1/2]

void Fl_PostScript_File_Device::origin ( int *  x,
int *  y 
)
virtual

Computes the coordinates of the current origin of graphics functions.

Parameters
[out]x,yIf non-null, *x and *y are set to the horizontal and vertical coordinates of the graphics origin.

Reimplemented from Fl_Widget_Surface.

◆ origin() [2/2]

void Fl_PostScript_File_Device::origin ( int  x,
int  y 
)
virtual

Sets the position of the origin of graphics in the drawable part of the drawing surface.

Arguments should be expressed relatively to the result of a previous printable_rect() call. That is, printable_rect(&w, &h); origin(w/2, 0); sets the graphics origin at the top center of the drawable area. Successive origin() calls don't combine their effects. Origin() calls are not affected by rotate() calls (for classes derived from Fl_Paged_Device).

Parameters
[in]x,yHorizontal and vertical positions in the drawing surface of the desired origin of graphics.

Reimplemented from Fl_Widget_Surface.

◆ printable_rect()

int Fl_PostScript_File_Device::printable_rect ( int *  w,
int *  h 
)
virtual

Computes the width and height of the drawable area of the drawing surface.

Values are in the same unit as that used by FLTK drawing functions and are unchanged by calls to origin(). If the object is derived from class Fl_Paged_Device, values account for the user-selected paper type and print orientation and are changed by scale() calls.

Returns
0 if OK, non-zero if any error

Reimplemented from Fl_Widget_Surface.

◆ rotate()

void Fl_PostScript_File_Device::rotate ( float  angle)
virtual

Rotates the graphics operations relatively to paper.

The rotation is centered on the current graphics origin. Successive rotate() calls don't combine their effects.

Parameters
angleRotation angle in counter-clockwise degrees.

Reimplemented from Fl_Paged_Device.

◆ scale()

void Fl_PostScript_File_Device::scale ( float  scale_x,
float  scale_y = 0. 
)
virtual

Changes the scaling of page coordinates.

This function also resets the origin of graphics functions at top left of printable page area. After a scale() call, do a printable_rect() call to get the new dimensions of the printable page area. Successive scale() calls don't combine their effects.

Parameters
scale_xHorizontal dimensions of plot are multiplied by this quantity.
scale_ySame as above, vertically. The value 0. is equivalent to setting scale_y = scale_x. Thus, scale(factor); is equivalent to scale(factor, factor);

Reimplemented from Fl_Paged_Device.

◆ start_job() [1/2]

int Fl_PostScript_File_Device::start_job ( int  pagecount = 0,
enum Fl_Paged_Device::Page_Format  format = Fl_Paged_Device::A4,
enum Fl_Paged_Device::Page_Layout  layout = Fl_Paged_Device::PORTRAIT 
)
inline

Synonym of begin_job().

For API compatibility with FLTK 1.3.x

◆ start_job() [2/2]

int Fl_PostScript_File_Device::start_job ( FILE *  ps_output,
int  pagecount = 0,
enum Fl_Paged_Device::Page_Format  format = Fl_Paged_Device::A4,
enum Fl_Paged_Device::Page_Layout  layout = Fl_Paged_Device::PORTRAIT 
)
inline

Synonym of begin_job().

For API compatibility with FLTK 1.3.x

◆ translate()

void Fl_PostScript_File_Device::translate ( int  x,
int  y 
)
virtual

Translates the current graphics origin accounting for the current rotation.

Each translate() call must be matched by an untranslate() call. Successive translate() calls add up their effects.

Reimplemented from Fl_Widget_Surface.


The documentation for this class was generated from the following file: