Crazy Eddies GUI System  0.7.2
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 {
49 class CEGUIEXPORT ClippedContainer : public Window
50 {
51 public:
52  /*************************************************************************
53  Constants
54  *************************************************************************/
55  static const String WidgetTypeName;
56  static const String EventNamespace;
57 
58  /*************************************************************************
59  Object construction and destruction
60  *************************************************************************/
65  ClippedContainer(const String& type, const String& name);
66 
71  ~ClippedContainer(void);
72 
73  /*************************************************************************
74  Public interface methods
75  *************************************************************************/
83  const Rect& getClipArea(void) const;
84 
89  Window* getClipperWindow(void) const;
90 
95  void setClipArea(const Rect& r);
96 
105  void setClipperWindow(Window* w);
106 
107  // Overridden from Window.
108  virtual Rect getUnclippedInnerRect_impl(void) const;
109 
110 protected:
111  /*************************************************************************
112  Implementation methods
113  *************************************************************************/
124  virtual bool testClassName_impl(const String& class_name) const
125  {
126  if (class_name=="ClippedContainer") return true;
127  return Window::testClassName_impl(class_name);
128  }
129 
130  /*************************************************************************
131  Overridden from Window.
132  *************************************************************************/
133  virtual void drawSelf(const RenderingContext&) {}
134 
135  /*************************************************************************
136  Data fields
137  *************************************************************************/
139  Rect d_clipArea;
141  Window* d_clipperWindow;
142 };
143 
144 } // End of CEGUI namespace section
145 
146 #endif // end of guard _CEGUIClippedContainer_h_
Generated by   doxygen 1.8.3.1