OP/OP_NetworkBoxFlags.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:
 *      Sevag Gharibian
 *      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 network boxes
 *
 */

#ifndef __OP_NetworkBoxFlags_h__
#define __OP_NetworkBoxFlags_h__

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

#include <UT/UT_String.h>

class OP_NetworkBox;

#define OP_NETWORKBOX_PICK_FLAG         'p'
#define OP_NETWORKBOX_MINIMIZED_FLAG    'm'

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

    void                setMarked       (bool flag) { myMarked        = flag;  }
    void                setMinimized    (bool flag) { myMinimized     = flag;  }
    void                setPicked       (bool flag) { myPicked        = flag;  }
    void                setResizing     (bool flag) { myResizing      = flag;  }
    
    bool                getUndoColor()     const    { return myUndoColor;      }
    bool                getUndoLayout()    const    { return myUndoLayout;     }
    bool                getUndoMinimize()  const    { return myUndoMinimize;   }
    bool                getUndoPick()      const    { return myUndoPick;       }
    bool                getUndoRename()    const    { return myUndoRename;     }
    bool                getUndoResize()    const    { return myUndoResize;     }
    
    bool                getMarked()        const    { return myMarked;         }
    bool                getMinimized()     const    { return myMinimized;      }
    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
                myMinimized:1,  // Netbox is minimized
                myPicked:1,     // Picked by user
                myResizing:1,   // Network box is being resized

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

private:

    OP_NetworkBoxFlags();
    OP_NetworkBoxFlags(const OP_NetworkBoxFlags &source);

    friend class OP_NetworkBox;
    
    ///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_NetworkBoxFlags &source);

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

};

#endif

---