Crazy Eddie's GUI System
0.8.4
|
00001 /*********************************************************************** 00002 created: Sat Jun 16 2012 00003 author: Paul D Turner <paul@cegui.org.uk> 00004 *************************************************************************/ 00005 /*************************************************************************** 00006 * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team 00007 * 00008 * Permission is hereby granted, free of charge, to any person obtaining 00009 * a copy of this software and associated documentation files (the 00010 * "Software"), to deal in the Software without restriction, including 00011 * without limitation the rights to use, copy, modify, merge, publish, 00012 * distribute, sublicense, and/or sell copies of the Software, and to 00013 * permit persons to whom the Software is furnished to do so, subject to 00014 * the following conditions: 00015 * 00016 * The above copyright notice and this permission notice shall be 00017 * included in all copies or substantial portions of the Software. 00018 * 00019 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 00020 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 00021 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 00022 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 00023 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 00024 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 00025 * OTHER DEALINGS IN THE SOFTWARE. 00026 ***************************************************************************/ 00027 #ifndef _CEGUIPropertyDefinitionBase_h_ 00028 #define _CEGUIPropertyDefinitionBase_h_ 00029 00030 #include "CEGUI/String.h" 00031 00032 namespace CEGUI 00033 { 00034 class XMLSerializer; 00035 00042 class CEGUIEXPORT PropertyDefinitionBase 00043 { 00044 public: 00045 PropertyDefinitionBase(const String& name, const String& help, 00046 const String& initialValue, 00047 bool redrawOnWrite, bool layoutOnWrite, 00048 const String& fireEvent, const String& eventNamespace); 00049 00050 virtual ~PropertyDefinitionBase(); 00051 00052 const String& getPropertyName() const; 00053 void setPropertyName(const String& name); 00054 00055 const String& getInitialValue() const; 00056 void setInitialValue(const String& value); 00057 00058 const String& getHelpString() const; 00059 void setHelpString(const String& help); 00060 00061 bool isRedrawOnWrite() const; 00062 void setRedrawOnWrite(bool value); 00063 00064 bool isLayoutOnWrite() const; 00065 void setLayoutOnWrite(bool value); 00066 00067 const String& getEventFiredOnWrite() const; 00068 void setEventFiredOnWrite(const String& eventName); 00069 00070 const String& getEventNamespace() const; 00071 void setEventNamespace(const String& eventNamespace); 00072 00081 virtual void writeDefinitionXMLToStream(XMLSerializer& xml_stream) const; 00082 00084 static const String UserStringNameSuffix; 00085 00086 protected: 00087 00097 virtual void writeDefinitionXMLElementType(XMLSerializer& xml_stream) const = 0; 00098 00109 virtual void writeDefinitionXMLAttributes(XMLSerializer& xml_stream) const; 00110 00111 String d_propertyName; 00112 String d_initialValue; 00113 String d_helpString; 00114 bool d_writeCausesRedraw; 00115 bool d_writeCausesLayout; 00116 String d_eventFiredOnWrite; 00117 String d_eventNamespace; 00118 }; 00119 00120 } 00121 00122 #endif 00123