ComponentBase.h

/***********************************************************************
    filename:   CEGUIComponentBase.h
    created:    Mon Jul 18 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 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 "CEGUI/falagard/Dimensions.h"
#include "CEGUI/Window.h"
#include "CEGUI/ColourRect.h"

namespace CEGUI
{
class CEGUIEXPORT FalagardComponentBase :
    public AllocatedObject<FalagardComponentBase>
{
public:
    FalagardComponentBase();
    virtual ~FalagardComponentBase();

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

    void render(Window& srcWindow, const Rectf& baseRect,
                const CEGUI::ColourRect* modColours = 0,
                const Rectf* 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);

    virtual bool handleFontRenderSizeChange(Window& window,
                                            const Font* font) const;

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

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

    bool writeColoursXML(XMLSerializer& xml_stream) const;

    ComponentArea d_area;
    ColourRect d_colours;
    String d_colourPropertyName;
};

}

#endif