Cairo::PdfSurface Class Reference

Inheritance diagram for Cairo::PdfSurface:
[legend]
List of all members.

Detailed Description

A PdfSurface provides a way to render PDF documents from cairo.

This surface is not rendered to the screen but instead renders the drawing to a PDF file on disk.

Note:
For this Surface to be available, cairo must have been compiled with PDF support
Warning:
This is an experimental surface. It is not yet marked as a fully supported surface by the cairo library


Public Member Functions

 PdfSurface (cairo_surface_t *cobject, bool has_reference=false)
 Create a C++ wrapper for the C instance.
void set_dpi (double x_dpi, double y_dpi)
 Sets the resolution of the image in dots per inch.
virtual ~PdfSurface ()

Static Public Member Functions

static RefPtr< PdfSurfacecreate (cairo_write_func_t write_func, void *closure, double width_in_points, double height_in_points)
 Creates a PdfSurface with a specified dimensions that will be written to the given write function instead of saved directly to disk.
static RefPtr< PdfSurfacecreate (std::string filename, double width_in_points, double height_in_points)
 Creates a PdfSurface with a specified dimensions that will be saved as the given filename.


Constructor & Destructor Documentation

Cairo::PdfSurface::PdfSurface ( cairo_surface_t *  cobject,
bool  has_reference = false 
) [explicit]

Create a C++ wrapper for the C instance.

This C++ instance should then be given to a RefPtr.

Parameters:
cobject The C instance.
has_reference whether we already have a reference. Otherwise, the constructor will take an extra reference.

virtual Cairo::PdfSurface::~PdfSurface (  )  [virtual]


Member Function Documentation

static RefPtr<PdfSurface> Cairo::PdfSurface::create ( cairo_write_func_t  write_func,
void *  closure,
double  width_in_points,
double  height_in_points 
) [static]

Creates a PdfSurface with a specified dimensions that will be written to the given write function instead of saved directly to disk.

Parameters:
write_func The function to be called when the backend needs to write data to an output stream
closure closure data for the write function
width_in_points The width of the PDF document in points
height_in_points The height of the PDF document in points

static RefPtr<PdfSurface> Cairo::PdfSurface::create ( std::string  filename,
double  width_in_points,
double  height_in_points 
) [static]

Creates a PdfSurface with a specified dimensions that will be saved as the given filename.

Parameters:
filename The name of the PDF file to save the surface to
width_in_points The width of the PDF document in points
height_in_points The height of the PDF document in points

void Cairo::PdfSurface::set_dpi ( double  x_dpi,
double  y_dpi 
)

Sets the resolution of the image in dots per inch.

Parameters:
x_dpi The dpi in the x direction
y_dpi The dpi in the y direction


The documentation for this class was generated from the following file:
Generated on Sun Jul 23 16:49:21 2006 for cairomm by  doxygen 1.4.7