#include <guiScrollCtrl.h>

Inheritance diagram for GuiScrollCtrl:

Public Types
enum	Region { UpArrow, DownArrow, LeftArrow, RightArrow, UpPage, DownPage, LeftPage, RightPage, VertThumb, HorizThumb, None }

enum	{ ScrollBarAlwaysOn = 0, ScrollBarAlwaysOff = 1, ScrollBarDynamic = 2 }

Public Types inherited from GuiControl
enum	horizSizingOptions { horizResizeRight = 0, horizResizeWidth, horizResizeLeft, horizResizeCenter, horizResizeRelative }

enum	vertSizingOptions { vertResizeBottom = 0, vertResizeHeight, vertResizeTop, vertResizeCenter, vertResizeRelative }

Public Member Functions
Region	findHitRegion (const Point2I &)

	GuiScrollCtrl ()

	DECLARE_CONOBJECT (GuiScrollCtrl)

void	autoScroll (Region reg)

void	scrollTo (S32 x, S32 y)

void	scrollDelta (S32 x, S32 y)

void	scrollRectVisible (RectI rect)

void	computeSizes ()

void	loadBitmapArray ()

void	addObject (SimObject *obj)
	Add an object to the group. More...

void	resize (const Point2I &newPosition, const Point2I &newExtent)

void	childResized (GuiControl *child)

Point2I	getChildPos ()

Point2I	getChildRelPos ()

Point2I	getChildExtent ()

Point2I	getContentExtent ()

Point2I	getChildMargin ()

bool	getUseScrollEvents ()

void	setUseScrollEvents (const bool &flag)

S32	getBorderThickness (void)

S32	scrollBarThickness () const

S32	scrollBarArrowBtnLength () const

bool	hasHScrollBar () const

bool	hasVScrollBar () const

bool	enabledHScrollBar () const

bool	enabledVScrollBar () const

bool	isScrolledToBottom ()

bool	wantsTabListMembership ()

bool	becomeFirstResponder ()

bool	loseFirstResponder ()

Region	getCurHitRegion (void)

bool	onKeyDown (const GuiEvent &event)

void	onMouseDown (const GuiEvent &event)

void	onMouseRepeat (const GuiEvent &event)

void	onMouseUp (const GuiEvent &event)

void	onMouseDragged (const GuiEvent &event)

bool	onMouseWheelUp (const GuiEvent &event)

bool	onMouseWheelDown (const GuiEvent &event)

bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end. More...

void	onSleep ()
	Called when this object is asked to sleep. More...

void	onPreRender ()
	Do special pre-render proecessing. More...

void	onRender (Point2I offset, const RectI &updateRect)

virtual void	drawBorder (const Point2I &offset, bool isFirstResponder)

virtual void	drawVScrollBar (const Point2I &offset)

virtual void	drawHScrollBar (const Point2I &offset)

virtual void	drawScrollCorner (const Point2I &offset)

virtual GuiControl *	findHitControl (const Point2I &pt, S32 initialLayer=-1)

Public Member Functions inherited from GuiControl
virtual void	getScrollLineSizes (U32 rowHeight, U32 columnWidth)

virtual void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)

void	awaken ()
	Called when this control and its children have been wired up. More...

void	sleep ()
	Called when this control is no more. More...

void	preRender ()
	Prerender this control and all its children. More...

virtual bool	onInputEvent (const InputEvent &event)
	General input handler. More...

virtual bool	ControlIsChild (GuiControl *child)

void	setControlProfile (GuiControlProfile *prof)

virtual void	onAction ()
	Occurs when this control performs its "action". More...

void	renderJustifiedText (Point2I offset, Point2I extent, const char *text)

void	inspectPostApply ()

void	inspectPreApply ()

void	setSizing (S32 horz, S32 vert)

void	write (Stream &stream, U32 tabStop, U32 flags)
	Overrides Parent Serialization to allow specific controls to not be saved (Dynamic Controls, etc) More...

bool	getCanSave ()
	Returns boolean specifying if a control can be serialized. More...

void	setCanSave (bool bCanSave)
	Set serialization flag. More...

bool	getCanSaveParent ()
	Returns boolean as to whether any parent of this control has the 'no serialization' flag set. More...

const Point2I &	getPosition ()
	Returns position of the control. More...

const Point2I &	getExtent ()
	Returns extents of the control. More...

const RectI &	getBounds ()
	Returns the bounds of the control. More...

const Point2I &	getMinExtent ()
	Returns minimum size the control can be. More...

const S32	getLeft ()
	Returns the X position of the control. More...

const S32	getTop ()
	Returns the Y position of the control. More...

const S32	getWidth ()
	Returns the width of the control. More...

const S32	getHeight ()
	Returns the height of the control. More...

virtual void	setVisible (bool value)

bool	isVisible ()
	Returns true if the object is visible. More...

void	setActive (bool value)

bool	isActive ()
	Returns true if this control is active. More...

bool	isAwake ()
	Returns true if this control is awake. More...

void	addObject (SimObject *obj)

void	removeObject (SimObject *obj)

GuiControl *	getParent ()
	Returns the control which owns this one. More...

GuiCanvas *	getRoot ()

Point2I	localToGlobalCoord (const Point2I &src)

Point2I	globalToLocalCoord (const Point2I &src)

virtual void	setPosition (const Point2I &newPosition)

virtual void	setExtent (const Point2I &newExtent)

virtual void	setBounds (const RectI &newBounds)

virtual void	setLeft (S32 newLeft)

virtual void	setTop (S32 newTop)

virtual void	setWidth (S32 newWidth)

virtual void	setHeight (S32 newHeight)

virtual void	parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)

virtual bool	renderTooltip (Point2I cursorPos, const char *tipText=NULL)

void	renderChildControls (Point2I offset, const RectI &updateRect)

void	setUpdateRegion (Point2I pos, Point2I ext)

virtual void	setUpdate ()
	Sets the update area of the control to encompass the whole control. More...

virtual void	onRemove ()
	Called when this object is removed. More...

virtual void	onChildRemoved (GuiControl *child)
	Called when one of this objects children is removed. More...

bool	onAdd ()
	Called when this object is added to the scene. More...

virtual void	onChildAdded (GuiControl *child)
	Called when this object has a new child. More...

virtual bool	pointInControl (const Point2I &parentCoordPoint)

bool	cursorInControl ()
	Returns true if the global cursor is inside this control. More...

void	mouseLock (GuiControl *lockingControl)

void	mouseLock ()
	Turn on mouse locking with last used lock control. More...

void	mouseUnlock ()
	Unlock the mouse. More...

bool	isMouseLocked ()
	Returns true if the mouse is locked. More...

virtual void	onMouseMove (const GuiEvent &event)

virtual void	onMouseEnter (const GuiEvent &event)

virtual void	onMouseLeave (const GuiEvent &event)

virtual void	onRightMouseDown (const GuiEvent &event)

virtual void	onRightMouseUp (const GuiEvent &event)

virtual void	onRightMouseDragged (const GuiEvent &event)

virtual void	onMiddleMouseDown (const GuiEvent &event)

virtual void	onMiddleMouseUp (const GuiEvent &event)

virtual void	onMiddleMouseDragged (const GuiEvent &event)

virtual bool	onMouseDownEditor (const GuiEvent &event, Point2I offset)

virtual bool	onMouseUpEditor (const GuiEvent &event, Point2I offset)

virtual bool	onRightMouseDownEditor (const GuiEvent &event, Point2I offset)

virtual bool	onMouseDraggedEditor (const GuiEvent &event, Point2I offset)

virtual GuiControl *	findFirstTabable ()
	Find the first tab-accessable child of this control. More...

virtual GuiControl *	findLastTabable (bool firstCall=true)

virtual GuiControl *	findPrevTabable (GuiControl *curResponder, bool firstCall=true)

virtual GuiControl *	findNextTabable (GuiControl *curResponder, bool firstCall=true)

virtual void	setFirstResponder (GuiControl *firstResponder)

virtual void	makeFirstResponder (bool value)

bool	isFirstResponder ()
	Returns true if this control is a first responder. More...

virtual void	setFirstResponder ()
	Sets this object to be a first responder. More...

void	clearFirstResponder ()
	Clears the first responder for this chain. More...

GuiControl *	getFirstResponder ()
	Returns the first responder for this chain. More...

virtual void	onLoseFirstResponder ()
	Occurs when the first responder for this chain is lost. More...

void	addAcceleratorKey ()
	Adds the accelerator key for this object to the canvas. More...

virtual void	buildAcceleratorMap ()

virtual void	acceleratorKeyPress (U32 index)

virtual void	acceleratorKeyRelease (U32 index)

virtual bool	onKeyUp (const GuiEvent &event)

virtual bool	onKeyRepeat (const GuiEvent &event)

void	messageSiblings (S32 message)
	Send a message to all siblings. More...

virtual void	onMessage (GuiControl *sender, S32 msg)

virtual void	onDialogPush ()
	Called if this object is a dialog, when it is added to the visible layers. More...

virtual void	onDialogPop ()
	Called if this object is a dialog, when it is removed from the visible layers. More...

void	setConsoleVariable (const char *variable)

void	setConsoleCommand (const char *newCmd)

const char *	getConsoleCommand ()
	Returns the name of the function bound to this GuiControl. More...

LangTable *	getGUILangTable (void)

const UTF8 *	getGUIString (S32 id)

virtual const char *	getScriptValue ()
	Returns the value of the variable bound to this object. More...

virtual void	setScriptValue (const char *value)
	Sets the value of the variable bound to this object. More...

	DECLARE_CONOBJECT (GuiControl)

	GuiControl ()

virtual	~GuiControl ()

Public Member Functions inherited from SimGroup
	~SimGroup ()

void	addObject (SimObject *, SimObjectId)

void	addObject (SimObject , const char name)

virtual SimObject *	findObject (const char *name)
	Find an object in the group. More...

bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...

	DECLARE_CONOBJECT (SimGroup)

Public Member Functions inherited from SimSet
	SimSet ()

	~SimSet ()

virtual void	onDeleteNotify (SimObject *object)

virtual U32	getTamlChildCount (void) const
	Called when Taml attempts to compile a list of children. More...

virtual SimObject *	getTamlChild (const U32 childIndex) const
	Called when Taml attempts to compile a list of children. More...

virtual void	addTamlChild (SimObject *pSimObject)
	Called when Taml attempts to populate an objects children during a read. More...

void	callOnChildren (const char method, S32 argc, const char argv[], bool executeOnChildGroups=true)

SimObject *	findObjectByInternalName (const char *internalName, bool searchChildren=false)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

void	lock ()

void	unlock ()

	DECLARE_CONOBJECT (SimSet)

void	_setVectorAssoc (const char *file, const U32 line)

virtual void	pushObject (SimObject *)

virtual void	popObject ()
	Remove an object from the end of the list. More...

void	bringObjectToFront (SimObject *obj)

void	pushObjectToBack (SimObject *obj)

SimObject *	front ()

SimObject *	first ()

SimObject *	last ()

bool	empty ()

S32	size () const

iterator	begin ()

iterator	end ()

value	operator[] (S32 index)

iterator	find (iterator first, iterator last, SimObject *obj)

iterator	find (SimObject *obj)

template<typename T >
bool	containsType (void)

virtual bool	reOrder (SimObject obj, SimObject target=0)

SimObject *	at (S32 index) const

void	deleteObjects (void)

void	clear ()

Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const

StringTableEntry	getSuperClassNamespace () const

void	setClassNamespace (const char *classNamespace)

void	setSuperClassNamespace (const char *superClassNamespace)

void	pushScriptCallbackGuard (void)

void	popScriptCallbackGuard (void)

S32	getScriptCallbackGuard (void)

Namespace *	getNamespace ()
	Return the object's namespace. More...

const char *	tabComplete (const char *prevText, S32 baseLen, bool)

virtual void	dump ()

virtual void	dumpClassHierarchy ()

SimObject *	clone (const bool copyDynamicFields)

virtual void	copyTo (SimObject *object)

template<typename T >
bool	isType (void)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)

	DECLARE_CONOBJECT (SimObject)

Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...

void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...

void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...

void	clearAllNotifications ()
	Remove all notifications for this object. More...

void	processDeleteNotifies ()
	Send out deletion notifications. More...

void	registerReference (SimObject **obj)

void	unregisterReference (SimObject **obj)

const char *	getDataField (StringTableEntry slotName, const char *array)

void	setDataField (StringTableEntry slotName, const char array, const char value)

const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)

void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)

const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)

void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)

StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)

U32	getDataFieldType (StringTableEntry slotName, const char *array)

SimFieldDictionary *	getFieldDictionary ()

void	clearDynamicFields (void)
	Clear all dynamic fields. More...

void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...

bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...

void	setInternalName (const char *newname)

StringTableEntry	getInternalName ()
	Get the internal of of this control. More...

virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...

virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...

SimObjectId	getId (void) const

StringTableEntry	getIdString (void) const

U32	getType () const

const StringTableEntry	getName (void) const

void	setId (SimObjectId id)

void	assignName (const char *name)

SimGroup *	getGroup () const

bool	isChildOfGroup (SimGroup *pGroup)

bool	isProperlyAdded () const

bool	isDeleted () const

bool	isRemoved () const

bool	isLocked ()

void	setLocked (bool b)

bool	isHidden ()

void	setHidden (bool b)

void	setProgenitorFile (const char *pFile)

StringTableEntry	getProgenitorFile (void) const

void	setPeriodicTimerID (const S32 timerID)

S32	getPeriodicTimerID (void) const

bool	isPeriodicTimerActive (void) const

bool	isSelected () const

bool	isExpanded () const

void	setSelected (bool sel)

void	setExpanded (bool exp)

void	setModDynamicFields (bool dyn)

void	setModStaticFields (bool sta)

	SimObject (const U8 namespaceLinkMask=LinkSuperClassName\|LinkClassName)

virtual	~SimObject ()

virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...

virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...

virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...

virtual void	onStaticModified (const char slotName, const char newValue=NULL)

virtual void	onEditorEnable ()
	Called when the editor is activated. More...

virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...

bool	registerObject ()

bool	registerObject (U32 id)

bool	registerObject (const char *name)

bool	registerObject (const char *name, U32 id)

void	unregisterObject ()

void	deleteObject ()

bool	addToSet (SimObjectId)

bool	addToSet (const char *)

bool	removeFromSet (SimObjectId)

bool	removeFromSet (const char *)

virtual bool	writeField (StringTableEntry fieldname, const char *value)

virtual void	writeFields (Stream &stream, U32 tabStop)

virtual void	buildFilterList ()

void	addFieldFilter (const char *fieldName)

void	removeFieldFilter (const char *fieldName)

void	clearFieldFilters ()

bool	isFiltered (const char *fieldName)

void	assignFieldsFrom (SimObject *obj)

void	assignDynamicFieldsFrom (SimObject *obj)

Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...

virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...

bool	setField (const char fieldName, const char value)
	Set the value of a field. More...

virtual	~ConsoleObject ()

const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...

AbstractClassRep::FieldList &	getModifiableFieldList ()

bool &	getDynamicGroupExpand ()

S32	getClassId (U32 netClassGroup) const

const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields ()

Static Public Member Functions inherited from GuiControl
static void	initPersistFields ()

Public Attributes
bool	stateDepressed

Region	curHitRegion

bool	disabled

S32	mForceHScrollBar

S32	mForceVScrollBar

bool	mUseConstantHeightThumb

bool	mWillFirstRespond

Public Attributes inherited from GuiControl
GuiControlProfile *	mProfile

GuiControlProfile *	mTooltipProfile

S32	mTipHoverTime

S32	mTooltipWidth

bool	mVisible

bool	mActive

bool	mAwake

bool	mSetFirstResponder

bool	mCanSave

bool	mIsContainer
	if true, then the GuiEditor can drag other controls into this one. More...

S32	mLayer

RectI	mBounds

Point2I	mMinExtent

StringTableEntry	mLangTableName

LangTable *	mLangTable

SimObjectPtr< GuiControl >	mFirstResponder

Protected Types
enum	BitmapIndices { BmpUp, BmpDown, BmpVThumbTopCap, BmpVThumb, BmpVThumbBottomCap, BmpVPage, BmpLeft, BmpRight, BmpHThumbLeftCap, BmpHThumb, BmpHThumbRightCap, BmpHPage, BmpResize, BmpCount }

enum	BitmapStates { BmpDefault = 0, BmpHilite, BmpDisabled, BmpStates }

Protected Member Functions
virtual bool	calcChildExtents ()

virtual void	calcScrollRects (void)

void	calcThumbs ()

void	scrollByRegion (Region reg)

Protected Member Functions inherited from GuiControl
const char *	execConsoleCallback ()
	Executes mConsoleCommand, and returns the result. More...

const char *	execAltConsoleCallback ()
	Executes mAltConsoleCommand, and returns the result. More...

void	setVariable (const char *value)

void	setIntVariable (S32 value)

void	setFloatVariable (F32 value)

const char *	getVariable ()
	Returns value of control's bound variable as a string. More...

S32	getIntVariable ()
	Returns value of control's bound variable as a integer. More...

F32	getFloatVariable ()
	Returns value of control's bound variable as a float. More...

Protected Attributes
RectI *	mBitmapBounds

TextureHandle	mTextureHandle

S32	mBorderThickness

Point2I	mChildMargin

S32	mScrollBarThickness

S32	mScrollBarArrowBtnLength

S32	mScrollBarDragTolerance

bool	mHBarEnabled

bool	mVBarEnabled

bool	mHasHScrollBar

bool	mHasVScrollBar

Point2I	mContentPos

Point2I	mContentExt

Point2I	mChildPos

Point2I	mChildExt

Point2I	mChildRelPos

Point2I	mChildRelPosAnchor

S32	mThumbMouseDelta

S32	mLastUpdated

S32	mHThumbSize

S32	mHThumbPos

S32	mVThumbSize

S32	mVThumbPos

S32	mBaseThumbSize

RectI	mUpArrowRect

RectI	mDownArrowRect

RectI	mLeftArrowRect

RectI	mRightArrowRect

RectI	mHTrackRect

RectI	mVTrackRect

bool	mUseScrollEvents

Protected Attributes inherited from GuiControl
S32	mHorizSizing
	Set from horizSizingOptions. More...

S32	mVertSizing
	Set from vertSizingOptions. More...

StringTableEntry	mConsoleVariable

StringTableEntry	mConsoleCommand

StringTableEntry	mAltConsoleCommand

StringTableEntry	mAcceleratorKey

StringTableEntry	mTooltip

Additional Inherited Members
Static Public Attributes inherited from GuiControl
static GuiEditCtrl *	smEditorHandle = NULL

static S32	smCursorChanged = -1
	Has this control modified the cursor? -1 or type. More...

static bool	smDesignTime = false

static GuiControl *	smPrevResponder = NULL

static GuiControl *	smCurResponder = NULL

Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)

static bool	setSuperClass (void obj, const char data)

static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)

static bool	writeInternalName (void *obj, StringTableEntry pFieldName)

static bool	setParentGroup (void obj, const char data)

static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)

static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)

static bool	writeClass (void *obj, StringTableEntry pFieldName)

static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Member Enumeration Documentation

anonymous enum

Enumerator
ScrollBarAlwaysOn
ScrollBarAlwaysOff
ScrollBarDynamic

enum BitmapIndices

protected

Enumerator
BmpUp
BmpDown
BmpVThumbTopCap
BmpVThumb
BmpVThumbBottomCap
BmpVPage
BmpLeft
BmpRight
BmpHThumbLeftCap
BmpHThumb
BmpHThumbRightCap
BmpHPage
BmpResize
BmpCount

enum BitmapStates

protected

Enumerator
BmpDefault
BmpHilite
BmpDisabled
BmpStates

enum Region

Enumerator
UpArrow
DownArrow
LeftArrow
RightArrow
UpPage
DownPage
LeftPage
RightPage
VertThumb
HorizThumb
None

Constructor & Destructor Documentation

GuiScrollCtrl ( )

Member Function Documentation

void addObject ( SimObject * obj )

virtual

Add an object to the group.

Reimplemented from SimGroup.

void autoScroll ( Region reg )

bool becomeFirstResponder ( )

bool calcChildExtents ( )

protectedvirtual

void calcScrollRects ( void )

protectedvirtual

void calcThumbs ( )

protected

void childResized ( GuiControl * child )

virtual

Called when a child control of the object is resized

Parameters

child Child object

Reimplemented from GuiControl.

void computeSizes ( )

DECLARE_CONOBJECT ( GuiScrollCtrl )

void drawBorder	(	const Point2I &	offset,
		bool	isFirstResponder
	)

virtual

void drawHScrollBar ( const Point2I & offset )

virtual

void drawScrollCorner ( const Point2I & offset )

virtual

void drawVScrollBar ( const Point2I & offset )

virtual

bool enabledHScrollBar ( ) const

inline

bool enabledVScrollBar ( ) const

inline

GuiControl * findHitControl	(	const Point2I &	pt,
		S32	initialLayer = `-1`
	)

virtual

Returns the control which the provided point is under, with layering

Parameters

pt	Point to test
initialLayer	Layer of gui objects to begin the search

Reimplemented from GuiControl.

GuiScrollCtrl::Region findHitRegion ( const Point2I & pt )

S32 getBorderThickness ( void )

inline

Point2I getChildExtent ( )

inline

Point2I getChildMargin ( )

inline

Point2I getChildPos ( )

inline

Point2I getChildRelPos ( )

inline

Point2I getContentExtent ( )

inline

Region getCurHitRegion ( void )

inline

bool getUseScrollEvents ( )

inline

bool hasHScrollBar ( ) const

inline

bool hasVScrollBar ( ) const

inline

void initPersistFields ( )

static

Initial value:

{

object->setUseScrollEvents(dAtoi(argv[2]))

bool isScrolledToBottom ( )

inline

void loadBitmapArray ( )

bool loseFirstResponder ( )

bool onKeyDown ( const GuiEvent & event )

virtual

Happens when a key is depressed

Parameters

event Event descriptor (which contains the key)

Reimplemented from GuiControl.

void onMouseDown ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

void onMouseDragged ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

void onMouseRepeat ( const GuiEvent & event )

void onMouseUp ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

bool onMouseWheelDown ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

bool onMouseWheelUp ( const GuiEvent & event )

virtual

Reimplemented from GuiControl.

void onPreRender ( )

virtual

Do special pre-render proecessing.

Reimplemented from GuiControl.

void onRender	(	Point2I	offset,
		const RectI &	updateRect
	)

virtual

Called when this control is to render itself

Parameters

offset	The location this control is to begin rendering
updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

void onSleep ( )

virtual

Called when this object is asked to sleep.

Reimplemented from GuiControl.

bool onWake ( )

virtual

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

void resize	(	const Point2I &	newPosition,
		const Point2I &	newExtent
	)

virtual

Changes the size and/or position of this control

Parameters

newPosition	New position of this control
newExtent	New size of this control

Reimplemented from GuiControl.

S32 scrollBarArrowBtnLength ( ) const

inline

S32 scrollBarThickness ( ) const

inline

void scrollByRegion ( Region reg )

protected

void scrollDelta	(	S32	x,
		S32	y
	)

void scrollRectVisible ( RectI rect )

void scrollTo	(	S32	x,
		S32	y
	)

void setUseScrollEvents ( const bool & flag )

inline

bool wantsTabListMembership ( )

Member Data Documentation

Region curHitRegion

bool disabled

S32 mBaseThumbSize

protected

RectI* mBitmapBounds

protected

S32 mBorderThickness

protected

Point2I mChildExt

protected

Point2I mChildMargin

protected

Point2I mChildPos

protected

Point2I mChildRelPos

protected

Point2I mChildRelPosAnchor

protected

Point2I mContentExt

protected

Point2I mContentPos

protected

RectI mDownArrowRect

protected

S32 mForceHScrollBar

S32 mForceVScrollBar

bool mHasHScrollBar

protected

bool mHasVScrollBar

protected

bool mHBarEnabled

protected

S32 mHThumbPos

protected

S32 mHThumbSize

protected

RectI mHTrackRect

protected

S32 mLastUpdated

protected

RectI mLeftArrowRect

protected

RectI mRightArrowRect

protected

S32 mScrollBarArrowBtnLength

protected

S32 mScrollBarDragTolerance

protected

S32 mScrollBarThickness

protected

TextureHandle mTextureHandle

protected

S32 mThumbMouseDelta

protected

RectI mUpArrowRect

protected

bool mUseConstantHeightThumb

bool mUseScrollEvents

protected

bool mVBarEnabled

protected

S32 mVThumbPos

protected

S32 mVThumbSize

protected

RectI mVTrackRect

protected

bool mWillFirstRespond

bool stateDepressed

The documentation for this class was generated from the following files:

gui/containers/guiScrollCtrl.h
gui/containers/guiScrollCtrl.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation