Crazy Eddies GUI System  0.7.2
CEGUIFalWidgetComponent.h
1 /***********************************************************************
2  filename: CEGUIFalWidgetComponent.h
3  created: Mon Jun 13 2005
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIFalWidgetComponent_h_
29 #define _CEGUIFalWidgetComponent_h_
30 
31 #include "CEGUIFalDimensions.h"
32 #include "CEGUIFalPropertyInitialiser.h"
33 #include "../CEGUIWindow.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
50  class CEGUIEXPORT WidgetComponent
51  {
52  public:
53  WidgetComponent() {}
54  WidgetComponent(const String& type, const String& look, const String& suffix, const String& renderer);
55 
60  void create(Window& parent) const;
61 
62  const ComponentArea& getComponentArea() const;
63  void setComponentArea(const ComponentArea& area);
64 
65  const String& getBaseWidgetType() const;
66  void setBaseWidgetType(const String& type);
67 
68  const String& getWidgetLookName() const;
69  void setWidgetLookName(const String& look);
70 
71  const String& getWidgetNameSuffix() const;
72  void setWidgetNameSuffix(const String& suffix);
73 
74  const String& getWindowRendererType() const;
75  void setWindowRendererType(const String& type);
76 
77  VerticalAlignment getVerticalWidgetAlignment() const;
78  void setVerticalWidgetAlignment(VerticalAlignment alignment);
79 
80  HorizontalAlignment getHorizontalWidgetAlignment() const;
81  void setHorizontalWidgetAlignment(HorizontalAlignment alignment);
82 
83  void addPropertyInitialiser(const PropertyInitialiser& initialiser);
84  void clearPropertyInitialisers();
85 
86  void layout(const Window& owner) const;
87 
99  void writeXMLToStream(XMLSerializer& xml_stream) const;
100 
110  const PropertyInitialiser* findPropertyInitialiser(const String& propertyName) const;
111 
112  private:
113  typedef std::vector<PropertyInitialiser> PropertiesList;
114 
115  ComponentArea d_area;
116  String d_baseType;
117  String d_imageryName;
118  String d_nameSuffix;
119  String d_rendererType;
120  VerticalAlignment d_vertAlign;
121  HorizontalAlignment d_horzAlign;
122  PropertiesList d_properties;
123  };
124 
125 } // End of CEGUI namespace section
126 
127 
128 #if defined(_MSC_VER)
129 # pragma warning(pop)
130 #endif
131 
132 #endif // end of guard _CEGUIFalWidgetComponent_h_