OP/OP_PostItNoteFlags.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.
 *
 * Produced by:
 *      Oleg Samus
 *      Side Effects Software Inc.
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        OP Library (C++)
 *
 * COMMENTS:    A simple class to hold flags for post it notes
 *
 */

#ifndef __OP_PostItNoteFlags_h__
#define __OP_PostItNoteFlags_h__

#include "OP_API.h"
#include "OP_NetworkBoxItemFlags.h"
#include <iostream.h>

#include <UT/UT_String.h>

class OP_PostIt;

#define OP_POSTITNOTE_PICK_FLAG                 'p'
#define OP_POSTITNOTE_MINIMIZED_FLAG            'm'

class OP_API OP_PostItNoteFlags : public OP_NetworkBoxItemFlags
{
public:
    
    void                setUndoColor        (bool flag) { myUndoColor     = flag;  }
    void                setUndoLayout       (bool flag) { myUndoLayout    = flag;  }
    void                setUndoPick         (bool flag) { myUndoPick      = flag;  }
    void                setUndoRename       (bool flag) { myUndoRename    = flag;  }
    void                setUndoTextChange   (bool flag) { myUndoTextChange     = flag;  }
    void                setUndoResize       (bool flag) { myUndoResize    = flag;  }
    void                setUndoMinimize     (bool flag) { myUndoMinimize  = flag;  }

    void                setMinimized        (bool flag) { myMinimized     = flag;  }
    void                setMarked           (bool flag) { myMarked        = flag;  }
    void                setPicked           (bool flag) { myPicked            = flag;  }
    void                setResizing         (bool flag) { myResizing      = flag;  }
    
    bool                getUndoMinimize()       const    { return myUndoMinimize;      }
    bool                getUndoColor()          const    { return myUndoColor;      }
    bool                getUndoLayout()         const    { return myUndoLayout;     }
    bool                getUndoPick()           const    { return myUndoPick;       }
    bool                getUndoRename()         const    { return myUndoRename;     }
    bool                getUndoTextChange()     const    { return myUndoTextChange;     }
    bool                getUndoResize()         const    { return myUndoResize;     }

    bool                getMinimized()          const    { return myMinimized;      }
    bool                getMarked()             const    { return myMarked;            }
    bool                getPicked()             const    { return myPicked;            }
    bool                getResizing()           const    { return myResizing;       }

    void                getFlagOptions(UT_String &options) const;

private:
    bool        myMarked:1,     // Temporary marking for various purposes
                myPicked:1,     // Picked by user
                myResizing:1,   // Post-it is being resized
                myMinimized:1,

                // These flags are used to save whether a particular
                // type of change for the node has been saved.
                myUndoColor:1,
                myUndoLayout:1,
                myUndoPick:1,
                myUndoRename:1,
                myUndoTextChange:1,
                myUndoResize:1,
                myUndoMinimize:1;

private:

    OP_PostItNoteFlags();
    OP_PostItNoteFlags(const OP_PostItNoteFlags &source);

    void                save(ostream &os, int binary = 0, int forundo = 0);
    bool                load(UT_IStream &os, const char *path=0);

    bool                loadAsciiFlag(const char *name, const char *val);
    bool                loadBinaryFlag(int tag, int val);

    friend class OP_PostIt;
    
    ///Writes out the values of the flags specified by 'flags' to 'os'. If 
    ///'flags' is NULL, writes out values for all our flags
    void        appendCommandString(ostream &os, const char *flags,
                                    bool save_to_hip) const;

    void        shallowCopy(const OP_PostItNoteFlags &source);

    ///Initializes all the flags to their default values
    void        setDefaults(void);

};

#endif

---