LayerAV_Layer
ObjectAVGrafSelect

An AVGrafSelect is a graphics selection on a page. It is a rectangular region of a page that can be copied to the clipboard as a sampled image. After a plug-in creates an AVGrafSelect, it can use AVDocSetSelection() to set the AVGrafSelect as the current selection, and AVDocShowSelection() to scroll it to a visible position in the window.



Typedef Summary
 Typedef
 AVGrafSelect
Method Summary
 Method
 
AVGrafSelect AVGrafSelectCreate(AVPageView pageView, const ASFixedRectP selRect)
Creates a graphics selection. After creation, the selection can be set using AVDocSetSelection().
 
Destroys a graphics selection. Use this method to destroy the selection only if you have not called AVDocSetSelection() with it. If the selection has been set by a call to AVDocSetSelection(), it will automatically be destroyed by a call to AVDocClearSelection() or the next call to AVDocSetSelection().
 
Gets the specified graphics selection's bounding rectangle.

Typedefs Detail
AVGrafSelect 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVGrafSelect* AVGrafSelect;

File: AVExpT.h
Line: 5357



Method Detail
AVGrafSelectCreate()
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

AVGrafSelect AVGrafSelectCreate(AVPageView pageView, const ASFixedRectP selRect)

Creates a graphics selection. After creation, the selection can be set using AVDocSetSelection().

Parameters

pageView — 

The AVPageView in which a graphics selection is created.

 
selRect — 

A pointer to the ASFixedRect bounding the region from which a graphics selection is created, specified in user space coordinates.

Returns

The newly created AVGrafSelect, or NULL if selRect is NULL or is an empty rectangle.

See Also

Exceptions

genErrBadParm
genErrNoMemory

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 3103
AVGrafSelectDestroy() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVGrafSelectDestroy(AVGrafSelect avGraf)

Destroys a graphics selection. Use this method to destroy the selection only if you have not called AVDocSetSelection() with it. If the selection has been set by a call to AVDocSetSelection(), it will automatically be destroyed by a call to AVDocClearSelection() or the next call to AVDocSetSelection().

Parameters

avGraf — 

IN/OUT The graphics selection to destroy.

See Also

Exceptions

genErrBadParm

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 3116
AVGrafSelectGetBoundingRect() 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

void AVGrafSelectGetBoundingRect(AVGrafSelect avGraf, ASFixedRect* boundRectP)

Gets the specified graphics selection's bounding rectangle.

Parameters

avGraf — 

IN/OUT The graphics selection whose bounding rectangle is obtained.

 
boundRectP — 

IN/OUT A pointer to the graphics selection's bounding rectangle, specified in user space coordinates.

See Also

Exceptions

genErrBadParm

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h
Line: 3129