VOP_TabMenuFilter.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:        ( VOP Library, C++)
 *
 * COMMENTS:
 */

#ifndef __VOP_TabMenuFilter_h__
#define __VOP_TabMenuFilter_h__

#include "VOP_API.h"
#include <OP/OP_Value.h>
#include <UT/UT_StringArray.h>
class OP_Network;
class OP_Operator;


class VOP_API VOP_TabMenuFilter
{
public:
     VOP_TabMenuFilter( OP_Network &network_node );
    ~VOP_TabMenuFilter();

    /// Returns true if the given operator can show up in the Tab menu
    /// inside the member network.
    bool         isOperatorAllowedInTabMenu( OP_Operator *op );


    /// Returns true if the filter has an explicitly set mask (empty or not).
    /// Ie, there is a spare parm on the network node that specifies the mask.
    bool         hasMask();

private:
    /// @{ Manages member data based on the network node's parameters.
    void         dirtyTabMenuContext();
    void         updateTabMenuContext();
    /// @}

    /// Reacts to the change in the network node owning the Tab menu.
    static void  handleNetworkNodeChange( OP_Node *caller,
                    void *callee, OP_EventType t, void *data);

private:
    enum class FilterState
    {
        NEEDS_UPDATE,       // Undetermined state yet.
        FIND_WORD,          // Find the keyword given in the mask string.
    };

    FilterState         myState;            // State of this filter object.
    UT_StringArray      myTabMenuMask;      // Target names/keywords to match.
    OP_Network &        myNetworkNode;      // Network owning the Tab menu.
    bool                myHasMask;          // Network has tab menu mask parm.
};

#endif