Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Protected Member Functions | Friends
nsIPrintJobPS Class Reference

#include <nsIPrintJobPS.h>

Inheritance diagram for nsIPrintJobPS:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~nsIPrintJobPS ()
 Obligatory virtual destructor for polymorphic objects.
virtual nsresult SetNumCopies (int aNumCopies)=0
 Set the number of copies for this print job.
virtual void SetJobTitle (const PRUnichar *aTitle)
 Set the print job title.
virtual nsresult StartSubmission (FILE **aHandle)=0
 Begin submitting a print job.
virtual nsresult FinishSubmission ()=0
 Finish submitting a print job.

Protected Member Functions

virtual nsresult Init (nsIDeviceContextSpecPS *aContext)=0
 Initialize an object from a device context spec.

Friends

class nsPrintJobFactoryPS

Detailed Description

Definition at line 56 of file nsIPrintJobPS.h.


Constructor & Destructor Documentation

Obligatory virtual destructor for polymorphic objects.

Definition at line 67 of file nsPrintJobPS.cpp.

{}

Member Function Documentation

virtual nsresult nsIPrintJobPS::FinishSubmission ( ) [pure virtual]

Finish submitting a print job.

The caller must call this after calling StartSubmission() and writing the text of the print job to the file handle. The return value indicates the overall success or failure of the print operation.

Returns:
NS_ERROR_GFX_PRINTING_NOT_IMPLEMENTED if the print job object doesn't actually support printing (e.g. for print preview) NS_OK for success Another value for initialization/startup failures.

Implemented in nsPrintJobCUPS, nsPrintJobPipePS, nsPrintJobFilePS, and nsPrintJobPreviewPS.

Here is the caller graph for this function:

virtual nsresult nsIPrintJobPS::Init ( nsIDeviceContextSpecPS aContext) [protected, pure virtual]

Initialize an object from a device context spec.

This must be called before any of the public methods.

Parameters:
aContextThe device context spec describing the desired print job.
Returns:
NS_OK or a suitable error value.

Implemented in nsPrintJobCUPS, nsPrintJobPipePS, nsPrintJobFilePS, and nsPrintJobPreviewPS.

Here is the caller graph for this function:

virtual void nsIPrintJobPS::SetJobTitle ( const PRUnichar aTitle) [inline, virtual]

Set the print job title.

Some printing systems accept a job title which is displayed on a banner page, in a print queue listing, etc.

This must be called after Init() and before StartSubmission(). nsIPrintJobPS provides a stub implementation because most classes do not make use of this information.

Parameters:
aTitleThe job title.

Reimplemented in nsPrintJobCUPS.

Definition at line 92 of file nsIPrintJobPS.h.

{ }

Here is the caller graph for this function:

virtual nsresult nsIPrintJobPS::SetNumCopies ( int  aNumCopies) [pure virtual]

Set the number of copies for this print job.

Some printing systems allow setting this out of band, instead of embedding it into the postscript.

Parameters:
aNumCopiesNumber of copies requested. Values <= 1 are interpreted as "do not specify a copy count to the printing system" when possible, or else as one copy.
Returns:
NS_ERROR_NOT_IMPLEMENTED if this print job class doesn't support the specific copy count requested.
NS_OK The print job class will request the specified number of copies when printing the job.

Implemented in nsPrintJobCUPS, nsPrintJobFilePS, and nsPrintJobPreviewPS.

Here is the caller graph for this function:

virtual nsresult nsIPrintJobPS::StartSubmission ( FILE **  aHandle) [pure virtual]

Begin submitting a print job.

Parameters:
aHandleIf the return value is NS_OK, this will be filled in with a file handle which the caller should use to write the text of the print job. The file handle may not support seeking. The caller must not close the file handle.
Returns:
NS_ERROR_GFX_PRINTING_NOT_IMPLEMENTED if the print job object doesn't actually support printing (e.g. for print preview) NS_OK for success Another value for initialization/startup failures.

Implemented in nsPrintJobCUPS, nsPrintJobPipePS, nsPrintJobFilePS, and nsPrintJobPreviewPS.

Here is the caller graph for this function:


Friends And Related Function Documentation

friend class nsPrintJobFactoryPS [friend]

Definition at line 65 of file nsIPrintJobPS.h.


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