ClippedContainer.h

/***********************************************************************
        created:        Sun Jun 11 2006
        author:         Tomas Lindquist Olsen
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIClippedContainer_h_
#define _CEGUIClippedContainer_h_

#include "../Window.h"
#include "../WindowFactory.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ClippedContainer : public Window
{
public:
    /*************************************************************************
        Constants
    *************************************************************************/
    static const String WidgetTypeName;     
    static const String EventNamespace;     

    /*************************************************************************
        Object construction and destruction
    *************************************************************************/
    ClippedContainer(const String& type, const String& name);

    ~ClippedContainer(void);

    /*************************************************************************
        Public interface methods
    *************************************************************************/
    const Rectf& getClipArea(void) const;

    Window* getClipperWindow(void) const;

    void setClipArea(const Rectf& r);

    void setClipperWindow(Window* w);

protected:
    /*************************************************************************
        Overridden from Window.
    *************************************************************************/
    virtual Rectf getUnclippedInnerRect_impl(bool skipAllPixelAlignment) const;
    virtual void drawSelf(const RenderingContext&) {}

    /*************************************************************************
        Data fields
    *************************************************************************/
    Rectf d_clipArea;
    Window* d_clipperWindow;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIClippedContainer_h_