os::ResStream Class Reference
[Various utillity classes.]

Data stream helper class for os::Resources. More...

Inheritance diagram for os::ResStream:

os::SeekableIO os::StreamableIO List of all members.

Public Member Functions

 ~ResStream ()
String GetName () const
 Get the resource name.
String GetType () const
 Get the resource mime-type.
ssize_t GetSize () const
 Get the size of the resource.
virtual ssize_t Read (void *pBuffer, ssize_t nSize)
virtual ssize_t Write (const void *pBuffer, ssize_t nSize)
virtual ssize_t ReadPos (off_t nPos, void *pBuffer, ssize_t nSize)
virtual ssize_t WritePos (off_t nPos, const void *pBuffer, ssize_t nSize)
virtual off_t Seek (off_t nPos, int nMode)

Friends

class Resources

Classes

class  Private

Detailed Description

Description:
Instances of this class is returned by various members of the os::Resources class to give access to data inside the resource archive.
As the private constructor indicate you should never create instances of this class yourself.
Since:
0.3.7
See also:
os::Resources
Author:
Kurt Skauen ([email protected])


Constructor & Destructor Documentation

ResStream::~ResStream (  ) 


Member Function Documentation

String ResStream::GetName (  )  const

Description:
Get the resource name.
Returns:
An STL string containing the resource name.
See also:
GetType(), GetSize()
Author:
Kurt Skauen ([email protected])

String ResStream::GetType ( void   )  const

Description:
Get the resource mime-type.
Returns:
An STL string containing the resource mime-type.
See also:
GetName(), GetSize()
Author:
Kurt Skauen ([email protected])

ssize_t ResStream::GetSize (  )  const

Description:
Get the size of the resource.
Returns:
The resource size in bytes.
See also:
GetName(), GetType()
Author:
Kurt Skauen ([email protected])

ssize_t ResStream::Read ( void *  pBuffer,
ssize_t  nSize 
) [virtual]

Implements os::StreamableIO.

ssize_t ResStream::Write ( const void *  pBuffer,
ssize_t  nSize 
) [virtual]

Implements os::StreamableIO.

ssize_t ResStream::ReadPos ( off_t  nPos,
void *  pBuffer,
ssize_t  nSize 
) [virtual]

Implements os::SeekableIO.

ssize_t ResStream::WritePos ( off_t  nPos,
const void *  pBuffer,
ssize_t  nSize 
) [virtual]

Implements os::SeekableIO.

off_t ResStream::Seek ( off_t  nPos,
int  nMode 
) [virtual]

Implements os::SeekableIO.


Friends And Related Function Documentation

friend class Resources [friend]


Generated on Sat May 9 22:51:16 2009 for Syllable higlevel API by  doxygen 1.5.1