ExportedBitmaps Class Reference

Encapsulate the process of maintaining an list of Bitmaps already exported from the current document out to file. More...

#include <expbmp.h>

Inheritance diagram for ExportedBitmaps:

CCObject SimpleCCObject List of all members.

Public Member Functions

 ExportedBitmaps ()
 Construct the class which encapsulates a list of exported Bitmaps.
 ~ExportedBitmaps ()
 Destroy the class which encapsulates a list of exported Bitmaps.
BOOL AddBitmap (KernelBitmap *pNewBmp, INT32 RecordNumber)
 Add the specified Bitmap to the list of already exported Bitmaps.
ExportBitmapGetBitmap (KernelBitmap *pSearchBmp)
 Find an indexed Bitmap in the exported list.
ExportBitmapEnumerateBitmaps (ExportBitmap *pExpBmp=NULL)
 

UINT32 GetCount ()

Protected Attributes

ExportBitmapList Bitmaps

Detailed Description

Encapsulate the process of maintaining an list of Bitmaps already exported from the current document out to file.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
See also:
NewExportBitmap; ExportBitmapList

Definition at line 175 of file expbmp.h.


Constructor & Destructor Documentation

ExportedBitmaps::ExportedBitmaps  ) 
 

Construct the class which encapsulates a list of exported Bitmaps.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/5/96
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-
See also:
ExportedBitmaps

Definition at line 215 of file expbmp.cpp.

00216 {
00217 }

ExportedBitmaps::~ExportedBitmaps  ) 
 

Destroy the class which encapsulates a list of exported Bitmaps.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-
See also:
ExportedBitmaps

Definition at line 233 of file expbmp.cpp.

00234 {
00235 }


Member Function Documentation

BOOL ExportedBitmaps::AddBitmap KernelBitmap pBmp,
INT32  RecordNumber
 

Add the specified Bitmap to the list of already exported Bitmaps.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
Parameters:
pNewBmp - the Bitmap to put in the list. [INPUTS] RecordNumber - the number of the record that this Bitmap definition has been saved in.
Returns:
TRUE if the Bitmap could be added; FALSE if not

Errors: -

See also:
ExportBitmapList;

Definition at line 254 of file expbmp.cpp.

00255 {
00256     ERROR2IF(pBmp->HasBeenDeleted(), FALSE, "Trying to add a deleted bitmap to the export list");
00257 
00258     // Add the Bitmap onto our list
00259     ExportBitmap * pNewBmp = Bitmaps.AddBitmap(pBmp, RecordNumber);
00260     if (pNewBmp)
00261         return TRUE;
00262     
00263     return FALSE;
00264 }

ExportBitmap * ExportedBitmaps::EnumerateBitmaps ExportBitmap pExpBmp = NULL  ) 
 

Author:
Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/8/96
Parameters:
- [INPUTS]
Returns:
if the item is found then returns - Pointer to the exported Bitmap list item if the item is not found then returns - NULL.
See also:
ExportBitmapList

Definition at line 319 of file expbmp.cpp.

00320 {
00321     if (pExpBmp == NULL)
00322         return (ExportBitmap *)Bitmaps.GetHead();
00323 
00324     return (ExportBitmap *)Bitmaps.GetNext(pExpBmp);
00325 }

ExportBitmap * ExportedBitmaps::GetBitmap KernelBitmap pSearchBmp  ) 
 

Find an indexed Bitmap in the exported list.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
Parameters:
pSearchBmp - the Bitmap to search for in the list. [INPUTS]
Returns:
if the item is found then returns - Pointer to the exported Bitmap list item if the item is not found then returns - NULL.
See also:
ExportBitmapList

Definition at line 280 of file expbmp.cpp.

00281 {
00282     if (pSearchBmp == NULL)
00283     {
00284         ERROR3("ExportedBitmaps::GetBitmap - searching for a null indexed Bitmap!");
00285     }
00286 
00287     ERROR2IF(pSearchBmp->HasBeenDeleted(), NULL, "Why am I looking for a deleted bitmap ?");
00288 
00289     ExportBitmap* pExportedBitmap = (ExportBitmap *)Bitmaps.GetHead();
00290     while (pExportedBitmap)
00291     {
00292         // Compare the indexed Bitmap pointers and return the match if they are the same
00293         if (pExportedBitmap->pBmp == pSearchBmp)
00294             return pExportedBitmap;
00295         
00296         // Try the next Bitmap in the list
00297         pExportedBitmap = (ExportBitmap *)Bitmaps.GetNext(pExportedBitmap);
00298     }
00299 
00300     // No - return failure.
00301     return NULL;
00302 }

UINT32 ExportedBitmaps::GetCount  )  [inline]
 

Definition at line 193 of file expbmp.h.

00193 { return Bitmaps.GetCount(); }


Member Data Documentation

ExportBitmapList ExportedBitmaps::Bitmaps [protected]
 

Definition at line 197 of file expbmp.h.


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