TGUI
0.7.8
|
Text box widget. More...
#include <TGUI/Widgets/TextBox.hpp>
Public Types | |
typedef std::shared_ptr< TextBox > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const TextBox > | ConstPtr |
Shared constant widget pointer. | |
Public Types inherited from tgui::Widget | |
typedef std::shared_ptr< Widget > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Widget > | ConstPtr |
Shared constant widget pointer. | |
Public Member Functions | |
TextBox (const TextBox ©) | |
Copy constructor. More... | |
TextBox & | operator= (const TextBox &right) |
Overload of assignment operator. More... | |
std::shared_ptr< TextBoxRenderer > | getRenderer () const |
Returns the renderer, which gives access to functions that determine how the widget is displayed. More... | |
virtual void | setPosition (const Layout2d &position) override |
Set the position of the widget. More... | |
virtual void | setSize (const Layout2d &size) override |
Changes the size of the text box. More... | |
virtual sf::Vector2f | getFullSize () const override |
Returns the full size of the text box. More... | |
virtual void | setFont (const Font &font) override |
Changes the font of the text in the widget. More... | |
void | setText (const sf::String &text) |
Changes the text of the text box. More... | |
void | addText (const sf::String &text) |
Appends some text to the text that was already in the text box. More... | |
sf::String | getText () const |
Returns the text of the text box. More... | |
sf::String | getSelectedText () const |
Returns the text that you currently have selected. More... | |
void | setTextSize (unsigned int size) |
Changes the character size of the text. More... | |
unsigned int | getTextSize () const |
Returns the character size of the text. More... | |
void | setMaximumCharacters (std::size_t maxChars=0) |
Changes the maximum character limit. More... | |
std::size_t | getMaximumCharacters () const |
Returns the maximum character limit. More... | |
void | setScrollbar (Scrollbar::Ptr scrollbar) |
Changes the scrollbar of the text box. More... | |
Scrollbar::Ptr | getScrollbar () |
Access the scrollbar of the text box. More... | |
void | setReadOnly (bool readOnly=true) |
Make the text box read-only or make it writable again. More... | |
bool | isReadOnly () const |
Check if the text box read-only or writable. More... | |
virtual void | setOpacity (float opacity) override |
Changes the opacity of the widget. More... | |
virtual sf::Vector2f | getWidgetOffset () const override |
Returns the distance between the position where the widget is drawn and where the widget is placed. More... | |
virtual void | setPosition (const Layout2d &position) |
set the position of the widget More... | |
void | setPosition (const Layout &x, const Layout &y) |
set the position of the widget More... | |
virtual void | setSize (const Layout2d &size) |
Changes the size of the widget. More... | |
void | setSize (const Layout &width, const Layout &height) |
Changes the size of the widget. More... | |
Public Member Functions inherited from tgui::Widget | |
Widget () | |
Default constructor. | |
Widget (const Widget ©) | |
Copy constructor. More... | |
~Widget () | |
Destructor. | |
Widget & | operator= (const Widget &right) |
Overload of assignment operator. More... | |
std::shared_ptr< WidgetRenderer > | getRenderer () const |
Returns the renderer, which gives access to functions that determine how the widget is displayed. More... | |
virtual sf::Vector2f | getAbsolutePosition () const |
Get the absolute position of the widget instead of the relative position to its parent. More... | |
virtual void | show () |
Shows the widget. More... | |
virtual void | showWithEffect (ShowAnimationType type, sf::Time duration) |
Shows the widget by introducing it with an animation. More... | |
virtual void | hide () |
Hides the widget. More... | |
virtual void | hideWithEffect (ShowAnimationType type, sf::Time duration) |
Hides the widget by making it leave with an animation. More... | |
bool | isVisible () const |
Returns true when the widget is visible. More... | |
virtual void | enable () |
Enables the widget. More... | |
virtual void | disable (bool blockMouseEvents=true) |
Disables the widget. More... | |
bool | isEnabled () const |
Returns true when the widget is enabled. More... | |
virtual void | focus () |
Focus the widget. More... | |
virtual void | unfocus () |
Unfocus the widget. More... | |
bool | isFocused () const |
Returns true when the widget is focused and false otherwise. More... | |
const std::string & | getWidgetType () const |
Returns the type of the widget. More... | |
Container * | getParent () const |
Returns a pointer to the parent widget. More... | |
float | getOpacity () const |
Returns the opacity of the widget. More... | |
virtual void | moveToFront () |
Places the widget before all other widgets. | |
virtual void | moveToBack () |
Places the widget behind all other widgets. | |
void | setToolTip (Widget::Ptr toolTip) |
Sets the tool tip that should be displayed when hovering over the widget. More... | |
Widget::Ptr | getToolTip () |
Returns the tool tip that is displayed when hovering over the widget. More... | |
std::shared_ptr< sf::Font > | getFont () const |
Returns the font associated with the widget (if any) More... | |
void | detachTheme () |
Detach the theme from the widget. More... | |
std::shared_ptr< BaseTheme > | getTheme () const |
Returns the theme to which the widget is currently connected. More... | |
std::string | getPrimaryLoadingParameter () const |
Returns the primary parameter that was passed to the loader to load this widget. More... | |
std::string | getSecondaryLoadingParameter () const |
Returns the secondary parameter that was passed to the loader to load this widget. More... | |
void | setPosition (const Layout &x, const Layout &y) |
set the position of the widget More... | |
void | setSize (const Layout &width, const Layout &height) |
Changes the size of the widget. More... | |
Public Member Functions inherited from tgui::Transformable | |
virtual | ~Transformable () |
Virtual destructor. | |
void | setPosition (const Layout &x, const Layout &y) |
set the position of the widget More... | |
sf::Vector2f | getPosition () const |
get the position of the widget More... | |
void | move (const Layout2d &offset) |
Move the widget by a given offset. More... | |
void | move (const Layout &x, const Layout &y) |
Move the widget by a given offset. More... | |
void | setSize (const Layout &width, const Layout &height) |
Changes the size of the widget. More... | |
virtual sf::Vector2f | getSize () const |
Returns the size of the widget. More... | |
void | scale (const Layout2d &factors) |
Scale the widget. More... | |
void | scale (const Layout &x, const Layout &y) |
Scale the widget. More... | |
Public Member Functions inherited from tgui::SignalWidgetBase | |
SignalWidgetBase ()=default | |
Default constructor. | |
SignalWidgetBase (const SignalWidgetBase ©) | |
Copy constructor. More... | |
SignalWidgetBase & | operator= (const SignalWidgetBase &right) |
Overload of assignment operator. More... | |
template<typename Func , typename... Args> | |
unsigned int | connect (const std::string &signalNames, Func func, Args... args) |
Connects a signal handler function to one or more signals. More... | |
template<typename Func , typename... Args> | |
unsigned int | connectEx (const std::string &signalName, Func func, Args... args) |
Connects a signal handler function to one or more signals. More... | |
void | disconnect (unsigned int id) |
Disconnects a connection. More... | |
void | disconnectAll (const std::string &signalName) |
Disconnect all connections from a certain signal. More... | |
void | disconnectAll () |
Disconnect all connections from a all signals. | |
Static Public Member Functions | |
static TextBox::Ptr | create () |
Creates a new text box widget. More... | |
static TextBox::Ptr | copy (TextBox::ConstPtr textBox) |
Makes a copy of another text box. More... | |
Protected Member Functions | |
virtual void | reload (const std::string &primary="", const std::string &secondary="", bool force=false) override |
Reload the widget. More... | |
virtual Widget::Ptr | clone () const override |
Makes a copy of the widget if you don't know its exact type. More... | |
Protected Member Functions inherited from tgui::Widget | |
void | attachTheme (std::shared_ptr< BaseTheme > theme) |
Attach a theme to the widget. More... | |
Text box widget.
Signals:
tgui::TextBox::TextBox | ( | const TextBox & | copy | ) |
Copy constructor.
copy | Instance to copy |
void tgui::TextBox::addText | ( | const sf::String & | text | ) |
Appends some text to the text that was already in the text box.
text | Text that will be added to the text that is already in the text box |
|
inlineoverrideprotectedvirtual |
Makes a copy of the widget if you don't know its exact type.
This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.
Implements tgui::Widget.
|
static |
Makes a copy of another text box.
textBox | The other text box |
|
static |
Creates a new text box widget.
|
overridevirtual |
Returns the full size of the text box.
This is the size including the borders.
Reimplemented from tgui::Transformable.
|
inline |
Returns the maximum character limit.
There is no character limit by default.
|
inline |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Scrollbar::Ptr tgui::TextBox::getScrollbar | ( | ) |
Access the scrollbar of the text box.
You should not change the scrollbar yourself
sf::String tgui::TextBox::getSelectedText | ( | ) | const |
Returns the text that you currently have selected.
|
inline |
Returns the text of the text box.
|
inline |
Returns the character size of the text.
|
overridevirtual |
Returns the distance between the position where the widget is drawn and where the widget is placed.
This is basically the width and height of the optional borders drawn around widgets.
Reimplemented from tgui::Widget.
bool tgui::TextBox::isReadOnly | ( | ) | const |
Check if the text box read-only or writable.
When the text box is read-only, you can no longer delete characters and type text. Selecting text, copying text and even calling the setText function will still work.
Overload of assignment operator.
right | Instance to assign |
|
overrideprotectedvirtual |
Reload the widget.
primary | Primary parameter for the loader |
secondary | Secondary parameter for the loader |
force | Try to only change the looks of the widget and not alter the widget itself when false |
Exception | when the connected theme could not create the widget |
When primary is an empty string the built-in white theme will be used.
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the font of the text in the widget.
font | The new font. |
When you don't call this function then the font from the parent widget will be used.
Reimplemented from tgui::Widget.
void tgui::TextBox::setMaximumCharacters | ( | std::size_t | maxChars = 0 | ) |
Changes the maximum character limit.
maxChars | The new character limit. Set it to 0 to disable the limit. |
This character limit is disabled by default.
|
overridevirtual |
Changes the opacity of the widget.
opacity | The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque. |
Reimplemented from tgui::Widget.
set the position of the widget
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).
x | New x coordinate |
y | New y coordinate |
Usage examples:
|
virtual |
set the position of the widget
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).
position | New position |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Set the position of the widget.
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).
position | New position |
Reimplemented from tgui::Widget.
void tgui::TextBox::setReadOnly | ( | bool | readOnly = true | ) |
Make the text box read-only or make it writable again.
readOnly | Should the text box be read-only? |
When the text box is read-only, you can no longer delete characters and type text. Selecting text, copying text and even calling the setText function will still work.
void tgui::TextBox::setScrollbar | ( | Scrollbar::Ptr | scrollbar | ) |
Changes the scrollbar of the text box.
scrollbar | The new scrollbar to use in the text box |
Pass a nullptr to remove the scrollbar. Note that when removing the scrollbar while there are too many items to fit in the text box then the excess items will be removed.
The scrollbar should have no parent and you should not change it yourself. The function is meant to be used like this:
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
Usage examples:
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the size of the text box.
This size does not include the borders.
size | The new size of the text box |
Reimplemented from tgui::Widget.
void tgui::TextBox::setText | ( | const sf::String & | text | ) |
Changes the text of the text box.
text | New text |
void tgui::TextBox::setTextSize | ( | unsigned int | size | ) |
Changes the character size of the text.
size | The new text size. The minimum text size is 8. |