FPDFPROGRESSIVE

Classes
struct	_IFSDK_PAUSE
	IFSDK_PAUSE interface. More...
Files
file	fpdfprogressive.h
	Header file for the progressive module - progressive functionality allows an application to respond to other operations while a document is in the process of displaying.
Defines
#define	DLLEXPORT
#define	STDCALL
#define	FPDF_RENDER_READER   0
#define	FPDF_RENDER_TOBECOUNTINUED   1
#define	FPDF_RENDER_DONE   2
#define	FPDF_RENDER_FAILED   3
Typedefs
typedef struct _IFSDK_PAUSE	IFSDK_PAUSE
	IFSDK_PAUSE interface.
Functions
DLLEXPORT int STDCALL	FPDF_RenderPageBitmap_Start (FPDF_BITMAP bitmap, FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y, int rotate, int flags, IFSDK_PAUSE *pause)
DLLEXPORT int STDCALL	FPDF_RenderPage_Continue (FPDF_PAGE page, IFSDK_PAUSE *pause)
DLLEXPORT int STDCALL	FPDF_RenderPage_EstimateProgress (FPDF_PAGE page)
DLLEXPORT void STDCALL	FPDF_RenderPage_Close (FPDF_PAGE page)
	_FPDFPROGRESSIVE_H_

---

Detailed Description

Header file for the progressive module.

---

Define Documentation

#define FPDF_RENDER_READER   0

Flags for progressive process status.

---

Function Documentation

DLLEXPORT void STDCALL FPDF_RenderPage_Close

(

FPDF_PAGE

page

)

_FPDFPROGRESSIVE_H_

Release the page resource allocated during page rendering. This function must be called after page rendering finishes or if rendering of the page is canceled.

Parameters:

[in]

- Handle to the page. Returned by the FPDF_LoadPage function.

Return values:

No	return value.

DLLEXPORT int STDCALL FPDF_RenderPage_Continue	(	FPDF_PAGE	page,
		IFSDK_PAUSE *	pause
	)

Continue rendering a PDF page. Parameters:

Parameters:

[in]	page	- Handle to the page. Returned by the FPDF_LoadPage function.
[in]	pause	- The IFSDK_PAUSE interface. A callback mechanism that allows the page rendering process to be paused before it is finished. This can be set to NULL if pause is not needed.

Return values:

The	rendering status. See "progressive process status" flags for more details.

DLLEXPORT int STDCALL FPDF_RenderPage_EstimateProgress

(

FPDF_PAGE

page

)

Provides the current status of the page rendering process (meaured in percent complete).

Parameters:

[in]

page

- Handle to the page. Return by FPDF_LoadPage function.

Return values:

An	estimated value (in percent complete) of the current rendering progress.

DLLEXPORT int STDCALL FPDF_RenderPageBitmap_Start	(	FPDF_BITMAP	bitmap,
		FPDF_PAGE	page,
		int	start_x,
		int	start_y,
		int	size_x,
		int	size_y,
		int	rotate,
		int	flags,
		IFSDK_PAUSE *	pause
	)

Progressively render the specified page contents to a device independent bitmap.

Parameters:

[in]	bitmap	- Handle to the device independent bitmap (as the output buffer). Bitmap handle can be created by the FPDFBitmap_Create function.
[in]	page	- Handle to the page. Returned by FPDF_LoadPage function.
[in]	start_x	- Left pixel position of the display area in bitmap coordinates.
[in]	start_y	- Top pixel position of the display area in bitmap coordinates.
[in]	size_x	- Horizontal size (in pixels) for displaying the page.
[in]	size_y	- Vertical size (in pixels) for displaying the page.
[in]	rotate	- Page orientation: 0 (normal), 1 (rotated 90 degrees clockwise), 2 (rotated 180 degrees), 3 (rotated 90 degrees counter-clockwise).
[in]	flags	- 0 for normal display, or combination of flags defined in fpdfpview.h.
[in]	pause	- The IFSDK_PAUSE interface. A callback mechanism that allows the page rendering process to be paused before it is finished. This can be set to NULL if pause is not needed.

Return values:

The	rendering status. See "progressive process status" flags above for more details.