OSDLBackBufferedWidget.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_BACK_BUFFERED_WIDGET_H_
#define OSDL_BACK_BUFFERED_WIDGET_H_


#include "OSDLWidget.h"          // for inheritance
#include "OSDLVideoTypes.h"      // for Length, etc.


#include <string>




namespace OSDL
{


    namespace Video
    {



        // A BackBufferedWidget is and owns a Surface:
        class Surface ;
        
        
        
        namespace TwoDimensional
        {

    
    
            // To locate a widget in its container:
            class Point2D ;
            
            
            

            class OSDL_DLL BackBufferedWidget : public Widget
            {
            
                    
                public:
                        
                        
            
                     BackBufferedWidget( 
                        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 ~BackBufferedWidget() throw() ;
                        
                        
                            
                    virtual void resize( Length newWidth, Length newHeight, 
                        bool ignored = false ) ;
                                         


                    virtual void setBaseColorMode( 
                        BaseColorMode newBaseColorMode,
                        Pixels::ColorDefinition newBaseColor ) ;
                                                


                    virtual void redraw() ;


                                            
                    virtual void redrawInternal() ;
            
            
            
                    virtual void redrawBackBuffer() ;
                    
                    

                    Surface & getWidgetRenderTarget() ; 

                    
                    
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                    
                    
                        
                                            
                protected:
                                            
                    
                    
                    virtual void setBackBufferRedrawState( 
                        bool needsToBeRedrawn ) ;

                
                
                    virtual bool getBackBufferRedrawState() const ;



                    Surface * _overallSurface ;
                    
                    
                    
                    
                    
                private:    



                    bool _needsBackBufferRedraw ;



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

}               



#endif // OSDL_BACK_BUFFERED_WIDGET_H_

---