|  | OGRE 14.3
    Object-Oriented Graphics Rendering Engine | 
Scrollable text box widget. More...
#include <OgreTrays.h>
 Inheritance diagram for OgreBites::TextBox:
 Inheritance diagram for OgreBites::TextBox:| Public Member Functions | |
| TextBox (const Ogre::String &name, const Ogre::DisplayString &caption, Ogre::Real width, Ogre::Real height) | |
| Do not instantiate any widgets directly. Use TrayManager. | |
| void | _cursorMoved (const Ogre::Vector2 &cursorPos, float wheelDelta) override | 
| void | _cursorPressed (const Ogre::Vector2 &cursorPos) override | 
| void | _cursorReleased (const Ogre::Vector2 &cursorPos) override | 
| void | _focusLost () override | 
| void | appendText (const Ogre::DisplayString &text) | 
| void | clearText () | 
| const Ogre::DisplayString & | getCaption () | 
| unsigned int | getHeightInLines () | 
| Gets how many lines of text can fit in this window. | |
| Ogre::Real | getPadding () | 
| Ogre::Real | getScrollPercentage () | 
| Gets how far scrolled down the text is as a percentage. | |
| const Ogre::DisplayString & | getText () | 
| void | refitContents () | 
| Makes adjustments based on new padding, size, or alignment info. | |
| void | setCaption (const Ogre::DisplayString &caption) | 
| void | setPadding (Ogre::Real padding) | 
| void | setScrollPercentage (Ogre::Real percentage) | 
| Sets how far scrolled down the text is as a percentage. | |
| void | setText (const Ogre::DisplayString &text) | 
| Sets text box content. | |
| void | setTextAlignment (Ogre::TextAreaOverlayElement::Alignment ta) | 
| Sets text box content horizontal alignment. | |
|  Public Member Functions inherited from OgreBites::Widget | |
| Widget () | |
| virtual | ~Widget () | 
| void | _assignListener (TrayListener *listener) | 
| void | _assignToTray (TrayLocation trayLoc) | 
| void | cleanup () | 
| const Ogre::String & | getName () | 
| Ogre::OverlayElement * | getOverlayElement () | 
| TrayLocation | getTrayLocation () | 
| void | hide () | 
| bool | isVisible () | 
| void | show () | 
| Additional Inherited Members | |
|  Static Public Member Functions inherited from OgreBites::Widget | |
| static Ogre::Vector2 | cursorOffset (Ogre::OverlayElement *element, const Ogre::Vector2 &cursorPos) | 
| Static utility method used to get the cursor's offset from the center of an overlay element in pixels. | |
| static void | fitCaptionToArea (const Ogre::DisplayString &caption, Ogre::TextAreaOverlayElement *area, Ogre::Real maxWidth) | 
| Static utility method to cut off a string to fit in a text area. | |
| static Ogre::Real | getCaptionWidth (const Ogre::DisplayString &caption, Ogre::TextAreaOverlayElement *area) | 
| Static utility method used to get the width of a caption in a text area. | |
| static bool | isCursorOver (Ogre::OverlayElement *element, const Ogre::Vector2 &cursorPos, Ogre::Real voidBorder=0) | 
| Static utility method to check if the cursor is over an overlay element. | |
| static void | nukeOverlayElement (Ogre::OverlayElement *element) | 
| Static utility method to recursively delete an overlay element plus all of its children from the system. | |
Scrollable text box widget.
| OgreBites::TextBox::TextBox | ( | const Ogre::String & | name, | 
| const Ogre::DisplayString & | caption, | ||
| Ogre::Real | width, | ||
| Ogre::Real | height ) | 
Do not instantiate any widgets directly. Use TrayManager.
| void OgreBites::TextBox::setPadding | ( | Ogre::Real | padding | ) | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Referenced by appendText().
| void OgreBites::TextBox::setText | ( | const Ogre::DisplayString & | text | ) | 
Sets text box content.
Most of this method is for wordwrap.
Referenced by appendText(), and clearText().
| void OgreBites::TextBox::setTextAlignment | ( | Ogre::TextAreaOverlayElement::Alignment | ta | ) | 
Sets text box content horizontal alignment.
| 
 | inline | 
References setText().
| 
 | inline | 
| void OgreBites::TextBox::refitContents | ( | ) | 
Makes adjustments based on new padding, size, or alignment info.
| void OgreBites::TextBox::setScrollPercentage | ( | Ogre::Real | percentage | ) | 
Sets how far scrolled down the text is as a percentage.
| 
 | inline | 
Gets how far scrolled down the text is as a percentage.
| 
 | inline | 
Gets how many lines of text can fit in this window.
| 
 | overridevirtual | 
Reimplemented from OgreBites::Widget.
| 
 | inlineoverridevirtual | 
Reimplemented from OgreBites::Widget.
| 
 | overridevirtual | 
Reimplemented from OgreBites::Widget.
| 
 | inlineoverridevirtual | 
Reimplemented from OgreBites::Widget.