• Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List

CEGUIFalWidgetComponent.h

00001 /***********************************************************************
00002     filename:   CEGUIFalWidgetComponent.h
00003     created:    Mon Jun 13 2005
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIFalWidgetComponent_h_
00029 #define _CEGUIFalWidgetComponent_h_
00030 
00031 #include "CEGUIFalDimensions.h"
00032 #include "CEGUIFalPropertyInitialiser.h"
00033 #include "../CEGUIWindow.h"
00034 
00035 #if defined(_MSC_VER)
00036 #       pragma warning(push)
00037 #       pragma warning(disable : 4251)
00038 #endif
00039 
00040 // Start of CEGUI namespace section
00041 namespace CEGUI
00042 {
00050     class CEGUIEXPORT WidgetComponent
00051     {
00052     public:
00053         WidgetComponent() {}
00054         WidgetComponent(const String& type, const String& look, const String& suffix, const String& renderer);
00055 
00060         void create(Window& parent) const;
00061 
00062         const ComponentArea& getComponentArea() const;
00063         void setComponentArea(const ComponentArea& area);
00064 
00065         const String& getBaseWidgetType() const;
00066         void setBaseWidgetType(const String& type);
00067 
00068         const String& getWidgetLookName() const;
00069         void setWidgetLookName(const String& look);
00070 
00071         const String& getWidgetNameSuffix() const;
00072         void setWidgetNameSuffix(const String& suffix);
00073 
00074         const String& getWindowRendererType() const;
00075         void setWindowRendererType(const String& type);
00076 
00077         VerticalAlignment getVerticalWidgetAlignment() const;
00078         void setVerticalWidgetAlignment(VerticalAlignment alignment);
00079 
00080         HorizontalAlignment getHorizontalWidgetAlignment() const;
00081         void setHorizontalWidgetAlignment(HorizontalAlignment alignment);
00082 
00083         void addPropertyInitialiser(const PropertyInitialiser& initialiser);
00084         void clearPropertyInitialisers();
00085 
00086         void layout(const Window& owner) const;
00087 
00099         void writeXMLToStream(XMLSerializer& xml_stream) const;
00100 
00110         const PropertyInitialiser* findPropertyInitialiser(const String& propertyName) const;
00111 
00112     private:
00113         typedef std::vector<PropertyInitialiser> PropertiesList;
00114 
00115         ComponentArea   d_area;              
00116         String   d_baseType;                 
00117         String   d_imageryName;              
00118         String   d_nameSuffix;               
00119         String   d_rendererType;             
00120         VerticalAlignment    d_vertAlign;    
00121         HorizontalAlignment  d_horzAlign;    
00122         PropertiesList  d_properties;        
00123     };
00124 
00125 } // End of  CEGUI namespace section
00126 
00127 
00128 #if defined(_MSC_VER)
00129 #       pragma warning(pop)
00130 #endif
00131 
00132 #endif  // end of guard _CEGUIFalWidgetComponent_h_

Generated on Sat Sep 25 2010 02:10:34 for Crazy Eddies GUI System by  doxygen 1.7.1