MFDocumentViewControllerDelegate Protocol Reference
Declared in | MFDocumentViewControllerDelegate.h |
Tasks
-
– documentViewController:didChangeDirectionTo:
This method will notify a change in the direction used to present the document.
-
– documentViewController:didGoToPage:
This method will be called to notify the transition to a new page. Use this to update page number related UI’s elements or synchronize selected actions.
-
– documentViewController:didChangeLeadTo:
This method will notify a change in the lead used to present the document.
-
– documentViewController:didChangeModeTo:automatic:
This method will notify a change in the mode of the document, either by esplicity setting it or automatic on rotation.
-
– documentViewController:didReceiveTapAtPoint:
This method will notify if the user has tapped the document view at a point different from a document element, like an annotation.
-
– documentViewController:didReceiveURIRequest:
This method will notify if the user has tapped on a annotation with a remote uri action. This is usually invoked when an external link is activated and an internet browser should be open to show the link’s content.
-
– documentViewController:didReceiveTapOnPage:atPoint:
This method will notify if and where the user has tapped on a page bounds. Coordinates of the point are in document’s user space.
-
– documentViewController:didEndZoomingAtScale:
This method will report the last zoom level achieved by the document detail view. You can use this callback to animate an icon that report the current zoom to the user.
-
– documentViewController:willFocusOnPage:
This method will be called right before displaying a high definition version of the current page. Could be used to start an Activity Indicator.
-
– documentViewController:didFocusOnPage:
This method will be called upon the showing up of the high definition version of the current page. Could be used to stop and Activity Indicator.
-
– documentViewControllerDidUnfocus:
This method will be called when the high definition version of the page is removed from the view.
-
– documentViewController:didReceiveDoubleTapOnAnnotationRect:withUri:onPage:
This method will be called when user double tap on an annotation.
-
– documentViewController:didReceiveTapOnAnnotationRect:withUri:onPage:
This method will be called when an user tap on an annotation.
-
– documentViewController:doesHaveToAutoplayVideo:
This method will be called to ask the delegate if the video player needs to start automatically once visible.
-
– documentViewController:doesHaveToLoopVideo:
Self explanatory. This method will be called to ask the delegate if the video player needs to loop the video.
-
– documentViewController:doesHaveToAutoplayAudio:
Implement this method to return whether the audio clip should play automatically once loaded.
-
– documentViewController:willFollowLinkToPage:
This method will be invoked before automatically moving to a page due to the user tapping on an embedded internal link inside the document.
-
– documentViewController:didReceiveRequestToGoToDestinationNamed:ofFile:
This method will be invoked when the user tap on an annotation with an associated Go-To Remote action. The user can then load the file passed as third argument and then get the page number with MFDocumentManager’s -pageNumberForDestinationNamed: and present the right page for display.
-
– documentViewController:didReceiveRequestToGoToPage:ofFile:
This method will be invoked when the user tap on an annotation with an associated Go-To Remote action. The user can then load the file passed as last argument and then set the page to the page number passed as second parameter.
-
– classForAudioPlayerView
This method will be called to provide a class of the view to use as player audio control. You can use the default class provide in the sample or develop your own to suit the look and feel of you application better.
Instance Methods
classForAudioPlayerView
This method will be called to provide a class of the view to use as player audio control. You can use the default class provide in the sample or develop your own to suit the look and feel of you application better.
- (Class<MFAudioPlayerViewProtocol>)classForAudioPlayerView
Discussion
This method will be called to provide a class of the view to use as player audio control. You can use the default class provide in the sample or develop your own to suit the look and feel of you application better.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didChangeDirectionTo:
This method will notify a change in the direction used to present the document.
- (void)documentViewController:(MFDocumentViewController *)dvc didChangeDirectionTo:(MFDocumentDirection)direction
Discussion
This method will notify a change in the direction used to present the document.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didChangeLeadTo:
This method will notify a change in the lead used to present the document.
- (void)documentViewController:(MFDocumentViewController *)dvc didChangeLeadTo:(MFDocumentLead)lead
Discussion
This method will notify a change in the lead used to present the document.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didChangeModeTo:automatic:
This method will notify a change in the mode of the document, either by esplicity setting it or automatic on rotation.
- (void)documentViewController:(MFDocumentViewController *)dvc didChangeModeTo:(MFDocumentMode)mode automatic:(BOOL)automatically
Discussion
This method will notify a change in the mode of the document, either by esplicity setting it or automatic on rotation.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didEndZoomingAtScale:
This method will report the last zoom level achieved by the document detail view. You can use this callback to animate an icon that report the current zoom to the user.
- (void)documentViewController:(MFDocumentViewController *)dvc didEndZoomingAtScale:(float)level
Discussion
This method will report the last zoom level achieved by the document detail view. You can use this callback to animate an icon that report the current zoom to the user.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didFocusOnPage:
This method will be called upon the showing up of the high definition version of the current page. Could be used to stop and Activity Indicator.
- (void)documentViewController:(MFDocumentViewController *)dvc didFocusOnPage:(NSUInteger)page
Discussion
This method will be called upon the showing up of the high definition version of the current page. Could be used to stop and Activity Indicator.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didGoToPage:
This method will be called to notify the transition to a new page. Use this to update page number related UI’s elements or synchronize selected actions.
- (void)documentViewController:(MFDocumentViewController *)dvc didGoToPage:(NSUInteger)page
Discussion
This method will be called to notify the transition to a new page. Use this to update page number related UI’s elements or synchronize selected actions.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveDoubleTapOnAnnotationRect:withUri:onPage:
This method will be called when user double tap on an annotation.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveDoubleTapOnAnnotationRect:(CGRect)rect withUri:(NSString *)uri onPage:(NSUInteger)page
Discussion
This method will be called when user double tap on an annotation.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveRequestToGoToDestinationNamed:ofFile:
This method will be invoked when the user tap on an annotation with an associated Go-To Remote action. The user can then load the file passed as third argument and then get the page number with MFDocumentManager’s -pageNumberForDestinationNamed: and present the right page for display.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveRequestToGoToDestinationNamed:(NSString *)destinationName ofFile:(NSString *)fileName
Discussion
This method will be invoked when the user tap on an annotation with an associated Go-To Remote action. The user can then load the file passed as third argument and then get the page number with MFDocumentManager’s -pageNumberForDestinationNamed: and present the right page for display.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveRequestToGoToPage:ofFile:
This method will be invoked when the user tap on an annotation with an associated Go-To Remote action. The user can then load the file passed as last argument and then set the page to the page number passed as second parameter.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveRequestToGoToPage:(NSUInteger)pageNumber ofFile:(NSString *)fileName
Discussion
This method will be invoked when the user tap on an annotation with an associated Go-To Remote action. The user can then load the file passed as last argument and then set the page to the page number passed as second parameter.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveTapAtPoint:
This method will notify if the user has tapped the document view at a point different from a document element, like an annotation.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveTapAtPoint:(CGPoint)point
Discussion
This method will notify if the user has tapped the document view at a point different from a document element, like an annotation.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveTapOnAnnotationRect:withUri:onPage:
This method will be called when an user tap on an annotation.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveTapOnAnnotationRect:(CGRect)rect withUri:(NSString *)uri onPage:(NSUInteger)page
Discussion
This method will be called when an user tap on an annotation.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveTapOnPage:atPoint:
This method will notify if and where the user has tapped on a page bounds. Coordinates of the point are in document’s user space.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveTapOnPage:(NSUInteger)page atPoint:(CGPoint)point
Discussion
This method will notify if and where the user has tapped on a page bounds. Coordinates of the point are in document’s user space.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:didReceiveURIRequest:
This method will notify if the user has tapped on a annotation with a remote uri action. This is usually invoked when an external link is activated and an internet browser should be open to show the link’s content.
- (void)documentViewController:(MFDocumentViewController *)dvc didReceiveURIRequest:(NSString *)uri
Discussion
This method will notify if the user has tapped on a annotation with a remote uri action. This is usually invoked when an external link is activated and an internet browser should be open to show the link’s content.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:doesHaveToAutoplayAudio:
Implement this method to return whether the audio clip should play automatically once loaded.
- (BOOL)documentViewController:(MFDocumentViewController *)dvc doesHaveToAutoplayAudio:(NSString *)audioUri
Discussion
Implement this method to return whether the audio clip should play automatically once loaded.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:doesHaveToAutoplayVideo:
This method will be called to ask the delegate if the video player needs to start automatically once visible.
- (BOOL)documentViewController:(MFDocumentViewController *)dvc doesHaveToAutoplayVideo:(NSString *)videoUri
Discussion
This method will be called to ask the delegate if the video player needs to start automatically once visible.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:doesHaveToLoopVideo:
Self explanatory. This method will be called to ask the delegate if the video player needs to loop the video.
- (BOOL)documentViewController:(MFDocumentViewController *)dvc doesHaveToLoopVideo:(NSString *)videoUri
Discussion
Self explanatory. This method will be called to ask the delegate if the video player needs to loop the video.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:willFocusOnPage:
This method will be called right before displaying a high definition version of the current page. Could be used to start an Activity Indicator.
- (void)documentViewController:(MFDocumentViewController *)dvc willFocusOnPage:(NSUInteger)page
Discussion
This method will be called right before displaying a high definition version of the current page. Could be used to start an Activity Indicator.
Declared In
MFDocumentViewControllerDelegate.h
documentViewController:willFollowLinkToPage:
This method will be invoked before automatically moving to a page due to the user tapping on an embedded internal link inside the document.
- (void)documentViewController:(MFDocumentViewController *)dvc willFollowLinkToPage:(NSUInteger)page
Discussion
This method will be invoked before automatically moving to a page due to the user tapping on an embedded internal link inside the document.
Declared In
MFDocumentViewControllerDelegate.h
documentViewControllerDidUnfocus:
This method will be called when the high definition version of the page is removed from the view.
- (void)documentViewControllerDidUnfocus:(MFDocumentViewController *)dvc
Discussion
This method will be called when the high definition version of the page is removed from the view.
Declared In
MFDocumentViewControllerDelegate.h