OSDLTextWidget.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_TEXT_WIDGET_H_
#define OSDL_TEXT_WIDGET_H_


#include "OSDLBackBufferedWidget.h"   // for inheritance
#include "OSDLFont.h"                 // for RenderingQuality, etc.

#include <string>




namespace OSDL
{



    namespace Video
    {
        
        
        
        namespace TwoDimensional
        {

    
    
            namespace Text
            {
        
                // TextWidget instances use fonts to render text.
                class Font ;
                
            }
            
            
            

            class OSDL_DLL TextWidget: public BackBufferedWidget
            {
            
                    
                public:
                    
                    
                    
                    enum Shape { SquareCorners, RoundCorners } ;    
            
            
            
                    static const Length DefaultEdgeWidth ;
            
                    
                    
                    
                    TextWidget( Surface & container, 
                        const Point2D & relativePosition,
                        Length width, 
                        Length maximumHeight, 
                        Shape shape,
                        Pixels::ColorDefinition textColor,
                        Pixels::ColorDefinition edgeColor,
                        Pixels::ColorDefinition backgroundColor, 
                        const std::string & text, 
                        Text::Font & font, 
                        bool minimumHeight = true,
                        bool verticallyAligned = true,
                        bool justified = true, 
                        Text::Font::RenderQuality quality = Text::Font::Blended,
                        const std::string & title = "",
                        bool minMaximizable = false, 
                        bool draggable = false, 
                        bool wrappable = false, 
                        bool closable = false ) ;
                                
                            
                            
                    virtual ~TextWidget() throw() ;
                    
                            
                            
                    virtual void setText( const std::string & newText ) ;
                    
                    
                    
                    virtual const std::string & getText() const ;
                    
                    
                    
                    virtual Text::TextIndex getRenderIndex() const ;
                    
                    
                    
                    virtual void redrawBackBuffer() ;
            
                    
                    
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                    
                    
                                            
                protected:
                        


                    virtual void updateClientArea() ;



                    static const Length _TextWidthOffset ;
                    
                    
                    static const Length _TextHeightOffset ;
                    
                    
                    
                    Length _minimumHeight ;
                    
                    
                    
                    Length _maximumHeight ;
                    
                    
                    
                    Shape _shape ;
                            
                                                                                
                    Pixels::ColorDefinition _textColor ;
                    
                    
                    Pixels::ColorDefinition _edgeColor ;
                    
                    
                    
                    Pixels::ColorDefinition _backColorForRoundCorners ;
                    
                    
                    
                    Length _roundOffset ;
                    
                     
                     
                    std::string _text ;
                    
                    
                    Text::Font * _font ;


                    
                    bool _verticallyAligned ;
                    
                    
                    bool _justified ;
                    
                    
                    
                    
                    Text::Font::RenderQuality _quality ;
                    
                    
                    
                    Text::TextIndex _currentIndex ;
                    



                private:    



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

}               



#endif // OSDL_TEXT_WIDGET_H_

---