Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

NULLXaraFile Class Reference

Dummy CXaraFile that swallows up all bytes written to it. More...

#include <cxfile.h>

Inheritance diagram for NULLXaraFile:

CXaraFile CCObject SimpleCCObject List of all members.

Public Member Functions

 NULLXaraFile ()
virtual BOOL OpenToWrite (CCLexFile *pThisCCFile)
 Writes out the 8 byte header.
virtual BOOL Close ()
 Doesn't do anything.
virtual BOOL Write (BYTE b)
 This version doesn't actually write anything out. It just counts those bytes.
virtual FilePos GetFilePos ()
 Always returns 0.
virtual BOOL IsCompressionOn ()
 Function to see if compression is on. As this is the null filter used to count objects, it always returns FALSE.
virtual BOOL StartCompression ()
 Function to turn Compression on when we are writing to the file. As this is the null filter used to count objects, do nothing.
virtual BOOL StopCompression ()
 Function to turn Compression off when we are writing to the file. As this is the null filter used to count objects, do nothing.
virtual CCLexFile * GetCCFile () const
 Function to give public access to the underlying CCLexFile that is being used to save out the data. Note: only people who have a genuine reason need to access this - e.g. bitmap savers As this is the null filter used to count objects, do nothing.

Protected Member Functions

virtual BOOL FixStreamedRecordHeader (UINT32 *RecordSize)
 Fixes up the previously saved record header for a streamed record.

Private Member Functions

 CC_DECLARE_DYNAMIC (NULLXaraFile)

Detailed Description

Dummy CXaraFile that swallows up all bytes written to it.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
3/6/96 Base Class: CXaraFile
See also:
CXaraFile

Definition at line 363 of file cxfile.h.

Constructor & Destructor Documentation

NULLXaraFile::NULLXaraFile (   )  [inline]
 

Definition at line 369 of file cxfile.h.

00369 { /* empty */ }

Member Function Documentation

NULLXaraFile::CC_DECLARE_DYNAMIC (  NULLXaraFile   )  [private]
 

BOOL NULLXaraFile::Close (  void   )  [virtual]
 

Doesn't do anything.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
4/6/96
Parameters:
- [INPUTS]
Returns:
TRUE

Errors: -

See also:
-

Reimplemented from CXaraFile.

Definition at line 2302 of file cxfile.cpp.

02303 {
02304     return TRUE;
02305 }

BOOL NULLXaraFile::FixStreamedRecordHeader (  UINT32 *  RecordSize  )  [protected, virtual]
 

Fixes up the previously saved record header for a streamed record.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
19/6/96
Parameters:
- [INPUTS]
RecordSize - the size of the record just written [OUTPUTS]
Returns:
True if worked ok, False otherwise.

Errors: -

See also:
-

Reimplemented from CXaraFile.

Definition at line 2425 of file cxfile.cpp.

02426 {
02427     return TRUE;
02428 }

CCLexFile * NULLXaraFile::GetCCFile (  void   )  const [virtual]
 

Function to give public access to the underlying CCLexFile that is being used to save out the data. Note: only people who have a genuine reason need to access this - e.g. bitmap savers As this is the null filter used to count objects, do nothing.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
20/6/96
Parameters:
- [INPUTS]
Returns:
The CCLexFile that is being used to export the data.

Errors: -

See also:
BitmapListComponent::SaveBitmapDefinition; BaseCamelotFilter::GetCCFile;

Reimplemented from CXaraFile.

Definition at line 2405 of file cxfile.cpp.

02406 {
02407     return NULL;
02408 }

FilePos NULLXaraFile::GetFilePos (   )  [virtual]
 

Always returns 0.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
4/6/96
Parameters:
- [INPUTS]
Returns:
0

Errors: -

See also:
-

Reimplemented from CXaraFile.

Definition at line 2321 of file cxfile.cpp.

02322 {
02323     return 0;
02324 }

BOOL NULLXaraFile::IsCompressionOn (   )  [virtual]
 

Function to see if compression is on. As this is the null filter used to count objects, it always returns FALSE.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
31/7/96
Parameters:
- [INPUTS]
Returns:
Always returns FALSE

Errors: -

See also:
StopCompression(); BaseCamelotFilter::StartCompression();

Reimplemented from CXaraFile.

Definition at line 2341 of file cxfile.cpp.

02342 {
02343     return FALSE;
02344 }

BOOL NULLXaraFile::OpenToWrite (  CCLexFile *  pThisCCFile  )  [virtual]
 

Writes out the 8 byte header.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
4/6/96
Parameters:
params not used [INPUTS]
Returns:
TRUE

Errors: -

See also:
-

Reimplemented from CXaraFile.

Definition at line 2277 of file cxfile.cpp.

02278 {
02279     BOOL ok = TRUE;
02280 
02281     // The first 8 bytes should be our unique ID sequence
02282     if (ok) ok = CXaraFile::Write((UINT32)CXF_IDWORD1);
02283     if (ok) ok = CXaraFile::Write((UINT32)CXF_IDWORD2);
02284 
02285     return ok;
02286 }

BOOL NULLXaraFile::StartCompression (   )  [virtual]
 

Function to turn Compression on when we are writing to the file. As this is the null filter used to count objects, do nothing.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
19/6/96
Parameters:
- [INPUTS]
Returns:
TRUE if ok FALSE otherwise

Errors: -

See also:
StopCompression(); BaseCamelotFilter::StartCompression();

Reimplemented from CXaraFile.

Definition at line 2362 of file cxfile.cpp.

02363 {
02364     return TRUE;
02365 }

BOOL NULLXaraFile::StopCompression (   )  [virtual]
 

Function to turn Compression off when we are writing to the file. As this is the null filter used to count objects, do nothing.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
19/6/96
Parameters:
- [INPUTS]
Returns:
TRUE if ok FALSE otherwise

Errors: -

See also:
StartCompression(); BaseCamelotFilter::StopCompression();

Reimplemented from CXaraFile.

Definition at line 2383 of file cxfile.cpp.

02384 {
02385     return TRUE;
02386 }

BOOL NULLXaraFile::Write (  BYTE  b  )  [virtual]
 

This version doesn't actually write anything out. It just counts those bytes.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
4/6/96
Parameters:
b = BYTE to write to [INPUTS]
Returns:
TRUE if written successfully FALSE otherwise

Errors: -

See also:
-

Reimplemented from CXaraFile.

Definition at line 2251 of file cxfile.cpp.

02252 {
02253     BOOL ok = TRUE;
02254 
02255     if (WriteToRecord && pRecord != NULL)
02256         ok = pRecord->WriteBYTE(b);
02257     else
02258         IncNumBytesWritten(1);
02259 
02260     return ok;
02261 }

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:57:15 2007 for Camelot by  doxygen 1.4.4