Cairo::PdfSurface Class Reference

Inheritance diagram for Cairo::PdfSurface:

Inheritance graph
[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

Public Member Functions

 PdfSurface (cairo_surface_t *cobject, bool has_reference=false)
 Create a C++ wrapper for the C instance.
void set_size (double width_in_points, double height_in_points)
 Changes the size of a PDF surface for the current (and subsequent) pages.
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_size ( double  width_in_points,
double  height_in_points 
)

Changes the size of a PDF surface for the current (and subsequent) pages.

This function should only be called before any drawing operations have been performed on the current page. The simplest way to do this is to call this function immediately after creating the surface or immediately after completing a page with either Context::show_page() or Context::copy_page().

Parameters:
width_in_points new surface width, in points (1 point == 1/72.0 inch)
height_in_points new surface height, in points (1 point == 1/72.0 inch)


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

Generated on Thu Sep 4 21:57:17 2008 for cairomm by  doxygen 1.5.5