SCTextIndex.h

Go to the documentation of this file.

//
//  SCTextIndex.h
//  scl
//
//  Created by Viacheslav Smolensky on 06.02.13.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCServiceObject.h>
#import <scl/SCTypes.h>

#define SCTextIndexClass           @"SCTextIndex"         ///< SCTextIndex class name

@interface SCTextIndex : SCServiceObject {
        SCULong fLine;          // Line index
        SCULong fCharacter;     // Character index
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Line index property
@property (assign, getter=line, setter=setLine:) SCULong line;
// Character index property
@property (assign, getter=character, setter=setCharacter:) SCULong character;
#endif

#pragma mark -
#pragma mark Creating Text Index

+ (SCTextIndex *)textIndexWithDataDictionary:(NSDictionary *)dictionary;

+ (SCTextIndex *)textIndexWithDataDictionaryFromFile:(NSString *)path;

+ (SCTextIndex *)textIndexWithCoder:(NSCoder *)coder;

+ (SCTextIndex *)textIndexWithContentsOfSerializedFile:(NSString *)path;

+ (SCTextIndex *)textIndexWithStream:(SCStream *)stream;

+ (SCTextIndex *)textIndexWithFileStream:(NSString *)path;

+ (SCTextIndex *)textIndex;

+ (SCTextIndex *)textIndexWithLine:(SCULong)line character:(SCULong)character;

+ (SCTextIndex *)textIndexWithTextIndex:(SCTextIndex *)index;

#pragma mark -
#pragma mark Initializing Text Index

- (id)init;

- (id)initWithLine:(SCULong)line character:(SCULong)character;

- (id)initWithTextIndex:(SCTextIndex *)index;

#pragma mark -
#pragma mark Setting and Getting Text Index Properties

- (SCULong)line;

- (SCULong)character;

- (NSString *)description;

- (void)setLine:(SCULong)line;

- (void)setCharacter:(SCULong)character;

- (void)setLine:(SCULong)line character:(SCULong)character;

- (void)setTextIndex:(SCTextIndex *)index;

#pragma mark -
#pragma mark Comparing Text Index

- (BOOL)isEqualToTextIndex:(SCTextIndex *)index;

- (BOOL)isEqual:(id)object;

- (BOOL)isEqualToLine:(SCULong)line character:(SCULong)character;

@end

#pragma mark -
#pragma mark Functions

SCTextIndex *SCMakeTextIndex( SCULong line, SCULong character);