Crazy Eddie's GUI System 0.8.7
ClippedContainer.h
1/***********************************************************************
2 created: Sun Jun 11 2006
3 author: Tomas Lindquist Olsen
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUIClippedContainer_h_
28#define _CEGUIClippedContainer_h_
29
30#include "../Window.h"
31#include "../WindowFactory.h"
32
33#if defined(_MSC_VER)
34# pragma warning(push)
35# pragma warning(disable : 4251)
36#endif
37
38// Start of CEGUI namespace section
39namespace CEGUI
40{
53class CEGUIEXPORT ClippedContainer : public Window
54{
55public:
56 /*************************************************************************
57 Constants
58 *************************************************************************/
59 static const String WidgetTypeName;
60 static const String EventNamespace;
61
62 /*************************************************************************
63 Object construction and destruction
64 *************************************************************************/
69 ClippedContainer(const String& type, const String& name);
70
76
77 /*************************************************************************
78 Public interface methods
79 *************************************************************************/
87 const Rectf& getClipArea(void) const;
88
94
99 void setClipArea(const Rectf& r);
100
110
111protected:
112 /*************************************************************************
113 Overridden from Window.
114 *************************************************************************/
115 virtual Rectf getUnclippedInnerRect_impl(bool skipAllPixelAlignment) const;
116 virtual void drawSelf(const RenderingContext&) {}
117
118 /*************************************************************************
119 Data fields
120 *************************************************************************/
125};
126
127} // End of CEGUI namespace section
128
129#if defined(_MSC_VER)
130# pragma warning(pop)
131#endif
132
133#endif // end of guard _CEGUIClippedContainer_h_
Helper container window that has configurable clipping. Used by the ItemListbox widget.
Definition: ClippedContainer.h:54
static const String WidgetTypeName
Type name for ClippedContainer.
Definition: ClippedContainer.h:59
Window * getClipperWindow(void) const
Returns the reference window used for converting the clipper rect to screen space.
void setClipperWindow(Window *w)
Set the clipper reference window.
ClippedContainer(const String &type, const String &name)
Constructor for ClippedContainer objects.
Window * d_clipperWindow
the base window which the clipping rect is relative to.
Definition: ClippedContainer.h:124
virtual void drawSelf(const RenderingContext &)
Perform the actual rendering for this Window.
Definition: ClippedContainer.h:116
const Rectf & getClipArea(void) const
Return the current clipping rectangle.
static const String EventNamespace
Namespace for global events.
Definition: ClippedContainer.h:60
void setClipArea(const Rectf &r)
Set the custom clipper area in pixels.
virtual Rectf getUnclippedInnerRect_impl(bool skipAllPixelAlignment) const
Default implementation of function to return Element's inner rect area.
Rectf d_clipArea
the pixel rect to be used for clipping relative to either a window or the screen.
Definition: ClippedContainer.h:122
~ClippedContainer(void)
Destructor for ClippedContainer objects.
String class used within the GUI system.
Definition: String.h:64
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
struct that holds some context relating to a RenderingSurface object.
Definition: RenderingContext.h:41