#import <UIDocumentView.h>

Public Member Functions
(void)	- centerContent
	Centers the content in the document view.
(void)	- dealloc `[implementation]`
(id)	- init `[implementation]`
	Initializes the internal variables of the object.
(id)	- initWithCoder: `[implementation]`
	Initializes the object using the data in a given unarchiver.
(id)	- initWithDocument:
	Returns a document view initialized with the specified document.
(id)	- initWithFrame: `[implementation]`
	Initializes the object with the specified frame rectangle and default display settings.
(void)	- refresh
	Refreshes the document view: lazy loads all unloaded images in the preload area and unloads the rest.
(void)	- scrollViewDidEndDecelerating: `[implementation]`
(void)	- scrollViewDidEndDragging:willDecelerate: `[implementation]`
(void)	- scrollViewDidEndScrollingAnimation: `[implementation]`
(void)	- scrollViewDidEndZooming:withView:atScale: `[implementation]`
(void)	- scrollViewDidScroll: `[implementation]`
(void)	- scrollViewDidScrollToTop: `[implementation]`
(void)	- scrollViewDidZoom: `[implementation]`
(BOOL)	- scrollViewShouldScrollToTop: `[implementation]`
(void)	- scrollViewWillBeginDecelerating: `[implementation]`
(void)	- scrollViewWillBeginDragging: `[implementation]`
(void)	- scrollViewWillBeginZooming:withView: `[implementation]`
(void)	- setDocument: `[implementation]`
	Sets the document displayed in the document view.
(UIView *)	- viewForZoomingInScrollView: `[implementation]`
Protected Attributes
UIView *	container
	A containing superview for the UIImageView objects that represent the pages of the document.
NSOperationQueue *	operationQueue
	An operation queue for lazy loading the page images.
Properties
id< UIScrollViewDelegate >	delegate
	The delegate of the document view object.
UIDocument *	document
	The document displayed in the document view.
UIImage *	placeholder
	The placeholder image to use for document pages that have not been loaded into memory yet.
CGFloat	preloadFactor
	How many view-heights above and below the currently viewed area should be preloaded into memory.

Member Function Documentation

- (void) centerContent

Centers the content in the document view.

This method is called automatically whenever the document view is zoomed.

Here is the caller graph for this function:

- (void) dealloc [implementation]

- (id) init [implementation]

Initializes the internal variables of the object.

Do not use this method to initialize new instances of the object. It only encapsulates common initialization code and does not call any superclass constructors. Use initWithDocument or initWithFrame instead.

Returns:: The initialized object.

Here is the caller graph for this function:

- (id) initWithCoder: (NSCoder *) aDecoder [implementation]

Initializes the object using the data in a given unarchiver.

This method is used to provide compatibility with xib files. Do not call it programmatically.

Parameters:

aDecoder An unarchiver object.

Returns:: The initialized object, or nil if the object couldn't be created.

Here is the call graph for this function:

- (id) initWithDocument: (UIDocument *) uiDocument

Returns a document view initialized with the specified document.

Parameters:

uiDocument The initial document to display in the document view.

Returns:: An initialized document view object.

Here is the call graph for this function:

- (id) initWithFrame: (CGRect) frame [implementation]

Initializes the object with the specified frame rectangle and default display settings.

Parameters:

frame The frame rectangle for the view, measured in points.

Returns:: The initialized object, or nil if the object couldn't be created.

Here is the call graph for this function:

- (void) refresh

Refreshes the document view: lazy loads all unloaded images in the preload area and unloads the rest.

This method is called automatically whenever the document view is scrolled or zoomed.

Here is the call graph for this function:

Here is the caller graph for this function:

- (void) scrollViewDidEndDecelerating: (UIScrollView *) scrollView [implementation]

- (void) scrollViewDidEndDragging:	(UIScrollView *)	scrollView
willDecelerate:	(BOOL)	decelerate
		`[implementation]`

- (void) scrollViewDidEndScrollingAnimation: (UIScrollView *) scrollView [implementation]

- (void) scrollViewDidEndZooming:	(UIScrollView *)	scrollView
withView:	(UIView *)	view
atScale:	(float)	scale
		`[implementation]`

- (void) scrollViewDidScroll: (UIScrollView *) scrollView [implementation]

Here is the call graph for this function:

- (void) scrollViewDidScrollToTop: (UIScrollView *) scrollView [implementation]

- (void) scrollViewDidZoom: (UIScrollView *) scrollView [implementation]

Here is the call graph for this function:

- (BOOL) scrollViewShouldScrollToTop: (UIScrollView *) scrollView [implementation]

- (void) scrollViewWillBeginDecelerating: (UIScrollView *) scrollView [implementation]

- (void) scrollViewWillBeginDragging: (UIScrollView *) scrollView [implementation]

- (void) scrollViewWillBeginZooming:	(UIScrollView *)	scrollView
withView:	(UIView *)	view
		`[implementation]`

- (void) setDocument: (UIDocument *) value [implementation]

Sets the document displayed in the document view.

Calling this method resets the content offset to start and the zoom level as close as possible to fit-to-width as the minimumZoomScale and maximumZoomScale properties allow.

Parameters:

value The document to be displayed in the document view.

Here is the call graph for this function:

- (UIView *) viewForZoomingInScrollView: (UIScrollView *) scrollView [implementation]

Member Data Documentation

- (UIView*) container [protected]

A containing superview for the UIImageView objects that represent the pages of the document.

- (NSOperationQueue*) operationQueue [protected]

An operation queue for lazy loading the page images.

Property Documentation

- (id< UIScrollViewDelegate >) delegate [read, write, assign]

The delegate of the document view object.

- (UIDocument *) document [read, write, retain]

The document displayed in the document view.

Returns the currently displayed document in the document view.

Returns:: The currently displayed document.

- (UIImage *) placeholder [read, write, retain]

The placeholder image to use for document pages that have not been loaded into memory yet.

Default is nil.

- (CGFloat) preloadFactor [read, write, assign]

How many view-heights above and below the currently viewed area should be preloaded into memory.

Default is 0.

The documentation for this class was generated from the following files:

/Users/awniemel/Notepad-SVN/svn/trunk/CatNiP/CatNiP/UIDocumentView.h
/Users/awniemel/Notepad-SVN/svn/trunk/CatNiP/CatNiP/UIDocumentView.m

Public Member Functions

Protected Attributes

Properties

Member Function Documentation

Member Data Documentation

Property Documentation