PDFActionRemoteGoTo Class Reference
| Inherits from | |
| Conforms to | |
| Framework | Library/Frameworks/Quartz.framework/Frameworks/PDFKit.framework |
| Availability | Available in Mac OS X v10.5 and later.
|
| Declared in | PDFActionRemoteGoTo.h |
Overview
PDFActionRemoteGoTo, a subclass of PDFAction, defines methods for getting and setting the destination of a go-to action that targets another document.
Tasks
Initializing the Remote Go-to Action
Accessing the Page Index of the Referenced Document
Accessing a Point on the Referenced Page
Accessing the URL of the Referenced Document
Instance Methods
initWithPageIndex:atPoint:fileURL:
Initializes the remote go-to action with the specified page index, point, and document URL.
- (id)initWithPageIndex:(NSUInteger)pageIndex atPoint:(NSPoint)point fileURL:(NSURL *)url
Parameters
- pageIndex
The page index of the remote document.
- point
The point on the page in the remote document.
- url
The URL of the remote PDF document.
Return Value
An initialized PDFActionRemoteGoTo instance, or NULL if the object could not be initialized..
Discussion
The PDFActionRemoteGoTo object uses a zero-based page index, not a PDFPage object. This simplifies the handling of remote destinations for documents that may not be instantiated yet.
Availability
- Available in Mac OS X v10.5 and later.
Declared In
PDFActionRemoteGoTo.hpageIndex
Returns the zero-based page index referenced by the remote go-to action.
- (NSUInteger)pageIndex
Return Value
The page index referenced by the remote go-to action.
Availability
- Available in Mac OS X v10.5 and later.
See Also
Declared In
PDFActionRemoteGoTo.hpoint
Returns the point, in page space, on the page referenced by the remote go-to action.
- (NSPoint)point
Return Value
The point on the page of the remote document referenced by the action. If either the x value or the y value of the point is kPDFDestinationUnspecifiedValue, no position on the page is specified.
Discussion
Page space is a 72-dpi coordinate system with the origin at the lower-left corner of the current page.
Availability
- Available in Mac OS X v10.5 and later.
Declared In
PDFActionRemoteGoTo.hsetPageIndex:
Sets the zero-based page index referenced by the remote go-to action.
- (void)setPageIndex:(NSUInteger)pageIndex
Parameters
- pageIndex
The page index in the remote document to go to.
Availability
- Available in Mac OS X v10.5 and later.
See Also
Declared In
PDFActionRemoteGoTo.hsetPoint:
Sets the point, in page space, on the page referenced by the remote go-to action.
- (void)setPoint:(NSPoint)point
Parameters
- point
The point on the remote page to go to. If either the x value or the y value of the point is
kPDFDestinationUnspecifiedValue, no position on the page is specified.
Discussion
Page space is a 72-dpi coordinate system with the origin at the lower-left corner of the current page.
Availability
- Available in Mac OS X v10.5 and later.
Declared In
PDFActionRemoteGoTo.hsetURL:
Sets the URL of the document referenced by the remote go-to action.
- (void)setURL:(NSURL *)url
Parameters
- url
The URL of the remote document to go to.
Availability
- Available in Mac OS X v10.5 and later.
Declared In
PDFActionRemoteGoTo.hURL
Returns the URL of the document referenced by the remote go-to action.
- (NSURL *)URL
Return Value
The URL of the remote document referenced by the action.
Availability
- Available in Mac OS X v10.5 and later.
Declared In
PDFActionRemoteGoTo.h
Last updated: 2007-12-11
  |
||
|
|
|
|
| ||
Get information on Apple products.
Visit the Apple Store online or at retail locations. 1-800-MY-APPLE Copyright © 2007 Apple Inc. All rights reserved. | Terms of use | Privacy Notice |