HOM_ParameterEditor.h

Go to the documentation of this file.

/*
#include "HOM_EnumValue.h"
 * 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.
 *
 * COMMENTS:
 */

#ifndef __HOM_ParameterEditor_h__
#define __HOM_ParameterEditor_h__

#include "HOM_PathBasedPaneTab.h"
#include "HOM_PythonPanelInterface.h"
#include "HOM_EnumModules.h"
#include "HOM_EnumValue.h"
#include "HOM_Vector2.h"

class HOM_Parm;
class HOM_ParmTuple;

SWIGOUT(%rename(ParameterEditor) HOM_ParameterEditor;)

class HOM_API HOM_ParameterEditor : virtual public HOM_PathBasedPaneTab
{
public:
    HOM_ParameterEditor()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_ParameterEditor(const HOM_ParameterEditor &pane)
    : HOM_PaneTab(pane), HOM_PathBasedPaneTab(pane)
    { HOM_CONSTRUCT_OBJECT(this) }

    ~HOM_ParameterEditor() override
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__() = 0;)

    virtual HOM_Vector2 scrollPosition() = 0;
    virtual void setScrollPosition( HOM_Vector2 &position ) = 0;

    virtual void setFilterEnabled( bool on, bool keyboard_lock=false ) = 0;
    virtual bool filterEnabled() = 0;

    virtual void setFilterPattern( const char* filter ) = 0;
    virtual std::string filterPattern() = 0;

    virtual void setFilterExactMatch( bool on ) = 0;
    virtual bool filterExactMatch() = 0;

    virtual void setFilterMode( HOM_EnumValue &mode=HOM_parmFilterMode::AllParms) = 0;
    virtual HOM_EnumValue &filterMode() = 0;

    virtual void setFilterCriteria( HOM_EnumValue &criteria=HOM_parmFilterCriteria::NameOrLabel ) = 0;
    virtual HOM_EnumValue &filterCriteria() = 0;

    virtual bool isShowingParmDialog() = 0;
    virtual void setShowParmDialog( bool show ) = 0;

    virtual bool _pressColorButton(const char *parm) = 0;

    // Shared Methods by ParameterEditor and NetworkEditor
    virtual void _scrollToParms(const char *parms) = 0;
    virtual void _filterParms(const char *parms) = 0;
    virtual void _filterParmFolders(const char *parms) = 0;

    virtual void setMultiParmTab(const char *parm, int index) = 0;
    virtual int multiParmTab(const char *parm) = 0;

    virtual std::vector<HOM_ElemPtr<HOM_ParmTuple> > visibleParms() = 0;

    SWIGOUT(%newobject pythonPanelInterface;)
    virtual HOM_PythonPanelInterface *pythonPanelInterface() = 0;

    SWIGOUT(%ignore _opaquePythonPanelInterfaceRootWidget;)
    virtual void * _opaquePythonPanelInterfaceRootWidget() = 0;

#ifdef SWIG
%extend
{
    // Return the active interface's root widget.
    virtual InterpreterObject pythonPanelInterfaceRootWidget()
    {
        return HOMincRef((InterpreterObject)self->_opaquePythonPanelInterfaceRootWidget());
    }
}
#endif
};

#endif