SCTextIndex Class Reference

Text position class. More...

#import <SCTextIndex.h>

Inheritance diagram for SCTextIndex:

List of all members.

Public Member Functions
Initializing Text Index
(id)	- init
(id)	- initWithLine:character:
(id)	- initWithTextIndex:
Setting and Getting Text Index Properties
(SCULong)	- line
(SCULong)	- character
(NSString *)	- description
(void)	- setLine:
(void)	- setCharacter:
(void)	- setLine:character:
(void)	- setTextIndex:
Comparing Text Index
(BOOL)	- isEqualToTextIndex:
(BOOL)	- isEqual:
(BOOL)	- isEqualToLine:character:
Static Public Member Functions
Creating Text Index
(SCTextIndex *)	+ textIndexWithDataDictionary:
(SCTextIndex *)	+ textIndexWithDataDictionaryFromFile:
(SCTextIndex *)	+ textIndexWithCoder:
(SCTextIndex *)	+ textIndexWithContentsOfSerializedFile:
(SCTextIndex *)	+ textIndexWithStream:
(SCTextIndex *)	+ textIndexWithFileStream:
(SCTextIndex *)	+ textIndex
(SCTextIndex *)	+ textIndexWithLine:character:
(SCTextIndex *)	+ textIndexWithTextIndex:

---

Detailed Description

Text position class.

Class implements the pointer within text information (line and character indexes).
Class was introduced in version 1.1.4.

Class declares the following properties:

• SCULong line - line index
• SCULong character - character index

---

Member Function Documentation

- (SCULong) character

Returns the character index.

Returns:

Character index

- (NSString *) description

Returns a string with text index description.

Returns:

Text index description

- (id) init

Initializes the text index using the default line and character indexes.

Returns:

A newly initialized text index

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

Initializes the text index using the specified line and character indexes.

Parameters:

line	- line index
character	- character index

Returns:

A newly initialized text index

- (id) initWithTextIndex:

(SCTextIndex *)

index

Initializes the text index using the specified existing text index.

Parameters:

index

- existing text index

Returns:

A newly initialized text index

- (BOOL) isEqual:

(id)

object

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

Parameters:

object

- class instance with which to compare the receiving class instance

Returns:

YES if the receiving text index is equal to the specified class instance, otherwise NO

Reimplemented from SCObject.

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

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

Parameters:

line	- line index
character	- character index

Returns:

YES if the receiving text index is equal to the specified line and character indexes, otherwise NO

- (BOOL) isEqualToTextIndex:

(SCTextIndex *)

index

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

Parameters:

index

- text index with which to compare the receiving class instance

Returns:

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

- (SCULong) line

Returns the line index.

Returns:

Line index

- (void) setCharacter:

(SCULong)

character

Sets the specified character index.

Parameters:

character

- character index

- (void) setLine:

(SCULong)

line

Sets the specified line index.

Parameters:

line	- line index

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

Sets the specified line and character indexes.

Parameters:

line	- line index
character	- character index

- (void) setTextIndex:

(SCTextIndex *)

index

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

Parameters:

index

- source text index

+ (SCTextIndex *) textIndex

Returns a text index created by using the default line and character indexes.

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 contents of 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 dictionary.

Parameters:

dictionary

- source dictionary

Returns:

A created text index

+ (SCTextIndex *) textIndexWithDataDictionaryFromFile:

(NSString *)

path

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

Parameters:

path	- source dictionary file path

Returns:

A created text index

+ (SCTextIndex *) textIndexWithFileStream:

(NSString *)

path

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

Parameters:

path	- stream file path

Returns:

A created text index

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

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

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

Parameters:

line	- line index
character	- character index

Returns:

A created text index

+ (SCTextIndex *) textIndexWithStream:

(SCStream *)

stream

Returns a text index created from the specified stream.

Parameters:

stream

- stream for reading text index

Returns:

A created text index

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

+ (SCTextIndex *) textIndexWithTextIndex:

(SCTextIndex *)

index

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

Parameters:

index

- existing text index

Returns:

A created text index

---

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

• SCTextIndex.h
• SCTextIndex.m