Crazy Eddies GUI System  0.6.0
CEGUIClippedContainer.h
1 /***********************************************************************
2  filename: CEGUIClippedContainer.h
3  created: Sun Jun 11 2006
4  author: Tomas Lindquist Olsen
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIClippedContainer_h_
29 #define _CEGUIClippedContainer_h_
30 
31 #include "CEGUIWindow.h"
32 #include "CEGUIWindowFactory.h"
33 
34 // Start of CEGUI namespace section
35 namespace CEGUI
36 {
42 class CEGUIEXPORT ClippedContainer : public Window
43 {
44 public:
45  /*************************************************************************
46  Constants
47  *************************************************************************/
48  static const String WidgetTypeName;
49  static const String EventNamespace;
50 
51  /*************************************************************************
52  Object construction and destruction
53  *************************************************************************/
58  ClippedContainer(const String& type, const String& name);
59 
64  ~ClippedContainer(void);
65 
66  /*************************************************************************
67  Public interface methods
68  *************************************************************************/
76  const Rect& getClipArea(void) const;
77 
82  Window* getClipperWindow(void) const;
83 
88  void setClipArea(const Rect& r);
89 
98  void setClipperWindow(Window* w);
99 
100  // Overridden from Window.
101  virtual Rect getUnclippedInnerRect_impl(void) const;
102 
103 protected:
104  /*************************************************************************
105  Implementation methods
106  *************************************************************************/
117  virtual bool testClassName_impl(const String& class_name) const
118  {
119  if (class_name=="ClippedContainer") return true;
120  return Window::testClassName_impl(class_name);
121  }
122 
123  /*************************************************************************
124  Overridden from Window.
125  *************************************************************************/
126  virtual void drawSelf(float) {}
127 
128  /*************************************************************************
129  Data fields
130  *************************************************************************/
135 };
136 
137 } // End of CEGUI namespace section
138 
139 #endif // end of guard _CEGUIClippedContainer_h_