TorqueScript Reference
Public Member Functions | List of all members
GuiExpandCtrl Class Reference

#include <guiExpandCtrl_ScriptBinding.h>

Inherits GuiControl.

Public Member Functions

String getExpandEaseFunction ()
 
Integer getExpandEaseTime ()
 
Boolean getExpanded ()
 
void setExpandEase (EaseFunction, [EaseTime])
 
void setExpanded (bool expanded)
 
- Public Member Functions inherited from GuiControl
void addGuiControl (int controlId)
 
Integer findHitControl (int x, int y)
 
String getCenter ()
 
String getExtent (...)
 
String getGlobalCenter ()
 
String getGlobalPosition ()
 
String getMinExtent ()
 
Integer getParent ()
 
String getPosition ()
 
String getText ()
 
Boolean getTextExtend ()
 
Boolean getTextWrap ()
 
String getValue ()
 
Boolean isActive ()
 
Boolean isAwake ()
 
Boolean isVisible ()
 
void makeFirstResponder (isFirst)
 
void performClick ()
 
Boolean pointInControl (int x, int y)
 
void reorderChild (child1, child2)
 
void resize (int x, int y, int w, int h)
 
void setActive (isActive)
 
void setCanSave (bool canSave)
 
void setCenter (int x, int y)
 
void setExtent (int width, int height)
 
void setFirstResponder ()
 
void setPosition (int x, int y)
 
void setPositionGlobal (int x, int y)
 
void setProfile (GuiControlProfile p)
 
void setText (text)
 
void setTextExtend (setting)
 
void setTextID (id)
 
void setTextWrap (setting)
 
void setValue (value)
 
void setVisible (isVisible)
 

Member Function Documentation

◆ getExpandEaseFunction()

String getExpandEaseFunction ( )

Gets the name of the current easing function used for expanding and collapsing.

Returns
Name of the current easing function.

◆ getExpandEaseTime()

Integer getExpandEaseTime ( )

Gets the amount of time in milliseconds that it takes to expand or collapse.

Returns
Time in milliseconds.

◆ getExpanded()

Boolean getExpanded ( )

Gets if the extent has changed or is changing to fit all available children in the right or down directions.

Returns
True if the extent is dynamically expanded.

◆ setExpandEase()

void setExpandEase ( EaseFunction  )

Sets the easing that should be used to expand or collapse. Time in milliseconds can optionally be provided.

Parameters
EaseFunctionName of the selected easing function to use. Defaults to Linear (none).
EaseTimeOptional length of time in milliseconds that it takes to expand or collapse.
Returns
No return value.

◆ setExpanded()

void setExpanded ( bool  expanded)

Sets if the control should collapse or expand.

Parameters
expandedTrue if the Expand should expand to fit children.
Returns
No return value.