UIDocument Class Reference

#import <UIDocument.h>

Inheritance diagram for UIDocument:

List of all members.

Public Member Functions
(UIImage *)	- getImageOfPage:
	Draws and returns an image of the specified page of the document.
(CGSize)	- getSizeOfPage:
	Returns the size of the specified page.
(id)	- initWithContentsOfFile:
	Initializes and returns the document object with the contents of the specified file.
(id)	- initWithData:
	Initializes and returns the document object with the specified data.
Static Public Member Functions
(UIDocument *)	+ documentWithContentsOfFile:
	Creates and returns a document object by loading the document data from the file at the specified path.
(UIDocument *)	+ documentWithData:
	Creates and returns a document object that uses the specified document data.
Properties
int	numberOfPages
	The number of pages in the document.
CGSize	size
	The dimensions of the entire document, in points, when its pages are vertically concatenated with zero margins.

---

Member Function Documentation

+ (UIDocument *) documentWithContentsOfFile:

(NSString *)

path

Creates and returns a document object by loading the document data from the file at the specified path.

Parameters:

path	The full or partial path to the file.

Returns:

An autoreleased document object for the specified file, or nil if the method could not initialize the image from the specified file.

+ (UIDocument *) documentWithData:

(NSData *)

data

Creates and returns a document object that uses the specified document data.

Parameters:

data	The document data. This can be data from a file or data you create programmatically.

Returns:

An autoreleased document object for the specified file, or nil if the method could not initialize the image from the specified data.

- (UIImage *) getImageOfPage:

(int)

pageNumber

Draws and returns an image of the specified page of the document.

Parameters:

pageNumber

The number of the page, starting from 1.

Returns:

An autoreleased UIImage object that contains a graphical representation of the specified page. The orientation of the page is taken into account.

Reimplemented in UIDocumentPDF.

Here is the caller graph for this function:

- (CGSize) getSizeOfPage:

(int)

pageNumber

Returns the size of the specified page.

Parameters:

pageNumber

The number of the page, starting from 1.

Returns:

The dimensions of the specified page, in points, with page orientation taken into account.

Reimplemented in UIDocumentPDF.

Here is the caller graph for this function:

- (id) initWithContentsOfFile:

(NSString *)

path

Initializes and returns the document object with the contents of the specified file.

Parameters:

path	The path to the file.

Returns:

An initialized document object, or nil if the method could not find the file or initialize the document from its contents.

Reimplemented in UIDocumentPDF.

- (id) initWithData:

(NSData *)

data

Initializes and returns the document object with the specified data.

Parameters:

data	The data object containing the document data.

Returns:

An initialized document object, or nil if the method could not initialize the document from the specified data.

Reimplemented in UIDocumentPDF.

---

Property Documentation

- (int) numberOfPages [read, assign]

The number of pages in the document.

- (CGSize) size [read, assign]

The dimensions of the entire document, in points, when its pages are vertically concatenated with zero margins.

Page orientation is taken into account.

---

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

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