From a5e6bcc8b32f7a691559e6f5659af99afc9f6343 Mon Sep 17 00:00:00 2001 From: Jeena Paradies Date: Sat, 14 Nov 2009 20:10:06 +0100 Subject: [PATCH] moved the Documentation directory --- .../JPImagePickerController/index.html | 188 ------------------ .../Classes/JPImagePickerController/toc.html | 35 ---- .../index.html | 136 ------------- .../toc.html | 29 --- .../index.html | 108 ---------- .../JPImagePickerControllerDelegate/toc.html | 28 --- JPImagePickerDemo/Documentation/index.html | 117 ----------- JPImagePickerDemo/Documentation/toc.html | 32 --- 8 files changed, 673 deletions(-) delete mode 100644 JPImagePickerDemo/Documentation/Classes/JPImagePickerController/index.html delete mode 100644 JPImagePickerDemo/Documentation/Classes/JPImagePickerController/toc.html delete mode 100644 JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/index.html delete mode 100644 JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/toc.html delete mode 100644 JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/index.html delete mode 100644 JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/toc.html delete mode 100644 JPImagePickerDemo/Documentation/index.html delete mode 100644 JPImagePickerDemo/Documentation/toc.html diff --git a/JPImagePickerDemo/Documentation/Classes/JPImagePickerController/index.html b/JPImagePickerDemo/Documentation/Classes/JPImagePickerController/index.html deleted file mode 100644 index 46064ac..0000000 --- a/JPImagePickerDemo/Documentation/Classes/JPImagePickerController/index.html +++ /dev/null @@ -1,188 +0,0 @@ - - - JPImagePickerController - - - - - - - - -
- -
-
- -

JPImagePickerController

-

A image picker view controller. -

-

Superclass: UIViewController
-Declared In: JPImagePickerController.h
-

-
-
Discussion -

A class which represents a image picker controller like apples UIImagePickerController -but lets you use a external dataSource for the images. - -

Updated:
Saturday, November 14, 2009
-
-

-

Methods

-
-
-cancelPicking:
-
-
-
- -

cancelPicking:

-

-
- (void)cancelPicking:(id)sender;
-
-
Parameters
-
-
-
sender

The button which sends the action.

-
-
-

-

Properties

-
-
dataSource
-

The data source for the picker view. -

-
delegate
-

The image picker's delegate object. -

-
imagePickerTitle
-

The image picker title. -

-
modalNavigationController
-

The additional navigation controller. -

-
originalStatusBarStyle
-

Original StatusBarStyle at the beginning. -

-
overviewController
-

Controller for the scrollView. -

-
-
- -

dataSource

-

The data source for the picker view. -

-

-
@property (
-    nonatomic,
-    retain) id<JPImagePickerControllerDataSource> dataSource;
-
-
Discussion -

The data source must adopt the JPImagePickerControllerDataSource protocol -and implement the required methods to return the number of components and the -number of rows in each component. - -

- -

delegate

-

The image picker's delegate object. -

-

-
@property (
-    nonatomic,
-    retain) id<JPImagePickerControllerDelegate> delegate;
-
-
Discussion -

The delegate receives notifications when the user picks an image, -or exits the picker interface. The delegate also decides when to dismiss -the picker interface, so you must provide a delegate to use a picker. -If this property is nil, the picker is dismissed immediately if you try -to show it. - -

- -

imagePickerTitle

-

The image picker title. -

-

-
@property (
-    nonatomic,
-    retain) NSString *imagePickerTitle;
-
-
Discussion -

You can set the title for the image overview here. - -

- -

modalNavigationController

-

The additional navigation controller. -

-

-
@property (
-    nonatomic,
-    retain) IBOutlet UINavigationController *modalNavigationController;
-
-
Discussion -

We need it to be able to view a navigation when the user -picks a image. - -

- -

originalStatusBarStyle

-

Original StatusBarStyle at the beginning. -

-

-
@property (
-    nonatomic,
-    readonly) UIStatusBarStyle originalStatusBarStyle;
-
-
Discussion -

This property saves the UIStatusBarStyle at the beginning, so that -we'll be able to change it back when we dismiss the image picker. - -

- -

overviewController

-

Controller for the scrollView. -

-

-
@property (
-    nonatomic,
-    retain) JPImagePickerOverviewController *overviewController;
-
-
Discussion -

This controller holds the scrollView with all the buttons which -represent the images. - -

Last Updated: Saturday, November 14, 2009 -

diff --git a/JPImagePickerDemo/Documentation/Classes/JPImagePickerController/toc.html b/JPImagePickerDemo/Documentation/Classes/JPImagePickerController/toc.html deleted file mode 100644 index 32da805..0000000 --- a/JPImagePickerDemo/Documentation/Classes/JPImagePickerController/toc.html +++ /dev/null @@ -1,35 +0,0 @@ - - - -Documentation for JPImagePickerController (JPImagePickerController.h) - - - - - - -
 

- - - -
 Class:
  JPImagePickerController
-


Introduction

-

Methods

-
Instance Methods
-      -cancelPicking:
-

Properties

- -      dataSource
-      delegate
-      imagePickerTitle
-      modalNavigationController
-      originalStatusBarStyle
-      overviewController
-

Other Reference

-      Header
-

Updated: Saturday, November 14, 2009

 

-

- diff --git a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/index.html b/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/index.html deleted file mode 100644 index 15a21ff..0000000 --- a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/index.html +++ /dev/null @@ -1,136 +0,0 @@ - - - JPImagePickerControllerDataSource - - - - - - -
- -
- -
-
- -

JPImagePickerControllerDataSource

-

The data source protocol for JPImagePickerController -

-

Extends Protocol: NSObject
-Declared In: JPImagePickerController.h
-

-
-
Discussion -

The JPImagePickerController asks this data source for all -data which it wants to display. - -


-

Methods

-
-
-imagePicker:imageForImageNumber:
-

Asks the data source for a image to show in a preview. -

-
-imagePicker:thumbnailForImageNumber:
-

Asks the data source for a thumbnail to insert in a particular location -the image picker. -

-
-numberOfImagesInImagePicker:
-

Should return the number of images. -

-
-
- -

imagePicker:imageForImageNumber:

-

Asks the data source for a image to show in a preview. -

-

-
- (UIImage *)imagePicker:(JPImagePickerController *)picker 
-        imageForImageNumber:(NSInteger)imageNumber;
-
-
Parameters
-
-
-
picker

A picker-object requesting the image.

-
imageNumber

A image number locating the image in the picker.

-
-
-
Discussion -

This method should return a UIImage image for the preview at -the image number position. The image should have the width of kJPImagePickerControllerPreviewImageWidth -and height of kJPImagePickerControllerPreviewImageWidth. If it is not that size the -image picker will resize it so it fits. - -

- -

imagePicker:thumbnailForImageNumber:

-

Asks the data source for a thumbnail to insert in a particular location -the image picker. -

-

-
- (UIImage *)imagePicker:(JPImagePickerController *)picker 
-        thumbnailForImageNumber:(NSInteger)imageNumber;
-
-
Parameters
-
-
-
picker

A picker-object requesting the thumbnail.

-
imageNumber

A image number locating the image in the picker.

-
-
-
Discussion -

This method should return a UIImage thumbnail for a image at the -image number position. The image should have the width of kJPImagePickerControllerThumbnailWidth -and height of kJPImagePickerControllerThumbnailWidth. If it is not that size the -image picker will resize it so it fits. - -

- -

numberOfImagesInImagePicker:

-

Should return the number of images. -

-

-
- (NSInteger)numberOfImagesInImagePicker:(JPImagePickerController *)picker;
-
-
Parameters
-
-
-
picker

The picker which called this method.

-
-
-
Discussion -

This method should return the number of images which the -picker should display. - -

Last Updated: Saturday, November 14, 2009 -

diff --git a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/toc.html b/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/toc.html deleted file mode 100644 index c6fe482..0000000 --- a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDataSource/toc.html +++ /dev/null @@ -1,29 +0,0 @@ - - - -Documentation for JPImagePickerControllerDataSource (JPImagePickerController.h) - - - - - - -
 

- - - -
 Protocol:
  JPImagePickerControllerDataSource
-


Introduction

-

Methods

-
Instance Methods
-      -imagePicker:‍imageForImageNumber:‍
-      -imagePicker:‍thumbnailForImageNumber:‍
-      -numberOfImagesInImagePicker:
-

Other Reference

-      Header
-

 

-

- diff --git a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/index.html b/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/index.html deleted file mode 100644 index 65ed027..0000000 --- a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/index.html +++ /dev/null @@ -1,108 +0,0 @@ - - - JPImagePickerControllerDelegate - - - - - - -
- -
- -
-
- -

JPImagePickerControllerDelegate

-

Delegate protocol for the JPImagePickerController -

-

Extends Protocol: NSObject
-Declared In: JPImagePickerController.h
-

-
-
Discussion -

You have to implement this delegate in order to -use the JPImagePickerController. This delegate is responsible -for dismissing the picker on cancel or finished picking. - -


-

Methods

-
-
-imagePicker:didFinishPickingWithImageNumber:
-

Called when the user picked a image. -

-
-imagePickerDidCancel:
-

Called when picker did cancel -

-
-
- -

imagePicker:didFinishPickingWithImageNumber:

-

Called when the user picked a image. -

-

-
- (void)imagePicker:(JPImagePickerController *)picker 
-        didFinishPickingWithImageNumber:(NSInteger)imageNumber;
-
-
Parameters
-
-
-
picker

The picker which called this method.

-
imageNumber

The number which image the user picked.

-
-
-
Discussion -

This method is called when the user die finish picking. -The delegate is responsible to dismiss the picker here. - -

- -

imagePickerDidCancel:

-

Called when picker did cancel -

-

-
- (void)imagePickerDidCancel:(JPImagePickerController *)picker;
-
-
Parameters
-
-
-
picker

The picker which called this method.

-
-
-
Discussion -

This method is called when the user canceled picking. -The delegate is responsible to dismiss the picker here. - -

Last Updated: Saturday, November 14, 2009 -

diff --git a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/toc.html b/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/toc.html deleted file mode 100644 index 58af0e2..0000000 --- a/JPImagePickerDemo/Documentation/Protocols/JPImagePickerControllerDelegate/toc.html +++ /dev/null @@ -1,28 +0,0 @@ - - - -Documentation for JPImagePickerControllerDelegate (JPImagePickerController.h) - - - - - - -
 

- - - -
 Protocol:
  JPImagePickerControllerDelegate
-


Introduction

-

Methods

-
Instance Methods
-      -imagePicker:‍didFinishPickingWithImageNumber:‍
-      -imagePickerDidCancel:
-

Other Reference

-      Header
-

 

-

- diff --git a/JPImagePickerDemo/Documentation/index.html b/JPImagePickerDemo/Documentation/index.html deleted file mode 100644 index 1ebf105..0000000 --- a/JPImagePickerDemo/Documentation/index.html +++ /dev/null @@ -1,117 +0,0 @@ - - - JPImagePickerController.h - - - - - - -
- - -
- -
-
- -

JPImagePickerController.h

-

Use the links in the table of contents to the left to access the documentation.
-

-

-
-


-

Classes

-
-
JPImagePickerController
-

A image picker view controller. -

-
- -

Protocols

-
-
JPImagePickerControllerDataSource
-

The data source protocol for JPImagePickerController -

-
JPImagePickerControllerDelegate
-

Delegate protocol for the JPImagePickerController -

-
-

-

Enumerated Types

-
-
JPImagePickerControllerPreviewImageSize
-

Specifies the preview image width and height. -

-
JPImagePickerControllerThumbnailSize
-

Specifies the thumbnail width and height. -

-
-
- -

JPImagePickerControllerPreviewImageSize

-

Specifies the preview image width and height. -

-

-
enum JPImagePickerControllerPreviewImageSize { 
-    kJPImagePickerControllerPreviewImageSizeWidth = 320, 
-    kJPImagePickerControllerPreviewImageSizeHeight = 420 
-};
-
-
Constants
-
-
-
kJPImagePickerControllerPreviewImageSizeWidth

Preview image width 320 px.

-
kJPImagePickerControllerPreviewImageSizeHeight

Preview image height 420 px.

-
-
-

- -

JPImagePickerControllerThumbnailSize

-

Specifies the thumbnail width and height. -

-

-
enum JPImagePickerControllerThumbnailSize { 
-    kJPImagePickerControllerThumbnailSizeWidth = 75, 
-    kJPImagePickerControllerThumbnailSizeHeight = 75 
-};
-
-
Constants
-
-
-
kJPImagePickerControllerThumbnailSizeWidth

Thumbnail width 75 px.

-
kJPImagePickerControllerThumbnailSizeHeight

Thumbnail height 75 px.

-
-
-

Last Updated: Saturday, November 14, 2009 -

diff --git a/JPImagePickerDemo/Documentation/toc.html b/JPImagePickerDemo/Documentation/toc.html deleted file mode 100644 index e4d034f..0000000 --- a/JPImagePickerDemo/Documentation/toc.html +++ /dev/null @@ -1,32 +0,0 @@ - - - -Documentation for JPImagePickerController.h - - - - - - -
 

- - - -
 Header:
  JPImagePickerController.h
-


Introduction

-

Enumerations -

- -      JPImagePickerControllerPreviewImageSize
-      JPImagePickerControllerThumbnailSize
-

Classes

-      JPImagePickerController
-

Protocols

-      JPImagePickerControllerDataSource
-      JPImagePickerControllerDelegate
-

 

-

-