CH_BookmarkPropagateData.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:    CH Bookmark (C++)
 *
 * COMMENTS: Propagation data used by CH_Manager when a bookmark is changed
 *
 */

#ifndef __CH_BookmarkPropagateData_h__
#define __CH_BookmarkPropagateData_h__

#include "CH_API.h"

#include <DEP/DEP_MicroNode.h>

enum class CH_BookmarkEvent {
    Created,
    InteractionStarted,
    Modified,
    InteractionFinished,
    Deleted,
    Reset, // Fires when the entire bookmark list is reset,
           // loading entirely new ones.
};

class CH_API CH_BookmarkPropagateData : public DEP_PropagateData
{
public:

    CH_BookmarkPropagateData(CH_BookmarkEvent action, int64 id)
        : myBookmarkId(id), myEvent(action)
    {
    }

    int64 getBookmarkId() const { return myBookmarkId; }
    CH_BookmarkEvent getEvent() const { return myEvent; }

private:
    // Id of the bookmark that was modified. If -1, the entire list was swapped out/reset.
    // Event should be 'Reset' in this case.
    int64 myBookmarkId;
    // Event which was taken on the bookmark
    CH_BookmarkEvent myEvent;
};


#endif