OSDLMouseHandler.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#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 ) ;
                
                
                
                virtual ~MouseHandler() throw() ;



                bool hasDefaultMouse() const ;
                 


                Mouse & getDefaultMouse() ;



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



                virtual void blank() ;


                
                virtual void checkMouseAt( MouseNumber index ) const ;
                
                
                

                MouseNumber _miceCount ;
                
                
                 
                Mouse ** _mice ;



                bool _useClassicalMice ;




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



#endif // OSDL_MOUSE_HANDLER_H_

---