SCTextDelegate Class Reference

Text object event handlers class. More...

#import <SCTextDelegate.h>

Inheritance diagram for SCTextDelegate:

Processing Strings
(void)	- processString:text:

Handling Text Errors
(BOOL)	- text:didDetectException:

Adding Strings Events Handlers
(void)	- text:willAddString:
(void)	- text:willInsertString:atIndex:
(void)	- text:didFinishAddingString:
(void)	- text:didFinishInsertingString:atIndex:

Removing Strings Events Handlers
(void)	- willRemoveAllStringsFromText:
(void)	- text:willRemoveStringAtIndex:
(void)	- text:willRemoveString:
(void)	- text:willRemoveTextInRange:
(void)	- text:willRemoveSubstring:
(void)	- text:willRemoveText:
(void)	- didFinishRemovingAllStringsFromText:
(void)	- text:didFinishRemovingStringAtIndex:
(void)	- text:didFinishRemovingString:
(void)	- text:didFinishRemovingTextInRange:
(void)	- text:didFinishRemovingSubstring:
(void)	- text:didFinishRemovingText:

Sorting Strings Events Handlers
(void)	- text:willSortAscending:sorter:
(void)	- text:didFinishSortingAscending:sorter:

Replacing Strings Events Handlers
(void)	- text:willReplaceStringAtIndex:withString:
(void)	- text:willReplaceString:withString:
(void)	- text:willReplaceTextInRange:withText:
(void)	- text:willReplaceText:withText:
(void)	- text:didFinishReplacingStringAtIndex:withString:
(void)	- text:didFinishReplacingString:withString:
(void)	- text:didFinishReplacingTextInRange:withText:
(void)	- text:didFinishReplacingText:withText:

Copying and Moving Strings Events Handlers
(void)	- text:willExchangeStringAtIndex:withStringAtIndex:
(void)	- text:willDuplicateStringAtIndex:
(void)	- willDuplicateText:
(void)	- text:willExchangeTextInRange:withTextInRange:
(void)	- text:didFinishExchangingStringAtIndex:withStringAtIndex:
(void)	- text:didFinishDuplicatingStringAtIndex:
(void)	- didFinishDuplicatingText:
(void)	- text:didFinishExchangingTextInRange:withTextInRange:

Reading and Writing Files Events Handlers
(void)	- text:willReadFromStream:
(void)	- text:willReadWithPath:
(void)	- text:willWriteToStream:
(void)	- text:willWriteWithPath:
(void)	- willResetText:
(void)	- text:didFinishReadingFromStream:
(void)	- text:didFinishReadingWithPath:
(void)	- text:didFinishWritingToStream:
(void)	- text:didFinishWritingWithPath:
(void)	- didFinishResettingText:

Additional Inherited Members
Instance Methods inherited from SCObject
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(instancetype)	- initWithDataDictionary:
(instancetype)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(instancetype)	- initWithStream:
(instancetype)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(id)	- copyObject
(SCComparisonResult)	- compareWithObject:
(BOOL)	- isEqual:
(instancetype)	- initWithData:
(instancetype)	- initWithDataWrapper:
(instancetype)	- initWithContentsOfFile:
(instancetype)	- initWithContentsOfURL:
(instancetype)	- initWithContentsOfURLString:
(void)	- writeToData:
(BOOL)	- writeToFile:
(BOOL)	- writeToURL:
(BOOL)	- writeToURLString:
(NSData *)	- data
Instance Methods inherited from <SCTextDelegate>
Properties inherited from SCObject
NSString *	className

Detailed Description

Text object event handlers class.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.4

Implements the methods, which declared in the SCTextDelegate protocol

Method Documentation

- (void) didFinishDuplicatingText:

(SCStrings *)

text

Tells the delegate that the text is finished the duplicating content.

Parameters

text	- the text instance

Reimplemented from <SCTextDelegate>.

- (void) didFinishRemovingAllStringsFromText:

(SCStrings *)

text

Tells the delegate that the text is finishing the deleting all strings.

Parameters

text	- the text instance

Reimplemented from <SCTextDelegate>.

- (void) didFinishResettingText:

(SCTextFile *)

text

Tells the delegate that the receiving text file is finished resetting the content.

Parameters

text	- the text file instance

Reimplemented from <SCTextDelegate>.

- (void) processString:		(NSString *)	string
text:		(SCStrings *)	text

Tells the delegate for the specified string from the specified text.

Parameters

string	- the current string instance
text	- the text instance

Reimplemented from <SCTextDelegate>.

- (BOOL) text:		(SCStrings *)	text
didDetectException:		(SCTextException *)	exception

Tells the delegate that the text detects the specified exception.

Parameters

text	- the erroneous text instance
exception	- detected exception

Returns

YES if the text must ignored the exception, otherwise NO

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishAddingString:		(NSString *)	string

Tells the delegate that the text is finishing the adding the specified string.

Parameters

text	- the text instance
string	- the added string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishDuplicatingStringAtIndex:		(SCIndex)	index

Tells the delegate that the text is finished the duplicating string at the specified index.

Parameters

text	- the text instance
index	- the index of the duplicated string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishExchangingStringAtIndex:		(SCIndex)	index
withStringAtIndex:		(SCIndex)	destination

Tells the delegate that the text is finished the exchanging strings at the specified indexes.

Parameters

text	- the text instance
index	- the index of the first string
destination	- the index of the second string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
didFinishExchangingTextInRange:		(NSRange)	source
withTextInRange:		(NSRange)	destination

Tells the delegate that the receiving text is finished the exchanging text in the specified range with the text in the specified text.

Parameters

text	- the text instance
source	- the first range of strings
destination	- the second range of strings

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishInsertingString:		(NSString *)	string
atIndex:		(SCIndex)	index

Tells the delegate that the text is finished the inserting string at the specified index.

Parameters

text	- the text instance
string	- the inserted string
index	- the index at which to insert string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
didFinishReadingFromStream:		(SCStream *)	stream

Tells the delegate that the receiving text is finished reading the content from the specifies stream.

Parameters

text	- the text file instance
stream	- the input stream

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
didFinishReadingWithPath:		(NSString *)	path

Tells the delegate that the receiving text file is finished reading the content from the file with the specified path.

Parameters

text	- the text file instance
path	- the path to the readed file

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishRemovingString:		(NSString *)	string

Tells the delegate that the text is finished the removing the specified string.

Parameters

text	- the text instance
string	- the removed string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishRemovingStringAtIndex:		(SCIndex)	index

Tells the delegate that the text is finished the removing string at the specified index.

Parameters

text	- the text instance
index	- the index of removed string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
didFinishRemovingSubstring:		(NSString *)	substring

Tells the delegate that is finished the removing the specified substring from the receiving text.

Parameters

text	- the text instance
substring	- the removed substring

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
didFinishRemovingText:		(SCStrings *)	removedText

Tells the delegate that is finished the removing the specified text from the receiving text.

Parameters

text	- the text instance
removedText	- the removed text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
didFinishRemovingTextInRange:		(NSRange)	range

Tells the delegate that is finished the removing text in the specified range from the receiving text.

Parameters

text	- the text instance
range	- the range of removed strings

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishReplacingString:		(NSString *)	string
withString:		(NSString *)	newString

Tells the delegate that the text is finished the replacing specified string by using a given another string.

Parameters

text	- the text instance
string	- the replaced string
newString	- the replacement string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishReplacingStringAtIndex:		(SCIndex)	index
withString:		(NSString *)	string

Tells the delegate that the text is finished the replacing string at the specified index by using the specified string.

Parameters

text	- the text instance
index	- the index of the replaced line
string	- the replacement string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
didFinishReplacingText:		(SCStrings *)	oldText
withText:		(SCStrings *)	newText

Tells the delegate that the text is finished the replacing specified text by using a given another text.

Parameters

text	- the text instance
oldText	- the replaced text
newText	- the replacement text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
didFinishReplacingTextInRange:		(NSRange)	range
withText:		(SCStrings *)	ntext

Tells the delegate that is finished the replacing the text in the specified range by using the specified replacement text in the receiving text.

Parameters

text	- the text instance
range	- the range of the replaced strings
ntext	- the replacement text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
didFinishSortingAscending:		(BOOL)	ascending
sorter:		(id<SCSorter>)	sorter

Tells the delegate that the text is finished the sorting strings.

Parameters

text	- the text instance
ascending	- YES for ascending direction, otherwise NO
sorter	- the strings sorter

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
didFinishWritingToStream:		(SCStream *)	stream

Tells the delegate that the receiving text file is finished writing the content to the specified stream.

Parameters

text	- the text file instance
stream	- the output stream

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
didFinishWritingWithPath:		(NSString *)	path

Tells the delegate that the receiving text file is finished writing the content to the file with the specified path.

Parameters

text	- the text file instance
path	- the path of the destination file

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willAddString:		(NSString *)	string

Tells the delegate that the text is about to add the specified string.

Parameters

text	- the text instance
string	- the string for adding into the text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willDuplicateStringAtIndex:		(SCIndex)	index

Tells the delegate that the text is about to duplicate string at the specified index.

Parameters

text	- the text instance
index	- the index of a duplicated string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willExchangeStringAtIndex:		(SCIndex)	index
withStringAtIndex:		(SCIndex)	destination

Tells the delegate that the text is about to exchange strings at the specified indexes.

Parameters

text	- the text instance
index	- the index of the first string
destination	- the index of the second string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
willExchangeTextInRange:		(NSRange)	source
withTextInRange:		(NSRange)	destination

Tells the delegate that the receiving text is about to exchange the text in the specified range with the text in the specified range.

Parameters

text	- the text instance
source	- the first range of strings
destination	- the second range of strings

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willInsertString:		(NSString *)	string
atIndex:		(SCIndex)	index

Tells the delegate that the text is about to insert the string at specified index.

Parameters

text	- the text instance
string	- the string for inserting into the text
index	- the index at which to insert string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
willReadFromStream:		(SCStream *)	stream

Tells the delegate that the receiving text file is about to read the strings from a specified stream.

Parameters

text	- the text file instance
stream	- the input stream

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
willReadWithPath:		(NSString *)	path

Tells the delegate that the receiving text file is about to read the strings from a file at the specified path.

Parameters

text	- the text file instance
path	- the path to the readed file

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willRemoveString:		(NSString *)	string

Tells the delegate that the text is about to remove the specified string.

Parameters

text	- the text instance
string	- the string to be removed from text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willRemoveStringAtIndex:		(SCIndex)	index

Tells the delegate that the text is about to remove the string at the specified index.

Parameters

text	- the text instance
index	- the index of the string to be removed from text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
willRemoveSubstring:		(NSString *)	substring

Tells the delegate that the receiving text is about to remove the specified substring.

Parameters

text	- the text instance
substring	- the substring to be removed from text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
willRemoveText:		(SCStrings *)	removedText

Tells the delegate that the receiving text is about to remove the specified text.

Parameters

text	- the text instance
removedText	- the text to be removed

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
willRemoveTextInRange:		(NSRange)	range

Tells the delegate that the receiving text is about to remove text in the specified range.

Parameters

text	- the text instance
range	- the range of strings to be removed from text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willReplaceString:		(NSString *)	string
withString:		(NSString *)	newString

Tells the delegate that the text is about to replace the specified string with a given another string.

Parameters

text	- the text instance
string	- the string to be replaced
newString	- the replacement string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willReplaceStringAtIndex:		(SCIndex)	index
withString:		(NSString *)	string

Tells the delegate that the text is about to replace string with the specified index by using the specified string.

Parameters

text	- the text instance
index	- the index of string to be replaced
string	- the replacement string

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
willReplaceText:		(SCStrings *)	oldText
withText:		(SCStrings *)	newText

Tells the delegate that the text is about to replace the specified text with a given another text.

Parameters

text	- the text instance
oldText	- the text to be replaced
newText	- the replacement text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCText *)	text
willReplaceTextInRange:		(NSRange)	range
withText:		(SCStrings *)	ntext

Tells the delegate that the receiving text is about to replace the text in the specified range by using the specified new text.

Parameters

text	- the text instance
range	- the range of strings to be replaced
ntext	- the replacement text

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCStrings *)	text
willSortAscending:		(BOOL)	ascending
sorter:		(id<SCSorter>)	sorter

Tells the delegate that the text is about to sorting the strings.

Parameters

text	- the text instance
ascending	- YES for ascending direction, otherwise NO
sorter	- the strings sorter

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
willWriteToStream:		(SCStream *)	stream

Tells the delegate that the receiving text file is about to write the strings to the specified stream.

Parameters

text	- the text file instance
stream	- the output stream

Reimplemented from <SCTextDelegate>.

- (void) text:		(SCTextFile *)	text
willWriteWithPath:		(NSString *)	path

Tells the delegate that the receiving text file is about to write the strings to the file with the specified path.

Parameters

text	- the text file instance
path	- the path to the destination file

Reimplemented from <SCTextDelegate>.

- (void) willDuplicateText:

(SCStrings *)

text

Tells the delegate that the text is about to duplicate the content.

Parameters

text	- the text instance

Reimplemented from <SCTextDelegate>.

- (void) willRemoveAllStringsFromText:

(SCStrings *)

text

Tells the delegate that the text is about to remove all strings.

Parameters

text	- the text instance

Reimplemented from <SCTextDelegate>.

- (void) willResetText:

(SCTextFile *)

text

Tells the delegate that the receiving text file is about to reset.

Parameters

text	- the text file instance

Reimplemented from <SCTextDelegate>.

---

The documentation for this class was generated from the following files:

• SCTextDelegate.h
• SCTextDelegate.m