OSDLWidget.h

Go to the documentation of this file.

#ifndef OSDL_WIDGET_H_
#define OSDL_WIDGET_H_


#include "OSDLSurface.h"   // for Surface, SurfaceEvent
#include "OSDLPixel.h"     // for ColorDefinition
#include "OSDLPoint2D.h"   // for Point2D
#include "OSDLFont.h"      // for HorizontalAlignment, etc.


#include "Ceylan.h"        // for EventSource


#include <string>



namespace OSDL
{

    namespace Video
    {
        
        namespace TwoDimensional
        {

    

            class OSDL_DLL RedrawRequestEvent : public SurfaceEvent
            {
                public:
                
                    RedrawRequestEvent( Ceylan::EventSource & source ) throw() ;
                    virtual  ~RedrawRequestEvent() throw() ;
            } ;



            /* To be added later, maybe :
            class OSDL_DLL WidgetSettings : public Ceylan::TextDisplayable
            {
            
                public:
                
                    WidgetSettings() throw() ;
                    virtual ~WidgetSettings() throw() ;
                private:
                
            } ;

            */


            class OSDL_DLL Widget : public Surface, 
                public Ceylan::EventListener
            {
            
                    
                public:
                        
            
                    enum BaseColorMode { 
                        BackgroundColor, 
                        Colorkey, 
                        None, 
                        NotInitialized } ;
                    
                    
                    
                     Widget( 
                        Surface & container, 
                        const Point2D & relativePosition,
                        Length width, Length height,
                        BaseColorMode baseColorMode, 
                        Pixels::ColorDefinition baseColor,
                        const std::string & title = "",
                        bool minMaximizable = true, bool draggable = true, 
                        bool wrappable = true, bool closable = true ) 
                            throw( VideoException ) ;
                                
                            
                     virtual ~Widget() throw() ;
                        
                        
                        
                     // Resize section.
                     
                            
                     virtual void setWidth( Length newWidth ) throw() ;
                
                
                     virtual void setHeight( Length newHeight ) throw() ;
                     

                    virtual void resize( Length newWidth, Length newHeight, 
                        bool ignored = false ) throw() ;
                      
                    
                    
                    // Base color (color key and background color) section.
                    
                      
                    virtual BaseColorMode getBaseColorMode() const throw() ;   
                    
                    
                    virtual void setBaseColorMode( 
                            BaseColorMode newBaseColorMode,
                            Pixels::ColorDefinition newBaseColor ) 
                        throw( VideoException ) ;
                    
                     
                     
                    virtual Pixels::ColorDefinition getBaseColor() 
                        const throw() ;
                                            
                    
                    /*
                     * No setBaseColor since it has to be modified thanks to
                     * 'setBaseColorMode'.
                     *
                     */
                                
                                
                                     
                    virtual void setDecorationStatus( 
                        bool newDecorationStatus ) throw() ; 
                     
                     
                     
                    virtual const UprightRectangle & getClientArea() 
                        const throw() ; 
                    
                                        
                    virtual bool clean() throw() ; 
                           
                           
                    virtual void beNotifiedOf( const Ceylan::Event & newEvent )
                        throw() ;
                        

                    virtual void setRedrawState( bool needsToBeRedrawn ) 
                        throw() ;
                                     
                                         
                    virtual void redraw() throw() ;
                
                                            
                    virtual void redrawInternal() throw() ;
            
                    
                    virtual const std::string toString( 
                            Ceylan::VerbosityLevels level = Ceylan::high ) 
                        const throw() ;
                
                
                
                    // Static section.
                
                
                    static Pixels::ColorDefinition GetEdgeColor() throw() ;
                    
                    
                    static void SetEdgeColor( 
                        Pixels::ColorDefinition edgeColorDef ) throw() ;
                    
                        
                            
                                            
                protected:
                        
    
    
                    virtual void updateDecorationFlag() throw() ;
                                                
                    
                    virtual void updateClientArea() throw() ;
                        
                        
                    virtual Surface & getContainer() throw() ;
                                
                                                                
                    virtual const Surface & getConstContainer() const throw() ;
                                                                
                    
                    virtual void drawFundamentals( Surface & targetSurface )
                        throw() ;
                    
                    
                    virtual bool isDecorated() const throw() ;      
                    
                    
                    virtual void drawDecorations( Surface & targetSurface )
                        throw() ;
                            
                            
                            
                            
                    // Attributes section.      
                    
                    
                    Point2D _upperLeftCorner ;      


                    UprightRectangle _clientArea ;
                    
                                        

                    bool _decorated ;
                    
                    
                    std::string _title ;


                    bool _minMaximizable ;      

                            
                    bool _draggable ;       
                        
                                                                    
                    bool _wrappable ;       
                                                                    
                            
                    bool _closable ;        
    
    
                    bool _hasFocus ;                            
                    
                            
                    
                    BaseColorMode _baseColorMode ;
                    
                    
                    Pixels::ColorDefinition _baseColor ;
                    
                    
                    Pixels::PixelColor _actualBaseColor ;
                    
                    
                    /*
                     * Static attributes section.
                     *
                     * Most are non-const since may be modified at runtime.
                     *
                     */
                    
                    
                    static Pixels::ColorDefinition _EdgeColor ;

                    static Pixels::ColorDefinition _TitleColor ;


                    static Text::HorizontalAlignment _TitleHorizontalAlignment ;


                    static Text::VerticalAlignment _TitleVerticalAlignment ;



                    static Length _ClientOffsetWidth ;
                    

                    static Length _ClientOffsetHeight ;
                    
                

                    static Coordinate _TitleOffsetAbscissa ;
                    
                    
                    static Coordinate _TitleOffsetOrdinate ;
                    
                    
                    static Coordinate _TitleBarOffsetOrdinate ;
                    
                    
                    static std::string _DefaultTitle ;
                    
                    
                    
                private:    


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

}               


#endif // OSDL_WIDGET_H_

---