Crazy Eddie's GUI System  0.8.7
DefaultWindow.h
1 /***********************************************************************
2  created: 5/6/2004
3  author: Paul D Turner
4 
5  purpose: Interface to a default window
6 *************************************************************************/
7 /***************************************************************************
8  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining
11  * a copy of this software and associated documentation files (the
12  * "Software"), to deal in the Software without restriction, including
13  * without limitation the rights to use, copy, modify, merge, publish,
14  * distribute, sublicense, and/or sell copies of the Software, and to
15  * permit persons to whom the Software is furnished to do so, subject to
16  * the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be
19  * included in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27  * OTHER DEALINGS IN THE SOFTWARE.
28  ***************************************************************************/
29 #ifndef _CEGUIDefaultWindow_h_
30 #define _CEGUIDefaultWindow_h_
31 
32 #include "../Window.h"
33 #include "../WindowFactory.h"
34 
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
50 class CEGUIEXPORT DefaultWindow : public Window
51 {
52 public:
53  /*************************************************************************
54  Constants
55  *************************************************************************/
56  // type name for this widget
57  static const String WidgetTypeName;
58 
59 
60  /*************************************************************************
61  Construction and Destruction
62  *************************************************************************/
67  DefaultWindow(const String& type, const String& name);
68 
69 
74  virtual ~DefaultWindow(void) {}
75 
76 
77 protected:
80 
81  // overridden functions from Window base class
82  bool moveToFront_impl(bool wasClicked);
83 
84  // override the mouse event handlers
92 };
93 
94 } // End of CEGUI namespace section
95 
96 #endif // end of guard _CEGUIDefaultWindow_h_
CEGUI::DefaultWindow::moveToFront_impl
bool moveToFront_impl(bool wasClicked)
Implements move to front behavior.
CEGUI::DefaultWindow::onMouseClicked
void onMouseClicked(MouseEventArgs &e)
Handler called when a mouse button has been clicked (that is depressed and then released,...
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::MouseEventArgs
EventArgs based class that is used for objects passed to input event handlers concerning mouse input.
Definition: InputEvent.h:281
CEGUI::DefaultWindow::onMouseButtonUp
void onMouseButtonUp(MouseEventArgs &e)
Handler called when a mouse button has been released within this window's area.
CEGUI::DefaultWindow::updateMouseEventHandled
void updateMouseEventHandled(MouseEventArgs &e) const
helper to update mouse input handled state
CEGUI::DefaultWindow
Window class intended to be used as a simple, generic Window.
Definition: DefaultWindow.h:51
CEGUI::DefaultWindow::onMouseMove
void onMouseMove(MouseEventArgs &e)
Handler called when the mouse cursor has been moved within this window's area.
CEGUI::DefaultWindow::WidgetTypeName
static const String WidgetTypeName
The unique typename of this widget.
Definition: DefaultWindow.h:57
CEGUI::DefaultWindow::onMouseButtonDown
void onMouseButtonDown(MouseEventArgs &e)
Handler called when a mouse button has been depressed within this window's area.
CEGUI::DefaultWindow::DefaultWindow
DefaultWindow(const String &type, const String &name)
Constructor for DefaultWindows.
CEGUI::Window
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
CEGUI::DefaultWindow::~DefaultWindow
virtual ~DefaultWindow(void)
Destructor for DefaultWindows.
Definition: DefaultWindow.h:74
CEGUI::DefaultWindow::onMouseWheel
void onMouseWheel(MouseEventArgs &e)
Handler called when the mouse wheel (z-axis) position changes within this window's area.
CEGUI::DefaultWindow::onMouseDoubleClicked
void onMouseDoubleClicked(MouseEventArgs &e)
Handler called when a mouse button has been double-clicked within this window's area.
CEGUI::String
String class used within the GUI system.
Definition: String.h:64
CEGUI::DefaultWindow::onMouseTripleClicked
void onMouseTripleClicked(MouseEventArgs &e)
Handler called when a mouse button has been triple-clicked within this window's area.