Torque3D/Engine/source/gui/editor/inspector/variableGroup.h

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

#ifndef _GUI_INSPECTOR_VARIABLEGROUP_H_
#define _GUI_INSPECTOR_VARIABLEGROUP_H_

#ifndef _GUI_INSPECTOR_GROUP_H_
#include "gui/editor/inspector/group.h"
#endif

// Forward refs
class GuiInspector;
class GuiInspectorField;

struct VariableField
{
   StringTableEntry mFieldName;
   StringTableEntry mFieldLabel;
   StringTableEntry mFieldDescription;

   StringTableEntry mFieldTypeName;
   S32 mFieldType;

   SimObject* mOwnerObject;

   StringTableEntry mDefaultValue;
   String mDataValues;

   String mGroup;

   StringTableEntry mSetCallbackName;

   bool mHidden;
   bool mEnabled;
};

class GuiInspectorVariableGroup : public GuiInspectorGroup
{
public:

   typedef GuiInspectorGroup Parent;

   String mSearchString;

   GuiInspectorVariableGroup();
   virtual ~GuiInspectorVariableGroup();

   DECLARE_CONOBJECT(GuiInspectorVariableGroup);
   DECLARE_CATEGORY( "Gui Editor" );

   virtual GuiInspectorField* constructField( S32 fieldType );

   virtual bool inspectGroup();

   void clearFields();
   void addField(VariableField* field);

   void addInspectorField(GuiInspectorField* field);
   GuiInspectorField* createInspectorField();

protected:
   Vector<VariableField*> mFields;
};

#endif // _GUI_INSPECTOR_VARIABLEGROUP_H_