ListLazyNotificationData.h

//========================================================================================
// 
// $File$
// 
// Owner: Ryan Gano
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ListLazyNotifsCookie__
#define __ListLazyNotifsCookie__

#include "LazyNotificationData.h"
#include "KeyValuePair.h"
#include <vector>

// The is a templated class so that clients can store data in the way that is
// most fitting for them. Two types of templates have been pre-defined. 
// The first takes a UID and the second takes a ClassID. 
// To add new types you must include the file LazyNotificationData.tpp so that
// the correct templated class can be compiled. Typically this is done in one
// location to avoid having to recompile the same template code over and over
// again. For app wide usage (things that you expect multiple plugins to have
// need of please put your definition in templates_pub.cpp. For plugin specific
// templates you can create a similar file in your plugin and add the definiation
// there. The definition should look like:
// template class ListLazyNotificationData<UID>;

template <class ItemType>
class ListLazyNotificationData : public LazyNotificationData
{
public:
 ListLazyNotificationData():LazyNotificationData(), fRebuildWholeList(false){};

 virtual void Add (const LazyNotificationData* other);

 virtual LazyNotificationData* Clone (bool16 undoData) const;

 virtual void MarkShouldRebuildAll ();

 void ItemAdded(ItemType itemID);

 void ItemDeleted(ItemType itemID);

 void ItemChanged(ItemType itemID);

 void BreakoutChanges(K2Vector<ItemType> *addedItems, K2Vector<ItemType> *deletedItems, K2Vector<ItemType> *changedItems) const;

 bool ShouldRebuildAll() const {return fRebuildWholeList;}

 virtual void Validate(IDataBase *db);
 

private:

 // Used as an indicator of how a particular item changed (used internally)
 enum ListCookieItemState {
 // Indicates that the item was added
 kAdded, 
 // Indicates that the item was deleted
 kDeleted, 
 // Indicates that the item was changed
 kChanged
 };

 // A typedef to make less typing. Combines an item and state.
 typedef KeyValuePair<ItemType, ListCookieItemState> StoredItemData;
 // A typedef to make less typing. Vector of items and states
 typedef std::vector<StoredItemData> ItemTypeVector;

 // This is the list of items and their changes
 std::vector<StoredItemData> fItemList;

 // This bool indicates whether the entire list should just be rebuilt
 bool fRebuildWholeList;
 enum {kMaxSize = 100};
};

#endif