PDFix SDK  6.5.0
PdfPageView Struct Referenceabstract

PdfPageView class. More...

Public Member Functions

virtual void Release ()=0
 
virtual int GetDeviceWidth ()=0
 Returns a width of the page view in device space coordinates. More...
 
virtual int GetDeviceHeight ()=0
 Returns a height of the page view in device space coordinates. More...
 
virtual void GetDeviceMatrix (PdfMatrix *matrix)=0
 Gets the matrix that transforms user space coordinates to pageview coordinates. More...
 
virtual void RectToDevice (PdfRect *rect, PdfDevRect *dev_rect)=0
 
virtual void PointToDevice (PdfPoint *point, PdfDevPoint *dev_point)=0
 Transforms a point's coordinates from user space to device space. More...
 
virtual void RectToPage (PdfDevRect *dev_rect, PdfRect *rect)=0
 
virtual void PointToPage (PdfDevPoint *dev_point, PdfPoint *point)=0
 Transforms a point's coordinates from device space to user space. More...
 

Detailed Description

PdfPageView class.

A PdfPageView has methods to display the contents of a document page.

Member Function Documentation

◆ GetDeviceHeight()

virtual int PdfPageView::GetDeviceHeight ( )
pure virtual

Returns a height of the page view in device space coordinates.

Returns
A page view height.
See also
PdfPageView::GetDeviceWidth

◆ GetDeviceMatrix()

virtual void PdfPageView::GetDeviceMatrix ( PdfMatrix matrix)
pure virtual

Gets the matrix that transforms user space coordinates to pageview coordinates.

Parameters
matrix(Filled by the method) Pointer to the pageview matrix.

◆ GetDeviceWidth()

virtual int PdfPageView::GetDeviceWidth ( )
pure virtual

Returns a width of the page view in device space coordinates.

Returns
A page view width.
See also
PdfPageView::GetDeviceHeight

◆ PointToDevice()

virtual void PdfPageView::PointToDevice ( PdfPoint point,
PdfDevPoint dev_point 
)
pure virtual

Transforms a point's coordinates from user space to device space.

Parameters
pointPointer to the point whose coordinates are transformed, specified in user space coordinates.
dev_point(Filled by the method) Pointer to a point containing the device space coordinates corresponding to point.
See also
PdfPageView::RectToDevice

◆ PointToPage()

virtual void PdfPageView::PointToPage ( PdfDevPoint dev_point,
PdfPoint point 
)
pure virtual

Transforms a point's coordinates from device space to user space.

Parameters
dev_pointPointer to the point whose coordinates are transformed, specified in device space coordinates.
point(Filled by the method) Pointer to a point containing the user space coordinates corresponding to point.
See also
PdfPageView::RectToPage

◆ RectToDevice()

virtual void PdfPageView::RectToDevice ( PdfRect rect,
PdfDevRect dev_rect 
)
pure virtual

Draws the contents of a page into the page view PsImage. This method just draws a bitmap. Provides control over the rendering with respect to PdfPageRenderParams. The PsImage remains in the cache as the page view class exists or next PdfPageViewDrawPage method is called.

Parameters
paramsRendering parameters.
cancel_procCallback to check for canceling operations.
cancel_dataPointer to client data for the cancel procedure.
Returns
true if page was rendered, false otherwise.
See also
PdfPageView::GetImage Gets the image data for a page view. You should never depend on these objects lasting the lifetime of the document. You should extract the information you need from the object immediately and refer to it no further in your code. NOTE: Do not destroy the returned PsImage when done with it.
Returns
Acquired Image data for page view. Returns null if there are no image data.
See also
PdfPageView::DrawPage Transforms a rectangle's coordinates from user space to device space. The resulting PdfDevRect will be normalized, that is, left < right and top < bottom.
Parameters
rectPointer to the rectangle whose coordinates are transformed, specified in user space coordinates.
dev_rect(Filled by the method) Pointer to a rectangle containing the device space coordinates corresponding to rect.
See also
PdfPageView::PointToDevice

◆ RectToPage()

virtual void PdfPageView::RectToPage ( PdfDevRect dev_rect,
PdfRect rect 
)
pure virtual

Transforms a rectangle's coordinates from device space to user space. The resulting PdfDevRect will be normalized, that is, left < right and top < bottom.

Parameters
rectPointer to the rectangle whose coordinates are transformed, specified in device space coordinates.
dev_rect(Filled by the method) Pointer to a rectangle containing the page space coordinates corresponding to rect.
See also
PdfPageView::PointToPage

◆ Release()

virtual void PdfPageView::Release ( )
pure virtual

Releases the page view resources. NOTE: The caller can call PdfPageView::Release to optimize a memory handling. Otherwise the page is responsible for freeing PdfPageViews resources.

Parameters
page_viewThe page view to delete.
See also
PdfPage::AcquirePageView