GlobalBitmapList Class Reference

A list of Greyscale bitmaps A list of all the OIL Bitmaps available in the application. More...

#include <bmplist.h>

Inheritance diagram for GlobalBitmapList:

List of all members.

Public Member Functions
	GlobalBitmapList ()
	GlobalBitmapList constructor.
	~GlobalBitmapList ()
	GlobalBitmapList destructor.
BOOL	AddItem (OILBitmap *NewBitmap)
	Adds an item to the tail of the GlobalBitmaplist.
void	MakeNameUnique (String_256 *)
	Ensures a bitmap name is unique.
ListItem *	GetFirstBitmapName (String_256 *)
	Find the names of the bitmaps in the list.
ListItem *	GetNextBitmapName (ListItem *, String_256 *)
	Find the names of the bitmaps in the list.
OILBitmap *	GetBitmapFromName (String_256 *)
	Finds a bitmap with a particular name.
OILBitmap *	FindDuplicateBitmap (OILBitmap *pBitmap)
	Looks to see if an identical bitmap is already in the bitmap list.
void	DeleteAllUnusedBitmaps ()
	Called when a document is deleted, to delete all the unused bitmaps.
BOOL	IsBitmapOnClipBoard (OILBitmap *pOILBmp)
	Check to see if a bitmap is used on the clipboard.
BOOL	IsUsedInDocument (Document *pDoc, OILBitmap *pOILBmp)
	Checks if the specified OIL bitmap is in the bitmap list of the specified document.
INT32	GetDocumentBitmapCount (Document *pDoc)
	Find how many bitmaps are being used by this document.
INT32	GetDocumentBitmapSize (Document *pDoc)
	Find the total size of the bitmaps being used by this document.
Static Public Member Functions
static BOOL	Init ()
	Initialise the GlobalBitmapList.
static BOOL	DeInit ()
	DeInitialise the GlobalBitmapList.

---

Detailed Description

A list of Greyscale bitmaps A list of all the OIL Bitmaps available in the application.

Author:

Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>

See also:

-

Definition at line 185 of file bmplist.h.

---

Constructor & Destructor Documentation

GlobalBitmapList::GlobalBitmapList (   )

GlobalBitmapList constructor. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 161 of file bmplist.cpp. { }

GlobalBitmapList::~GlobalBitmapList (   )

GlobalBitmapList destructor. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 178 of file bmplist.cpp. { }

---

Member Function Documentation

BOOL GlobalBitmapList::AddItem (  OILBitmap *  Item  )

Adds an item to the tail of the GlobalBitmaplist. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Returns: TRUE Definition at line 260 of file bmplist.cpp. { ERROR3IF(Item == NULL, "Trying to add NULL item to Global Bitmap List"); if (Item == NULL) return FALSE; // Is this Bitmap already in the list ? LISTPOS pos = FindPosition((ListItem*)Item); if (pos == NOT_IN_LIST || pos == EMPTY_LIST) { // It's not in the list yet, so add it on the end AddTail((ListItem*)Item); return TRUE; } else { // It's already in the list, so just return return FALSE; } }

BOOL GlobalBitmapList::DeInit (   )  [static]

DeInitialise the GlobalBitmapList. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 6/2/95 Returns: FALSE if failed. Definition at line 215 of file bmplist.cpp. { // First deinit the global bitmap list GlobalBitmapList* pBmpList = GetApplication()->GetGlobalBitmapList(); ListItem* pItem = pBmpList->GetHead(); while (pItem != NULL) { ListItem* pNext = pBmpList->GetNext(pItem); OILBitmap* pBitmap = (OILBitmap*)pItem; ERROR3IF(pBitmap->IsTemp(), "Warning. Found temp bitmap in global bitmap list"); if (pBitmap == OILBitmap::Default) { // Don't delete the default bitmap, just remove it from the list pBitmap->RemoveFromGlobalList(); } else { delete pBitmap; // This will remove it from the list before deleting it } pItem = pNext; } // Now deinit the greyscale bitmap list // GreyscaleBitmapList::DeInit(); return TRUE; }

void GlobalBitmapList::DeleteAllUnusedBitmaps (   )

Called when a document is deleted, to delete all the unused bitmaps. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Definition at line 609 of file bmplist.cpp. { InternalClipboard::AttrsHaveChanged(); // As we now have two clipboards, we need to sort out both InternalClipboard::Swap(); // Swap to alternative clipboard InternalClipboard::AttrsHaveChanged(); InternalClipboard::Swap(); // Swap back to orignal clipboard ListItem* pItem = GetHead(); while (pItem != NULL) { OILBitmap* pOILBmp = (OILBitmap*)pItem; ERROR3IF(pOILBmp->IsAFractal(), "There's a fractal in the global list ! How'd that happen ?"); BOOL IsUsed = FALSE; if (pOILBmp == OILBitmap::Default) { IsUsed = TRUE; } // DY 16/3/2000, we don't want to delete bitmaps that are used by brushes when the // document they are in is deleted. if (pOILBmp->IsUsedByBrush()) { IsUsed = TRUE; } else { // Go though all the documents Document* pDoc = (Document*)GetApplication()->Documents.GetHead(); while (pDoc != NULL) { if (IsUsedInDocument(pDoc, pOILBmp)) { IsUsed = TRUE; break; } // Move onto the next document pDoc = (Document*)GetApplication()->Documents.GetNext(pDoc); } #if !defined(EXCLUDE_FROM_RALPH) // Now check the ClipBoard to see if the Bitmap is in there if (!IsUsed && IsBitmapOnClipBoard(pOILBmp)) { IsUsed = TRUE; //break; } // Should do this but will ERROR2 on exit as the clipboard has no doc components // Should be ok as we now clear out the bitmap lists when the clipboard is cleared /*if (!IsUsed) { Document * pClipDoc = InternalClipboard::Instance(); if (pClipDoc && IsUsedInDocument(pClipDoc, pOILBmp)) { IsUsed = TRUE; } } */ // As we now have two clipboards, we need to check both // Now check the ClipBoard to see if the Bitmap is in there if (!IsUsed) { InternalClipboard::Swap(); // Swap to alternative clipboard if (IsBitmapOnClipBoard(pOILBmp)) { IsUsed = TRUE; // break; } InternalClipboard::Swap(); // Swap back to orignal clipboard } // Should do this but will ERROR2 on exit as the clipboard has no doc components // Should be ok as we now clear out the bitmap lists when the clipboard is cleared /*if (!IsUsed) { Document * pClipDoc = InternalClipboard::Other(); if (pClipDoc && IsUsedInDocument(pClipDoc, pOILBmp)) . { IsUsed = TRUE; } } */ #endif } // Get next item before we delete this item pItem = GetNext(pItem); if (!IsUsed) { delete pOILBmp; // Delete if not used pOILBmp = NULL; } } }

OILBitmap * GlobalBitmapList::FindDuplicateBitmap (  OILBitmap *  pOILBitmap  )

Looks to see if an identical bitmap is already in the bitmap list. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Definition at line 421 of file bmplist.cpp. { ListItem* pItem = GetHead(); while (pItem != NULL) { OILBitmap* pBmp = (OILBitmap*)pItem; ERROR3IF(pBmp == pOILBitmap, "Why is this bitmap already in the list ?"); if (pBmp != pOILBitmap && *pBmp == *pOILBitmap) { return pBmp; } pItem = GetNext(pItem); } return NULL; }

OILBitmap * GlobalBitmapList::GetBitmapFromName (  String_256 *  BitmapName  )

Finds a bitmap with a particular name. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Returns: Ptr to Bitmap of the name given, or NULL if not found. Definition at line 352 of file bmplist.cpp. { ListItem* pItem = GetHead(); while (pItem != NULL) { OILBitmap* pBmp = (OILBitmap*)pItem; if (!pBmp->HasBeenDeleted()) { if (*BitmapName == pBmp->GetName()) return pBmp; } pItem = GetNext(pItem); } return NULL; }

INT32 GlobalBitmapList::GetDocumentBitmapCount (  Document *  pDoc  )

Find how many bitmaps are being used by this document. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Definition at line 454 of file bmplist.cpp. { INT32 Count = 0; INT32 DefaultIsUsed = FALSE; if (pDoc != NULL) { // Now get the actual bitmap list BitmapList* Bitmaps = pDoc->GetBitmapList(); if (Bitmaps) { // Go through all the bitmaps in the list ListItem *Ptr = Bitmaps->GetHead(); while (Ptr != NULL) { KernelBitmap* Bmp = (KernelBitmap*)Ptr; if (Bmp->IsDefaultBitmap() && !DefaultIsUsed) { if (Bmp->IsUsedInDocument(pDoc)) DefaultIsUsed = TRUE; } else if (Bmp->IsUsedInDocument(pDoc)) { Count++; } Ptr = Bitmaps->GetNext(Ptr); } } } if (DefaultIsUsed) Count++; return Count; }

INT32 GlobalBitmapList::GetDocumentBitmapSize (  Document *  pDoc  )

Find the total size of the bitmaps being used by this document. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Definition at line 502 of file bmplist.cpp. { INT32 Mem = 0; INT32 DefaultIsUsed = FALSE; if (pDoc != NULL) { // Now get the actual bitmap list BitmapList* Bitmaps = pDoc->GetBitmapList(); if (Bitmaps) { // Go through all the bitmaps in the list ListItem *Ptr = Bitmaps->GetHead(); while (Ptr != NULL) { KernelBitmap* Bmp = (KernelBitmap*)Ptr; if (Bmp->IsDefaultBitmap() && !DefaultIsUsed) { if (Bmp->IsUsedInDocument(pDoc)) DefaultIsUsed = TRUE; } else if (Bmp->IsUsedInDocument(pDoc)) { Mem += Bmp->ActualBitmap->GetBitmapSize(); } Ptr = Bitmaps->GetNext(Ptr); } } } if (DefaultIsUsed) { Mem += OILBitmap::Default->GetBitmapSize(); } return Mem; }

ListItem * GlobalBitmapList::GetFirstBitmapName (  String_256 *  BitmapName  )

Find the names of the bitmaps in the list. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Returns: The bitmap found at the head of the List, or NULL if none found. Definition at line 294 of file bmplist.cpp. { ListItem* First = GetHead(); while (First != NULL) { if (!((OILBitmap*)First)->HasBeenDeleted()) { *BitmapName = ((OILBitmap*)First)->GetName(); return First; } First = GetNext(First); } return NULL; }

ListItem * GlobalBitmapList::GetNextBitmapName (  ListItem *  Prev, String_256 *  BitmapName )

Find the names of the bitmaps in the list. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Returns: The next bitmap in the List, or NULL if none found. Definition at line 323 of file bmplist.cpp. { ListItem* Next = GetNext(Prev); while (Next != NULL) { if (!((OILBitmap*)Next)->HasBeenDeleted()) { *BitmapName = ((OILBitmap*)Next)->GetName(); return Next; } Next = GetNext(Next); } return NULL; }

BOOL GlobalBitmapList::Init (  void   )  [static]

Initialise the GlobalBitmapList. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 6/2/95 Returns: FALSE if failed. Reimplemented from SimpleCCObject. Definition at line 193 of file bmplist.cpp. { // GreyscaleBitmapList::Init(); #if !defined(EXCLUDE_FROM_RALPH) return OpDeleteBitmap::Init(); #else return TRUE; #endif }

BOOL GlobalBitmapList::IsBitmapOnClipBoard (  OILBitmap *  pOILBmp  )

Check to see if a bitmap is used on the clipboard. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/8/96 Definition at line 720 of file bmplist.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // Clear out any Cached attrs on the Clipboard Node* Subtree = (Node*) InternalClipboard::GetInsertionLayer(); if (!Subtree) return FALSE; Range ClipRange(Subtree->FindFirstChild(), Subtree->FindLastChild(), RangeControl(TRUE,TRUE,TRUE,TRUE)); // Go though all the nodes on the clipboard Node* Current = ClipRange.FindFirst(); while (Current != NULL) { // And search right down each subtree Node* pNodeToCheck = Current->FindFirstDepthFirst(); while (pNodeToCheck != NULL) { // See if this node uses the bitmap INT32 Count = 0; // Does this node have any bitmaps in it ? KernelBitmap* pKernelBmp = pNodeToCheck->EnumerateBitmaps(Count++); while (pKernelBmp != NULL) { // Found a bitmap reference, but ... is it the one we want ? if (pKernelBmp->GetActualBitmap() == pOILBmp) { return TRUE; } // Check whether this bitmap is an XPE master if (pKernelBmp->GetActualBitmap()) { PORTNOTE("other","Removed IXMLDOMDocumentPtr usage") #ifndef EXCLUDE_FROM_XARALX OILBitmap* pMaster = NULL; IXMLDOMDocumentPtr pInfo = NULL; pKernelBmp->GetActualBitmap()->GetXPEInfo(pMaster, pInfo); if (pMaster == pOILBmp) return TRUE; #endif } pKernelBmp = pNodeToCheck->EnumerateBitmaps(Count++); } pNodeToCheck = pNodeToCheck->FindNextDepthFirst(Current); } Current = ClipRange.FindNext(Current); } #endif return FALSE; }

BOOL GlobalBitmapList::IsUsedInDocument (  Document *  pDoc, OILBitmap *  pOILBmp )

Checks if the specified OIL bitmap is in the bitmap list of the specified document. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/8/97 Parameters: pDoc  Document to check bitmap list of [INPUTS] pOILBmp the OIL bitmap to find in the list Returns: True if the bitmap is found, False otherwise See also: DeleteAllUnusedBitmaps; Definition at line 558 of file bmplist.cpp. { ERROR2IF(pDoc == NULL || pOILBmp == NULL,FALSE,"GlobalBitmapList::IsUsedInDocument Bad params!"); // Get the bitmap list for the specified document BitmapList* pBitmaps = pDoc->GetBitmapList(); if (pBitmaps) { ListItem* pKBmp = pBitmaps->GetHead(); while (pKBmp) { KernelBitmap* pBmp = (KernelBitmap*)pKBmp; if (pBmp->ActualBitmap == pOILBmp) { // Found a copy of the bitmap and so return TRUE return TRUE; } PORTNOTETRACE("other","GlobalBitmapList::IsUsedInDocument - skip XPE master bit"); #ifndef EXCLUDE_FROM_XARALX // Check whether this bitmap is an XPE master if (pBmp->ActualBitmap) { OILBitmap* pMaster = NULL; IXMLDOMDocumentPtr pInfo = NULL; pBmp->ActualBitmap->GetXPEInfo(pMaster, pInfo); if (pMaster == pOILBmp) return TRUE; } #endif pKBmp = pBitmaps->GetNext(pKBmp); } } // Bitmap not found and so return FALSE return FALSE; }

void GlobalBitmapList::MakeNameUnique (  String_256 *  BitmapName  )

Ensures a bitmap name is unique. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/94 Definition at line 382 of file bmplist.cpp. { ListItem* Bitmap = GetHead(); INT32 Number = 1; String_256 Name = *BitmapName; while (Bitmap != NULL) { if ( Name == ((OILBitmap*)Bitmap)->GetName() ) { // This name already exists, so lets make it unique String_256 Str; camSnprintf( Str, 256, TEXT("%d"), Number++ ); Name = (*BitmapName); Name += Str; Bitmap = GetHead(); // Start at the beginning again } else { Bitmap = GetNext(Bitmap); } } *BitmapName = Name; }

---

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

• Kernel/bmplist.h (r1785/r751)
• Kernel/bmplist.cpp (r1785/r1488)

---