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

#include <guiScrollCtrl_ScriptBinding.h>

Inherits GuiControl.

Public Member Functions

void computeSizes ()"
 
S32 getScrollPositionX ()"
 
S32 getScrollPositionY ()"
 
void scrollToBottom ()"
 
void scrollToLeft ()"
 
void scrollToRight ()"
 
void scrollToTop ()"
 
void setArrowProfile (GuiControlProfile p)
 
void setScrollPosition (x, y)"
 
void setThumbProfile (GuiControlProfile p)
 
void setTrackProfile (GuiControlProfile p)
 
- 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

◆ computeSizes()

void computeSizes ( )

Refreshes all the contents of the scroll container.

Returns
No return value.

◆ getScrollPositionX()

S32 getScrollPositionX ( )

Gets the current horizontal scroll position.

Returns
The position of the content in the horizontal direction.

◆ getScrollPositionY()

S32 getScrollPositionY ( )

Gets the current vertical scroll position.

Returns
The position of the content in the vertical direction.

◆ scrollToBottom()

void scrollToBottom ( )

Scrolls the content area to the bottom.

Returns
No return value.
See also
scrollToTop
scrollToLeft
scrollToRight
scrollToPosition

◆ scrollToLeft()

void scrollToLeft ( )

Scrolls the content area to the left.

Returns
No return value.
See also
scrollToTop
scrollToBottom
scrollToRight
scrollToPosition

◆ scrollToRight()

void scrollToRight ( )

Scrolls the content area to the right.

Returns
No return value.
See also
scrollToTop
scrollToBottom
scrollToLeft
scrollToPosition

◆ scrollToTop()

void scrollToTop ( )

Scrolls the content area to the top.

Returns
No return value.
See also
scrollToBottom
scrollToLeft
scrollToRight
scrollToPosition

◆ setArrowProfile()

void setArrowProfile ( GuiControlProfile  p)

Sets the currently used ArrowProfile for the GuiControl

Parameters
pThe Arrowprofile you wish to set the control to use
Returns
No return value

◆ setScrollPosition()

void setScrollPosition ( ,
 
)

Scrolls the content area to the specified position.

Parameters
xThe horizontal target position.
yThe vertical target position.
Returns
No return value.

◆ setThumbProfile()

void setThumbProfile ( GuiControlProfile  p)

Sets the currently used ThumbProfile for the GuiControl

Parameters
pThe Thumbprofile you wish to set the control to use
Returns
No return value

◆ setTrackProfile()

void setTrackProfile ( GuiControlProfile  p)

Sets the currently used TrackProfile for the GuiControl

Parameters
pThe Trackprofile you wish to set the control to use
Returns
No return value