• Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List

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 {
00049 class CEGUIEXPORT ClippedContainer : public Window
00050 {
00051 public:
00052     /*************************************************************************
00053         Constants
00054     *************************************************************************/
00055     static const String WidgetTypeName;     
00056     static const String EventNamespace;     
00057 
00058     /*************************************************************************
00059         Object construction and destruction
00060     *************************************************************************/
00065     ClippedContainer(const String& type, const String& name);
00066 
00071     ~ClippedContainer(void);
00072 
00073     /*************************************************************************
00074         Public interface methods
00075     *************************************************************************/
00083     const Rect& getClipArea(void) const;
00084 
00089     Window* getClipperWindow(void) const;
00090 
00095     void setClipArea(const Rect& r);
00096 
00105     void setClipperWindow(Window* w);
00106 
00107     // Overridden from Window.
00108     virtual Rect getUnclippedInnerRect_impl(void) const;
00109 
00110 protected:
00111     /*************************************************************************
00112         Implementation methods
00113     *************************************************************************/
00124         virtual bool    testClassName_impl(const String& class_name) const
00125         {
00126                 if (class_name=="ClippedContainer")     return true;
00127                 return Window::testClassName_impl(class_name);
00128         }
00129 
00130     /*************************************************************************
00131         Overridden from Window.
00132     *************************************************************************/
00133     virtual void drawSelf(const RenderingContext&) {}
00134 
00135     /*************************************************************************
00136         Data fields
00137     *************************************************************************/
00139     Rect d_clipArea;
00141     Window* d_clipperWindow;
00142 };
00143 
00144 } // End of  CEGUI namespace section
00145 
00146 #endif  // end of guard _CEGUIClippedContainer_h_

Generated on Sat Sep 25 2010 02:10:33 for Crazy Eddies GUI System by  doxygen 1.7.1