Contents User Forum Source Index APIs by Task APIs by Level Data G3D::GuiTextBox Class Reference Text box for entering strings. More... #include <GuiTextBox.h> Inherits G3D::GuiControl. List of all members. Public Types enum   Update { IMMEDIATE_UPDATE, DELAYED_UPDATE } Public Member Functions const GuiCaption &  caption () const bool  enabled () const bool  focused () const bool  mouseOver () const void  moveBy (float dx, float dy) void  moveBy (const Vector2 &delta) void  moveRightOf (const GuiControl *control) const Rect2D &  rect () const void  setCaption (const GuiCaption &text) void  setEnabled (bool e) void  setFocused (bool b) void  setHeight (float h) void  setPosition (float x, float y) void  setPosition (const Vector2 &v) virtual void  setRect (const Rect2D &) void  setSize (float x, float y) void  setSize (const Vector2 &v) void  setVisible (bool b) void  setWidth (float w) GuiSkinRef  skin () const bool  visible () const Protected Member Functions void  fireActionEvent ()   GuiTextBox (GuiWindow *gui, GuiPane *parent, const GuiCaption &caption, const Pointer< std::string > &value, Update update) virtual bool  onEvent (const GEvent &event) void  processRepeatKeysym () virtual void  render (RenderDevice *rd, const GuiSkinRef &skin) const void  setRepeatKeysym (SDL_keysym key) void  unsetRepeatKeysym () Protected Attributes GuiCaption  m_caption Rect2D  m_clickRect GuiCaption  m_cursor int  m_cursorPos bool  m_editing bool  m_enabled GuiWindow *  m_gui RealTime  m_keyDownTime RealTime  m_keyRepeatTime std::string  m_oldValue GuiPane *  m_parent Rect2D  m_rect SDL_keysym  m_repeatKeysym Update  m_update std::string  m_userValue Pointer< std::string >  m_value bool  m_visible Friends class  GuiPane class  GuiWindow Detailed Description Text box for entering strings. Fires a G3D::GuiEvent of type G3D::GEventType::GUI_ACTION on the containing window when the contents change or when the box loses focus, depending on how it is configured. Member Enumeration Documentation enum G3D::GuiTextBox::Update IMMEDIATE_UPDATE - Update the string and fire a GUI_ACTION every time the text is changed DELAYED_UPDATE - Wait until the box loses focus to fire an event and update the string. Enumerator: IMMEDIATE_UPDATE  DELAYED_UPDATE  Constructor & Destructor Documentation G3D::GuiTextBox::GuiTextBox ( GuiWindow *  gui, GuiPane *  parent, const GuiCaption &  caption, const Pointer< std::string > &  value, Update  update   ) [protected] Called by GuiPane. Member Function Documentation const GuiCaption& G3D::GuiControl::caption (  )  const [inherited] bool G3D::GuiControl::enabled (  )  const [inherited] void G3D::GuiControl::fireActionEvent (  )  [protected, inherited] Fires an action event. bool G3D::GuiControl::focused (  )  const [inherited] bool G3D::GuiControl::mouseOver (  )  const [inherited] void G3D::GuiControl::moveBy ( float  dx, float  dy   ) [inherited] void G3D::GuiControl::moveBy ( const Vector2 &  delta  )  [inherited] void G3D::GuiControl::moveRightOf ( const GuiControl *  control  )  [inherited] If these two controls have the same parent, move this one immediately to the right of the argument. virtual bool G3D::GuiTextBox::onEvent ( const GEvent &  event  )  [protected, virtual] Events are only delivered to a control when the control that control has the key focus (which is transferred during a mouse down). Reimplemented from G3D::GuiControl. void G3D::GuiTextBox::processRepeatKeysym (  )  [protected] Called from render and onEvent to enact the action triggered by the repeat key. const Rect2D& G3D::GuiControl::rect (  )  const [inherited] virtual void G3D::GuiTextBox::render ( RenderDevice *  rd, const GuiSkinRef &  skin   ) const [protected, virtual] Called by GuiPane. Implements G3D::GuiControl. void G3D::GuiControl::setCaption ( const GuiCaption &  text  )  [inherited] void G3D::GuiControl::setEnabled ( bool  e  )  [inherited] void G3D::GuiControl::setFocused ( bool  b  )  [inherited] Grab or release keyboard focus. void G3D::GuiControl::setHeight ( float  h  )  [inherited] void G3D::GuiControl::setPosition ( float  x, float  y   ) [inherited] void G3D::GuiControl::setPosition ( const Vector2 &  v  )  [inherited] virtual void G3D::GuiTextBox::setRect ( const Rect2D &  rect  )  [virtual] If you explicitly change the rectangle of a control, the containing pane may clip its borders. Call pack() on the containing pane (or window) to resize that container appropriately. Reimplemented from G3D::GuiControl. void G3D::GuiTextBox::setRepeatKeysym ( SDL_keysym  key  )  [protected] Called from onEvent when a key is pressed. void G3D::GuiControl::setSize ( float  x, float  y   ) [inherited] void G3D::GuiControl::setSize ( const Vector2 &  v  )  [inherited] void G3D::GuiControl::setVisible ( bool  b  )  [inherited] void G3D::GuiControl::setWidth ( float  w  )  [inherited] GuiSkinRef G3D::GuiControl::skin (  )  const [inherited] void G3D::GuiTextBox::unsetRepeatKeysym (  )  [protected] Called from onEvent when the repeat key is released. bool G3D::GuiControl::visible (  )  const [inherited] Friends And Related Function Documentation friend class GuiPane [friend] Reimplemented from G3D::GuiControl. friend class GuiWindow [friend] Reimplemented from G3D::GuiControl. Member Data Documentation GuiCaption G3D::GuiControl::m_caption [protected, inherited] Rect2D G3D::GuiControl::m_clickRect [protected, inherited] Rect bounds used for mouse actions. Updated by setRect. GuiCaption G3D::GuiTextBox::m_cursor [protected] String to be used as the cursor character. int G3D::GuiTextBox::m_cursorPos [protected] Character position in m_editContents of the cursor. bool G3D::GuiTextBox::m_editing [protected] True if currently being edited, that is, if the user has changed the string more recently than the program has changed it. bool G3D::GuiControl::m_enabled [protected, inherited] GuiWindow* G3D::GuiControl::m_gui [protected, inherited] The window that ultimately contains this control. RealTime G3D::GuiTextBox::m_keyDownTime [protected] Time at which setRepeatKeysym was called. RealTime G3D::GuiTextBox::m_keyRepeatTime [protected] Time at which the key will repeat (if down). std::string G3D::GuiTextBox::m_oldValue [protected] Original value before the user started editing. This is used to detect changes in m_value while the user is editing. GuiPane* G3D::GuiControl::m_parent [protected, inherited] Parent pane. Rect2D G3D::GuiControl::m_rect [protected, inherited] Rect bounds used for rendering and layout. Relative to the enclosing pane's clientRect. SDL_keysym G3D::GuiTextBox::m_repeatKeysym [protected] Key that is currently auto-repeating. Update G3D::GuiTextBox::m_update [protected] std::string G3D::GuiTextBox::m_userValue [protected] The value currently being set by the user. If in IMMEDIATE_UPDATE mode, this is continually synchronized with m_value. Pointer<std::string> G3D::GuiTextBox::m_value [protected] The string that this box is associated with. bool G3D::GuiControl::m_visible [protected, inherited] The documentation for this class was generated from the following file: GuiTextBox.h Hosted by