OSDLMouseCursor.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_CURSOR_H_
#define OSDL_MOUSE_CURSOR_H_


#include "OSDLVideoTypes.h"  // for VideoException

#include "Ceylan.h"          // for inheritance


#include <string>




#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

// No need to include SDL header here:
struct SDL_Cursor ;

#endif //  ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 




namespace OSDL
{



    namespace Video
    {


        
        #if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 
    
        /*
         * No way of forward declaring LowLevelCursor apparently:
         * we would have liked to specify 'struct LowLevelThing ;' here and 
         * in the implementation file (.cc): 'typedef BackendThing
         * LowLevelThing' but then the compiler finds they are conflicting
         * declarations.
         *
         */
         
        typedef SDL_Cursor LowLevelCursor ;

        #else // OSDL_USES_SDL

        struct LowLevelCursor {} ;

        #endif // OSDL_USES_SDL

        
        
        // Cursor shape may be a surface.
        class Surface ;
        
        
        
        namespace OpenGL
        {
        
            // Cursor shape may be a surface.
            class GLTexture ;
        
        }
        
        
        
        
        namespace TwoDimensional
        {

    

            class OSDL_DLL MouseCursorException: public VideoException
            {
                public:
                
                    MouseCursorException( const std::string & exception )  ;
                        
                    virtual ~MouseCursorException() throw() ;
                    
            } ;




            class OSDL_DLL MouseCursor: public Ceylan::TextDisplayable
            {
            
                    
                    
                public:
                        
                    
                    
                    enum CursorType 
                    {
                    
                        SystemCursor,
                        BlittedCursor,
                        TexturedCursor
                    
                    } ;
                        
                        
                            
                    MouseCursor( 
                        Length width,
                        Length height,
                        const Ceylan::Uint8 & data,
                        const Ceylan::Uint8 & mask,
                        Coordinate hotSpotAbscissa,
                        Coordinate hotSpotOrdinate ) ;
                    
                    
                        
                    MouseCursor( 
                        const Surface & cursorSurface,
                        Coordinate hotSpotAbscissa,
                        Coordinate hotSpotOrdinate ) ;
                        
                        
                    
                    virtual ~MouseCursor() throw() ;
                    
                    
                    
                    
                    CursorType getType() const ;
                    
                    
                    
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                        
                            
                                            
                protected:
                        
                        
                        
                    CursorType _type ;
                    
                    
                    
                    LowLevelCursor * _systemCursor ;
                    
                        
                                        
                    
                    Length _width ;
                    
                    
                    Length _height ;
                    
                    
                    
                    Surface * _surface ;
                    
                    
                    
                    OpenGL::GLTexture * _texture ;
                    
                    
                    
                    
                    Coordinate _hotSpotAbscissa ;
                    
                    
                    Coordinate _hotSpotOrdinate ;
                    
                    
                    
                    
                private:    



                    explicit MouseCursor( const MouseCursor & source ) ;
            
            
            
                    MouseCursor & operator = ( const MouseCursor & source ) ;
                    
                    
            } ;
                        
                                            
        }
    
    }

}               



#endif // OSDL_MOUSE_CURSOR_H_

---