CBLUITableSource.h

Go to the documentation of this file.

//
//  CBLUITableSource.h
//  CouchbaseLite
//
//  Created by Jens Alfke on 8/2/11.
//  Copyright 2011-2013 Couchbase, Inc. All rights reserved.
//

#import "CBLBase.h"
#import <UIKit/UIKit.h>
@class CBLDocument, CBLLiveQuery, CBLQueryRow;

NS_ASSUME_NONNULL_BEGIN

@interface CBLUITableSource : NSObject <UITableViewDataSource, UIDataSourceModelAssociation>

@property (nonatomic, retain) IBOutlet UITableView* tableView;

@property (retain) CBLLiveQuery* query;

-(void) reloadFromQuery;


#pragma mark Row Accessors:

@property (nonatomic, readonly, nullable) CBLArrayOf(CBLQueryRow*)* rows;

- (nullable CBLQueryRow*) rowAtIndex: (NSUInteger)index;

- (nullable NSIndexPath*) indexPathForDocument: (CBLDocument*)document;

- (nullable CBLQueryRow*) rowAtIndexPath: (NSIndexPath*)path;

- (nullable CBLDocument*) documentAtIndexPath: (NSIndexPath*)path;


#pragma mark Displaying The Table:

@property (nonatomic) UITableViewRowAnimation rowInsertAnimation;
@property (nonatomic) UITableViewRowAnimation rowDeleteAnimation;
@property (nonatomic) UITableViewRowAnimation rowReplaceAnimation;

@property (copy, nullable) NSString* labelProperty;


#pragma mark Editing The Table:

@property (nonatomic) BOOL deletionAllowed;

- (BOOL) deleteDocumentsAtIndexes: (CBLArrayOf(NSIndexPath*)*)indexPaths
                            error: (NSError**)outError;

- (BOOL) deleteDocuments: (CBLArrayOf(CBLDocument*)*)documents
                   error: (NSError**)outError;

@end


@protocol CBLUITableDelegate <UITableViewDelegate>
@optional


- (void)couchTableSource:(CBLUITableSource*)source
             willUseCell:(UITableViewCell*)cell
                  forRow:(CBLQueryRow*)row;

- (nullable UITableViewCell *)couchTableSource:(CBLUITableSource*)source
                         cellForRowAtIndexPath:(NSIndexPath *)indexPath;

- (void)couchTableSource:(CBLUITableSource*)source
     willUpdateFromQuery:(CBLLiveQuery*)query;

- (void)couchTableSource:(CBLUITableSource*)source
         updateFromQuery:(CBLLiveQuery*)query
            previousRows:(CBLArrayOf(CBLQueryRow*) *)previousRows;

- (bool)couchTableSource:(CBLUITableSource*)source
               deleteRow:(CBLQueryRow*)row;

- (void)couchTableSource:(CBLUITableSource*)source
            deleteFailed:(NSError*)error;

@end


NS_ASSUME_NONNULL_END