OSDLMouseCursor.h

Go to the documentation of this file.

#ifndef OSDL_MOUSE_CURSOR_H_
#define OSDL_MOUSE_CURSOR_H_


#include "OSDLVideoTypes.h"  // for VideoException

#include "Ceylan.h"          // for inheritance


#include <string>


// Cursor may embed an SDL cursor :
struct SDL_Cursor ;


namespace OSDL
{

    namespace Video
    {
        
        
        // 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 ) 
                        throw() ;
                        
                    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 )
                        throw( MouseCursorException ) ;
                    
                    
                        
                    MouseCursor( const Surface & cursorSurface,
                            Coordinate hotSpotAbscissa,
                            Coordinate hotSpotOrdinate )
                        throw( MouseCursorException ) ;
                        
                    
                    virtual ~MouseCursor() throw() ;
                    
                    
                    
                    CursorType getType() const throw() ;
                    
                    
                    virtual const std::string toString( 
                            Ceylan::VerbosityLevels level = Ceylan::high ) 
                        const throw() ;
                
                        
                            
                                            
                protected:
                        
                        
                    
                    CursorType _type ;
                    
                    
                    SDL_Cursor * _systemCursor ;
                    
                                        
                    
                    Length _width ;
                    
                    Length _height ;
                    
                    
                    
                    Surface * _surface ;
                    
                    
                    OpenGL::GLTexture * _texture ;
                    
                    
                    
                    Coordinate _hotSpotAbscissa ;
                    
                    Coordinate _hotSpotOrdinate ;
                    
                    
                    
                private:    


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

}               


#endif // OSDL_MOUSE_CURSOR_H_

---