Permalink
Browse files

Added description of public methods and protocol methods.

  • Loading branch information...
1 parent 5b4a828 commit ba137b9001f294f021887b8746f6704e7a6322b6 @caesarcat committed Jul 19, 2012
Showing with 70 additions and 3 deletions.
  1. +70 −3 README.md
View
@@ -1,23 +1,27 @@
-InfinityPagingView
+InfinitePagingView
=====================
Overview
--------
-InfinityPagingView is a subclass of UIView. It contains an endlessly scrollable UIScrollView.
+InfinitePagingView is a subclass of UIView. It contains an endlessly scrollable UIScrollView.
Features
--------
- Endlessly scrollable to horizontal (or vertical) direction.
- Each page view contents are available to a UIView based custom view.
+- Implements paging delegate protocol.
+- Page scroll action methods.
+
Requirements
------------
- iOS 4+
-- Xcode 4.3 (Uses ARC)
+- Xcode 4.3 (Use ARC)
Screenshots
-----------
+![Screenshot0](http://resources.qnote.jp/infinity-paging-view/sample4.png)
![Screenshot0](http://resources.qnote.jp/infinity-paging-view/sample1.png)
![Screenshot0](http://resources.qnote.jp/infinity-paging-view/sample2.png)
![Screenshot0](http://resources.qnote.jp/infinity-paging-view/sample3.png)
@@ -52,6 +56,69 @@ How to use
Build and run the project files. Enjoy more examples!
+Public methods
+--------
+
+```Objective-C
+- (void)addPageView:(UIView *)pageView;
+```
+Adds a view to the inner scrollview's subviews.
+
+-
+
+```Objective-C
+- (void)scrollToPreviousPage;
+```
+Scroll to the previous page.
+
+-
+
+```Objective-C
+- (void)scrollToNextPage;
+```
+Scroll to the next page.
+
+
+
+InfinitePagingViewDelegate Protocols
+-
+
+```Objective-C
+- (void)pagingView:(InfinitePagingView *)pagingView willBeginDragging:(UIScrollView *)scrollView;
+```
+Tells the delegate when the paging view is about to start scrolling the content.
+
+-
+
+```Objective-C
+- (void)pagingView:(InfinitePagingView *)pagingView didScroll:(UIScrollView *)scrollView;
+```
+Tells the delegate when the user scrolls the content view within the receiver.
+
+-
+
+```Objective-C
+- (void)pagingView:(InfinitePagingView *)pagingView didEndDragging:(UIScrollView *)scrollView;
+```
+Tells the delegate when dragging ended in the paging view.
+
+
+-
+
+```Objective-C
+- (void)pagingView:(InfinitePagingView *)pagingView willBeginDecelerating:(UIScrollView *)scrollView;
+```
+
+Tells the delegate that the paging view is starting to decelerate the scrolling movement.
+
+-
+
+```Objective-C
+- (void)pagingView:(InfinitePagingView *)pagingView didEndDecelerating:(UIScrollView *)scrollView atPageIndex:(NSInteger)pageIndex;
+```
+Tells the delegate that the scroll view has ended decelerating the scrolling movement.
+
+
License
-------

0 comments on commit ba137b9

Please sign in to comment.