PFQueryCollectionViewController.h

/*
 *  Copyright (c) 2014, Parse, LLC. All rights reserved.
 *
 *  You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
 *  copy, modify, and distribute this software in source code or binary form for use
 *  in connection with the web services and APIs provided by Parse.
 *
 *  As with any software that integrates with the Parse platform, your use of
 *  this software is subject to the Parse Terms of Service
 *  [https://www.parse.com/about/terms]. This copyright notice shall be
 *  included in all copies or substantial portions of the software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#import <UIKit/UIKit.h>

#import <Parse/PFConstants.h>
#import <ParseUI/ParseUIConstants.h>

NS_ASSUME_NONNULL_BEGIN

@class BFTask<__covariant BFGenericType>;
@class PFCollectionViewCell;
@class PFObject;
@class PFQuery;

@interface PFQueryCollectionViewController : UICollectionViewController <UICollectionViewDelegateFlowLayout>

@property (nullable, nonatomic, copy) IBInspectable NSString *parseClassName;

@property (nonatomic, assign) IBInspectable BOOL loadingViewEnabled;

@property (nonatomic, assign) IBInspectable BOOL pullToRefreshEnabled;

@property (nonatomic, assign) IBInspectable BOOL paginationEnabled;

@property (nonatomic, assign) IBInspectable NSUInteger objectsPerPage;

@property (nonatomic, assign, getter=isLoading) BOOL loading;


- (instancetype)initWithClassName:(nullable NSString *)className;

- (instancetype)initWithCollectionViewLayout:(UICollectionViewLayout *)layout
                                   className:(nullable NSString *)className NS_DESIGNATED_INITIALIZER;


- (void)objectsWillLoad NS_REQUIRES_SUPER;

- (void)objectsDidLoad:(nullable NSError *)error NS_REQUIRES_SUPER;


@property (nonatomic, copy, readonly) NSArray<__kindof PFObject *> *objects;

- (nullable PFObject *)objectAtIndexPath:(nullable NSIndexPath *)indexPath;

- (void)removeObjectAtIndexPath:(nullable NSIndexPath *)indexPath;

- (void)removeObjectsAtIndexPaths:(nullable NSArray<NSIndexPath *> *)indexes;


- (BFTask<NSArray<__kindof PFObject *> *> *)loadObjects;

- (BFTask<NSArray<__kindof PFObject *> *> *)loadObjects:(NSInteger)page clear:(BOOL)clear;

- (void)loadNextPage;

- (void)clear;


- (PFQuery *)queryForCollection;


- (nullable PFCollectionViewCell *)collectionView:(UICollectionView *)collectionView
                           cellForItemAtIndexPath:(NSIndexPath *)indexPath
                                           object:(nullable PFObject *)object;

- (nullable UICollectionReusableView *)collectionViewReusableViewForNextPageAction:(UICollectionView *)collectionView;

@end

NS_ASSUME_NONNULL_END