AV_Layer.AVPageView (Acrobat)

	Typedef
	AVPageView The area of the Acrobat viewer's window that displays the contents of a document page. Every AVDoc has an AVPageView and vice versa. It contains references to the PDDoc and PDPage objects for the document being displayed.

	Enumeration
	`AVPageViewControlID` (Acrobat 5.0 and later) Used with AVPageViewShowControl() to allow a plug-in author to turn on and off the controls shown in the status area at the bottom of a page view.
	`AVPageViewTabOrder`

	Callback
	AVPageViewClickProc A user-supplied callback that is called whenever there is a mouse click in its AVPageView. This callback is registered using AVAppRegisterForPageViewClicks().
	AVPageViewCursorProc A user-supplied callback that is called whenever the cursor is moved. This callback is registered using AVAppRegisterForPageViewAdjustCursor().
	AVPageViewDrawProc A user-supplied callback that is called whenever the AVPageView is drawn. This callback is registered using AVAppRegisterForPageViewDrawing().
	AVPageViewKeyDownProc Called whenever there is a key down in its AVPageView. This callback is registered using AVAppRegisterForPageViewKeyDown().

	Method
	void* AVPageViewAcquireDrawContext(AVPageView pageView, DrawContextType contextType) Acquires the platform-specific object needed to draw into the Acrobat viewer's document window using a platform's native graphics calls. When done, release the context using AVPageViewReleaseDrawContext().
	void* AVPageViewAcquireMachinePort(AVPageView pageView) DEPRECATED in Acrobat 10 Use AVPageViewAcquireDrawContext instead
	void AVPageViewAnnotDidPerformOp(AVPageView pageView, PDAnnot pdAnnot, AVAnnotOp annotOp, void* clientData) Goes out when an annotation has performed a focus operation (for example, kAVAnnotAcceptFocus or kAVAnnotLostFocus). No notification is issued for kAVAnnotDefaultAction or kAVAnnotShowMenu.
	void AVPageViewAppearanceGetAVMatrix(AVPageView PageView, AVFlagBits32 flags, CosObj appear, ASFixedRect* ar, ASFixedMatrix* mr) Calculates a matrix for use with AVPageViewDrawCosObj() or AVPageViewDrawCosObjEx() that leaves the appearance unrotated and un-zoomed as specified by flags. This is typically used in conjunction with drawing an annotation appearance represented by appear.
	void AVPageViewBeginOperation(AVPageView pageView) Increments an internal variable. Neither drawing nor AVPageViewDidChange() notifications will occur as long as the variable has a value greater than zero. In addition, frames are not pushed onto the view history stack.
	ASBool AVPageViewClearFocusAnnot(AVPageView pageView) Removes the focus from the currently selected annotation.
	void AVPageViewDevicePointToPage(AVPageView pageView, AVDevCoord x, AVDevCoord y, ASFixedPoint* p) Transforms a point's coordinates from device space to user space.
	void AVPageViewDeviceRectToPage(AVPageView pageView, const AVDevRect* rect, ASFixedRect* p) Transforms a rectangle from device space to user space coordinates. The resulting ASFixedRect is normal, meaning that left < right and bottom < top.
	void AVPageViewDeviceRectToPageRZ(AVPageView pageView, AVTFlagBits flags, AVDevCoord xHot, AVDevCoord yHot, const AVDevRect* rect, ASFixedRect* p) Transforms an annotation's rectangle from device space to user space coordinates, allowing for the annotation's attributes of whether it should zoom or rotate when the page is zoomed or rotated. It also specifies a point that can remain in the view.
	void AVPageViewDeviceToInfo(AVPageView pageView, AVlCoord x, AVlCoord y, ASFixedPoint* info) Translates the given point from the device space coordinate system to the info space coordinate system.
	void AVPageViewDidChange(AVPageView pageView, ASInt16 how, void* clientData) The page view has changed. Zero or more of the following events has occurred: The page number has changed. The zoom factor has changed. The window has been resized. The page has been scrolled.
	void AVPageViewDidChangeEx(AVPageView pageView, ASInt16 how, const AVDevRectP rect, void* clientData) The page view has changed. Zero or more of the following events has occurred: The page number has changed. The zoom factor has changed. The window has been resized. The page has been scrolled.
	void AVPageViewDidDraw(AVPageView pageView, void* clientData) Redrawing occurred in the page view section of the window.
	void AVPageViewDocDidChange(AVPageView pageView, AVDoc newDoc, AVDoc oldDoc, void* clientData) Sent when a page view becomes associated with an AVDoc. When a cross-document link is being performed, the same page view may be re-used with a different AVDoc. In this case this notification is sent twice, once when the old AVDoc is closed and the page view's AVDoc becomes NULL, and again when the new AVDoc is opened and associated with the page view.
	AVMenuItem AVPageViewDoPopupMenu(AVPageView pageView, AVMenu menu, AVDevCoord xHit, AVDevCoord yHit, ASBool rightMouse, AVMenuIndex choice) Displays the given AVMenu as a popup menu anchored at xHit and yHit, which are in device coordinates relative to pageView.
	void AVPageViewDragOutNewRect(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* resultRect) Allows the user to drag out a new rectangle. Call this method when the user clicks at some point and needs to create a rectangle. The method returns when the user releases the mouse button.
	AVTFlagBits AVPageViewDragOutNewRectSnapped(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* resultRect, AVCursor* cursorArray, AVTSmallArraySize nCursors) Drags out a rectangle anchored at the given point. The rectangle will be snapped to the layout grid.
	void AVPageViewDragRect(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* startRect, AVDevRect* resultRect, ASInt32 dragType, AVDevRect* extrema) Allows the user to move or resize a rectangle. Call this method when the user clicks on a rectangle to modify. It returns after the user releases the mouse button.
	AVTFlagBits AVPageViewDragRectSnapped(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* startRect, AVDevRect* resultRect, AVlDragType dragType, AVDevRect* extrema, AVCursor* cursorArray, AVTSmallArraySize nCursors) Superseded in Acrobat 6.0 by AVPageViewDragRectSnappedEx().
	AVTFlagBits AVPageViewDragRectSnappedEx(const AVDragRectParamsRec* params) Allows the user to move or resize an existing rectangle. This version of the method allows you to specify your own drawing procedure.
	void AVPageViewDrawAnnotSequence(AVPageView pv, PDAnnot an, const AVDevRect* bbox) Draws the annotation sequence number of an annotation in a rectangle.
	void AVPageViewDrawCosObj(AVPageView pageView, CosObj cosObj, const AVDevRect* r) Draws the CosObj (which currently must be a Form object) and scales it to fit the rectangle. This method may be used to draw an annotation appearance.
	void AVPageViewDrawCosObjEx(AVPageView pageView, CosObj cosObj, const AVDevRect* r, ASFixedMatrix* matrix) Draws the CosObj (which currently must be a Form object), scales it to fit the rectangle, and transforms it according to matrix. This method is the same as AVPageViewDrawCosObj(), but applies an ASFixedMatrix transformation to the CosObj once the CosObj has been scaled to the anamorphic dimensions of the AVRect. This method may be used to draw an annotation appearance.
	void AVPageViewDrawNow(AVPageView pageView) Forces any pending updates for the specified page view to finish drawing.
	void AVPageViewDrawNowWithTransition(AVPageView pageView, PDTrans trans) Forces any pending updates for the specified page view to finish drawing, using the specified transition effect.
	void AVPageViewDrawPolygon(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, ASCount numPoints, ASBool invert) Draws a polygon, filled with the color most recently set using AVPageViewSetColor(), or inverted.
	void AVPageViewDrawPolygonOutline(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, ASCount numPoints, ASBool invert) Draws a stroked (not filled) or inverted polygon, using the color most recently set using AVPageViewSetColor().
	void AVPageViewDrawRect(AVPageView pageView, const AVDevRect* rect) Draws a rectangle filled with the color most recently set using AVPageViewSetColor().
	void AVPageViewDrawRectOutline(AVPageView pageView, const AVDevRect* rect, AVDevSize lineWidth, ASFixed* dashArray, AVTArraySize arrayLen) Draws a stroked, but not filled, rectangle using the color most recently set using AVPageViewSetColor().
	void AVPageViewDrawRectOutlineWithHandles(AVPageView pageView, const AVDevRect* rect, ASBool bMidpoints, ASBool bThin, ASFixed* dashArray, AVTArraySize arrayLen) Draws the specified rectangle in the page view with drag handles.
	void AVPageViewEndOperation(AVPageView pageView) Decrements an internal variable. Neither drawing nor AVPageViewDidChange() notifications will occur as long as the variable has a value greater than zero. In addition, frames are not pushed onto the view history stack.
	ASBool AVPageViewFilterKeyDownForFocusAnnot(AVPageView pageView, AVKeyCode key, AVFlagBits16 flags, ASBool* annotWillLoseFocus) Processes a keystroke through the currently focused annotation. The current behavior is defined below:
	ASBool AVPageViewFocusAnnotPerformOp(AVPageView pageView, AVAnnotOp annotOp) Attempts to have the currently focused annotation perform the given operation. The method will fail if:
	PDBead AVPageViewGetActiveBead(AVPageView pageView) Gets the currently active article thread bead in the specified page view.
	void AVPageViewGetAnnotRect(AVPageView pageView, PDAnnot anAnnot, AVDevRect* rect) Gets an annotation's bounding rectangle. This may be a superset of the actual bounding box of a particular annotation view.
	void AVPageViewGetAperture(AVPageView pageView, AVDevRect* rect) Gets the aperture of the specified page view. The aperture is the rectangular region of the window in which the document is drawn, measured in device space units.
	AVDoc AVPageViewGetAVDoc(AVPageView pageView) Gets the AVDoc for the document currently displayed in pageView.
	AVWindow AVPageViewGetAVWindow(AVPageView pageView) Gets the AVWindow associated with this AVPageView.
	void AVPageViewGetColor(AVPageView pageView, PDColorValue color) Gets the color that will be used for subsequent drawing by AVPageViewDrawRect() and AVPageViewDrawRectOutline().
	void AVPageViewGetDevToPageMatrix(AVPageView pageView, ASFixedMatrix* devToPageMatrix) Gets the matrix that transforms device space coordinates to user space coordinates for the specified page view.
	PDPageNumber AVPageViewGetFirstVisiblePageNum(AVPageView pageView) Returns the page number of the first page that is visible on the screen.
	ASBool AVPageViewGetFocusAnnot(AVPageView pageView, PDAnnot* annot) Gets the currently focused annotation from the page view.
	void AVPageViewGetGrayRect(AVPageView pageView, AVDevRect* greyRect) Gets the rectangle that bounds a page view. This may include some of the gray area outside a page's crop box.
	ASBool AVPageViewGetInkPreview(AVPageView pageView) Returns the ink preview value for a page view.
	PDPageNumber AVPageViewGetLastVisiblePageNum(AVPageView pageView) Returns the page number of the last page that is visible on the screen.
	PDLayoutMode AVPageViewGetLayoutMode(AVPageView pageView) Gets the page layout mode for a page view.
	void AVPageViewGetMousePosition(AVPageView pageView, AVDevCoord* x, AVDevCoord* y) Gets the mouse position in pageView. The mouse position is specified in global coordinates. On Mac OS, it is equivalent to calling the Toolbox GetMouse call and adding the window's offset on the screen; on UNIX, it is equivalent to calling XQueryPointer and adding the window's offset on the screen.
	void AVPageViewGetMousePositionSnapped(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, AVDragType direction) Gets the current mouse position snapped to the layout grid.
	ASBool AVPageViewGetNextView(AVPageView pageView, PDDoc* pdDoc, PDPageNumber* pageNum, ASFixed* scale) Used by page caching code to determine the next page to cache (and at what scale). Allows clients to do their own page caching.
	ASInt32 AVPageViewGetNumVisibleInks(AVPageView pageView) Gets the number of inks (color separations) that are displayed for a page view. An ink, in this context, means the content that will appear on a single plate when the page is separated. For example, a DeviceCMYK color is four inks, and a separation color space is usually one ink.
	PDPage AVPageViewGetPage(AVPageView pageView) Gets a PDPage currently displayed in the specified page view. This does not acquire the page. Do not use this result across methods that might change the current page. To obtain a value that can be used across such calls, use PDDocAcquirePage() instead.
	PDPageNumber AVPageViewGetPageNum(AVPageView pageView) Gets the current page number for pageView.
	void AVPageViewGetPageToDevMatrix(AVPageView pageView, ASFixedMatrix* pageToDevMatrix) Gets the matrix that transforms user space coordinates to device space coordinates for the specified page view.
	void AVPageViewGetPageToDevScaling(AVPageView pageView, float* xScale, float* yScale) Gets the point-to-pixel scaling factor that transforms page units to device space units for the specified page view. Although the method returns both x and y factors, these are normally the same.
	ASBool AVPageViewGetPixelInformationAtPoint(AVPageView pageView, AVDevCoord x, AVDevCoord y, AVInkValue* inkVector, ASUns32* inkVectorLength) Gets the color separation ink information for pixels at the cursor position in the specified page view. Ink previews must be turned on before calling this method.
	PDPageNumber AVPageViewGetSelectedAnnotPageNum(AVPageView pageView) Returns the page number of the currently selected annotation, or -1 if no annotation is selected.
	AVTArraySize AVPageViewGetThreadIndex(AVPageView pageView) Gets the index of the currently active thread in a page view.
	PDPageNumber AVPageViewGetVisibleAnnotPage(AVPageView pageView, PDAnnot annot) Gets the number of a page containing an annotation.
	void AVPageViewGetVisibleInks(AVPageView pageView, PDPageInkRec* inks) Gets the set of inks to be displayed in a separations preview for a page view.
	ASBool AVPageViewGetWireframeDrawing(AVPageView pageView) Gets the wireframe mode for a page view.
	ASFixed AVPageViewGetZoom(AVPageView pageView) Gets the current zoom for pageView. The zoom factor is point-to-point, not point-to-pixel. For example, a page that is 612 points wide at 100% zoom should be 612 points wide on the monitor, not 612 pixels.
	AVZoomType AVPageViewGetZoomType(AVPageView pageView) Gets the current zoom type.
	void AVPageViewGhostRectOutline(AVPageView pageView, const AVDevRect* rect) Draws the specified rectangle in pageView using the ghost outline.
	void AVPageViewGoBack(AVPageView pageView) Goes to the previous view on the view stack, if a previous view exists. This might result in a different document being made active.
	void AVPageViewGoForward(AVPageView pageView) Goes to the next view on the view stack, if a next view exists. This might result in a different document being made active.
	void AVPageViewGoTo(AVPageView pageView, PDPageNumber pageNum) Goes to the specified page, retaining the current location on the page and the current zoom (either explicit or a variable). It invalidates the display, but does not perform an immediate redraw. This allows your client to call AVPageViewZoomTo(), AVPageViewScrollTo(), or both, and get only a single redraw event. If you decide to do this, you should bracket the calls with AVPageViewBeginOperation() and AVPageViewEndOperation().
	void AVPageViewHighlightText(AVPageView pageView, PDTextSelect textSelect) Inverts the given text selection on the current page using the current AVPageView color.
	void AVPageViewInfoToDevice(AVPageView pageView, const ASFixedPoint* info, AVlCoord* x, AVlCoord* y) Translates the given point from info space to device space. See AVPageViewDeviceToInfo() for a definition of info space.
	void AVPageViewInfoToPoint(AVPageView pageView, const ASFixedPoint* info, ASFixedPoint* pt) Translates the given point from info space to user space. See AVPageViewDeviceToInfo() for a definition of info space.
	void AVPageViewInsetRect(AVPageView pageView, const AVDevRect* rr, ASBool down) Draws a 3-D looking inset rectangle on the page view. It can be used to implement an inset style link, where clicking the link causes the page to appear to push into the screen.
	void AVPageViewInvalidateRect(AVPageView pageView, AVDevRect* area) Indicates that the specified area of pageView is invalid and should be redrawn. This adds the rectangle to the list of regions to redraw, but does not force an immediate redraw. Use AVPageViewDrawNow() to force an immediate redraw.
	void AVPageViewInvalidateText(AVPageView pageView, PDTextSelect textSelect) Invalidates the bits that AVPageViewHighlightText() touches.
	void AVPageViewInvertQuad(AVPageView pageView, const Quad* quad, ASBool highlight) Inverts the interior of a quad.
	void AVPageViewInvertRect(AVPageView pageView, const AVDevRect* rect, ASBool highlight) Inverts the interior of a rectangle.
	void AVPageViewInvertRectOutline(AVPageView pageView, const AVDevRect* rect) Inverts the specified rectangle's outline.
	ASBool AVPageViewIsAnnotAtPoint(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDAnnot* hitAnnot) Tests whether the specified point is within an annotation. This method is typically used by mouse-handling code, to pass clicks within an annotation to the appropriate annotation handler. For each annotation, this method calls the appropriate annotation handler's AVAnnotHandlerPtInAnnotViewBBoxProc() to test whether the point is within the annotation.
	ASBool AVPageViewIsAnnotOfTypeAtPoint(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, ASAtom annotType, ASBool belowOthers, PDAnnot* annot) Determines if an annotation of the specified type resides under the given point. If so, a handle to the annotation is returned.
	ASBool AVPageViewIsBeadAtPoint(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDBead* beadP) Tests whether the specified point is within a bead. It returns the bead if it is.
	ASBool AVPageViewIsFocusAnnot(AVPageView pageView, PDAnnot annot) Used to determine if annot currently has focus.
	ASBool AVPageViewPageNumIsVisible(AVPageView pageView, PDPageNumber pageNum) Determines if a given page number is visible.
	ASBool AVPageViewPointInText(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDTextSelect pdText) Tests if the given point is in the PDTextSelect.
	void AVPageViewPointToDevice(AVPageView pageView, const ASFixedPointP p, AVDevCoord* x, AVDevCoord* y) Transforms a point's coordinates from user space to device space.
	void AVPageViewPointToInfo(AVPageView pageView, const ASFixedPoint* pt, ASFixedPoint* info) Translates the given point from user space to info space. See AVPageViewDeviceToInfo() for a definition of info space.
	void AVPageViewReadPageDown(AVPageView pageView) Scrolls down through a document, as if the user pressed the Enter key. The scrolling follows articles if Acrobat is currently in article-reading mode.
	void AVPageViewReadPageUp(AVPageView pageView) Scrolls up through a document, as if the user pressed the Enter key. The scrolling follows articles if Acrobat is currently in article-reading mode.
	void AVPageViewRectToDevice(AVPageView pageView, const ASFixedRectP p, AVDevRect* rect) Transforms a rectangle's coordinates from user space to device space. The resulting AVRect will be normal, meaning that left < right and top < bottom.
	void AVPageViewReleaseDrawContext(AVPageView pageView, DrawContextType contextType, void* drawContext) Releases the platform-specific drawing context needed to draw into Acrobat's document window using a platform's native graphics calls.
	void AVPageViewReleaseMachinePort(AVPageView pageView, void* port) DEPRECATED in Acrobat 10 Use AVPageViewReleaseDrawContext instead
	void AVPageViewResumeOffscreenDrawing(AVPageView pageView) Clients that correctly use machine ports should work with the off-screen drawing behavior introduced in Acrobat 5. For other clients, the AVPageViewResumeOffscreenDrawing() and AVPageViewSuspendOffscreenDrawing() are provided for temporarily disabling the off screen drawing behavior so that it acts more like Acrobat 4.0. The one restriction is that you cannot call these routines while the page is drawn. In other words, do not call these routines from within a drawing callback such as one passed to AVAppRegisterForPageViewDrawing() or an annotation handler's DoDraw or DoDrawEx callback.
	void AVPageViewScrollTo(AVPageView pageView, AVDevCoord xOrigin, AVDevCoord yOrigin) Scrolls pageView to the location specified by xOrigin and yOrigin, within the limits imposed by the current zoom mode and the Acrobat viewer.
	void AVPageViewScrollToAnnot(AVPageView pageView, PDAnnot annot) Scrolls the pageView to ensure that the specified annot is visible.
	void AVPageViewScrollToRect(AVPageView pageView, const AVDevRect* rect, ASBool favorLeft, ASBool favorTop, AVDevSize margin) If the specified rectangle and margin fits inside the aperture, the pageview is scrolled to center the rectangle within the aperture. This method is handy for auto-scrolling the AVPageView in a natural way to bring some page object completely into view. It does not affect the zoom level or AVZoomType.
	void AVPageViewSetAnnotLocation(PDAnnot anAnnot, AVPageView pageView, AVDevCoord x, AVDevCoord y) Sets an annotation's location, specified in device space coordinates.
	void AVPageViewSetColor(AVPageView pageView, PDConstColorValue color) Sets the color that will be used for subsequent drawing by AVPageViewDrawRect() and AVPageViewDrawRectOutline().
	ASBool AVPageViewSetFocusAnnot(AVPageView pageView, PDAnnot focusAnnot, AVAnnotOpData opData) Attempts to set an annotation as the active annotation.
	void AVPageViewSetInkPreview(AVPageView pageView, ASBool inkPreview) Sets or clears the ink preview value for a page view, which allows you to disable the rendering of individual inks. This does not change the set of visible inks. Enabling ink preview also enables overprint preview (OPP).
	void AVPageViewSetLayoutMode(AVPageView pageView, PDLayoutMode mode) Sets the layout mode for a page view.
	PDPageNumber AVPageViewSetPageNum(AVPageView pageView, PDPageNumber pageNum) Sets the current logical page of the page view, which might not be the same as the current number indicated on the screen.
	void AVPageViewSetVisibleInks(AVPageView pageView, ASInt32 nInks, PDPageInkRec* inks) Sets the set of inks to be displayed in a separations preview for a page view. The ink preview must be turned on for this method to have an effect.
	void AVPageViewSetWireframeDrawing(AVPageView pageView, ASBool drawWireframe) Sets the wireframe mode for a page view.
	void AVPageViewShowControl(AVPageView pageView, AVPageViewControlID controlID, ASBool show) Shows or hides the controls in the status area at the bottom of a page view.
	void AVPageViewSnapPoint(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, AVDragType direction) This method is superseded by AVPageViewSnapPointEx() in Acrobat 6.0.
	void AVPageViewSnapPointEx(AVPageView pageView, ASFixedPoint* pt, AVDragType direction) Snaps a point to the layout grid if the avpSnapToGrid preference is set, using page-space coordinates.
	void AVPageViewSnapRect(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevCoord xNow, AVDevCoord yNow, AVDevRect* startRect, AVDevRect* resultRect, ASInt32 handleType, ASUns32 modifiers, const AVDevRect* extrema) Given a starting point, ending point, and starting rectangle, this returns a resulting rectangle which is snapped to the grid. The routine is designed for use within a custom mouse-drag loop, when the default drawing behavior provided by AVPageViewDragRectSnapped() is insufficient.
	void AVPageViewStartReadingThread(AVPageView pageView, PDThread thread) Puts the specified page view into article thread-reading mode.
	void AVPageViewSuspendOffscreenDrawing(AVPageView pageView) Clients that correctly use machine ports should work with the new off-screen drawing behavior introduced in Acrobat 5.0. For other clients, the AVPageViewResumeOffscreenDrawing() and AVpageViewSuspendOffscreenDrawing() are provided for temporarily disabling the off screen drawing behavior so that it acts more like Acrobat 4.0. The one restriction is that you cannot call these routines while the page being is drawn. In other words, do not call these routines from within a drawing callback such as one passed to AVAppRegisterForPageViewDrawing() or an annotation handler's DoDraw or DoDrawEx callback. Off-screen drawing should be suspended as rarely and briefly as possible (for example, only while a client that does not use machine ports correctly has a selection active).
	AVDestInfo AVPageViewToDestInfo(AVPageView pageView, ASAtom fitType) Creates a destination info object from a given AVPageView and fit type.
	PDViewDestination AVPageViewToViewDest(AVPageView pageView, ASAtom fitType, PDDoc srcPDDoc) Builds a PDViewDestination from the current zoom and position.
	PDTextSelect AVPageViewTrackText(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDTextSelect current) Called in response to a mouse click to track a text selection on the screen. It uses the AVPageView current color, and leaves the screen with any highlights visible. It does not affect the current document selection.
	void AVPageViewTransformRectRZ(AVPageView pv, AVTFlagBits flags, ASFixedRect* ar, ASFixedMatrix* mr) Calculates where an annotation is drawn with no zoom or no rotation, as specified by the annotation flags. This method generalizes AVPageViewGetAnnotRect().
	void AVPageViewUpdateInfoPanel(AVPageView pageView, AVInfoPanelUpdateType updateType, void* data) Allow clients to control the Info panel output.
	void AVPageViewUseDestInfo(AVPageView pageView, AVDestInfo destInfo) Causes the given page view to change to the view given by an AVDestInfo object.
	void AVPageViewUseThisDestination(AVPageView pageView, PDViewDestination viewDest, ASFixed sourceZoom) Causes the given page view to change to the view given by viewDest and sourceZoom.
	void AVPageViewWasCreated(AVPageView pageView, void* clientData) Sent when a page view is created.
	void AVPageViewWillDestroy(AVPageView pageView, void* clientData) Sent before a page view is destroyed.
	void AVPageViewWillDraw(AVPageView pageView, void* clientData) Redrawing will occur in the page view section of the window.
	void AVPageViewZoomTo(AVPageView pageView, AVZoomType zoomType, ASFixed scale) Sets the zoom factor and zoom type for the specified page view.

Typedefs Detail

AVPageView

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVPageView* AVPageView;

The area of the Acrobat viewer's window that displays the contents of a document page. Every AVDoc has an AVPageView and vice versa. It contains references to the PDDoc and PDPage objects for the document being displayed.

File: AVExpT.h

Line: 789

Enumeration Detail

AVPageViewControlID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVPageViewControlID {

  kAVPageViewZoomControl,


 


  kAVPageViewPageFlipControls,


 


  kAVPageViewPageNumberControl,


 


  kAVPageViewPageSizeControl,


 


  kAVPageViewSplitterBar,


 


  kAVPageViewHorizontalScrollBar,


 


  kAVPageViewVerticalScrollBar,


 


  kAVPageViewGrayBorder

}

See Also

AVPageViewShowControl

File: AVExpT.h

Line: 863

Elements

	kAVPageViewZoomControl	The zoom control.

	kAVPageViewPageFlipControls	The page flip control.

	kAVPageViewPageNumberControl	The page number control.

	kAVPageViewPageSizeControl	The page size control.

	kAVPageViewSplitterBar	The splitter bar control.

	kAVPageViewHorizontalScrollBar	The horizontal scroll.

	kAVPageViewVerticalScrollBar	The vertical scroll.

	kAVPageViewGrayBorder	The gray border control.

AVPageViewTabOrder

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVPageViewTabOrder {

  kAVTabOrderFirst,


 


  kAVTabOrderLast,


 


  kAVTabOrderNext,


 


  kAVTabOrderPrev

}

File: AVExpT.h

Line: 3858

Callbacks Detail

AVPageViewClickProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVPageViewClickProc)(AVPageView pageView, AVDevCoord x, AVDevCoord y, AVFlagBits16 flags, AVTCount clickNo, void *data)

A user-supplied callback that is called whenever there is a mouse click in its AVPageView. This callback is registered using AVAppRegisterForPageViewClicks().

File: AVExpT.h

Line: 1191

AVPageViewCursorProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVPageViewCursorProc)(AVPageView pageView, AVDevCoord x, AVDevCoord y, void *data)

A user-supplied callback that is called whenever the cursor is moved. This callback is registered using AVAppRegisterForPageViewAdjustCursor().

File: AVExpT.h

Line: 1211

AVPageViewDrawProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*AVPageViewDrawProc)(AVPageView pageView, AVDevRect *updateRect, void *data)

A user-supplied callback that is called whenever the AVPageView is drawn. This callback is registered using AVAppRegisterForPageViewDrawing().

File: AVExpT.h

Line: 1169

AVPageViewKeyDownProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVPageViewKeyDownProc)(AVPageView pageView, AVKeyCode keyCode, AVFlagBits16 flags, void *data)

Called whenever there is a key down in its AVPageView. This callback is registered using AVAppRegisterForPageViewKeyDown().

File: AVExpT.h

Line: 1235

Method Detail

AVPageViewAcquireDrawContext

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void* AVPageViewAcquireDrawContext(AVPageView pageView, DrawContextType contextType)

Acquires the platform-specific object needed to draw into the Acrobat viewer's document window using a platform's native graphics calls. When done, release the context using AVPageViewReleaseDrawContext().

Parameters

	`pageView` —	IN/OUT The AVPageView whose platform-dependent port is acquired.

	`contextType` —	IN See DrawContextType definition in AVExpT.h

Returns

A platform-dependent value:

Operating system	Value
Mac OS	`GrafPtr`.
Windows	`WinPort`.
UNIX	`Widget`.

See Also

AVPageViewReleaseMachinePort

Since

PI_ACROVIEW_VERSION >= 0x000A0000

File: AVProcs.h

Line: 9976

AVPageViewAcquireMachinePort

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void* AVPageViewAcquireMachinePort(AVPageView pageView)

DEPRECATED in Acrobat 10 Use AVPageViewAcquireDrawContext instead

Acquires the platform-specific object needed to draw into the Acrobat viewer's document window using a platform's native graphics calls. When done, release it using AVPageViewReleaseMachinePort().

Parameters

pageView —

IN/OUT The AVPageView whose platform-dependent port is acquired.

Returns

A platform-dependent value:

Operating system	Value
Mac OS	`GrafPtr`.
Windows	`WinPort`.
UNIX	`Widget`.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2425

AVPageViewAnnotDidPerformOp

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewAnnotDidPerformOp(AVPageView pageView, PDAnnot pdAnnot, AVAnnotOp annotOp, void* clientData)

Goes out when an annotation has performed a focus operation (for example, kAVAnnotAcceptFocus or kAVAnnotLostFocus). No notification is issued for kAVAnnotDefaultAction or kAVAnnotShowMenu.

Parameters

	`pageView` —	The page view containing the annotation.

	`pdAnnot` —	The annotation that performed the operation.

	`annotOp` —	The operation.

	`clientData` —	A pointer to a block of user-supplied data that was passed when the client registered for this notification using `AVAppRegisterNotification()`.

See Also

AVPageViewFocusAnnotPerformOp

File: PIPokes.h

Line: 2084

AVPageViewAppearanceGetAVMatrix

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewAppearanceGetAVMatrix(AVPageView PageView, AVFlagBits32 flags, CosObj appear, ASFixedRect* ar, ASFixedMatrix* mr)

Calculates a matrix for use with AVPageViewDrawCosObj() or AVPageViewDrawCosObjEx() that leaves the appearance unrotated and un-zoomed as specified by flags. This is typically used in conjunction with drawing an annotation appearance represented by appear.

Parameters

	`PageView` —	The page view for which the matrix is calculated.

	`flags` —	Annotation flags obtained by PDAnnotGetFlags().

	`appear` —	The appearance of the object, which is a Form XObject.

	`ar` —	The bounding rectangle for `appear`.

	`mr` —	(Filled by the method) The transformation matrix.

Since

PI_ACROVIEW_VERSION >= 0x000400000x00060000.

File: AVProcs.h

Line: 4056

AVPageViewBeginOperation

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewBeginOperation(AVPageView pageView)

Increments an internal variable. Neither drawing nor AVPageViewDidChange() notifications will occur as long as the variable has a value greater than zero. In addition, frames are not pushed onto the view history stack.

Parameters

pageView —

IN/OUT The page view whose SuspendDraw variable is incremented.

See Also

AVPageViewEndOperation

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2141

AVPageViewClearFocusAnnot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewClearFocusAnnot(AVPageView pageView)

Removes the focus from the currently selected annotation.

Parameters

pageView —

IN/OUT The page view holding the focus.

Returns

false if there was no focus annotation in effect when the method was called, true if there was.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5340

AVPageViewDevicePointToPage

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDevicePointToPage(AVPageView pageView, AVDevCoord x, AVDevCoord y, ASFixedPoint* p)

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

Parameters

	`pageView` —	The page view for which the point's coordinates are transformed.

	`x` —	The x-coordinate of the point to transform, specified in device space coordinates.

	`y` —	The y-coordinate of the point to transform, specified in device space coordinates.

	`p` —	(Filled by the method) A pointer to a point whose user space coordinates correspond to `x` and `y`.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6964

AVPageViewDeviceRectToPage

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDeviceRectToPage(AVPageView pageView, const AVDevRect* rect, ASFixedRect* p)

Transforms a rectangle from device space to user space coordinates. The resulting ASFixedRect is normal, meaning that left < right and bottom < top.

Parameters

	`pageView` —	The page view for which the rectangle is transformed.

	`rect` —	A pointer to a device space rectangle whose coordinates are transformed to user space.

	`p` —	(Filled by the method) A pointer to a user space rectangle corresponding to `rect`.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6692

AVPageViewDeviceRectToPageRZ

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDeviceRectToPageRZ(AVPageView pageView, AVTFlagBits flags, AVDevCoord xHot, AVDevCoord yHot, const AVDevRect* rect, ASFixedRect* p)

Transforms an annotation's rectangle from device space to user space coordinates, allowing for the annotation's attributes of whether it should zoom or rotate when the page is zoomed or rotated. It also specifies a point that can remain in the view.

Parameters

pageView —

The page view for which the rectangle is transformed.

flags —

Flags to indicate whether the annotation rotates or zooms with the page view. These flags correspond to the annotation's F key and can be obtained from PDAnnotGetFlags().

It must be an OR of the following flags:

Flag	Description
pdAnnotNoZoom	The annotation does not zoom with the view.
pdAnnotNoRotate	The annotation does not rotate with the page.

xHot —

The x-coordinate of the point that should remain in the view.

yHot —

The y-coordinate of the point that should remain in the view.

rect —

A pointer to a device space annotation rectangle whose coordinates are transformed to user space.

p —

(Filled by the method) A pointer to a user space rectangle corresponding to src.

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 7063

AVPageViewDeviceToInfo

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDeviceToInfo(AVPageView pageView, AVlCoord x, AVlCoord y, ASFixedPoint* info)

Translates the given point from the device space coordinate system to the info space coordinate system.

Info space is the coordinate system used by the info palette to provide the user with visual feedback during layout operations. The origin of info space for a given page is the upper left corner of the page. The x-axis is horizontal and increases from left to right. The y-axis is vertical and increases from top to bottom. Units are measured in points. Conceptually, info space is the same as user space, with the y-axis flipped and the origin anchored at the upper left of the page.

Parameters

	`pageView` —	The page view holding the focus.

	`x` —	The x-coordinate in device space.

	`y` —	The y-coordinate in device space.

	`info` —	(Filled by the method) The translated point.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5913

AVPageViewDidChange

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewDidChange(AVPageView pageView, ASInt16 how, void* clientData)

The page view has changed. Zero or more of the following events has occurred:

The page number has changed.
The zoom factor has changed.
The window has been resized.
The page has been scrolled.

Parameters

pageView —

The AVPageView that has changed.

how —

Specifies how the page view did change. how is an OR of zero or more of the following (see AVExpT.h):

Value	Description
`PAGEVIEW_UPDATE_SCROLL`	The view has been scrolled.
`PAGEVIEW_UPDATE_PAGENUM`	The page number has changed.
`PAGEVIEW_UPDATE_PAGESIZE`	A new view has been created.
`PAGEVIEW_UPDATE_ZOOM`	The zoom has been changed.

clientData —

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification().

Notifications

AVDocActivePageViewDidChange
AVPageViewDidDraw
AVPageViewWasCreated
AVPageViewWillDestroy

File: PIPokes.h

Line: 360

AVPageViewDidChangeEx

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewDidChangeEx(AVPageView pageView, ASInt16 how, const AVDevRectP rect, void* clientData)

The page view has changed. Zero or more of the following events has occurred:

The page number has changed.
The zoom factor has changed.
The window has been resized.
The page has been scrolled.

Parameters

pageView —

The AVPageView that has changed.

how —

Specifies how the page view did change. how is an OR of zero or more of the following (see AVExpT.h):

Value	Description
`PAGEVIEW_UPDATE_SCROLL`	The view has been scrolled.
`PAGEVIEW_UPDATE_PAGENUM`	The page number has changed.
`PAGEVIEW_UPDATE_PAGESIZE`	A new view has been created.
`PAGEVIEW_UPDATE_ZOOM`	The zoom has been changed.

rect —

A pointer to the scroll rectangle for the pageView.

clientData —

A pointer to a block of user-supplied data that was passed when the client registered for this notification using AVAppRegisterNotification().

See Also

Notifications

AVDocActivePageViewDidChange
AVPageViewDidDraw
AVPageViewWasCreated
AVPageViewWillDestroy

File: PIPokes.h

Line: 2245

AVPageViewDidDraw

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewDidDraw(AVPageView pageView, void* clientData)

Redrawing occurred in the page view section of the window.

Parameters

	`pageView` —	The `AVPageView` in which drawing occurred.

	`clientData` —	A pointer to a block of user-supplied data that was passed when the client registered for this notification using `AVAppRegisterNotification()`.

See Also

AVPageViewDrawNow

Notifications

AVPageViewDidChange
AVPageViewWillDraw

File: PIPokes.h

Line: 313

AVPageViewDocDidChange

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewDocDidChange(AVPageView pageView, AVDoc newDoc, AVDoc oldDoc, void* clientData)

Sent when a page view becomes associated with an AVDoc. When a cross-document link is being performed, the same page view may be re-used with a different AVDoc. In this case this notification is sent twice, once when the old AVDoc is closed and the page view's AVDoc becomes NULL, and again when the new AVDoc is opened and associated with the page view.

Parameters

	`pageView` —	The `AVPageView` for which the document changed.

	`newDoc` —	The new document associated with the page view.

	`oldDoc` —	The document that was previously associated with the page view.

	`clientData` —	A pointer to a block of user-supplied data that was passed when the client registered for this notification using `AVAppRegisterNotification()`.

Notifications

AVDocActivePageViewDidChange
AVPageViewDidChange
AVPageViewWasCreated
AVPageViewWillDestroy

File: PIPokes.h

Line: 2478

AVPageViewDoPopupMenu

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenuItem AVPageViewDoPopupMenu(AVPageView pageView, AVMenu menu, AVDevCoord xHit, AVDevCoord yHit, ASBool rightMouse, AVMenuIndex choice)

Displays the given AVMenu as a popup menu anchored at xHit and yHit, which are in device coordinates relative to pageView.

Parameters

	`pageView` —	The page view in which the menu appears.

	`menu` —	The displayed menu.

	`xHit` —	The x-coordinate of the upper left corner of the menu.

	`yHit` —	The y-coordinate of the upper left corner of the menu.

	`rightMouse` —	`true` if the right mouse button (where applicable) was used to invoke the popup, `false` otherwise.

	`choice` —	The index of the AVMenuItem that should appear under the mouse at popup time.

Returns

The menu item selected from menu.

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 7022

AVPageViewDragOutNewRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDragOutNewRect(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* resultRect)

Allows the user to drag out a new rectangle. Call this method when the user clicks at some point and needs to create a rectangle. The method returns when the user releases the mouse button.

Parameters

	`pageView` —	The page view in which the rectangle is created.

	`xStart` —	The x-coordinate of the point where the user initially clicked, specified in device space coordinates.

	`yStart` —	The y-coordinate of the point where the user initially clicked, specified in device space coordinates.

	`resultRect` —	(Filled by the method) A pointer to the rectangle that the user dragged out, specified in device space coordinates.

See Also

AVPageViewDragRect

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6864

AVPageViewDragOutNewRectSnapped

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVTFlagBits AVPageViewDragOutNewRectSnapped(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* resultRect, AVCursor* cursorArray, AVTSmallArraySize nCursors)

Drags out a rectangle anchored at the given point. The rectangle will be snapped to the layout grid.

Parameters

	`pageView` —	The page view in which the rectangle will be created.

	`xStart` —	The x-coordinate of the anchor point.

	`yStart` —	The y-coordinate of the anchor point.

	`resultRect` —	(Filled by the method) The resulting rectangle generated by the user.

	`cursorArray` —	A pointer to an array of AVCursor objects. This value is used in conjunction with `nCursors` and is treated as follows: If it is `NULL`, the default cursor will be used during the drag. `nCursors` is ignored. If it is non-`NULL` and `nCursors` is `1`, the supplied cursor will replace the default cursor during the drag. If it is non-`NULL` and `nCursors` is `2`, the first cursor will replace the default cursor during the drag, and the second cursor will be used if the user presses the control key (on Windows) or the option key (on Mac OS).

	`nCursors` —	The number of cursors supplied in `cursorArray`.

Returns

A bit-wise OR of the Modifier Keys that were pressed as the rectangle was dragged out. See AVSysGetModifiers().

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 7166

AVPageViewDragRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDragRect(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* startRect, AVDevRect* resultRect, ASInt32 dragType, AVDevRect* extrema)

Allows the user to move or resize a rectangle. Call this method when the user clicks on a rectangle to modify. It returns after the user releases the mouse button.

Parameters

	`pageView` —	The page view in which the rectangle is located.

	`xStart` —	The x-coordinate of the point where the user initially clicked, specified in device space coordinates.

	`yStart` —	The y-coordinate of the point where the user initially clicked, specified in device space coordinates.

	`startRect` —	A pointer to the initial rectangle, which is to moved or resized, specified in device space coordinates.

	`resultRect` —	(Filled by the method) A pointer to the resized or moved rectangle, specified in device space coordinates.

	`dragType` —	One of the AVDragType constants.

	`extrema` —	(May be `NULL`) A pointer to the rectangle specifying the maximum limits of the user-dragged rectangle. If it is `NULL`, the rectangle returned by AVPageViewGetGrayRect() is used instead. The user cannot grow the rectangle outside `extrema`, specified in device space coordinates. Pass `NULL` if you do not wish to limit the changes the user is making. `extrema` is ignored if `dragType` is `0`.

See Also

AVPageViewDragOutNewRect

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6897

AVPageViewDragRectSnapped

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVTFlagBits AVPageViewDragRectSnapped(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevRect* startRect, AVDevRect* resultRect, AVlDragType dragType, AVDevRect* extrema, AVCursor* cursorArray, AVTSmallArraySize nCursors)

Superseded in Acrobat 6.0 by AVPageViewDragRectSnappedEx().

Allows the user to move or resize an existing rectangle. If the user has enabled Snap To Grid from the main menu, the resulting rectangle will be aligned to the layout grid according to the dragType parameter.

Parameters

pageView —

The page view in which the rectangle resides.

xStart —

The x-coordinate of the point where the user initially clicked, specified in device space coordinates.

yStart —

The y-coordinate of the point where the user initially clicked, specified in device space coordinates.

startRect —

The initial position of the rectangle.

resultRect —

(Filled by the method) The position of the rectangle at the end of the operation.

dragType —

One of the AVDragType constants. These determine whether the drag is a resize or a move operation.

To move the rectangle, specify one of the following:

Version	Description
kAVDragRect	The corner of the rectangle that is closest to (`xStart`,`yStart`) is snapped to the grid, and dragging begins from that point.
`kAVDragSnapToXXX`	The corner or edge specified by `'XXX'` (`TopLeft`, `Top`, and so on) is snapped, and dragging begins from that point.

To resize the rectangle, specify kAVDragXXX. The corner or edge specified by 'XXX' (TopLeft, Top, and so on) is dragged, and the opposite corner or edge is used as an anchor point.

extrema —

(May be NULL) The rectangle to which the drag operation is restricted. If it is NULL, the rectangle returned by AVPageViewGetGrayRect() is used instead. Use this to restrict the drag operation to a bounding rectangle. It may be NULL, in which case the bounding rectangle of the page view is used.

cursorArray —

A pointer to an array of AVCursor objects. This value is used in conjunction with nCursors and is treated as follows:

If it is NULL, the default cursor will be used during the drag. nCursors is ignored.
If it is non-NULL and nCursors is 1, the supplied cursor will replace the default cursor during the drag.
If it is non-NULL and nCursors is 2, the first cursor will replace the default cursor during the drag, and the second cursor will be used if the user presses the control key (on Windows) or the option key (on Mac OS).

nCursors —

The number of cursors supplied in cursorArray.

Returns

A bit-wise OR of the Modifier Keys that were pressed as the rectangle was dragged.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 7237

AVPageViewDragRectSnappedEx

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





AVTFlagBits AVPageViewDragRectSnappedEx(const AVDragRectParamsRec* params)

Allows the user to move or resize an existing rectangle. This version of the method allows you to specify your own drawing procedure.

Parameters

params —

The parameters with which to perform the drag operation. These include the page view object.

Returns

A bit-wise OR of the Modifier Keys that were in effect when the mouse button was released.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8902

AVPageViewDrawAnnotSequence

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawAnnotSequence(AVPageView pv, PDAnnot an, const AVDevRect* bbox)

Draws the annotation sequence number of an annotation in a rectangle.

Parameters

	`pv` —	The page view in which the annotation is drawn.

	`an` —	The annotation whose sequence number is drawn.

	`bbox` —	A bounding box in which to draw the sequence number of the annotation.

See Also

AVPageViewDrawRect

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 6760

AVPageViewDrawCosObj

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawCosObj(AVPageView pageView, CosObj cosObj, const AVDevRect* r)

Draws the CosObj (which currently must be a Form object) and scales it to fit the rectangle. This method may be used to draw an annotation appearance.

Parameters

	`pageView` —	The page view.

	`cosObj` —	The CosObj to draw.

	`r` —	The rectangle in which to draw.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 6706

AVPageViewDrawCosObjEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawCosObjEx(AVPageView pageView, CosObj cosObj, const AVDevRect* r, ASFixedMatrix* matrix)

Draws the CosObj (which currently must be a Form object), scales it to fit the rectangle, and transforms it according to matrix. This method is the same as AVPageViewDrawCosObj(), but applies an ASFixedMatrix transformation to the CosObj once the CosObj has been scaled to the anamorphic dimensions of the AVRect. This method may be used to draw an annotation appearance.

Parameters

	`pageView` —	The page view.

	`cosObj` —	The CosObj to draw.

	`r` —	The rectangle in which to draw.

	`matrix` —	A pointer to a matrix specifying the matrix to transform the `cosObj` based on the rectangle. For example, if the AVRect is [10 20 110 220] describing a 100 x 200 area near the top left corner of the page, a ASFixedMatrix of [0.5 0 0 0.5 50 100] would scale the CosObj to 50% and center it inside the AVRect.

Since

PI_ACROVIEW_VERSION >= 0x00020003

File: AVProcs.h

Line: 6746

AVPageViewDrawNow

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawNow(AVPageView pageView)

Forces any pending updates for the specified page view to finish drawing.

Parameters

pageView —

IN/OUT The AVPageView to redraw.

See Also

AVPageViewInvalidateRect

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2270

AVPageViewDrawNowWithTransition

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawNowWithTransition(AVPageView pageView, PDTrans trans)

Forces any pending updates for the specified page view to finish drawing, using the specified transition effect.

Parameters

	`pageView` —	The AVPageView to redraw.

	`trans` —	The transition to use.

See Also

AVPageViewDrawNow

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8760

AVPageViewDrawPolygon

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawPolygon(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, ASCount numPoints, ASBool invert)

Draws a polygon, filled with the color most recently set using AVPageViewSetColor(), or inverted.

Parameters

	`pageView` —	The page view in which the polygon is drawn.

	`x` —	The list of x-coordinates for the vertices of the polygon.

	`y` —	The list of y-coordinates for the vertices of the polygon.

	`numPoints` —	The number of vertices in the polygon.

	`invert` —	When `true`, it inverts the polygon instead of filling it with the set color.

See Also

AVPageViewDrawPolygonOutline

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 9058

AVPageViewDrawPolygonOutline

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawPolygonOutline(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, ASCount numPoints, ASBool invert)

Draws a stroked (not filled) or inverted polygon, using the color most recently set using AVPageViewSetColor().

Parameters

	`pageView` —	The page view in which the polygon is drawn.

	`x` —	The list of x-coordinates for the vertices of the polygon.

	`y` —	The list of y-coordinates for the vertices of the polygon.

	`numPoints` —	The number of vertices in the polygon.

	`invert` —	When `true`, it inverts the polygon instead of stroking it with the set color.

See Also

AVPageViewDrawPolygon

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 9077

AVPageViewDrawRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawRect(AVPageView pageView, const AVDevRect* rect)

Draws a rectangle filled with the color most recently set using AVPageViewSetColor().

Parameters

	`pageView` —	IN/OUT The page view in which the rectangle is drawn.

	`rect` —	IN/OUT A pointer to the rectangle to draw, specified in device space coordinates.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6629

AVPageViewDrawRectOutline

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawRectOutline(AVPageView pageView, const AVDevRect* rect, AVDevSize lineWidth, ASFixed* dashArray, AVTArraySize arrayLen)

Draws a stroked, but not filled, rectangle using the color most recently set using AVPageViewSetColor().

Parameters

	`pageView` —	The page view in which the rectangle is drawn.

	`rect` —	A pointer to the rectangle to draw, specified in device space coordinates.

	`lineWidth` —	The border width in pixels. If `lineWidth > 1`, the border line is entirely inside the `rect`, thus shrinking the area inside the outline.

	`dashArray` —	A pointer to an array of fixed numbers, whose elements alternately specify the length of dashes and gaps. Pass `NULL` to draw a solid outline.

	`arrayLen` —	The number of elements in `dashArray`. It is ignored if `dashArray` is `NULL`. The maximum allowed number of elements is currently `10`.

See Also

AVPageViewDrawRect

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6616

AVPageViewDrawRectOutlineWithHandles

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewDrawRectOutlineWithHandles(AVPageView pageView, const AVDevRect* rect, ASBool bMidpoints, ASBool bThin, ASFixed* dashArray, AVTArraySize arrayLen)

Draws the specified rectangle in the page view with drag handles.

Parameters

	`pageView` —	The page view in which the `rect` is drawn.

	`rect` —	The rectangle that is to be drawn.

	`bMidpoints` —	If `true`, additional handles are drawn at the midpoint of each side of the rectangle.

	`bThin` —	If `true`, the rectangle is drawn using thin lines.

	`dashArray` —	A pointer to an array of fixed numbers whose elements alternately specify the length of dashes and gaps. Pass `NULL` to use a solid outline.

	`arrayLen` —	The number of elements in `dashArray`.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 6822

AVPageViewEndOperation

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewEndOperation(AVPageView pageView)

Decrements an internal variable. Neither drawing nor AVPageViewDidChange() notifications will occur as long as the variable has a value greater than zero. In addition, frames are not pushed onto the view history stack.

Parameters

pageView —

IN/OUT The page view whose SuspendDraw variable is decremented.

See Also

AVPageViewBeginOperation

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2154

AVPageViewFilterKeyDownForFocusAnnot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewFilterKeyDownForFocusAnnot(AVPageView pageView, AVKeyCode key, AVFlagBits16 flags, ASBool* annotWillLoseFocus)

Processes a keystroke through the currently focused annotation. The current behavior is defined below:

Behavior	Description
ASKEY_ESCAPE	The annotation loses focus.
ASKEY_TAB	Focus switches to next annotation in tab order.
ASKEY_ENTER, ASKEY_CR, and ASKEY_SPACE	It performs the default action associated with the annotation.

Parameters

	`pageView` —	IN/OUT The page view in which the annotation resides.

	`key` —	IN/OUT The key code. See ASKey.h for possible values.

	`flags` —	IN/OUT A bit-wise OR of the Modifier Flags. See AVSysGetModifiers().

	`annotWillLoseFocus` —	IN/OUT (Filled by the method) If `true` upon return, the keystroke has caused the annotation to lose focus. It may be `NULL` if the caller is not interested in that information.

Returns

true if the keystroke was processed, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5492

AVPageViewFocusAnnotPerformOp

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewFocusAnnotPerformOp(AVPageView pageView, AVAnnotOp annotOp)

Attempts to have the currently focused annotation perform the given operation. The method will fail if:

There is no currently selected annotation.
annotOp is other than kAVAnnotDefaultAction or kAVAnnotShowMenu.
The annotation handler is not available or does not support the operation.

Parameters

	`pageView` —	IN/OUT The page view containing the annotation.

	`annotOp` —	IN/OUT The operation to perform.

Returns

true if the operation was performed successfully, false otherwise.

Notifications

AVPageViewAnnotDidPerformOp

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5466

AVPageViewGetActiveBead

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDBead AVPageViewGetActiveBead(AVPageView pageView)

Gets the currently active article thread bead in the specified page view.

Parameters

pageView —

IN/OUT The page view whose currently active bead is obtained.

Returns

The current bead of the current thread, or a NULL Cos object if there is no current thread.

See Also

AVPageViewGetThreadIndex

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2396

AVPageViewGetAnnotRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetAnnotRect(AVPageView pageView, PDAnnot anAnnot, AVDevRect* rect)

Gets an annotation's bounding rectangle. This may be a superset of the actual bounding box of a particular annotation view.

If the page view has more than one page displayed, as in the continuous modes, you should call AVPageViewSetPageNum() with the annotation's page number before calling this method.

Parameters

	`pageView` —	The page view for which the rectangle is transformed.

	`anAnnot` —	The annotation whose bounding rectangle is obtained.

	`rect` —	(Filled by the method) A pointer to the annotation's bounding rectangle, specified in device space coordinates.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6652

AVPageViewGetAperture

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetAperture(AVPageView pageView, AVDevRect* rect)

Gets the aperture of the specified page view. The aperture is the rectangular region of the window in which the document is drawn, measured in device space units.

Parameters

	`pageView` —	The page view whose aperture is obtained.

	`rect` —	(Filled by the method) A pointer to the aperture rectangle, specified in device space coordinates.

See Also

AVPageViewGetGrayRect

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6525

AVPageViewGetAVDoc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVDoc AVPageViewGetAVDoc(AVPageView pageView)

Gets the AVDoc for the document currently displayed in pageView.

Parameters

pageView —

IN/OUT The page view whose AVDoc is obtained.

Returns

The AVDoc for pageView.

See Also

AVDocGetPageView
AVPageViewGetPage

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2037

AVPageViewGetAVWindow

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVWindow AVPageViewGetAVWindow(AVPageView pageView)

Gets the AVWindow associated with this AVPageView.

This routine may return NULL if the page view is not associated with any document window.

The primary use of this API is to determine which AVPageView objects returned by AVDocGetNthPageView() are associated with the document's active window. To do this, compare the return value of this method with the return value of AVDocGetAVWindow().

Parameters

pageView —

The AVPageView whose AVWindow is obtained.

Returns

The page view's AVWindow.

Since

PI_ACROVIEW_VERSION >= 0x00070000

File: AVProcs.h

Line: 9636

AVPageViewGetColor

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetColor(AVPageView pageView, PDColorValue color)

Gets the color that will be used for subsequent drawing by AVPageViewDrawRect() and AVPageViewDrawRectOutline().

Parameters

	`pageView` —	IN/OUT The page view whose drawing color is obtained.

	`color` —	IN/OUT (Filled by the method) The color to get.

See Also

AVPageViewSetColor

Exceptions

genErrBadParm

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2117

AVPageViewGetDevToPageMatrix

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetDevToPageMatrix(AVPageView pageView, ASFixedMatrix* devToPageMatrix)

Gets the matrix that transforms device space coordinates to user space coordinates for the specified page view.

Parameters

	`pageView` —	IN/OUT The page view whose matrix is obtained.

	`devToPageMatrix` —	IN/OUT (Filled by the method) A pointer to the transformation matrix.

See Also

AVPageViewGetPageToDevMatrix

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2468

AVPageViewGetFirstVisiblePageNum

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPageNumber AVPageViewGetFirstVisiblePageNum(AVPageView pageView)

Returns the page number of the first page that is visible on the screen.

Parameters

pageView —

The page view whose first visible page number is obtained.

Returns

The page number of the first page that is visible on the screen.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3368

AVPageViewGetFocusAnnot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewGetFocusAnnot(AVPageView pageView, PDAnnot* annot)

Gets the currently focused annotation from the page view.

Parameters

	`pageView` —	IN/OUT The page view.

	`annot` —	IN/OUT (Filled by the method) The currently focused annotation. It is `NULL` if the method returns `false`.

Returns

true if the annotation was obtained, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5316

AVPageViewGetGrayRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetGrayRect(AVPageView pageView, AVDevRect* greyRect)

Gets the rectangle that bounds a page view. This may include some of the gray area outside a page's crop box.

Parameters

	`pageView` —	The page view.

	`greyRect` —	(Filled by the method) A rectangle bounding the page view, specified in device space coordinates.

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 6773

AVPageViewGetInkPreview

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewGetInkPreview(AVPageView pageView)

Returns the ink preview value for a page view.

Parameters

pageView —

The page view whose number of visible inks is obtained.

Returns

See Also

AVPageViewSetInkPreview

Since

PI_ACROVIEW_VERSION >= 0x00090000

File: AVProcs.h

Line: 9954

AVPageViewGetLastVisiblePageNum

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPageNumber AVPageViewGetLastVisiblePageNum(AVPageView pageView)

Returns the page number of the last page that is visible on the screen.

Parameters

pageView —

The page view whose last visible page number is obtained.

Returns

The page number of the last page that is visible on the screen.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3384

AVPageViewGetLayoutMode

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDLayoutMode AVPageViewGetLayoutMode(AVPageView pageView)

Gets the page layout mode for a page view.

Parameters

pageView —

IN/OUT The page view whose layout mode is obtained.

Returns

The pageView object's page layout mode, described in PDLayoutMode.

See Also

AVPageViewSetLayoutMode

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3717

AVPageViewGetMousePosition

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetMousePosition(AVPageView pageView, AVDevCoord* x, AVDevCoord* y)

Gets the mouse position in pageView. The mouse position is specified in global coordinates. On Mac OS, it is equivalent to calling the Toolbox GetMouse call and adding the window's offset on the screen; on UNIX, it is equivalent to calling XQueryPointer and adding the window's offset on the screen.

Parameters

	`pageView` —	The page view in which the mouse location is obtained.

	`x` —	(Filled by the method) The x-coordinate of the mouse location.

	`y` —	(Filled by the method) The y-coordinate of the mouse location.

See Also

AVSysMouseIsStillDown

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6841

AVPageViewGetMousePositionSnapped

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetMousePositionSnapped(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, AVDragType direction)

Gets the current mouse position snapped to the layout grid.

Parameters

pageView —

The current page view.

x —

(Filled by the method) The x-coordinate of the mouse position.

y —

(Filled by the method) The y-coordinate of the mouse position.

direction —

An AVDragType indicating how the point is to be translated. Not all AVDragTypes are allowed: only those indicating how the point is to be translated are allowed.

The following AVDragTypes are used:

AVDragType	Description
kAVDragRect	Snap to the nearest grid intersection.
kAVDragSnapToTopLeft	Snap to the nearest grid intersection in the top left direction.
kAVDragSnapToTop	Snap to the nearest grid line above this point; `x` is unchanged.
kAVDragSnapToTopRight	Snap to the nearest grid intersection in the top right direction.
kAVDragSnapToRight	Snap to the nearest grid line right of this point; `y` is unchanged.
kAVDragSnapToBottomRight	Snap to the nearest grid intersection in the bottom right direction.
kAVDragSnapToBottom	Snap to the nearest grid line below this point; `x` is unchanged.
kAVDragSnapToBottomLeft	Snap to the nearest grid intersection in the bottom left direction.
kAVDragSnapToLeft	Snap to the nearest grid line left of this point; `y` is unchanged.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 7132

AVPageViewGetNextView

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewGetNextView(AVPageView pageView, PDDoc* pdDoc, PDPageNumber* pageNum, ASFixed* scale)

Used by page caching code to determine the next page to cache (and at what scale). Allows clients to do their own page caching.

You can replace this method with your own version, using HFTReplaceEntry().

Parameters

	`pageView` —	The page view.

	`pdDoc` —	(Filled by the method) The PDDoc containing the next page to cache.

	`pageNum` —	(Filled by the method) The next page to cache.

	`scale` —	(Filled by the method) The scale of the next page to cache.

Returns

true if the next page was cached, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3590

AVPageViewGetNumVisibleInks

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 AVPageViewGetNumVisibleInks(AVPageView pageView)

Gets the number of inks (color separations) that are displayed for a page view. An ink, in this context, means the content that will appear on a single plate when the page is separated. For example, a DeviceCMYK color is four inks, and a separation color space is usually one ink.

Parameters

pageView —

The page view whose number of visible inks is obtained.

Returns

The number of visible inks.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8564

AVPageViewGetPage

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPage AVPageViewGetPage(AVPageView pageView)

Gets a PDPage currently displayed in the specified page view. This does not acquire the page. Do not use this result across methods that might change the current page. To obtain a value that can be used across such calls, use PDDocAcquirePage() instead.

Parameters

pageView —

IN/OUT The page view whose PDPage is obtained.

Returns

PDPage currently displayed in pageView, or NULL if there is not a valid PDPage associated with pageView.

See Also

PDDocAcquirePage

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2053

AVPageViewGetPageNum

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPageNumber AVPageViewGetPageNum(AVPageView pageView)

Gets the current page number for pageView.

Parameters

pageView —

The page view whose current page number is obtained.

Returns

The current page number, or -1 if pageView is invalid. The first page in a document is page 0.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2105

AVPageViewGetPageToDevMatrix

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetPageToDevMatrix(AVPageView pageView, ASFixedMatrix* pageToDevMatrix)

Gets the matrix that transforms user space coordinates to device space coordinates for the specified page view.

Parameters

	`pageView` —	The page view whose transformation matrix is obtained.

	`pageToDevMatrix` —	(Filled by the method) A pointer to the transformation matrix.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2456

AVPageViewGetPageToDevScaling

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetPageToDevScaling(AVPageView pageView, float* xScale, float* yScale)

Gets the point-to-pixel scaling factor that transforms page units to device space units for the specified page view. Although the method returns both x and y factors, these are normally the same.

Parameters

	`pageView` —	The page view whose scaling is obtained.

	`xScale` —	(Filled by the method) A pointer to the horizontal scaling factor.

	`yScale` —	(Filled by the method) A pointer to the vertical scaling factor.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 9362

AVPageViewGetPixelInformationAtPoint

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewGetPixelInformationAtPoint(AVPageView pageView, AVDevCoord x, AVDevCoord y, AVInkValue* inkVector, ASUns32* inkVectorLength)

Gets the color separation ink information for pixels at the cursor position in the specified page view. Ink previews must be turned on before calling this method.

Parameters

	`pageView` —	The page view whose pixel information is obtained.

	`x` —	The horizontal cursor coordinate of the point, as obtained by the AVPageViewCursorProc() callback.

	`y` —	The vertical cursor coordinate of the point, as obtained by the AVPageViewCursorProc() callback.

	`inkVector` —	(Filled by the method) An array of ink values for the specified point.

	`inkVectorLength` —	(Filled by the method) The size of the `inkVector` array.

Returns

true if the information is successfully retrieved, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8603

AVPageViewGetSelectedAnnotPageNum

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPageNumber AVPageViewGetSelectedAnnotPageNum(AVPageView pageView)

Returns the page number of the currently selected annotation, or -1 if no annotation is selected.

Parameters

pageView —

The page view whose selected annotation page is obtained.

Returns

Returns the page number of the currently selected annotation, or -1 if no annotation is selected.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3436

AVPageViewGetThreadIndex

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVTArraySize AVPageViewGetThreadIndex(AVPageView pageView)

Gets the index of the currently active thread in a page view.

Parameters

pageView —

IN/OUT The page view whose active thread index is obtained.

Returns

The thread index of the current thread, or -1 if there is no current thread.

See Also

AVPageViewGetActiveBead

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2384

AVPageViewGetVisibleAnnotPage

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPageNumber AVPageViewGetVisibleAnnotPage(AVPageView pageView, PDAnnot annot)

Gets the number of a page containing an annotation.

Parameters

	`pageView` —	The page view with the annotation.

	`annot` —	The annotation whose page number is obtained.

Returns

The number of the page containing annot.

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 4068

AVPageViewGetVisibleInks

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGetVisibleInks(AVPageView pageView, PDPageInkRec* inks)

Gets the set of inks to be displayed in a separations preview for a page view.

Parameters

	`pageView` —	The page view whose number of visible inks is obtained.

	`inks` —	(Filled by the method) A pointer to an array of structures containing the visible ink names for the page. The vector must be large enough to hold the visible inks.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8580

AVPageViewGetWireframeDrawing

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewGetWireframeDrawing(AVPageView pageView)

Gets the wireframe mode for a page view.

Parameters

pageView —

IN The page view whose wireframe mode is obtained.

Returns

pageView's page wireframe mode.

See Also

AVPageViewSetWireframeDrawing

Since

PI_ACROVIEW_VERSION >= 0x00070000

File: AVProcs.h

Line: 9530

AVPageViewGetZoom

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASFixed AVPageViewGetZoom(AVPageView pageView)

Gets the current zoom for pageView. The zoom factor is point-to-point, not point-to-pixel. For example, a page that is 612 points wide at 100% zoom should be 612 points wide on the monitor, not 612 pixels.

Parameters

pageView —

The page view whose zoom is obtained.

Returns

Current zoom, as a fixed number measured in units in which 1.0 is 100% zoom.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2077

AVPageViewGetZoomType

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVZoomType AVPageViewGetZoomType(AVPageView pageView)

Gets the current zoom type.

Parameters

pageView —

IN/OUT The page view whose zoom type is obtained.

Returns

The current zoom type.

See Also

AVPageViewGetZoom

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2087

AVPageViewGhostRectOutline

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGhostRectOutline(AVPageView pageView, const AVDevRect* rect)

Draws the specified rectangle in pageView using the ghost outline.

Parameters

	`pageView` —	IN/OUT The page view into which `rect` is drawn.

	`rect` —	IN/OUT The rectangle to draw.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 6783

AVPageViewGoBack

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGoBack(AVPageView pageView)

Goes to the previous view on the view stack, if a previous view exists. This might result in a different document being made active.

Parameters

pageView —

IN/OUT The page view to change.

See Also

AVPageViewGoForward

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2228

AVPageViewGoForward

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGoForward(AVPageView pageView)

Goes to the next view on the view stack, if a next view exists. This might result in a different document being made active.

Parameters

pageView —

IN/OUT The page view to change.

See Also

AVPageViewGoBack

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2239

AVPageViewGoTo

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewGoTo(AVPageView pageView, PDPageNumber pageNum)

Goes to the specified page, retaining the current location on the page and the current zoom (either explicit or a variable). It invalidates the display, but does not perform an immediate redraw. This allows your client to call AVPageViewZoomTo(), AVPageViewScrollTo(), or both, and get only a single redraw event. If you decide to do this, you should bracket the calls with AVPageViewBeginOperation() and AVPageViewEndOperation().

Parameters

	`pageView` —	The page view in which a different page is displayed.

	`pageNum` —	The page number of the destination page. The first page in a document is page `0`.

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2175

AVPageViewHighlightText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewHighlightText(AVPageView pageView, PDTextSelect textSelect)

Inverts the given text selection on the current page using the current AVPageView color.

Parameters

	`pageView` —	IN/OUT The page view.

	`textSelect` —	IN/OUT The words to highlight.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3339

AVPageViewInfoToDevice

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInfoToDevice(AVPageView pageView, const ASFixedPoint* info, 
AVlCoord* x, 
AVlCoord* y)

Translates the given point from info space to device space. See AVPageViewDeviceToInfo() for a definition of info space.

Parameters

	`pageView` —	The page view holding the focus.

	`info` —	The point in info space.

	`x` —	(Filled by the method) The x-coordinate of `info` in device space.

	`y` —	(Filled by the method) The y-coordinate of `info` in device space.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5930

AVPageViewInfoToPoint

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInfoToPoint(AVPageView pageView, const ASFixedPoint* info, ASFixedPoint* pt)

Translates the given point from info space to user space. See AVPageViewDeviceToInfo() for a definition of info space.

Parameters

	`pageView` —	IN/OUT The page view holding the focus.

	`info` —	IN/OUT The point in info space.

	`pt` —	IN/OUT (Filled by the method) The point in user space.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5960

AVPageViewInsetRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInsetRect(AVPageView pageView, const AVDevRect* rr, ASBool down)

Draws a 3-D looking inset rectangle on the page view. It can be used to implement an inset style link, where clicking the link causes the page to appear to push into the screen.

Parameters

	`pageView` —	IN/OUT The page view on which to draw the rectangle.

	`rr` —	IN/OUT The rectangle to draw.

	`down` —	IN/OUT `true` to draw an inset rectangle, `false` to draw the rectangle in its normal state.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 6723

AVPageViewInvalidateRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInvalidateRect(AVPageView pageView, AVDevRect* area)

Indicates that the specified area of pageView is invalid and should be redrawn. This adds the rectangle to the list of regions to redraw, but does not force an immediate redraw. Use AVPageViewDrawNow() to force an immediate redraw.

Parameters

	`pageView` —	The AVPageView in which a region is invalidated.

	`area` —	A pointer to the rectangle to invalidate, specified in device space coordinates. Use AVPageViewRectToDevice() to convert a user space rectangle to device space. Pass `NULL` to invalidate the entire currently visible portion of the page.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6572

AVPageViewInvalidateText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInvalidateText(AVPageView pageView, PDTextSelect textSelect)

Invalidates the bits that AVPageViewHighlightText() touches.

Parameters

	`pageView` —	IN/OUT The page view.

	`textSelect` —	IN/OUT The words to invalidate.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3351

AVPageViewInvertQuad

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInvertQuad(AVPageView pageView, const Quad* quad, ASBool highlight)

Inverts the interior of a quad.

Parameters

	`pageView` —	The page view in which the inverted quad is drawn.

	`quad` —	A pointer to the quad to `invert`, specified in device space coordinates. Use AVPageViewPointToDevice() to convert the coordinates of the four corners of the quad that is specified in user space.

	`highlight` —	If `true`, it uses the highlight mode specified by `avpHighlightMode` in the Acrobat viewer's preferences file (see AVAppSetPreference()). If `false`, it uses a default highlighting mode.

See Also

AVPageViewInvertRect

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 4086

AVPageViewInvertRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInvertRect(AVPageView pageView, const AVDevRect* rect, ASBool highlight)

Inverts the interior of a rectangle.

Parameters

	`pageView` —	The page view in which the inverted rectangle is drawn.

	`rect` —	A pointer to the rectangle to invert, specified in device space coordinates. Use AVPageViewRectToDevice() to convert the coordinates of a rectangle that is specified in user space.

	`highlight` —	If `true`, it uses the highlight mode specified by `avpHighlightMode` in the Acrobat viewer's preferences file (see AVAppSetPreference()). If it is `false`, it uses a default highlighting mode.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6593

AVPageViewInvertRectOutline

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewInvertRectOutline(AVPageView pageView, const AVDevRect* rect)

Inverts the specified rectangle's outline.

Parameters

	`pageView` —	IN/OUT The page view in which the inverted rectangle outline is drawn.

	`rect` —	IN/OUT A pointer to the rectangle whose outline is inverted, specified in device space coordinates. Use AVPageViewRectToDevice() to convert the coordinates of a rectangle that is specified in user space coordinates.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 7299

AVPageViewIsAnnotAtPoint

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewIsAnnotAtPoint(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDAnnot* hitAnnot)

Tests whether the specified point is within an annotation. This method is typically used by mouse-handling code, to pass clicks within an annotation to the appropriate annotation handler. For each annotation, this method calls the appropriate annotation handler's AVAnnotHandlerPtInAnnotViewBBoxProc() to test whether the point is within the annotation.

Parameters

	`pageView` —	The page view for which the point to test.

	`xHit` —	The x-coordinate of the point to test.

	`yHit` —	The y-coordinate of the point to test.

	`hitAnnot` —	(Filled by the method) A pointer to the top-most annotation (if any) that was hit by the mouse click.

Returns

true if the location specified by xHit and yHit is within an annotation, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6923

AVPageViewIsAnnotOfTypeAtPoint

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewIsAnnotOfTypeAtPoint(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, ASAtom annotType, ASBool belowOthers, PDAnnot* annot)

Determines if an annotation of the specified type resides under the given point. If so, a handle to the annotation is returned.

Parameters

	`pageView` —	The page view.

	`xHit` —	The x-coordinate of the point.

	`yHit` —	The y-coordinate of the point.

	`annotType` —	The annotation type of interest.

	`belowOthers` —	If `true`, the search continues below the topmost annotation. Otherwise the search halts after a single annotation is found, irrespective of its type.

	`annot` —	(Filled by the method) The uppermost annotation of the given type.

Returns

true if an annotation was found, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 7346

AVPageViewIsBeadAtPoint

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewIsBeadAtPoint(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDBead* beadP)

Tests whether the specified point is within a bead. It returns the bead if it is.

Parameters

	`pageView` —	The page view in which the point is tested.

	`xHit` —	The x-coordinate of the point to test, specified in device space coordinates.

	`yHit` —	The y-coordinate of the point to test, specified in device space coordinates.

	`beadP` —	(Filled by the method) A pointer to the bead in which the point is located. This is only filled if the point is within a bead.

Returns

true if the point is within a bead, false otherwise. If the location is within a bead, the bead is returned in beadP.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6944

AVPageViewIsFocusAnnot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewIsFocusAnnot(AVPageView pageView, PDAnnot annot)

Used to determine if annot currently has focus.

Parameters

	`pageView` —	IN/OUT The page view in which the annotation resides.

	`annot` —	IN/OUT The annotation in question.

Returns

true if annot has the focus, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5350

AVPageViewPageNumIsVisible

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewPageNumIsVisible(AVPageView pageView, PDPageNumber pageNum)

Determines if a given page number is visible.

Parameters

	`pageView` —	IN/OUT The page view.

	`pageNum` —	IN/OUT The page number corresponding to the view of interest.

Returns

true if pageNum is visible, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3399

AVPageViewPointInText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewPointInText(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDTextSelect pdText)

Tests if the given point is in the PDTextSelect.

Parameters

	`pageView` —	The page view.

	`xHit` —	The x-coordinate to test.

	`yHit` —	The y-coordinate to test.

	`pdText` —	The text to hit-test upon.

Returns

true if the point is in the PDTextSelect, false otherwise.

See Also

AVPageViewTrackText

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 6997

AVPageViewPointToDevice

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewPointToDevice(AVPageView pageView, const ASFixedPointP p, AVDevCoord* x, AVDevCoord* y)

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

Parameters

	`pageView` —	The page view for which the point's coordinates are transformed.

	`p` —	A pointer to the ASFixedPoint whose coordinates, specified in user space, are transformed.

	`x` —	(Filled by the method) The x-coordinate of the device space point corresponding to `p`.

	`y` —	(Filled by the method) The y-coordinate of the device space point corresponding to `p`.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 7319

AVPageViewPointToInfo

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewPointToInfo(AVPageView pageView, const ASFixedPoint* pt, ASFixedPoint* info)

Translates the given point from user space to info space. See AVPageViewDeviceToInfo() for a definition of info space.

Parameters

	`pageView` —	IN/OUT The page view holding the focus.

	`pt` —	IN/OUT The point in user space.

	`info` —	IN/OUT (Filled by the method) The point in info space.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5945

AVPageViewReadPageDown

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewReadPageDown(AVPageView pageView)

Scrolls down through a document, as if the user pressed the Enter key. The scrolling follows articles if Acrobat is currently in article-reading mode.

Parameters

pageView —

IN/OUT The page view to scroll.

See Also

AVPageViewReadPageUp

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2217

AVPageViewReadPageUp

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewReadPageUp(AVPageView pageView)

Scrolls up through a document, as if the user pressed the Enter key. The scrolling follows articles if Acrobat is currently in article-reading mode.

Parameters

pageView —

IN/OUT The page view to scroll.

See Also

AVPageViewReadPageDown

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2206

AVPageViewRectToDevice

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewRectToDevice(AVPageView pageView, const ASFixedRectP p, AVDevRect* rect)

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

Parameters

	`pageView` —	The page view for which the coordinates are transformed.

	`p` —	A pointer to the rectangle whose coordinates are transformed, specified in user space coordinates.

	`rect` —	(Filled by the method) A pointer to a rectangle containing the device space coordinates corresponding to `p`.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6671

AVPageViewReleaseDrawContext

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewReleaseDrawContext(AVPageView pageView, DrawContextType contextType, void* drawContext)

Releases the platform-specific drawing context needed to draw into Acrobat's document window using a platform's native graphics calls.

Parameters

	`pageView` —	IN/OUT The AVPageView whose platform-dependent port is released.

	`contextType` —	IN/OUT The platform-specific port to release.

	`drawContext`

See Also

AVPageViewAcquireDrawContext

Since

PI_ACROVIEW_VERSION >= 0x000A0000

File: AVProcs.h

Line: 9989

AVPageViewReleaseMachinePort

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewReleaseMachinePort(AVPageView pageView, void* port)

DEPRECATED in Acrobat 10 Use AVPageViewReleaseDrawContext instead

Releases the platform-specific object needed to draw into Acrobat's document window using a platform's native graphics calls.

Parameters

	`pageView` —	IN/OUT The AVPageView whose platform-dependent port is released.

	`port` —	IN/OUT The platform-specific port to release.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2441

AVPageViewResumeOffscreenDrawing

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewResumeOffscreenDrawing(AVPageView pageView)

Clients that correctly use machine ports should work with the off-screen drawing behavior introduced in Acrobat 5. For other clients, the AVPageViewResumeOffscreenDrawing() and AVPageViewSuspendOffscreenDrawing() are provided for temporarily disabling the off screen drawing behavior so that it acts more like Acrobat 4.0. The one restriction is that you cannot call these routines while the page is drawn. In other words, do not call these routines from within a drawing callback such as one passed to AVAppRegisterForPageViewDrawing() or an annotation handler's DoDraw or DoDrawEx callback.

Parameters

pageView —

The AVPageView being drawn.

See Also

AVPageViewSuspendOffscreenDrawing

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 6117

AVPageViewScrollTo

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewScrollTo(AVPageView pageView, AVDevCoord xOrigin, AVDevCoord yOrigin)

Scrolls pageView to the location specified by xOrigin and yOrigin, within the limits imposed by the current zoom mode and the Acrobat viewer.

Parameters

	`pageView` —	The page view to scroll.

	`xOrigin` —	The x-coordinate to scroll to, specified in device space coordinates.

	`yOrigin` —	The y-coordinate to scroll to, specified in device space coordinates.

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6199

AVPageViewScrollToAnnot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewScrollToAnnot(AVPageView pageView, PDAnnot annot)

Scrolls the pageView to ensure that the specified annot is visible.

Parameters

	`pageView` —	IN/OUT The page view to scroll.

	`annot` —	IN/OUT The annotation to scroll to.

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 6031

AVPageViewScrollToRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewScrollToRect(AVPageView pageView, const AVDevRect* rect, ASBool favorLeft, ASBool favorTop, AVDevSize margin)

If the specified rectangle and margin fits inside the aperture, the pageview is scrolled to center the rectangle within the aperture. This method is handy for auto-scrolling the AVPageView in a natural way to bring some page object completely into view. It does not affect the zoom level or AVZoomType.

Parameters

	`pageView` —	The page view to scroll.

	`rect` —	A pointer to the rectangle that is completely visible.

	`favorLeft` —	Used when `rect` is wider than the window's aperture. If `favorLeft` is `true`, it favors the left side. If it is `false`, it favors the right side. Favoring a side means that the corresponding edge will appear within the aperture, even if the opposite edge will not.

	`favorTop` —	Used when `rect` is taller than the window's aperture. If `favorTop` is `true`, it favors the top side. If it is `false`, it favors the bottom side. Favoring a side means that the corresponding edge will appear within the aperture, even if the opposite edge will not.

	`margin` —	The number of pixels that `rect` should be from the nearest edges if it does not cause the rectangle to go from completely visible to partially obscured.

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 6555

AVPageViewSetAnnotLocation

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSetAnnotLocation(PDAnnot anAnnot, AVPageView pageView, AVDevCoord x, AVDevCoord y)

Sets an annotation's location, specified in device space coordinates.

Parameters

	`anAnnot` —	The annotation whose location is set.

	`pageView` —	The page view in which the annotation is displayed.

	`x` —	The annotation's new x-coordinate, specified in device space coordinates.

	`y` —	The annotation's new y-coordinate, specified in device space coordinates.

Notifications

PDAnnotWillChange
PDAnnotDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 7366

AVPageViewSetColor

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSetColor(AVPageView pageView, PDConstColorValue color)

Sets the color that will be used for subsequent drawing by AVPageViewDrawRect() and AVPageViewDrawRectOutline().

Parameters

	`pageView` —	IN/OUT The page view whose drawing color is set.

	`color` —	IN/OUT The color to set.

See Also

AVPageViewGetColor

Exceptions

genErrBadParm

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2129

AVPageViewSetFocusAnnot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVPageViewSetFocusAnnot(AVPageView pageView, PDAnnot focusAnnot, AVAnnotOpData opData)

Attempts to set an annotation as the active annotation.

Parameters

	`pageView` —	IN/OUT The page view in which the annotation resides.

	`focusAnnot` —	IN/OUT The annotation in question.

	`opData` —	IN/OUT Can be `NULL` and probably should be in most cases. If specified, it will be used for the kAVAnnotAcceptFocus operation.

Returns

true if annot was given the focus, false otherwise.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5330

AVPageViewSetInkPreview

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSetInkPreview(AVPageView pageView, ASBool inkPreview)

Sets or clears the ink preview value for a page view, which allows you to disable the rendering of individual inks. This does not change the set of visible inks. Enabling ink preview also enables overprint preview (OPP).

Parameters

	`pageView` —	The page view whose number of visible inks is obtained.

	`inkPreview` —	Indicates whether the page view has an ink preview.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8547

AVPageViewSetLayoutMode

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSetLayoutMode(AVPageView pageView, PDLayoutMode mode)

Sets the layout mode for a page view.

Parameters

	`pageView` —	IN/OUT The page view whose layout mode is set.

	`mode` —	IN/OUT The new layout mode for the page view.

See Also

AVPageViewGetLayoutMode

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3706

AVPageViewSetPageNum

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDPageNumber AVPageViewSetPageNum(AVPageView pageView, PDPageNumber pageNum)

Sets the current logical page of the page view, which might not be the same as the current number indicated on the screen.

Client writers in general do not need this, but if you wish to perform some operation on a page other than the one returned by AVPageViewGetPageNum(), you can use this call to temporarily set the page. You must restore the page number when you are done. You should avoid causing any major changes to the page view (such as scrolling) to ensure that you end up restoring the page to the correct value.

Parameters

	`pageView` —	The page view.

	`pageNum` —	The page number.

Returns

Previous page number.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3422

AVPageViewSetVisibleInks

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSetVisibleInks(AVPageView pageView, ASInt32 nInks, PDPageInkRec* inks)

Sets the set of inks to be displayed in a separations preview for a page view. The ink preview must be turned on for this method to have an effect.

Parameters

	`pageView` —	The page view whose number of visible inks is obtained.

	`nInks` —	The size of the inks array. The maximum number of inks is `16`.

	`inks` —	An array of the new visible inks for the page. It copies the inks into local storage, so the caller does not need to keep the array.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8531

AVPageViewSetWireframeDrawing

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSetWireframeDrawing(AVPageView pageView, ASBool drawWireframe)

Sets the wireframe mode for a page view.

Parameters

	`pageView` —	IN/OUT The page view whose wireframe mode is set.

	`drawWireframe` —	IN/OUT The new wireframe mode for the page view.

See Also

AVPageViewGetWireframeDrawing

Since

PI_ACROVIEW_VERSION >= 0x00070000

File: AVProcs.h

Line: 9519

AVPageViewShowControl

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewShowControl(AVPageView pageView, AVPageViewControlID controlID, ASBool show)

Shows or hides the controls in the status area at the bottom of a page view.

Parameters

	`pageView` —	The page view whose controls are affected.

	`controlID` —	The controls affected.

	`show` —	`true` if the controls are displayed, `false` if not shown.

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 4146

AVPageViewSnapPoint

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSnapPoint(AVPageView pageView, AVDevCoord* x, AVDevCoord* y, AVDragType direction)

This method is superseded by AVPageViewSnapPointEx() in Acrobat 6.0.

Snaps a point to the layout grid if the avpSnapToGrid preference is set.

Parameters

pageView —

The page view.

x —

(Filled by the method) The x-coordinate of the point.

y —

(Filled by the method) The y-coordinate of the point.

direction —

An AVDragType indicating how the point is to be translated. Not all AVDragTypes are allowed.

Only the following AVDragTypes are used:

AVDragType	Description
kAVDragRect	Snap to the nearest grid intersection.
kAVDragSnapToTopLeft	Snap to the nearest grid intersection in the top left direction.
kAVDragSnapToTop	Snap to the nearest grid line above this point; `x` is unchanged.
kAVDragSnapToTopRight	Snap to the nearest grid intersection in the top right direction.
kAVDragSnapToRight	Snap to the nearest grid line right of this point; `y` is unchanged.
kAVDragSnapToBottomRight	Snap to the nearest grid intersection in the bottom right direction.
kAVDragSnapToBottom	Snap to the nearest grid line below this point; `x` is unchanged.
kAVDragSnapToBottomLeft	Snap to the nearest grid intersection in the bottom left direction.
kAVDragSnapToLeft	Snap to the nearest grid line left of this point; `y` is unchanged.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 7098

AVPageViewSnapPointEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSnapPointEx(AVPageView pageView, ASFixedPoint* pt, AVDragType direction)

Snaps a point to the layout grid if the avpSnapToGrid preference is set, using page-space coordinates.

Parameters

pageView —

The page view.

pt —

(Filled by the method) The point that will be snapped to the grid, specified in page space.

direction —

An AVDragType indicating how the point is to be translated. Not all AVDragType values are allowed; only the following AVDragType values are used:

AVDragType	Description
kAVDragRect	Snap to the nearest grid intersection.
kAVDragSnapToTopLeft	Snap to the nearest grid intersection in the top left direction.
kAVDragSnapToTop	Snap to the nearest grid line above this point; `pt->h` is unchanged.
kAVDragSnapToTopRight	Snap to the nearest grid intersection in the top right direction.
kAVDragSnapToRight	Snap to the nearest grid line right of this point; `pt->v` is unchanged.
kAVDragSnapToBottomRight	Snap to the nearest grid intersection in the bottom right direction.
kAVDragSnapToBottom	Snap to the nearest grid line below this point; `pt->h` is unchanged.
kAVDragSnapToBottomLeft	Snap to the nearest grid intersection in the bottom left direction.
kAVDragSnapToLeft	Snap to the nearest grid line left of this point; `pt->v` is unchanged.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8880

AVPageViewSnapRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSnapRect(AVPageView pageView, AVDevCoord xStart, AVDevCoord yStart, AVDevCoord xNow, AVDevCoord yNow, AVDevRect* startRect, AVDevRect* resultRect, ASInt32 handleType, ASUns32 modifiers, const AVDevRect* extrema)

Given a starting point, ending point, and starting rectangle, this returns a resulting rectangle which is snapped to the grid. The routine is designed for use within a custom mouse-drag loop, when the default drawing behavior provided by AVPageViewDragRectSnapped() is insufficient.

Parameters

	`pageView` —	The page view.

	`xStart` —	The x-coordinate of the point where the user initially clicked, specified in device space coordinates.

	`yStart` —	The y-coordinate of the point where the user initially clicked, specified in device space coordinates.

	`xNow` —	The x-coordinate.

	`yNow` —	The y-coordinate.

	`startRect` —	The initial position of the rectangle.

	`resultRect` —	(Filled by the method) The position of the rectangle at the end of the operation.

	`handleType` —	One of the AVRectHandleType enumerated values, typically obtained by calling AVRectHandleHitTest() with the initial rectangle and starting coordinates. The `handleType` determines which point or edge of the rectangle should be snapped to the grid.

	`modifiers` —	Pass AVSysGetModifiers() to pass in one of the Modifier Keys. If the key indicates that the Shift key is pressed, one of the following is done: If the `handleType` parameter is a resizing parameter (kAVRectHandleTopLeft through kAVRectHandleLeftMiddle), then maintain the aspect ratio of the original rectangle. If the `handleType` parameter is kAVRectHandleNone, this means that the rectangle is being moved around rather than resized, and the result rectangle will be snapped to the x-axis or y-axis of the starting rectangle, whichever is closer.

	`extrema` —	Restricts the drag operation to a bounding rectangle. If it is `NULL`, the bounding rectangle of the page view is used.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 7284

AVPageViewStartReadingThread

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewStartReadingThread(AVPageView pageView, PDThread thread)

Puts the specified page view into article thread-reading mode.

Parameters

	`pageView` —	IN/OUT The page view to set to article thread- reading mode.

	`thread` —	IN/OUT The thread to read.

See Also

AVPageViewGetActiveBead

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2372

AVPageViewSuspendOffscreenDrawing

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewSuspendOffscreenDrawing(AVPageView pageView)

Clients that correctly use machine ports should work with the new off-screen drawing behavior introduced in Acrobat 5.0. For other clients, the AVPageViewResumeOffscreenDrawing() and AVpageViewSuspendOffscreenDrawing() are provided for temporarily disabling the off screen drawing behavior so that it acts more like Acrobat 4.0. The one restriction is that you cannot call these routines while the page being is drawn. In other words, do not call these routines from within a drawing callback such as one passed to AVAppRegisterForPageViewDrawing() or an annotation handler's DoDraw or DoDrawEx callback. Off-screen drawing should be suspended as rarely and briefly as possible (for example, only while a client that does not use machine ports correctly has a selection active).

Parameters

pageView —

The page view whose drawing is to be suspended.

See Also

AVPageViewResumeOffscreenDrawing

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 6100

AVPageViewToDestInfo

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVDestInfo AVPageViewToDestInfo(AVPageView pageView, ASAtom fitType)

Creates a destination info object from a given AVPageView and fit type.

Parameters

	`pageView` —	The page view from whose current view the destination information is created.

	`fitType` —	The ASAtom specifying the fit type that the view destination will have. The string associated with fit type must be one of View Destination Fit Types.

Returns

The newly created destination info.

See Also

AVDestInfoDestroy
AVPageViewUseDestInfo

Since

PI_ACROVIEW_VERSION >= 0x00020003

File: AVProcs.h

Line: 3904

AVPageViewToViewDest

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





PDViewDestination AVPageViewToViewDest(AVPageView pageView, ASAtom fitType, PDDoc srcPDDoc)

Builds a PDViewDestination from the current zoom and position.

Parameters

	`pageView` —	The page view from whose current view the destination is created.

	`fitType` —	The ASAtom specifying the fit type that the view destination will have. The string associated with `fitType` must be one of View Destination Fit Types.

	`srcPDDoc` —	The document in which the view destination is used.

Returns

The newly created view destination.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2259

AVPageViewTrackText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PDTextSelect AVPageViewTrackText(AVPageView pageView, AVDevCoord xHit, AVDevCoord yHit, PDTextSelect current)

Called in response to a mouse click to track a text selection on the screen. It uses the AVPageView current color, and leaves the screen with any highlights visible. It does not affect the current document selection.

Parameters

	`pageView` —	The page view.

	`xHit` —	The x-coordinate of the original click.

	`yHit` —	The y-coordinate of the original click.

	`current` —	Any existing selection that should be built upon.

Returns

PDTextSelect containing the words selected.

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 6983

AVPageViewTransformRectRZ

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewTransformRectRZ(AVPageView pv, AVTFlagBits flags, ASFixedRect* ar, ASFixedMatrix* mr)

Calculates where an annotation is drawn with no zoom or no rotation, as specified by the annotation flags. This method generalizes AVPageViewGetAnnotRect().

Parameters

	`pv` —	IN/OUT The page view used for the transformation.

	`flags` —	IN/OUT Annotation flags obtained by PDAnnotGetFlags.

	`ar` —	IN/OUT A pointer to the annotation's bounding rectangle, specified in user space coordinates.

	`mr` —	IN/OUT (Filled by the method) The transformation matrix.

Since

PI_ACROVIEW_VERSION >= 0x00040000

File: AVProcs.h

Line: 4034

AVPageViewUpdateInfoPanel

()

Product availability: Acrobat

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewUpdateInfoPanel(AVPageView pageView, AVInfoPanelUpdateType updateType, void* data)

Allow clients to control the Info panel output.

Parameters

pageView —

The page view.

updateType —

An AVInfoPanelUpdateType constant. If it is kAVInfoPanelLock or kAVInfoPanelUnlock, data should be NULL and is ignored. If updateType is kAVInfoPanelRect, clients should pass an AVRect32P through data. It is also useful to note how the rectangle will be interpreted by the info panel.

The info panel will display the following data:

Data	Description
`X`	The left of the rectangle.
`Y`	The top of the rectangle.
`W`	The width of the rectangle.
`H`	The height of the rectangle.

data —

User-supplied data.

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 5985

AVPageViewUseDestInfo

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewUseDestInfo(AVPageView pageView, AVDestInfo destInfo)

Causes the given page view to change to the view given by an AVDestInfo object.

Parameters

	`pageView` —	IN/OUT The page view to change.

	`destInfo` —	IN/OUT The destination to use.

Since

PI_ACROVIEW_VERSION >= 0x00020003

File: AVProcs.h

Line: 3915

AVPageViewUseThisDestination

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewUseThisDestination(AVPageView pageView, PDViewDestination viewDest, ASFixed sourceZoom)

Causes the given page view to change to the view given by viewDest and sourceZoom.

Parameters

	`pageView` —	IN/OUT The page view to change.

	`viewDest` —	IN/OUT The view destination.

	`sourceZoom` —	IN/OUT The zoom factor to use, unless `viewDest` specifies inheriting the current zoom, which is the zoom in effect when a link is clicked. For example, `sourceZoom` is used only if the view destination is of type `XYZ` ( that is, it specifies a point and a zoom) and the zoom is zero (meaning 'inherit the current zoom'). In this case, `sourceZoom` is used as the zoom to inherit.

See Also

PDViewDestCreate

Since

PI_ACROVIEW_VERSION >= 0x00020002

File: AVProcs.h

Line: 3748

AVPageViewWasCreated

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewWasCreated(AVPageView pageView, void* clientData)

Sent when a page view is created.

Parameters

	`pageView` —	The `AVPageView` that was created.

	`clientData` —	A pointer to a block of user-supplied data that was passed when the client registered for this notification using `AVAppRegisterNotification()`.

Notifications

AVDocActivePageViewDidChange
AVPageViewDocDidChange
AVPageViewDidChange
AVPageViewWillDestroy

File: PIPokes.h

Line: 2181

AVPageViewWillDestroy

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewWillDestroy(AVPageView pageView, void* clientData)

Sent before a page view is destroyed.

Parameters

	`pageView` —	The `AVPageView` that will be destroyed.

	`clientData` —	A pointer to a block of user-supplied data that was passed when the client registered for this notification using `AVAppRegisterNotification()`.

Notifications

AVDocActivePageViewDidChange
AVPageViewDocDidChange
AVPageViewDidChange

File: PIPokes.h

Line: 2197

AVPageViewWillDraw

()

Product availability: All

Platform availability: All

Syntax





void AVPageViewWillDraw(AVPageView pageView, void* clientData)

Redrawing will occur in the page view section of the window.

Parameters

	`pageView` —	The `AVPageView` in which drawing will occur.

	`clientData` —	A pointer to a block of user-supplied data that was passed when the client registered for this notification using `AVAppRegisterNotification()`.

See Also

AVPageViewDrawNow

Notifications

AVPageViewDidChange
AVPageViewDidDraw

File: PIPokes.h

Line: 2066

AVPageViewZoomTo

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVPageViewZoomTo(AVPageView pageView, AVZoomType zoomType, ASFixed scale)

Sets the zoom factor and zoom type for the specified page view.

Parameters

	`pageView` —	The page view to zoom.

	`zoomType` —	The zoom type to set.

	`scale` —	The zoom factor, specified as a magnification factor (for example, 1.0 displays the document at actual size). `scale` is ignored unless `zoomType` is AVZoomNoVary. Use zero to inherit the zoom.

Notifications

AVPageViewDidChange

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2191

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
AVPageView	Typedefs \| Enumerations \| Callbacks \| Methods

	kAVPageViewZoomControl,

	kAVPageViewPageFlipControls,

	kAVPageViewPageNumberControl,

	kAVPageViewPageSizeControl,

	kAVPageViewSplitterBar,

	kAVPageViewHorizontalScrollBar,

	kAVPageViewVerticalScrollBar,

	kAVPageViewGrayBorder

	kAVTabOrderFirst,

	kAVTabOrderLast,

	kAVTabOrderNext,

	kAVTabOrderPrev

Layer	AV_Layer
Object	AVPageView