ChatBox.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef TGUI_CHAT_BOX_HPP
#define TGUI_CHAT_BOX_HPP


#include <TGUI/Widget.hpp>


namespace tgui
{
 class Panel;
 class Scrollbar;


 class TGUI_API ChatBox : public Widget, public WidgetBorders
 {
 public:

 typedef SharedWidgetPtr<ChatBox> Ptr;

 ChatBox();


 ChatBox(const ChatBox& copy);


 virtual ~ChatBox();


 ChatBox& operator= (const ChatBox& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual ChatBox* clone();


 bool load(const std::string& configFileFilename, const std::string& sectionName = "ChatBox");


 const std::string& getLoadedConfigFile() const;


 void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 virtual sf::Vector2f getFullSize() const;


 void addLine(const sf::String& text);


 void addLine(const sf::String& text, unsigned int textSize);


 void addLine(const sf::String& text, const sf::Color& color);


 void addLine(const sf::String& text, const sf::Color& color, unsigned int textSize, const sf::Font* font = nullptr);


 sf::String getLine(unsigned int lineIndex);


 bool removeLine(unsigned int lineIndex);


 void removeAllLines();


 unsigned int getLineAmount();


 void setLineLimit(unsigned int maxLines);


 void setTextFont(const sf::Font& font);


 const sf::Font* getTextFont() const;


 void setTextSize(unsigned int size);


 unsigned int getTextSize() const;


 void setTextColor(const sf::Color& color);


 const sf::Color& getTextColor() const;


 virtual void setBorders(unsigned int leftBorder = 0,
 unsigned int topBorder = 0,
 unsigned int rightBorder = 0,
 unsigned int bottomBorder = 0);


 void setBackgroundColor(const sf::Color& backgroundColor);


 void setBorderColor(const sf::Color& borderColor);


 const sf::Color& getBackgroundColor() const;


 const sf::Color& getBorderColor() const;


 void setLineSpacing(unsigned int lineSpacing);


 void setLinesStartFromBottom(bool startFromBottom);


 bool setScrollbar(const std::string& scrollbarConfigFileFilename);


 void removeScrollbar();


 virtual void setTransparency(unsigned char transparency);


 virtual bool mouseOnWidget(float x, float y);

 virtual void leftMousePressed(float x, float y);

 virtual void leftMouseReleased(float x, float y);

 virtual void mouseMoved(float x, float y);

 virtual void mouseWheelMoved(int delta, int x, int y);

 virtual void mouseNotOnWidget();

 virtual void mouseNoLongerDown();


 // This function is a (slow) way to set properties on the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool setProperty(std::string property, const std::string& value);

 // This function is a (slow) way to get properties of the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool getProperty(std::string property, std::string& value) const;


 // Returns a list of all properties that can be used in setProperty and getProperty.
 // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
 virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


 private:

 // Retrieve the space of one of the lines.
 unsigned int getLineSpacing(unsigned int lineNumber);


 protected:

 // This function is called when the widget is added to a container.
 virtual void initialize(Container *const parent);


 // Update the position of the labels.
 void updateDisplayedText();


 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum ChatBoxCallbacks
 {
 AllChatBoxCallbacks = WidgetCallbacksCount - 1, 
 ChatBoxCallbacksCount = WidgetCallbacksCount
 };


 protected:

 std::string m_LoadedConfigFile;

 unsigned int m_LineSpacing;
 unsigned int m_TextSize;
 sf::Color m_TextColor;
 sf::Color m_BorderColor;

 unsigned int m_MaxLines;

 float m_FullTextHeight;

 bool m_LinesStartFromBottom;

 // The panel containing the labels
 Panel* m_Panel;

 // The scrollbar
 Scrollbar* m_Scroll;

 };

}


#endif // TGUI_TEXT_BOX_HPP