SCText.h

Go to the documentation of this file.

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

#import <scl/SCStrings.h>
#import <scl/SCTextIndex.h>

#define SCTextClass           @"SCText"         ///< SCText class name

@interface SCText : SCStrings {

}

#pragma mark -
#pragma mark Creating Text

+ (SCText *)textWithDataDictionary:(NSDictionary *)dictionary;

+ (SCText *)textWithDataDictionaryFromFile:(NSString *)path;

+ (SCText *)textWithCoder:(NSCoder *)coder;

+ (SCText *)textWithContentsOfSerializedFile:(NSString *)path;

+ (SCText *)textWithStream:(SCStream *)stream;

+ (SCText *)textWithFileStream:(NSString *)path;

+ (SCText *)textWithName:(NSString *)name
                                capacity:(SCULong)capacity
                                delegate:(id<SCTextDelegate>)delegate;

+ (SCText *)textWithName:(NSString *)name capacity:(SCULong)capacity;

+ (SCText *)textWithName:(NSString *)name delegate:(id<SCTextDelegate>)delegate;

+ (SCText *)textWithName:(NSString *)name;

+ (SCText *)textWithDelegate:(id<SCTextDelegate>)delegate;

+ (SCText *)textWithCapacity:(SCULong)capacity;

+ (SCText *)text;

+ (SCText *)textWithString:(NSString *)string;

+ (SCText *)textWithStrings:(NSString *)string, ...;

+ (SCText *)textWithCollection:(id)collection;

+ (SCText *)textWithList:(SCStrings *)list;

+ (SCText *)textWithText:(SCText *)text;

#pragma mark -
#pragma mark Initializing Text

- (id)initWithText:(SCText *)text;

#pragma mark -
#pragma mark Setting and Copying Texts

- (void)copyFromText:(SCText *)text;

#pragma mark -
#pragma mark Comparing Text

- (BOOL)isEqualToText:(SCText *)text caseInsensitive:(BOOL)value;

- (BOOL)isEqualToText:(SCText *)text;

- (BOOL)isEqualToContentsOfText:(SCText *)text caseInsensitive:(BOOL)value;

- (BOOL)isEqualToContentsOfText:(SCText *)text;

#pragma mark -
#pragma mark Converting Text

- (SCStrings *)list;

- (SCStrings *)strings;

#pragma mark -
#pragma mark Adding Text

- (void)addText:(SCText *)text;

- (void)insertText:(SCText *)text atIndex:(SCIndex)index;

#pragma mark -
#pragma mark Removing Text

- (void)removeAllText;

- (void)removeTextInRange:(NSRange)range;

- (void)removeTextFromIndex:(SCIndex)index;

- (void)removeTextToIndex:(SCIndex)index;

- (void)removeTextWithSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (void)removeTextWithSubstring:(NSString *)substring;

- (void)removeTextWithoutSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (void)removeTextWithoutSubstring:(NSString *)substring;

- (void)removeSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (void)removeSubstring:(NSString *)substring;

- (SCText *)cutTextInRange:(NSRange)range;

- (SCText *)cutTextFromIndex:(SCIndex)index;

- (SCText *)cutTextToIndex:(SCIndex)index;

#pragma mark -
#pragma mark Replacing Text

- (void)replaceTextInRange:(NSRange)range withText:(SCText *)text;

- (void)replaceTextInRange:(NSRange)range withStrings:(NSString *)string, ...;

- (void)replaceTextInRange:(NSRange)range withStringsFromCollection:(id)collection;

- (void)replaceTextInRange:(NSRange)range withStringsFromList:(SCStrings *)list;

- (void)replaceTextFromIndex:(SCIndex)index withText:(SCText *)text;

- (void)replaceTextFromIndex:(SCIndex)index withStrings:(NSString *)string, ...;

- (void)replaceTextFromIndex:(SCIndex)index withStringsFromCollection:(id)collection;

- (void)replaceTextFromIndex:(SCIndex)index withStringsFromList:(SCStrings *)list;

- (void)replaceTextToIndex:(SCIndex)index withText:(SCText *)text;

- (void)replaceTextToIndex:(SCIndex)index withStrings:(NSString *)string, ...;

- (void)replaceTextToIndex:(SCIndex)index withStringsFromCollection:(id)collection;

- (void)replaceTextToIndex:(SCIndex)index withStringsFromList:(SCStrings *)list;

#pragma mark -
#pragma mark Moving and Copying Text

- (void)exchangeTextInRange:(NSRange)source withTextInRange:(NSRange)destination;

- (void)duplicateTextInRange:(NSRange)range;

- (void)duplicateTextFromIndex:(SCIndex)index;

- (void)duplicateTextToIndex:(SCIndex)index;

- (void)duplicateStringsInRange:(NSRange)range;

- (void)duplicateStringsFromIndex:(SCIndex)index;

- (void)duplicateStringsToIndex:(SCIndex)index;

- (void)copyTextInRange:(NSRange)range toIndex:(SCIndex)destination;

- (void)copyTextFromIndex:(SCIndex)index toIndex:(SCIndex)destination;

- (void)copyTextToIndex:(SCIndex)index toIndex:(SCIndex)destination;

- (void)moveTextInRange:(NSRange)range toIndex:(SCIndex)destination;

- (void)moveTextFromIndex:(SCIndex)index toIndex:(SCIndex)destination;

- (void)moveTextToIndex:(SCIndex)index toIndex:(SCIndex)destination;

- (void)forwardMoveTextInRange:(NSRange)range steps:(SCULong)steps;

- (void)forwardMoveTextFromIndex:(SCIndex)index steps:(SCULong)steps;

- (void)forwardMoveTextInRange:(NSRange)range;

- (void)forwardMoveTextFromIndex:(SCIndex)index;

- (void)backwardMoveTextInRange:(NSRange)range steps:(SCULong)steps;

- (void)backwardMoveTextToIndex:(SCIndex)index steps:(SCULong)steps;

- (void)backwardMoveTextInRange:(NSRange)range;

- (void)backwardMoveTextToIndex:(SCIndex)index;

- (void)moveToFirstPositionTextInRange:(NSRange)range;

- (void)moveToFirstPositionTextFromIndex:(SCIndex)index;

- (void)moveToLastPositionTextInRange:(NSRange)range;

- (void)moveToLastPositionTextToIndex:(SCIndex)index;

#pragma mark -
#pragma mark Querying Text

- (SCText *)textInRange:(NSRange)range;

- (SCText *)textFromIndex:(SCIndex)index;

- (SCText *)textToIndex:(SCIndex)index;

#pragma mark -
#pragma mark Finding and Selecting Strings

- (BOOL)containsText:(SCText *)text caseInsensitive:(BOOL)value;

- (BOOL)containsText:(SCText *)text;

- (SCIndex)indexOfText:(SCText *)text caseInsensitive:(BOOL)value;

- (SCIndex)indexOfText:(SCText *)text;

- (SCUInteger)countOfText:(SCText *)text caseInsensitive:(BOOL)value;

- (SCUInteger)countOfText:(SCText *)text;

- (SCArray *)indexesOfText:(SCText *)text caseInsensitive:(BOOL)value;

- (SCArray *)indexesOfText:(SCText *)text;

- (SCText *)textWithSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCText *)textWithSubstring:(NSString *)substring;

- (SCText *)textWithoutSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCText *)textWithoutSubstring:(NSString *)substring;

- (SCTextIndex *)textIndexOfSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCTextIndex *)textIndexOfSubstring:(NSString *)substring;

- (SCArray *)textIndexesOfSubstring:(NSString *)substring caseInsensitive:(BOOL)value;

- (SCArray *)textIndexesOfSubstring:(NSString *)substring;

@end