OSDLTextWidget.h

Go to the documentation of this file.

#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 ) throw( VideoException ) ;
                                
                            
                    virtual ~TextWidget() throw() ;
                            
                            
                    virtual void setText( const std::string & newText ) 
                        throw() ;
                    
                    
                    virtual const std::string & getText() const throw() ;
                    
                    
                    virtual Text::TextIndex getRenderIndex() const throw() ;
                    
                    
                    virtual void redrawBackBuffer() throw() ;
            
                    
                    virtual const std::string toString( 
                            Ceylan::VerbosityLevels level = Ceylan::high ) 
                        const throw() ;
                
                    
                                            
                protected:
                        

                    virtual void updateClientArea() throw() ;


                    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 ) throw() ;
            
            
                    TextWidget & operator = ( const TextWidget & source )
                        throw() ;
                    
                    
            } ;         
                                            
        }
    
    }

}               


#endif // OSDL_TEXT_WIDGET_H_

---