Contents User Forum Source Index APIs by Task APIs by Level Data G3D::GuiButton Class Reference Push button that can be temporarily pressed. More... #include <GuiButton.h> Inherits G3D::GuiControl. List of all members. Public Types enum   Style { NORMAL_STYLE, TOOL_STYLE, NO_STYLE } 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 &rect) 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 ()   GuiButton (GuiWindow *gui, GuiPane *, const GuiCaption &text, Style style) virtual bool  onEvent (const GEvent &event) virtual void  render (RenderDevice *rd, const GuiSkinRef &skin) const Protected Attributes GuiCaption  m_caption Rect2D  m_clickRect bool  m_down bool  m_enabled GuiWindow *  m_gui GuiPane *  m_parent Rect2D  m_rect Style  m_style bool  m_visible Friends class  GuiPane class  GuiWindow Detailed Description Push button that can be temporarily pressed. When the button has been pressed and released, a G3D::GuiEvent of type G3D::GEventType::GUI_ACTION is fired on the containing window. See also GuiRadioButton and GuiCheckBox for creating buttons that stay down when pressed. Member Enumeration Documentation enum G3D::GuiButton::Style Controls the appearance of the button. Tool buttons are square and less 3D. They are also able to shrink to smaller sizes. The NO_STYLE creates buttons with a caption but no visible borders. Enumerator: NORMAL_STYLE  TOOL_STYLE  NO_STYLE  Constructor & Destructor Documentation G3D::GuiButton::GuiButton ( GuiWindow *  gui, GuiPane *  , const GuiCaption &  text, Style  style   ) [protected] Called by GuiWindow. 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::GuiButton::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. const Rect2D& G3D::GuiControl::rect (  )  const [inherited] virtual void G3D::GuiButton::render ( RenderDevice *  rd, const GuiSkinRef &  skin   ) const [protected, virtual] Called by GuiWindow. 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::GuiControl::setRect ( const Rect2D &  rect  )  [virtual, inherited] 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 in G3D::GuiCheckBox, G3D::GuiDropDownList, G3D::GuiPane, G3D::GuiRadioButton, and G3D::GuiTextBox. 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] 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. bool G3D::GuiButton::m_down [protected] Is the mouse currently down over this control? bool G3D::GuiControl::m_enabled [protected, inherited] GuiWindow* G3D::GuiControl::m_gui [protected, inherited] The window that ultimately contains this control. 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. Style G3D::GuiButton::m_style [protected] bool G3D::GuiControl::m_visible [protected, inherited] The documentation for this class was generated from the following file: GuiButton.h Hosted by