Protocol DTextReadable

Adopted by:
DBZipFile, DFile, DGZipFile, DText
Declared in:
DTextReadable.h

Protocol Description

The DTextReadable protocol specifies the interface for reading of text from a class implementing this interface.

Last modified:
31-Oct-2007 (DTextReadable.h)

Method Index

- (int) error
Return the last error
Returns:
the last error (or 0)
- (BOOL) isEof
Is the end of the readable reached ?
Returns:
is it?
- (char) readChar
Read a character
Returns:
the character read
- (DText *) readLine
Read a line of text (till Eof or \n)
Returns:
a (new) text string
- (DText *) readText
Read text string (all available text)
Returns:
a (new) text string
- (DText *) readText :(long) length
Read text string
Parameters:
length - the length of the text to be read
Returns:
a (new) text string
- (BOOL) seek :(unsigned long) offset :(int) origin
Move the current position in the readable
Parameters:
offset - the offset from the origin (in bytes)
origin - the origin for the offset (0=begin, 1=current, 2=end)
Returns:
success
- (BOOL) skip :(unsigned long) offset
Skip a number of positions
Parameters:
offset - the number of bytes to skip
Returns:
success
- (unsigned long) tell
Tell the current position in the readable
Returns:
the current position

generated 05-Nov-2007 by ObjcDoc 3.0.0