OSDLMouseHandler.h

Go to the documentation of this file.

#ifndef OSDL_MOUSE_HANDLER_H_
#define OSDL_MOUSE_HANDLER_H_



#include "OSDLInputDeviceHandler.h"   // for inheritance
#include "OSDLMouseCommon.h"          // for MouseNumber, etc.


#include <string>
#include <list>


namespace OSDL
{


    namespace MVC
    {

        /*
         * The mouse handler can propagate mouse events to the relevant
         * controllers.
         *
         */
        class Controller ;
    
    }

        
    namespace Events
    {
    
    
        // Manages mice.
        class Mouse ;
        
        
        
        class OSDL_DLL MouseHandler : public InputDeviceHandler
        {
        

            /*
             * The events module has to trigger the mouse event callbacks
             * of this mouse handler.
             *
             */
            friend class OSDL::Events::EventsModule ;

            
            public:



                explicit MouseHandler( bool useClassicalMice = true )
                    throw( InputDeviceHandlerException ) ;
                
                
                virtual ~MouseHandler() throw() ;


                virtual void linkToController( 
                        OSDL::MVC::Controller & controller ) 
                    throw( MouseException ) ;
                 
    
                virtual void linkToController( MouseNumber index,
                        OSDL::MVC::Controller & controller ) 
                    throw( MouseException ) ;
                 
            
                virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) 
                    const throw() ;
                
                
                
                // Static section.
                
                 
                static MouseNumber GetAvailableMiceCount() throw() ;
                
                
                
                
        protected :
                        
                    
                /*
                 * Event-driven callbacks for input propagation, from
                 * the Events module to this handler.
                 *
                 */
            
                    
                virtual void focusGained( 
                    const FocusEvent & mouseFocusEvent ) const throw() ;
                
                
                virtual void focusLost( 
                    const FocusEvent & mouseFocusEvent ) const throw() ;
                 
                        
                            
                virtual void mouseMoved( 
                    const MouseMotionEvent & mouseMovedEvent ) const throw() ;
                
                            
                virtual void buttonPressed( 
                        const MouseButtonEvent & mouseButtonPressedEvent )  
                    const throw() ;
                        
                            
                virtual void buttonReleased( 
                        const MouseButtonEvent & mouseButtonReleasedEvent ) 
                    const throw() ;



                virtual void blank() throw() ;

                
                virtual void checkMouseAt( MouseNumber index ) const throw() ;
                

                MouseNumber _miceCount ;
                
                 
                Mouse ** _mice ;


                bool _useClassicalMice ;


            private:
        
        
                explicit MouseHandler( const MouseHandler & source )
                    throw() ;
            
            
                MouseHandler & operator = ( 
                    const MouseHandler & source ) throw() ;
                                        
                
        } ;
    
    }   
    
}



#endif // OSDL_MOUSE_HANDLER_H_

---