GuiPaneControl
Engine/source/gui/containers/guiPaneCtrl.h
Collapsable pane control.
Public Types
Parent
Protected Attributes
bool
Whether to display the bitmapped pane bar behind the header text, too.
String table text ID to use as caption string.
bool
If true, the pane can be collapsed and extended by clicking its header.
bool
Whether the pane is currently collapsed.
bool
bool
Public Functions
DECLARE_CATEGORY("Gui Containers" )
DECLARE_DESCRIPTION("A container that wraps <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> single child <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> displaying <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">header\n</a>" "with <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> caption above it. If enabled, the pane can be collapsed and <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">expanded\n</a>" "by clicking the header." )
bool
Return whether the pane is currently collapsed.
onMouseDown(const GuiEvent & event)
onMouseEnter(const GuiEvent & event)
onMouseLeave(const GuiEvent & event)
onMouseMove(const GuiEvent & event)
bool
onWake()
Called when this object is asked to wake up returns true if it's actually awake at the end.
bool
setCaptionID(const char * id)
setCaptionID(S32 id)
setCollapsed(bool isCollapsed)
Collapse or expand the pane.
Public Static Functions
Detailed Description
Collapsable pane control.
This class wraps a single child control and displays a header with caption above it. If you click the header it will collapse or expand. The control resizes itself based on its collapsed/expanded size.
In the GUI editor, if you just want the header you can make collapsable false. The caption field lets you set the caption. It expects a bitmap (from the GuiControlProfile) that contains two images - the first is displayed when the control is expanded and the second is displayed when it is collapsed. The header is sized based off of the first image.
Public Types
typedef GuiControl Parent
Protected Attributes
bool mBarBehindText
Whether to display the bitmapped pane bar behind the header text, too.
String mCaption
Text to display as the pane caption.
StringTableEntry mCaptionID
String table text ID to use as caption string.
bool mCollapsable
If true, the pane can be collapsed and extended by clicking its header.
bool mCollapsed
Whether the pane is currently collapsed.
bool mDepressed
bool mMouseOver
Point2I mOriginalExtents
Point2I mThumbSize
Public Functions
GuiPaneControl()
DECLARE_CATEGORY("Gui Containers" )
DECLARE_CONOBJECT(GuiPaneControl )
DECLARE_DESCRIPTION("A container that wraps <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> single child <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> displaying <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">header\n</a>" "with <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> caption above it. If enabled, the pane can be collapsed and <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">expanded\n</a>" "by clicking the header." )
getCollapsed()
Return whether the pane is currently collapsed.
onMouseDown(const GuiEvent & event)
Reimplemented from: GuiControl
onMouseEnter(const GuiEvent & event)
Reimplemented from: GuiControl
onMouseLeave(const GuiEvent & event)
Reimplemented from: GuiControl
onMouseMove(const GuiEvent & event)
Reimplemented from: GuiControl
onMouseUp(const GuiEvent & event)
Reimplemented from: GuiControl
onRender(Point2I offset, const RectI & updateRect)
Reimplemented from: GuiControl
onWake()
Reimplemented from: GuiControl
resize(const Point2I & newPosition, const Point2I & newExtent)
Reimplemented from: GuiControl
setCaptionID(const char * id)
setCaptionID(S32 id)
setCollapsed(bool isCollapsed)
Collapse or expand the pane.