EditBox.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_EDIT_BOX_HPP
#define TGUI_EDIT_BOX_HPP


#include <TGUI/ClickableWidget.hpp>


namespace tgui
{

 class TGUI_API EditBox : public ClickableWidget, public WidgetBorders
 {
 public:

 typedef SharedWidgetPtr<EditBox> Ptr;


 struct Alignment
 {
 enum Alignments
 {
 Left,

 Center,

 Right
 };
 };


 EditBox();


 EditBox(const EditBox& copy);


 virtual ~EditBox();


 EditBox& operator= (const EditBox& 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 EditBox* clone();


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


 const std::string& getLoadedConfigFile() const;


 virtual void setPosition(float x, float y);
 using Transformable::setPosition;


 void setSize(float width, float height);


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


 sf::String getText() const;


 void setTextSize(unsigned int textSize);


 unsigned int getTextSize() const;


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


 const sf::Font* getTextFont() const;


 void setPasswordCharacter(char passwordChar = '\0');


 char getPasswordCharacter() const;


 void setMaximumCharacters(unsigned int maxChars = 0);


 unsigned int getMaximumCharacters() const;


 void setAlignment(Alignment::Alignments alignment);


 Alignment::Alignments getAlignment();


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


 void changeColors(const sf::Color& textColor = sf::Color( 0, 0, 0),
 const sf::Color& selectedTextColor = sf::Color(255, 255, 255),
 const sf::Color& selectedTextBackgroundColor = sf::Color( 10, 110, 255),
 const sf::Color& selectionPointColor = sf::Color(110, 110, 255));


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


 void setSelectedTextColor(const sf::Color& selectedTextColor);


 void setSelectedTextBackgroundColor(const sf::Color& selectedTextBackgroundColor);


 void setSelectionPointColor(const sf::Color& selectionPointColor);


 const sf::Color& getTextColor() const;


 const sf::Color& getSelectedTextColor() const;


 const sf::Color& getSelectedTextBackgroundColor() const;


 const sf::Color& getSelectionPointColor() const;


 void limitTextWidth(bool limitWidth);


 void setSelectionPointPosition(unsigned int charactersBeforeSelectionPoint);


 void setSelectionPointWidth(unsigned int width = 2);


 unsigned int getSelectionPointWidth() const;


 void setNumbersOnly(bool numbersOnly = true);


 virtual void setTransparency(unsigned char transparency);


 virtual void leftMousePressed(float x, float y);

 virtual void mouseMoved(float x, float y);

 virtual void keyPressed(const sf::Event::KeyEvent& event);

 virtual void textEntered(sf::Uint32 Key);

 virtual void widgetUnfocused();


 // 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;


 protected:


 // This function will search where the selection point should be. It will not change the selection point.
 // It will return after which character the selection point should be.
 unsigned int findSelectionPointPosition(float PosX);


 // Removes the selected characters. This function is called when pressing backspace, delete or a letter while there were
 // some characters selected.
 void deleteSelectedCharacters();


 // Recalculates the position of the texts.
 void recalculateTextPositions();


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


 // When AnimationManager changes the elapsed time then this function is called.
 virtual void update();


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


 public:

 enum EditBoxCallbacks
 {
 TextChanged = ClickableWidgetCallbacksCount * 1, 
 ReturnKeyPressed = ClickableWidgetCallbacksCount * 2, 
 AllEditBoxCallbacks = ClickableWidgetCallbacksCount * 4 - 1, 
 EditBoxCallbacksCount = ClickableWidgetCallbacksCount * 4
 };


 protected:

 std::string m_LoadedConfigFile;

 // Is the selection point visible or not?
 bool m_SelectionPointVisible;

 // When this boolean is true then you can no longer add text when the EditBox is full.
 // Changing it to false will allow you to scroll the text (default).
 // You can change the boolean with the limitTextWidth(bool) function.
 bool m_LimitTextWidth;

 // The text inside the edit box
 sf::String m_DisplayedText;
 sf::String m_Text;

 // This will store the size of the text ( 0 to auto size )
 unsigned int m_TextSize;

 // The text alignment
 Alignment::Alignments m_TextAlignment;

 // The selection
 unsigned int m_SelChars;
 unsigned int m_SelStart;
 unsigned int m_SelEnd;

 // The password character
 char m_PasswordChar;

 // The maximum allowed characters.
 // Zero by default, meaning no limit.
 unsigned int m_MaxChars;

 // If true then the image is split in three parts
 bool m_SplitImage;

 // When the text width is not limited, you can scroll the edit box and only a part will be visible.
 unsigned int m_TextCropPosition;

 // The rectangle behind the selected text
 sf::RectangleShape m_SelectedTextBackground;

 // The flickering selection point
 sf::RectangleShape m_SelectionPoint;

 // We need three SFML texts to draw our text, and one more for calculations.
 sf::Text m_TextBeforeSelection;
 sf::Text m_TextSelection;
 sf::Text m_TextAfterSelection;
 sf::Text m_TextFull;

 Texture m_TextureNormal_L;
 Texture m_TextureNormal_M;
 Texture m_TextureNormal_R;

 Texture m_TextureHover_L;
 Texture m_TextureHover_M;
 Texture m_TextureHover_R;

 Texture m_TextureFocused_L;
 Texture m_TextureFocused_M;
 Texture m_TextureFocused_R;

 // Is there a possibility that the user is going to double click?
 bool m_PossibleDoubleClick;

 bool m_NumbersOnly;
 bool m_SeparateHoverImage;


 };

}

#endif // TGUI_EDIT_BOX_HPP