variableGroup.h

Engine/source/gui/editor/inspector/variableGroup.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUI_INSPECTOR_VARIABLEGROUP_H_
25#define _GUI_INSPECTOR_VARIABLEGROUP_H_
26
27#ifndef _GUI_INSPECTOR_GROUP_H_
28#include "gui/editor/inspector/group.h"
29#endif
30
31// Forward refs
32class GuiInspector;
33class GuiInspectorField;
34
35struct VariableField
36{
37   StringTableEntry mFieldName;
38   StringTableEntry mFieldLabel;
39   StringTableEntry mFieldDescription;
40
41   StringTableEntry mFieldTypeName;
42   S32 mFieldType;
43
44   SimObject* mOwnerObject;
45
46   StringTableEntry mDefaultValue;
47   String mDataValues;
48
49   String mGroup;
50
51   StringTableEntry mSetCallbackName;
52
53   bool mHidden;
54   bool mEnabled;
55};
56
57class GuiInspectorVariableGroup : public GuiInspectorGroup
58{
59public:
60
61   typedef GuiInspectorGroup Parent;
62
63   String mSearchString;
64
65   GuiInspectorVariableGroup();
66   virtual ~GuiInspectorVariableGroup();
67
68   DECLARE_CONOBJECT(GuiInspectorVariableGroup);
69   DECLARE_CATEGORY( "Gui Editor" );
70
71   virtual GuiInspectorField* constructField( S32 fieldType );
72
73   virtual bool inspectGroup();
74
75   void clearFields();
76   void addField(VariableField* field);
77
78   void addInspectorField(GuiInspectorField* field);
79   GuiInspectorField* createInspectorField();
80
81protected:
82   Vector<VariableField*> mFields;
83};
84
85#endif // _GUI_INSPECTOR_VARIABLEGROUP_H_
86