guiMouseEventCtrl.h

Engine/source/gui/utility/guiMouseEventCtrl.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUIMOUSEEVENTCTRL_H_
25#define _GUIMOUSEEVENTCTRL_H_
26
27#ifndef _GUICONTROL_H_
28#include "gui/core/guiControl.h"
29#endif
30
31
32class GuiMouseEventCtrl : public GuiControl
33{
34   private:
35      typedef  GuiControl     Parent;
36      void sendMouseEvent(const char * name, const GuiEvent &);
37
38      // field info
39      bool        mLockMouse;
40
41   public:
42
43      GuiMouseEventCtrl();
44
45      DECLARE_CALLBACK( void, onMouseDown, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
46      DECLARE_CALLBACK( void, onMouseUp, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
47      DECLARE_CALLBACK( void, onMouseMove, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
48      DECLARE_CALLBACK( void, onMouseDragged, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
49      DECLARE_CALLBACK( void, onMouseEnter, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
50      DECLARE_CALLBACK( void, onMouseLeave, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
51      DECLARE_CALLBACK( void, onRightMouseDown, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
52      DECLARE_CALLBACK( void, onRightMouseUp, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
53      DECLARE_CALLBACK( void, onRightMouseDragged, ( S32 modifier, Point2I mousePoint, S32 mouseClickCount ));
54
55      // GuiControl
56      void onMouseDown(const GuiEvent & event);
57      void onMouseUp(const GuiEvent & event);
58      void onMouseMove(const GuiEvent & event);
59      void onMouseDragged(const GuiEvent & event);
60      void onMouseEnter(const GuiEvent & event);
61      void onMouseLeave(const GuiEvent & event);
62      void onRightMouseDown(const GuiEvent & event);
63      void onRightMouseUp(const GuiEvent & event);
64      void onRightMouseDragged(const GuiEvent & event);
65
66      static void initPersistFields();
67
68      DECLARE_CONOBJECT( GuiMouseEventCtrl );
69      DECLARE_CATEGORY( "Gui Other Script" );
70      DECLARE_DESCRIPTION( "A control that relays all mouse events to script." );
71};
72
73#endif
74