Skip to content

Commit

Permalink
header comments by way of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
brow committed Aug 2, 2010
1 parent b4e67df commit dba99dc
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions Leaves/LeavesView.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,20 @@

@property (assign) id<LeavesViewDataSource> dataSource;
@property (assign) id<LeavesViewDelegate> delegate;

// the automatically determined width of the interactive areas on either side of the page
@property (readonly) CGFloat targetWidth;
@property (assign) CGFloat preferredTargetWidth;

// the zero-based index of the page currently being displayed.
@property (assign) NSUInteger currentPageIndex;

// If backgroundRendering is YES, some pages not currently being displayed will be pre-rendered in background threads.
// The default value is NO. Only set this to YES if your implementation of the data source methods is thread-safe.
@property (assign) BOOL backgroundRendering;


// refreshes the contents of all pages via the data source methods, much like -[UITableView reloadData]
- (void) reloadData;

@end
Expand All @@ -61,11 +70,15 @@

@end


@protocol LeavesViewDelegate <NSObject>

@optional

// called when the user touches up on the left or right side of the page, or finishes dragging the page
- (void) leavesView:(LeavesView *)leavesView willTurnToPageAtIndex:(NSUInteger)pageIndex;

// called when the page-turn animation (following a touch-up or drag) completes
- (void) leavesView:(LeavesView *)leavesView didTurnToPageAtIndex:(NSUInteger)pageIndex;

@end
Expand Down

0 comments on commit dba99dc

Please sign in to comment.