AV_Layer.Macintosh (Acrobat)

	Define
	MAC_PLATFORM (Macintosh) (Mac OS only, previously known as MAC_ENV) Defined if the client is being compiled for Mac OS, undefined otherwise. MAC_PLATFORM, WIN_PLATFORM, and UNIX_PLATFORM should be used by client developers to conditionally compile platform-dependent code. MAC_PLATFORM is automatically set by the header files.

	Typedef
	AVRect32
	AVRect32P A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides).
	AVRectP

	Enumeration
	`AVRectHandleType` An enumerated list of the types of AVRect handles.

	Structure
	AVRect A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides).

	Method
	AVDragTypeEx AVRectHandleHitTest(const AVDevRect* rect, ASBool bMidpoints, AVDevCoord x, AVDevCoord y) Tests to determine whether the given point lies on any of the control handles of rect.
	void AVRectToRect(const AVRect* avr, Rect* r) Converts an AVRect into a QuickDraw rectangle.
	AVCursor AVWindowGetCursorAtPoint(AVWindow win, AVlCoord x, AVlCoord y) Queries the AVWindow for the appropriate cursor for display at the given point (in the AVWindow object's device coordinate space). This method may raise exceptions, depending on the method called.
	void RectToAVRect(const Rect* r, AVRect* avr) Converts a Quickdraw Rect into an AVRect.

Defines Detail

MAC_PLATFORM

Product availability: Acrobat, Reader

Platform availability: Macintosh

Syntax


#define MAC_PLATFORM 1

Description

(Mac OS only, previously known as MAC_ENV) Defined if the client is being compiled for Mac OS, undefined otherwise. MAC_PLATFORM, WIN_PLATFORM, and UNIX_PLATFORM should be used by client developers to conditionally compile platform-dependent code. MAC_PLATFORM is automatically set by the header files.

See Also

WIN_PLATFORM
UNIX_PLATFORM

File: MacPlatform.h

Line: 51

Typedefs Detail

AVRect32

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVRect AVRect32;

File: AVExpT.h

Line: 5908

AVRect32P

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVRectP AVRect32P;

A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides).

The AcroView coordinate system is defined so that (0,0) is at the top, x increases to the right, and y increases down (the same as GDI and QuickDraw but opposite to the PostScript language). An AVRect32 is defined so that its top is above its bottom, but this means that 0 < top < bottom.

File: AVExpT.h

Line: 5925

AVRectP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef AVRect AVRectP;

File: AVExpT.h

Line: 1085

Enumeration Detail

AVRectHandleType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum AVRectHandleType {

  kAVRectHandleNone,


 


  kAVRectHandleTopLeft,


 


  kAVRectHandleTopRight,


 


  kAVRectHandleBottomRight,


 


  kAVRectHandleBottomLeft,


 


  kAVRectHandleTopMiddle,


 


  kAVRectHandleRightMiddle,


 


  kAVRectHandleBottomMiddle,


 


  kAVRectHandleLeftMiddle

}

File: AVExpT.h

Line: 9348

Elements

	kAVRectHandleNone	No handle.

	kAVRectHandleTopLeft	Top left.

	kAVRectHandleTopRight	Top right.

	kAVRectHandleBottomRight	Bottom right.

	kAVRectHandleBottomLeft	Bottom left.

	kAVRectHandleTopMiddle	Top middle.

	kAVRectHandleRightMiddle	Right middle.

	kAVRectHandleBottomMiddle	Bottom middle.

	kAVRectHandleLeftMiddle	Left middle.

Structure Detail

AVRect

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct AVRect {

  AVSDKDependentInteger left;  


 


  AVSDKDependentInteger top;  


 


  AVSDKDependentInteger right;  


 


  AVSDKDependentInteger bottom;  

}

A data structure representing a rectangle (a quadrilateral having only horizontal and vertical sides).

The AcroView coordinate system is defined so that (0,0) is at the top, x increases to the right, and y increases down (the same as GDI and QuickDraw but opposite to the PostScript language). An AVRect is defined so that its top is above its bottom, but this means that 0 < top < bottom.

File: AVExpT.h

Line: 1072

Method Detail

AVRectHandleHitTest

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVDragTypeEx AVRectHandleHitTest(const AVDevRect* rect, ASBool bMidpoints, AVDevCoord x, AVDevCoord y)

Tests to determine whether the given point lies on any of the control handles of rect.

Parameters

	`rect` —	The rectangle to test.

	`bMidpoints` —	Pass `true` if you are interested in the midpoint handles. If it is `false` and a midpoint handle is hit, kAVDragRect is returned.

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

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

Returns

-1 if the point is not within the rectangle. If the point is within the rectangle, but not over a handle, kAVDragRect is returned. If the point is within a handle region, one of the AVRectHandleType constants is returned.

See Also

AVPageViewSnapRect

Since

PI_ACROVIEW_VERSION >= 0x00050000

File: AVProcs.h

Line: 6803

AVRectToRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh

Syntax





void AVRectToRect(const AVRect* avr, Rect* r)

Converts an AVRect into a QuickDraw rectangle.

This can throw numerous exceptions and broadcast numerous notifications.

Parameters

	`avr` —	IN/OUT Pointer to the AVRect to convert to a rectangle.

	`r` —	IN/OUT (Filled by the method) The rectangle corresponding to `avr`.

See Also

RectToAVRect

Since

PI_MACINTOSH_VERSION >= 0x00020000

File: MacProcs.h

Line: 42

AVWindowGetCursorAtPoint

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVCursor AVWindowGetCursorAtPoint(AVWindow win, AVlCoord x, AVlCoord y)

Queries the AVWindow for the appropriate cursor for display at the given point (in the AVWindow object's device coordinate space). This method may raise exceptions, depending on the method called.

Parameters

	`win` —	The AVWindow to query.

	`x` —	The x-coordinate of a point in `win`.

	`y` —	The y-coordinate of a point in `win`.

Returns

The AVCursor appropriate for the specified point in the window.

Since

PI_MACINTOSH_VERSION >= 0x00020002

File: AVProcs.h

Line: 3619

RectToAVRect

()

Product availability: Acrobat, Reader

Platform availability: Macintosh

Syntax





void RectToAVRect(const Rect* r, AVRect* avr)

Converts a Quickdraw Rect into an AVRect.

Parameters

	`r` —	Pointer to a Rect to convert to an AVRect.

	`avr` —	(Filled by the method) Pointer to the AVRect corresponding to rect.

See Also

AVRectToRect

Since

PI_MACINTOSH_VERSION >= 0x00020000

File: MacProcs.h

Line: 53

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
Macintosh	Defines \| Typedefs \| Enumerations \| Structures \| Methods

	kAVRectHandleNone,

	kAVRectHandleTopLeft,

	kAVRectHandleTopRight,

	kAVRectHandleBottomRight,

	kAVRectHandleBottomLeft,

	kAVRectHandleTopMiddle,

	kAVRectHandleRightMiddle,

	kAVRectHandleBottomMiddle,

	kAVRectHandleLeftMiddle

	AVSDKDependentInteger left;

	AVSDKDependentInteger top;

	AVSDKDependentInteger right;

	AVSDKDependentInteger bottom;

Layer	AV_Layer
Object	Macintosh