SCTextIndex Class Reference

Text index class. More...

#import <SCTextIndex.h>

Inheritance diagram for SCTextIndex:

Instance Properties
SCULong	line
SCULong	character
NSString *	description

Creating Text Indexes
(SCTextIndex *)	+ textIndexWithCoder:
(SCTextIndex *)	+ textIndexWithContentsOfSerializedFile:
(SCTextIndex *)	+ textIndexWithDataDictionary:
(SCTextIndex *)	+ textIndexWithDataDictionaryFromFile:
(SCTextIndex *)	+ textIndexWithStream:
(SCTextIndex *)	+ textIndexWithFileStream:
(SCTextIndex *)	+ textIndexWithLine:character:
(SCTextIndex *)	+ textIndexWithTextIndex:
(SCTextIndex *)	+ textIndex

Initializing Text Indexes
(id)	- initWithLine:character:
(id)	- initWithTextIndex:
(id)	- init

Copying Text Indexes
(void)	- setLine:character:
(void)	- setTextIndex:

Comparing Text Indexes
(BOOL)	- isEqualToTextIndex:
(BOOL)	- isEqualTo:
(BOOL)	- isEqual:
(BOOL)	- isEqualToLine:character:

Additional Inherited Members
Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:
(BOOL)	- writeContentsToSerializedFile:
(id)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(id)	- initWithFileStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>

Detailed Description

Text index class.

Since

version 1.1.4

Class SCTextIndex implements the entity of the text index, which is a combination of the string number within the strings list and the character number within the string.

Method Documentation

- (id) init

Initializes a text index using the default settings.

Returns

A newly initialized text index

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

Initializes a text index using the specified line number and character number.

Parameters

line	- line number
character	- character number

Returns

A newly initialized text index

- (id) initWithTextIndex:

(SCTextIndex *)

textIndex

Initializes a text index using the specified existing text index.

Parameters

textIndex

- existing source text index

Returns

A newly initialized text index

- (BOOL) isEqual:

(id)

object

Returns a boolean value that indicates whether the receiving text index is equals to the specified object.

Parameters

object

- object with which to compare the receiving text index

Returns

YES if the receiving text index is equals to the specified object, otherwise NO

See also

- isEqualTo:

Reimplemented from SCObject.

- (BOOL) isEqualTo:

(id)

object

Returns a boolean value that indicates whether the receiving text index is equals to the specified object.

Parameters

object

- class instance with which to compare the receiving text index

Returns

YES if the receiving text index is equals to the specified object, otherwise NO

See also

- isEqual:

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

Returns a boolean value that indicates whether the receiving text index is equals to the specified line number and character number.

Parameters

line	- line number with which to compare the receiving text index
character	- character number with which to compare the receiving text index

Returns

YES if the receiving text index is equal to the specified line and character numbers

- (BOOL) isEqualToTextIndex:

(SCTextIndex *)

index

Returns a boolean value that indicates whether the receiving text index is equals to the specified text index.

Parameters

index

- text index with which to compare the receiving text index

Returns

YES if the receiving and the specified text indexes are equal, otherwise NO

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

Sets the specified line number and character number.

Parameters

line	- line number
character	- character number

- (void) setTextIndex:

(SCTextIndex *)

index

Sets the line number and character number by using the specified existing text index.

Parameters

index

- existing source text index

+ (SCTextIndex *) textIndex

Returns a text index created by using the default settings.

Returns

A created text index

+ (SCTextIndex *) textIndexWithCoder:

(NSCoder *)

coder

Returns a text index created by using the specified coder.

Parameters

coder

- source coder

Returns

A created text index

+ (SCTextIndex *) textIndexWithContentsOfSerializedFile:

(NSString *)

path

Returns a text index created by using the content of the serialized file with the specified path.

Parameters

path	- source serialized file path

Returns

A created text index

+ (SCTextIndex *) textIndexWithDataDictionary:

(NSDictionary *)

dictionary

Returns a text index created by using the specified data dictionary.

Parameters

dictionary

- source data dictionary

Returns

A created text index

+ (SCTextIndex *) textIndexWithDataDictionaryFromFile:

(NSString *)

path

Returns a text index created by using the data dictionary from the specified file.

Parameters

path	- source data dictionary file path

Returns

A created text index

+ (SCTextIndex *) textIndexWithFileStream:

(NSString *)

path

Returns a text index created by using the data from the file stream with the specified path.

Parameters

path	- source file stream path

Returns

A created text index

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

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

Returns a text index created by using the specified line number and character number.

Parameters

line	- line number
character	- character number

Returns

A created text index

+ (SCTextIndex *) textIndexWithStream:

(SCStream *)

stream

Returns a text index created by using the data from the specified stream.

Parameters

stream

- source stream

Returns

A created text index

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (SCTextIndex *) textIndexWithTextIndex:

(SCTextIndex *)

textIndex

Returns a text index created by using the specified existing text index.

Parameters

textIndex

- existing source text index

Returns

A created text index

Property Documentation

- (SCULong) character

readwritenonatomicassign

Character number.

- (NSString *) description

readnonatomicretain

Text index description

- (SCULong) line

readwritenonatomicassign

Line number.

---

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

• SCTextIndex.h
• SCTextIndex.m