SCList.h

Go to the documentation of this file.

//
//  SCList.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCCollection.h>

#pragma mark -
#pragma mark Class Constants

#define SCListClass @"SCList"


@interface SCList : SCCollection {
    NSMutableArray *fList;  // Internal data storage
    SCIndex fCurrentObject; // Index of the current object
}

@property (nonatomic, readonly, assign) id currentObject;

@property (nonatomic, readonly, assign) id firstObject;

#pragma mark -
#pragma mark Initializing Lists
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithObject:(id<SCCollectioning>)object;
- (instancetype)initWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithList:(SCList *)list;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Lists
- (void)setList:(SCList *)list;

#pragma mark -
#pragma mark Comparing Lists
- (BOOL)isEqualToList:(SCList *)list;

#pragma mark -
#pragma mark List Control
- (id)nextObject;

#pragma mark -
#pragma mark Adding Objects
- (void)insertCurrentObject:(id<SCCollectioning>)object;
- (void)insertCurrentObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)insertCurrentCollection:(id<SCCollection>)collection;

- (void)insertFirstObject:(id<SCCollectioning>)object;
- (void)insertFirstObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)insertFirstCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Removing Objects
- (void)removeCurrentObject;
- (void)removeFirstObject;

#pragma mark -
#pragma mark Replacing Objects
- (void)replaceCurrentObjectWithObject:(id<SCCollectioning>)object;
- (void)replaceFirstObjectWithObject:(id<SCCollectioning>)object;

#pragma mark -
#pragma mark Copying Objects
- (void)duplicateCurrentObject;
- (void)duplicateFirstObject;

@end