CEGUIClippedContainer.h

00001 /***********************************************************************
00002         filename:       CEGUIClippedContainer.h
00003         created:        Sun Jun 11 2006
00004         author:         Tomas Lindquist Olsen
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIClippedContainer_h_
00029 #define _CEGUIClippedContainer_h_
00030 
00031 #include "CEGUIWindow.h"
00032 #include "CEGUIWindowFactory.h"
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00042 class CEGUIEXPORT ClippedContainer : public Window
00043 {
00044 public:
00045     /*************************************************************************
00046         Constants
00047     *************************************************************************/
00048     static const String WidgetTypeName;     
00049     static const String EventNamespace;     
00050 
00051     /*************************************************************************
00052         Object construction and destruction
00053     *************************************************************************/
00058     ClippedContainer(const String& type, const String& name);
00059 
00064     ~ClippedContainer(void);
00065 
00066     /*************************************************************************
00067         Public interface methods
00068     *************************************************************************/
00076     const Rect& getClipArea(void) const;
00077 
00082     Window* getClipperWindow(void) const;
00083 
00088     void setClipArea(const Rect& r);
00089 
00098     void setClipperWindow(Window* w);
00099 
00100     // Overridden from Window.
00101     virtual Rect getUnclippedInnerRect_impl(void) const;
00102 
00103 protected:
00104     /*************************************************************************
00105         Implementation methods
00106     *************************************************************************/
00117         virtual bool    testClassName_impl(const String& class_name) const
00118         {
00119                 if (class_name=="ClippedContainer")     return true;
00120                 return Window::testClassName_impl(class_name);
00121         }
00122 
00123     /*************************************************************************
00124         Overridden from Window.
00125     *************************************************************************/
00126     virtual void drawSelf(float) {}
00127 
00128     /*************************************************************************
00129         Data fields
00130     *************************************************************************/
00132     Rect d_clipArea;
00134     Window* d_clipperWindow;
00135 };
00136 
00137 } // End of  CEGUI namespace section
00138 
00139 #endif  // end of guard _CEGUIClippedContainer_h_

Generated on Sun Nov 5 14:35:28 2006 for Crazy Eddies GUI System by  doxygen 1.4.7