CEGUIFalComponentBase.h

/***********************************************************************
    filename:   CEGUIFalComponentBase.h
    created:    Mon Jul 18 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   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 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 _CEGUIFalComponentBase_h_
#define _CEGUIFalComponentBase_h_

#include "falagard/CEGUIFalDimensions.h"
#include "CEGUIWindow.h"

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT FalagardComponentBase
    {
    public:
        FalagardComponentBase();

        virtual ~FalagardComponentBase();

        void render(Window& srcWindow, float base_z, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;

        void render(Window& srcWindow, const Rect& baseRect, float base_z, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;

        const ComponentArea& getComponentArea() const;

        void setComponentArea(const ComponentArea& area);

        const ColourRect& getColours() const;

        void setColours(const ColourRect& cols);

        void setColoursPropertySource(const String& property);

        void setColoursPropertyIsColourRect(bool setting = true);

        void setVertFormattingPropertySource(const String& property);

        void setHorzFormattingPropertySource(const String& property);

    protected:
        void initColoursRect(const Window& wnd, const ColourRect* modCols, ColourRect& cr) const;

        virtual void render_impl(Window& srcWindow, Rect& destRect, float base_z, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const = 0;

        bool writeColoursXML(XMLSerializer& xml_stream) const;

        bool writeVertFormatXML(XMLSerializer& xml_stream) const;

        bool writeHorzFormatXML(XMLSerializer& xml_stream) const;


        // data fields
        ComponentArea   d_area;                 
        ColourRect      d_colours;              
        String          d_colourPropertyName;   
        bool            d_colourProperyIsRect;  
        String          d_vertFormatPropertyName;   
        String          d_horzFormatPropertyName;   
    };
} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIFalComponentBase_h_