Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Private Member Functions
nsIPageSequenceFrame Class Reference

Interface for accessing special capabilities of the page sequence frame. More...

#include <nsIPageSequenceFrame.h>

Inheritance diagram for nsIPageSequenceFrame:
Inheritance graph
[legend]
Collaboration diagram for nsIPageSequenceFrame:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD StartPrint (nsPresContext *aPresContext, nsIPrintSettings *aPrintOptions, PRUnichar *aDocTitle, PRUnichar *aDocURL)=0
 Print the set of pages.
NS_IMETHOD PrintNextPage (nsPresContext *aPresContext)=0
NS_IMETHOD GetCurrentPageNum (PRInt32 *aPageNum)=0
NS_IMETHOD GetNumPages (PRInt32 *aNumPages)=0
NS_IMETHOD IsDoingPrintRange (PRBool *aDoing)=0
NS_IMETHOD GetPrintRange (PRInt32 *aFromPage, PRInt32 *aToPage)=0
NS_IMETHOD SkipPageBegin ()=0
NS_IMETHOD SkipPageEnd ()=0
NS_IMETHOD DoPageEnd (nsPresContext *aPresContext)=0
NS_IMETHOD GetPrintThisPage (PRBool *aPrintThisPage)=0
NS_IMETHOD SetOffset (nscoord aX, nscoord aY)=0
NS_IMETHOD SuppressHeadersAndFooters (PRBool aDoSup)=0
NS_IMETHOD SetClipRect (nsPresContext *aPresContext, nsRect *aSize)=0
NS_IMETHOD SetSelectionHeight (nscoord aYOffset, nscoord aHeight)=0
NS_IMETHOD SetTotalNumPages (PRInt32 aTotal)=0
NS_IMETHOD GetDeadSpaceValue (nscoord *aValue)=0
NS_IMETHOD GetSTFPercent (float &aSTFPercent)=0

Private Member Functions

 NS_IMETHOD_ (nsrefcnt) AddRef(void)=0
 NS_IMETHOD_ (nsrefcnt) Release(void)=0

Detailed Description

Interface for accessing special capabilities of the page sequence frame.

Today all that exists are member functions for printing.

Definition at line 58 of file nsIPageSequenceFrame.h.


Member Function Documentation

NS_IMETHOD nsIPageSequenceFrame::DoPageEnd ( nsPresContext aPresContext) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

NS_IMETHOD nsIPageSequenceFrame::GetNumPages ( PRInt32 aNumPages) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIPageSequenceFrame::GetPrintRange ( PRInt32 aFromPage,
PRInt32 aToPage 
) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIPageSequenceFrame::GetPrintThisPage ( PRBool aPrintThisPage) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

NS_IMETHOD nsIPageSequenceFrame::GetSTFPercent ( float &  aSTFPercent) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

nsIPageSequenceFrame::NS_IMETHOD_ ( nsrefcnt  ) [private, pure virtual]
nsIPageSequenceFrame::NS_IMETHOD_ ( nsrefcnt  ) [private, pure virtual]
NS_IMETHOD nsIPageSequenceFrame::PrintNextPage ( nsPresContext aPresContext) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIPageSequenceFrame::SetClipRect ( nsPresContext aPresContext,
nsRect aSize 
) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIPageSequenceFrame::SetOffset ( nscoord  aX,
nscoord  aY 
) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIPageSequenceFrame::SetSelectionHeight ( nscoord  aYOffset,
nscoord  aHeight 
) [pure virtual]

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

NS_IMETHOD nsIPageSequenceFrame::StartPrint ( nsPresContext aPresContext,
nsIPrintSettings aPrintOptions,
PRUnichar aDocTitle,
PRUnichar aDocURL 
) [pure virtual]

Print the set of pages.

Parameters:
aPrintOptionsoptions for printing
aStatusCallbackinterface that the client provides to receive progress notifications. Can be NULL
Returns:
NS_OK if successful NS_ERROR_ABORT if the client cancels printing using the callback interface NS_ERROR_INVALID_ARG if printing a range of pages (not all pages) and the start page is greater than the total number of pages NS_ERROR_FAILURE if there is an error

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:

Implemented in nsSimplePageSequenceFrame.

Here is the caller graph for this function:


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