FLTK
Fl_EPS_File_Surface Class Reference

Encapsulated PostScript drawing surface. More...

#include <Fl_PostScript.H>

Inheritance diagram for Fl_EPS_File_Surface:
Fl_Widget_Surface Fl_Surface_Device

Public Member Functions

int close ()
 Closes using fclose() the underlying FILE pointer. More...
 
FILE * file ()
 Returns the underlying FILE pointer.
 
 Fl_EPS_File_Surface (int width, int height, FILE *eps, Fl_Color background=FL_WHITE)
 Constructor. More...
 
virtual void origin (int x, int y)
 Sets the position of the origin of graphics in the drawable part of the drawing surface. More...
 
virtual void origin (int *px, int *py)
 Computes the coordinates of the current origin of graphics functions. More...
 
virtual int printable_rect (int *w, int *h)
 Computes the width and height of the drawable area of the drawing surface. More...
 
virtual void translate (int x, int y)
 Translates the current graphics origin accounting for the current rotation. More...
 
virtual void untranslate ()
 Undoes the effect of a previous translate() call.
 
 ~Fl_EPS_File_Surface ()
 Destructor. More...
 
- 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...
 

Protected Member Functions

Fl_PostScript_Graphics_Driver * driver ()
 Returns the PostScript driver of this drawing surface. More...
 
- 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

- 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

Encapsulated PostScript drawing surface.

This drawing surface allows to store any FLTK graphics in vectorial form in an "Encapsulated PostScript" file.
Usage example:

Fl_Window *win = ...// Window to draw to an .eps file
int ww = win->decorated_w();
int wh = win->decorated_h();
FILE *eps = fl_fopen("/path/to/mywindow.eps", "w");
if (eps) {
surface->draw_decorated_window(win);
delete surface; // the .eps file is not complete until the destructor was run
fclose(eps);
}

Constructor & Destructor Documentation

◆ Fl_EPS_File_Surface()

Fl_EPS_File_Surface::Fl_EPS_File_Surface ( int  width,
int  height,
FILE *  eps,
Fl_Color  background = FL_WHITE 
)

Constructor.

Parameters
width,heightWidth and height of the EPS drawing area
epsA writable FILE pointer where the Encapsulated PostScript data will be sent
backgroundColor expected to cover the background of the EPS drawing area. This parameter affects only the drawing of transparent Fl_RGB_Image objects: transparent areas of RGB images are blended with the background color.

◆ ~Fl_EPS_File_Surface()

Fl_EPS_File_Surface::~Fl_EPS_File_Surface ( )

Destructor.

The underlying FILE pointer remains open after destruction of the Fl_EPS_File_Surface object unless close() was called.

Member Function Documentation

◆ close()

int Fl_EPS_File_Surface::close ( )

Closes using fclose() the underlying FILE pointer.

The only operation possible with the Fl_EPS_File_Surface object after calling close() is its destruction.

◆ driver()

Fl_PostScript_Graphics_Driver* Fl_EPS_File_Surface::driver ( )
inlineprotected

Returns the PostScript driver of this drawing surface.

◆ origin() [1/2]

virtual void Fl_EPS_File_Surface::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.

◆ origin() [2/2]

virtual void Fl_EPS_File_Surface::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.

◆ printable_rect()

virtual int Fl_EPS_File_Surface::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.

◆ translate()

virtual void Fl_EPS_File_Surface::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: