OSDLWidget.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_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 ) ;
                    
                    virtual ~RedrawRequestEvent() throw() ;
            } ;




            /* To be added later, maybe:
            class OSDL_DLL WidgetSettings : public Ceylan::TextDisplayable
            {
            
                public:
                
                    WidgetSettings() ;
                    virtual ~WidgetSettings() ;
                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 )  ;
                                
                            
                            
                     virtual ~Widget() throw() ;
                        
                        
                        
                     // Resize section.
                     
                            
                            
                     virtual void setWidth( Length newWidth ) ;
                
                
                
                     virtual void setHeight( Length newHeight ) ;
                     


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


                    virtual void setRedrawState( bool needsToBeRedrawn ) ;
                    
                                     
                                         
                    virtual void redraw() ;
                
                
                                            
                    virtual void redrawInternal() ;
            
                    
                    
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                
                
                
                    // Static section.
                
                
                
                    static Pixels::ColorDefinition GetEdgeColor() ;
                    
                    
                    
                    static void SetEdgeColor( 
                        Pixels::ColorDefinition edgeColorDef ) ;
                    
                        
                            
                                            
                protected:
                        
    
    
                    virtual void updateDecorationFlag() ;
                    
                                                
                    
                    virtual void updateClientArea() ;
                        
                        
                        
                    virtual Surface & getContainer() ;
                                
                            
                                                                
                    virtual const Surface & getConstContainer() const ;
                                                                
                    
                    
                    virtual void drawFundamentals( Surface & targetSurface ) ;
                    
                    
                    
                    virtual bool isDecorated() const ;      
                    
                    
                    
                    virtual void drawDecorations( Surface & targetSurface ) ;
                            
                            
                            
                            
                    // 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 ) ;
            
            
            
                    Widget & operator = ( const Widget & source ) ;
                    
                    
            } ; 
                    
                                            
        }
    
    }

}               



#endif // OSDL_WIDGET_H_

---