NSString Interface Reference

Unicode string operation class. More...

#import <nsstring.h>

Inheritance diagram for NSString:

List of all members.

Public Member Functions
(id)	init
	Initialize string object.
(id)	initWithCString:
	Initialize string object with given C-style string.
(id)	initWithCString:length:
	Initialize string object with given C-style string and length.
(id)	initWithData:encoding:
	Initialize string object with data and encoding info.
(id)	initWithGString:
	Initiaize string by GString of glib.
(void)	dealloc
	Release resource for the object.
(size_t)	length
	Get length of the string.
(size_t)	cStringLength
	Get size of the string (by bytes).
(unichar_t)	characterAtIndex:
	Get indexed character.
(NSRange)	rangeOfString:
	Get range of substring in the string.
(NSRange)	rangeOfString:options:
	Get range of substring in the string.
(NSRange)	rangeOfString:options:range:
	Get range of substring in the string.
(NSComparisonResult)	compare:
	Compare 2 string object.
(NSString *)	stringByAppendingString:
	Add the string to the end of string.
(NSString *)	substringWithRange:
	Get substring from source string.
(NSString *)	stringByPaddingToLength:withString:startingAtIndex:
	Pad the string until given length.
(NSString *)	stringByTrimmingCharactersInSet:
	Remove head/tail characters which belongs to given set. And generate new string.
(NSMutableArray *)	componentsSeparatedByString:
	Separate string by given separator.
(const char *)	cString
	Get pointer of string.
(GString *)	gString
	Get GString data.
Protected Attributes
GString *	str_body

---

Detailed Description

Unicode string operation class.

Description

NSString operates unicode string.

---

Member Function Documentation

- (unichar_t) NSString: (id)  (uint_t)  (id)  index

Get indexed character. Returns: Unicode at the index. Parameters: index  Index. Description Get indexed character.

- (NSComparisonResult) NSString: (id)  (NSString *)  (id)  src

Compare 2 string object. Returns: Result of comparison Parameters: src  Source string. Description This method compares the string and source string. If this object is smaller than source, returns NSOrderedAscending . Warning: Do not pass nil as src.

- (NSMutableArray *) NSString: (id)  (NSString *)  (id)  separator

Separate string by given separator. Returns: Array of separated strings. Parameters: separator  Separator string. DO NOT contain blanks at head and tail of the separator. Description Separate string by given separator. Spaces for each separated string are ignored.

- (const char *) NSString:

Get pointer of string. Returns: Pointer of string. This NEVER be null. Description Get pointer of string.

- (size_t) NSString:

Get size of the string (by bytes). Returns: Size of string. Description Get size of the string (by bytes).

- (void) NSString:

Release resource for the object. Description Release resource for the object. Implements NSObject. Implemented in NSMutableString.

- (GString *) NSString:

Get GString data. Returns: GString object. Description Get GString data. GString is data structure defined by glib. This method is custom method for Cacao library. Do not call this from outside. Warning: This method does not have compatibility with Cocoa. Do not call this except internal use.

- (id) NSString:

Initialize string object. Returns: Generated object. Description Initialize unicode string object. The empty string is set. Implements NSObject. Implemented in NSMutableString.

- (id) NSString: (id)  (const char *)  (id)  str

Initialize string object with given C-style string. Returns: Generated object. Parameters: str  Source C string. Description Initialize string object with given C-style string.

- (id) NSString: (id)  (const char *)  (id)  str length: (id)  (size_t)  (id)  length

Initialize string object with given C-style string and length. Returns: Generated string. Parameters: str  Source C string. length  Length of source string. Description Initialize string object with given C-style string.

- (id) NSString: (id)  (NSData *)  (id)  data encoding: (id)  (NSStringEncoding)  (id)  typ

Initialize string object with data and encoding info. Returns: Generated string. Parameters: data  Source encoding. typ  Encoding type. Description Initialize string object with data and encoding info.

- (id) NSString: (id)  (GString *)  (id)  gstr

Initiaize string by GString of glib. Returns: New string. Parameters: gstr  Source string. Description Initialize string by GString of glib. The copy is NOT copid in this method, but released destructor of this object. Do not free the source string. Warning: This method does not have compatibility with Cocoa. Do not call this except internal use.

- (size_t) NSString:

Get length of the string. Returns: Length of string. Description Get length of the string.

- (NSRange) NSString: (id)  (NSString *)  (id)  substr

Get range of substring in the string. Returns: Range of substring. If it is not found, this value will be {NSNotFound, 0}. Parameters: substr  Substring. Description

- (NSRange) NSString: (id)  (NSString *)  (id)  substr options: (id)  (uint_t)  (id)  mask

Get range of substring in the string. Returns: Range of substring. If it is not found, this value will be {NSNotFound, 0}. Parameters: substr  Substring. mask  Bit mask generated by NSStringSearchOption values. Description

- (NSRange) NSString: (id)  (NSString *)  (id)  substr options: (id)  (uint_t)  (id)  mask range: (id)  (NSRange)  (id)  range

Get range of substring in the string. Returns: Range of substring. If it is not found, this value will be {NSNotFound, 0}. Parameters: substr  Substring. mask  Bit mask generated by NSStringSearchOption values. Description

- (NSString *) NSString: (id)  (NSString *)  (id)  src

Add the string to the end of string. Returns: New string contains result of addition. Parameters: src  Source string to append. Description Add the string to the end of string.

- (NSString *) NSString: (id)  (size_t)  (id)  newlength withString: (id)  (NSString *)  (id)  padstr startingAtIndex: (id)  (uint_t)  (id)  padindex

Pad the string until given length. Returns: Generated string. Parameters: newlength  The length of new string. padstr  Addtional string to be added to the end of current string. padindex  The start point to add the padstr to the current string. If the added length is not enough to the newlength, the padstr is added from beggining.

- (NSString *) NSString: (id)  (NSCharacterSet *)  (id)  set

Remove head/tail characters which belongs to given set. And generate new string. Parameters: set  Character set to choose trim target. Description Remove head/tail characters which belongs to given character set.

- (NSString *) NSString: (id)  (NSRange)  (id)  range

Get substring from source string. Returns: Substring of original Parameters: range  Range of target substring. Description Get substring from source string. Invalid range causes system error.

---

Member Data Documentation

GString* NSString::str_body [protected]

Main string data

---

The documentation for this interface was generated from the following file:

• nsstring.h

---