CEGUIWindowRenderer.h

/***********************************************************************
    filename:   CEGUIWindowRenderer.h
    created:    Jan 11 2006
    author:     Tomas Lindquist Olsen

    purpose:    Defines interface for the WindowRenderer base class
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIWindowRenderer_h_
#define _CEGUIWindowRenderer_h_

#include "CEGUIWindow.h"
#include "CEGUIProperty.h"
#include <vector>
#include <utility>

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT WindowRenderer
{
public:
    /*************************************************************************
        Constructor / Destructor
    **************************************************************************/
    WindowRenderer(const String& name, const String& class_name="Window");

    virtual ~WindowRenderer();

    /*************************************************************************
        Public interface
    **************************************************************************/
    virtual void render() = 0;

    const String& getName() const   {return d_name;}

    Window* getWindow() const       {return d_window;}

    const String& getClass() const  {return d_class;}

    const WidgetLookFeel& getLookNFeel() const;

    virtual Rect getUnclippedInnerRect() const;

    virtual void performChildWindowLayout() {}

    virtual void getRenderingContext(RenderingContext& ctx) const;

    virtual void update(float /*elapsed*/) {}

protected:
    /*************************************************************************
        Implementation methods
    **************************************************************************/
    void registerProperty(Property* property, const bool ban_from_xml);

    void registerProperty(Property* property);

    virtual void onAttach();

    virtual void onDetach();

    virtual void onLookNFeelAssigned() {}

    virtual void onLookNFeelUnassigned() {}

    void operator=(const WindowRenderer&) {}

    /*************************************************************************
        Implementation data
    **************************************************************************/
    Window* d_window;       
    const String d_name;    
    const String d_class;   

    typedef std::pair<Property*, bool> PropertyEntry;
    typedef std::vector<PropertyEntry> PropertyList;
    PropertyList d_properties;  

    // Window is friend so it can manipulate our 'd_window' member directly.
    // We don't want users fiddling with this so no public interface.
    friend class Window;
};

class CEGUIEXPORT WindowRendererFactory
{
public:
    WindowRendererFactory(const String& name) : d_factoryName(name) {}

    virtual ~WindowRendererFactory() {}

    const String& getName() const {return d_factoryName;}

    virtual WindowRenderer* create() = 0;

    virtual void destroy(WindowRenderer* wr) = 0;

protected:
    String d_factoryName;   
};

} // End of CEGUI namespace

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif // _CEGUIWindowRenderer_h_