SectionSpecification.h

/***********************************************************************
    created:    Mon Jun 13 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 _CEGUIFalSectionSpecification_h_
#define _CEGUIFalSectionSpecification_h_

#include "../Window.h"
#include "../ColourRect.h"


// Start of CEGUI namespace section
namespace CEGUI
{
    // forward refs
    class WidgetLookFeel;

    class CEGUIEXPORT SectionSpecification :
        public AllocatedObject<SectionSpecification>
    {
    public:
        SectionSpecification();

        SectionSpecification(const String& owner, const String& sectionName,
                             const String& controlPropertySource,
                             const String& controlPropertyValue,
                             const String& controlPropertyWidget);

        SectionSpecification(const String& owner, const String& sectionName,
                             const String& controlPropertySource,
                             const String& controlPropertyValue,
                             const String& controlPropertyWidget,
                             const ColourRect& cols);

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

        void render(Window& srcWindow, const Rectf& baseRect, const ColourRect* modcols = 0, const Rectf* clipper = 0, bool clipToDisplay = false) const;

        const String& getOwnerWidgetLookFeel() const;

        void setOwnerWidgetLookFeel(const String& owner);

        const String& getSectionName() const;
        void setSectionName(const String& name);

        const ColourRect& getOverrideColours() const;

        void setOverrideColours(const ColourRect& cols);

        bool isUsingOverrideColours() const;

        void setUsingOverrideColours(bool setting = true);
        const String& getOverrideColoursPropertySource() const;

        void setOverrideColoursPropertySource(const String& property);

        const String& getRenderControlPropertySource() const;

        void setRenderControlPropertySource(const String& property);

        const String& getRenderControlValue() const;

        void setRenderControlValue(const String& value);

        const String& getRenderControlWidget() const;

        void setRenderControlWidget(const String& widget);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

    protected:
        void initColourRectForOverride(const Window& wnd, ColourRect& cr) const;

        bool shouldBeDrawn(const Window& wnd) const;

    private:
        String          d_owner;                
        String          d_sectionName;          
        ColourRect      d_coloursOverride;      
        bool            d_usingColourOverride;  
        String          d_colourPropertyName;   

        String d_renderControlProperty;
        String d_renderControlValue;
        String d_renderControlWidget;
    };


} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIFalSectionSpecification_h_