owl::TStream Class Reference

An abstract base class, TStream provides links between streams and documents, views, and document files. More...

#include <owl/docview.h>

Inheritance diagram for owl::TStream:

Public Member Functions
TDocument &	GetDocument ()
	Returns the current document that is open for streaming.
	~TStream ()
	Closes the stream.
int	GetOpenMode ()
	Gets mode flags used when opening document streams.
LPCTSTR	GetStreamName ()
	Gets the name of the stream used for opening the document.

Protected Member Functions
	TStream (TDocument &doc, LPCTSTR name, int mode)
	Constructs a TStream object.

Protected Attributes
TDocument &	Doc
	Stores the document that owns this stream.
TStream *	NextStream
	Points to the next stream in the list of active streams.

Friends
class	TDocument

Detailed Description

An abstract base class, TStream provides links between streams and documents, views, and document files.

Definition at line 568 of file docview.h.

Constructor & Destructor Documentation

~TStream()

owl::TStream::~TStream ( )

inline

Closes the stream.

Derived classes generally close the document if it was opened especially for this stream.

Definition at line 1215 of file docview.h.

References owl::TDocument::DetachStream(), and Doc.

TStream()

owl::TStream::TStream ( TDocument & doc, LPCTSTR name, int mode )

inlineprotected

Constructs a TStream object.

'name' is the user-defined name of the stream and can be 0. Note: If 'name' is not null, the referenced string must outlive the object. No copy is made.

Definition at line 1224 of file docview.h.

References owl::TDocument::AttachStream(), and Doc.

Member Function Documentation

GetDocument()

TDocument & owl::TStream::GetDocument ( )

inline

Returns the current document that is open for streaming.

Definition at line 1207 of file docview.h.

References Doc.

GetOpenMode()

int owl::TStream::GetOpenMode ( )

inline

Gets mode flags used when opening document streams.

For example, the stream can be opened in ofRead mode to allow reading, but not changing (writing to) the file.

Definition at line 1245 of file docview.h.

GetStreamName()

LPCTSTR owl::TStream::GetStreamName ( )

inline

Gets the name of the stream used for opening the document.

Definition at line 1236 of file docview.h.

Friends And Related Symbol Documentation

TDocument

friend class TDocument

friend

Definition at line 585 of file docview.h.

Member Data Documentation

Doc

TDocument& owl::TStream::Doc

protected

Stores the document that owns this stream.

Definition at line 576 of file docview.h.

NextStream

TStream* owl::TStream::NextStream

protected

Points to the next stream in the list of active streams.

Definition at line 577 of file docview.h.

---

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

• include/owl/docview.h