label_widget.hpp

//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2009-2015 Marianne Gagnon
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 
 
#ifndef HEADER_LABEL_HPP
#define HEADER_LABEL_HPP
 
#include <irrString.h>
#include <SColor.h>
 
#include "guiengine/widget.hpp"
#include "utils/leak_check.hpp"
#include "utils/ptr_vector.hpp"
 
namespace irr
{
    namespace gui { class IGUIFont; }
}
 
namespace GUIEngine
{
    class LabelWidget : public Widget
    {
    public:
        
        enum LabelType
        {
            NORMAL,
            BRIGHT,
            TITLE,
            SMALL_TITLE,
            TINY_TITLE,
            COUNT
        };
        
    private:
        
        LabelType         m_type;
        irr::video::SColor m_color;
        bool               m_has_color;
        bool               m_expand_if_needed;
        bool               m_word_wrap;
 
        irr::gui::IGUIFont* getCurrentFont() const;
        void updateExpandedText(const irr::core::stringw& text);
 
        float              m_scroll_speed;
 
        float              m_per_character_size;
 
        float              m_scroll_offset;
 
        // Hide overloaded methods
        using Widget::setText;
 
    public:
        
        LEAK_CHECK()
        
        
        LabelWidget(LabelType type = NORMAL);
        
        virtual ~LabelWidget() {}
        
        virtual void add();
 
        void     setColor(const irr::video::SColor& color);
        void     setErrorColor();
        void     setDefaultColor();
        
        virtual void update(float dt);
                
        virtual void setText(const irr::core::stringw& text, bool expandAsNeeded);
 
        // --------------------------------------------------------------------
        
        void setScrollSpeed(float speed);
        
        // --------------------------------------------------------------------
        float getScrollSpeed() const { return m_scroll_speed; }
        // --------------------------------------------------------------------
        bool scrolledOff() const;
 
        virtual void resize();
    };
}
 
#endif