PI_OHLPersistent.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:        PI_OHLPersistent.h.h ( PI Library, C++)
 *
 * COMMENTS:
 *
 *      Abstraction for a persistent PI.
 */

#ifndef __PI_OHLPersistent__
#define __PI_OHLPersistent__

#include "PI_API.h"
#include <OP/OP_Value.h>
#include "PI_OpHandleLink.h"
#include "PI_SettingList.h"

class PI_Manager;

class PI_API PI_OHLPersistent : public PI_OpHandleLink
{
public:
    const UT_String     &getName() const;
    void                 setName(const char *name);

    const UT_String     &getPaneMask() const;
    void                 setPaneMask(const char *mask);

    bool                 getExpose() const;
    void                 setExpose(bool expose);

    bool                 getDisplayInParent() const;
    void                 setDisplayInParent(bool display);
    bool                 getDisplayInChild() const;
    void                 setDisplayInChild(bool display);
    bool                 getDisplayInSibling() const;
    void                 setDisplayInSibling(bool display);
    bool                 getDisplayAlways() const;
    void                 setDisplayAlways(bool display);

    // Accessor to the PI handle link which owns this persistent PI.  
    // The OHLPersistent is never the MPI or IMP you eventually define, 
    // but is owned by it.  However, the PI_Manager only has a list 
    // of OHLs.
    void                 setPIOwner(PI_OpHandleLink *piowner)
                         { myPIOwner = piowner; }
    PI_OpHandleLink     *getPIOwner() const { return myPIOwner; }

    void                 setActiveColor(const UT_Color &c) override;

    const PI_SettingList &getSettingList() const { return mySettingList; }
          PI_SettingList &getSettingList()       { return mySettingList; }
    void                 setSettings(const char *setting_string);
    void                 clearSettingList() { mySettingList.clear(); }

    int                  setEqual(const PI_OpHandleLink &pi) override;

protected:
    void                 handleOpChange(OP_Node *op, OP_EventType etype,
                                        void *data) override;

private:
             PI_OHLPersistent(PI_Manager *manager, const char *name,
                              const PI_PITemplate &templ);
            ~PI_OHLPersistent() override;

    PI_Manager          *myManager;
    UT_String            myName;
    UT_String            myPaneMask;
    bool                 myExpose;

    bool                 myNetDisplayInParent;
    bool                 myNetDisplayInChild;
    bool                 myNetDisplayInSibling;
    bool                 myNetDisplayAlways;

    PI_SettingList       mySettingList;

    PI_OpHandleLink     *myPIOwner;

    friend class PI_Manager;
};

#endif