nevrax.org : docs

00001 
+00007 /* Copyright, 2000-2002 Nevrax Ltd.
+00008  *
+00009  * This file is part of NEVRAX NEL.
+00010  * NEVRAX NEL is free software; you can redistribute it and/or modify
+00011  * it under the terms of the GNU General Public License as published by
+00012  * the Free Software Foundation; either version 2, or (at your option)
+00013  * any later version.
+00014 
+00015  * NEVRAX NEL is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+00018  * General Public License for more details.
+00019 
+00020  * You should have received a copy of the GNU General Public License
+00021  * along with NEVRAX NEL; see the file COPYING. If not, write to the
+00022  * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+00023  * MA 02111-1307, USA.
+00024  */
+00025 
+00026 #ifndef NL_MOUSE_DEVICE_H
+00027 #define NL_MOUSE_DEVICE_H
+00028 
+00029 #include "nel/misc/types_nl.h"
+00030 #include "nel/misc/input_device.h"
+00031 
+00032 
+00033 
+00034 namespace NLMISC
+00035 {
+00036 
+00037 class CRect;
+00038 
+00040 struct IMouseDevice : public IInputDevice
+00041 {
+00042         enum TAxisMode { Raw, Clamped, AxisModeLast };
+00043         enum TAxis      { XAxis = 0, YAxis = 1, AxisLast };
+00044         enum TMessageMode { NormalMode, RawMode, MessageModeLast };
+00045 
+00047 
+00048 
+00059                 virtual void                                    setMessagesMode(TMessageMode mode) = 0;
+00061                 virtual TMessageMode                    getMessagesMode() const = 0;
+00063 
+00065 
+00066 
+00070                 virtual void                                    setMouseMode(TAxis axis, TAxisMode axisMode) = 0;
+00074                 virtual TAxisMode                               getMouseMode(TAxis axis) const  = 0;
+00078                 virtual void                                    setMouseSpeed(float speed)  = 0;
+00082                 virtual float                                   getMouseSpeed() const  = 0;
+00088                 virtual void                                    setMouseFrame(const CRect &rect)  = 0;
+00101                 virtual void                                    setFactors(float xFactor, float yFactor) = 0;
+00106                 virtual float                                   getXFactor() const = 0;
+00111                 virtual float                                   getYFactor() const = 0;
+00113 
+00114         // Get the current frame used for limiting mouse movements
+00115         virtual const CRect                             &getMouseFrame() const = 0;
+00116         // Set the maximum delay for a double click to be taken in account (in ms).
+00117         virtual void                                    setDoubleClickDelay(uint ms) = 0;
+00118         // Get the maximum delay for double click (in ms)
+00119         virtual uint                                    getDoubleClickDelay() const = 0;        
+00120         // Force the position of the mouse, expressed in pixels
+00121         virtual void                                    setMousePos(float x, float y) = 0;
+00122 };
+00123 
+00124 
+00125 } // NLMISC
+00126 
+00127 
+00128 #endif // NL_MOUSE_DEVICE_H
+00129 
+00130 /* End of u_mouse_device.h */
+