MFPageFlowView.h

//
// MFPageFlowView
// Mentally Friendly
//
// Created by Kyle Fuller on 24/09/2012.
// Copyright (c) 2012-2013 Mentally Friendly. All rights reserved.
//

#import <UIKit/UIKit.h>

@class MFPageFlowView;

/** The data source for MFPageFlowView. */
@protocol MFPageFlowViewDataSource <NSObject>

/** Asks the data source for the amount of views to display in the flow view
 * @param flowView The page flow view requesting this information
 * @return The number of views in the page flow view
 */
- (NSUInteger)numberOfPagesInFlowView:(MFPageFlowView*)flowView;

/** Asks the data source for the view to display in the flow view for an index
 * @param flowView The page flow view requesting this information
 * @param index The index of the page
 * @return An object inheriting from UIView that the page flow view will use for this index. This must not be nil.
 */
- (UIView*)pageFlowView:(MFPageFlowView*)flowView
     viewForPageAtIndex:(NSUInteger)index;

@end

/// The layout orientation for a MFPageFlowView
typedef NS_ENUM(NSUInteger, MFPageFlowViewLayoutOrientation) {
    /// Horizontal layout orientation (default)
    MFPageFlowViewLayoutOrientationHorizontal,
    /// Vertical layout orientation
    MFPageFlowViewLayoutOrientationVertical,
};

/** MFPageFlowView is a view which allows you to have a set of pages that you can swipe across.

This class can be used to make a view which can swipe over images.
 */

@interface MFPageFlowView : UIScrollView

/** The layout orientation. Defaults to MFPageFlowViewLayoutOrientationHorizontal. */
@property (nonatomic, assign) MFPageFlowViewLayoutOrientation layoutOrientation;

/** The currently displayed page. */
@property (nonatomic, assign) NSUInteger currentPage;

/** The data source providing the pages. */
@property (nonatomic, weak) IBOutlet id<MFPageFlowViewDataSource> dataSource;

/** Once set, MFPageFlowView will update the page control */
@property (nonatomic, weak) IBOutlet UIPageControl *pageControl;

/** Reloads the pages of the receiver */
- (void)reloadData;

/** Changes the current page
 @param currentPage The page to change to
 @param animated When YES, the page flow view will animate to the new page
*/
- (void)setCurrentPage:(NSUInteger)currentPage
              animated:(BOOL)animated;
@end