Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
ClippedContainer.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 "../Window.h"
32 #include "../WindowFactory.h"
33 
34 #if defined(_MSC_VER)
35 # pragma warning(push)
36 # pragma warning(disable : 4251)
37 #endif
38 
39 // Start of CEGUI namespace section
40 namespace CEGUI
41 {
54 class CEGUIEXPORT ClippedContainer : public Window
55 {
56 public:
57  /*************************************************************************
58  Constants
59  *************************************************************************/
60  static const String WidgetTypeName;
61  static const String EventNamespace;
62 
63  /*************************************************************************
64  Object construction and destruction
65  *************************************************************************/
70  ClippedContainer(const String& type, const String& name);
71 
76  ~ClippedContainer(void);
77 
78  /*************************************************************************
79  Public interface methods
80  *************************************************************************/
88  const Rectf& getClipArea(void) const;
89 
94  Window* getClipperWindow(void) const;
95 
100  void setClipArea(const Rectf& r);
101 
110  void setClipperWindow(Window* w);
111 
112 protected:
113  /*************************************************************************
114  Overridden from Window.
115  *************************************************************************/
116  virtual Rectf getUnclippedInnerRect_impl(bool skipAllPixelAlignment) const;
117  virtual void drawSelf(const RenderingContext&) {}
118 
119  /*************************************************************************
120  Data fields
121  *************************************************************************/
123  Rectf d_clipArea;
125  Window* d_clipperWindow;
126 };
127 
128 } // End of CEGUI namespace section
129 
130 #if defined(_MSC_VER)
131 # pragma warning(pop)
132 #endif
133 
134 #endif // end of guard _CEGUIClippedContainer_h_