CH_UndoBookmark.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_UndoBookmark.h ( CH Library, C++)
 *
 * COMMENTS:    This class handles the undoing of Bookmark
 *              operations. 
 *              
 *              This class handles the updating of playbar bookmarks
 *              when they are modified, created, or deleted
 */

#ifndef __CH_UndoBookmark__
#define __CH_UndoBookmark__

#include "CH_API.h"
#include <UT/UT_Color.h>
#include <UT/UT_Options.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_Undo.h>
#include <SYS/SYS_Types.h>

class CH_Bookmark;

class CH_API CH_UndoBookmark : public UT_Undo
{
public:
    enum class Operation
    {
        Create,
        Modify,
        Delete,
    };

     CH_UndoBookmark(CH_Bookmark * bookmark,
                     int bookmark_index,
                     Operation operation,
                     bool metadata_changed = false);

    ~CH_UndoBookmark() override;

    void undo() override;
    void redo() override;

private:
    void swap();

    void undoDelete();
    void undoModify();

    // Index into the list of bookmarks at the time this bookmark was
    // created/modified/deleted
    int myBookmarkIndex;

    fpreal myStart;
    fpreal myEnd;
    UT_Color myColor;
    UT_StringHolder myName;
    UT_StringHolder myComment;
    bool myIsTemporary;
    bool myVisible;
    bool myEnabled;

    bool myMetadataChanged;

    UT_Options myMetadata;

    Operation myOperation;
};

#endif