• Skip to content
  • Skip to link menu
KDE 4.4 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

digikam

CPGFStream Class Reference

Abstract stream base class. More...

#include <Stream.h>

Inheritance diagram for CPGFStream:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CPGFStream ()
virtual ~CPGFStream ()
virtual UINT64 GetPos () const =0
virtual bool IsValid () const =0
virtual void Read (int *count, void *buffer)=0
virtual void SetPos (short posMode, INT64 posOff)=0
virtual void Write (int *count, void *buffer)=0

Detailed Description

Abstract stream base class.

Author:
C. Stamm

Definition at line 32 of file Stream.h.


Constructor & Destructor Documentation

CPGFStream::CPGFStream (  )  [inline]

Standard constructor.

Definition at line 36 of file Stream.h.

virtual CPGFStream::~CPGFStream (  )  [inline, virtual]

Standard destructor.

Definition at line 40 of file Stream.h.


Member Function Documentation

virtual UINT64 CPGFStream::GetPos (  )  const [pure virtual]

Get current stream position.

Returns:
Current stream position

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual bool CPGFStream::IsValid (  )  const [pure virtual]

Check stream validity.

Returns:
True if stream and current position is valid

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual void CPGFStream::Read ( int *  count,
void *  buffer 
) [pure virtual]

Read some bytes from this stream and stores them into a buffer.

Parameters:
count A pointer to a value containing the number of bytes should be read. After this call it contains the number of read bytes.
buffer A memory buffer

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual void CPGFStream::SetPos ( short  posMode,
INT64  posOff 
) [pure virtual]

Set stream position either absolute or relative.

Parameters:
posMode A position mode (FSFromStart, FSFromCurrent, FSFromEnd)
posOff A new stream position (absolute positioning) or a position offset (relative positioning)

Implemented in CPGFFileStream, and CPGFMemoryStream.

virtual void CPGFStream::Write ( int *  count,
void *  buffer 
) [pure virtual]

Write some bytes out of a buffer into this stream.

Parameters:
count A pointer to a value containing the number of bytes should be written. After this call it contains the number of written bytes.
buffer A memory buffer

Implemented in CPGFFileStream, and CPGFMemoryStream.


The documentation for this class was generated from the following file:
  • Stream.h

digikam

Skip menu "digikam"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • digikam
Generated for API Reference by doxygen 1.5.9-20090814
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal