GUI.GUIScrollText

Extends: GUIList
Modifiers: HideCategories ( Menu , Object ) native

Core.Object
|   
+-- GUI.GUI
   |   
   +-- GUI.GUIComponent
      |   
      +-- GUI.GUIListBase
         |   
         +-- GUI.GUIVertList
            |   
            +-- GUI.GUIList
               |   
               +-- GUI.GUIScrollText

Variables Summary
string	ClickedString
string	NewText
GUIScrollText
bool	bClickText
bool	bNewContent
bool	bNoTeletype
bool	bRepeat
bool	bStopped
float	CharDelay
string	Content
float	EOLDelay
float	InitialDelay
int	MaxHistory
int	oldWidth
float	RepeatDelay
eScrollState	ScrollState
string	Separator
int	VisibleChars
int	VisibleLines

Inherited Variables from GUI.GUIList
bListIsDirty, bNativeSort, bNeverSort, bSortForward, DisplayItem, Elements, TextAlign, TypeOfSort

Enumerations Summary
eScrollState STS_None, STS_Initial, STS_Char, STS_EOL, STS_Repeat,

Inherited Enumerations from GUI.GUIList
eSortType

Delegates Summary
		OnEndOfLine ()

Inherited Delegates from GUI.GUIList
CompareItem, ElementsEqual, ReorderByIndices, SwapIndices

Functions Summary
		Click ()))
		EndScrolling ()))
	string	GetWordUnderCursor ()
		InitComponent (GUIComponent MyOwner))
	bool	InternalOnKeyEvent (out byte Key, out byte State, float delta))
	bool	InternalOnKeyType (out byte Key, optional string Unicode))
		Restart ()))
		SetContent (string NewContent, optional string sep))
	bool	SkipChar ()))
		Stop ()))
		Timer ()))

Inherited Functions from GUI.GUIList
Add, AddElement, AlphabeticalCompare, AlphabeticalCompareExtra, AlphabeticalCompareItem, BooleanCompare, Clear, EqualsBool, EqualsExtra, EqualsInt, EqualsItem, EqualsObject, find, FindElement, FindExtra, FindIndex, Get, GetAtIndex, GetElement, GetExtra, GetExtraAtIndex, GetExtraBoolData, GetExtraIntAtIndex, GetExtraIntData, GetItemAtIndex, GetObject, GetObjectAtIndex, InitComponent, Insert, InsertElement, IPCompare, LoadFrom, NumericCompare, qSort, Remove, RemoveItem, ReorderItems, Replace, ReplaceElement, ReverseList, SelectedText, SetExtraAtIndex, SetExtraIntAtIndex, SetItemAtIndex, Sort, Swap

Inherited Functions from GUI.GUIList

Add, AddElement, AlphabeticalCompare, AlphabeticalCompareExtra, AlphabeticalCompareItem, BooleanCompare, Clear, EqualsBool, EqualsExtra, EqualsInt, EqualsItem, EqualsObject, find, FindElement, FindExtra, FindIndex, Get, GetAtIndex, GetElement, GetExtra, GetExtraAtIndex, GetExtraBoolData, GetExtraIntAtIndex, GetExtraIntData, GetItemAtIndex, GetObject, GetObjectAtIndex, InitComponent, Insert, InsertElement, IPCompare, LoadFrom, NumericCompare, qSort, Remove, RemoveItem, ReorderItems, Replace, ReplaceElement, ReverseList, SelectedText, SetExtraAtIndex, SetExtraIntAtIndex, SetItemAtIndex, Sort, Swap

Inherited Functions from GUI.GUIVertList
Click, Down, End, Home, InitComponent, InternalOnKeyEvent, InternalOnKeyType, InternalOnXControllerEvent, PgDn, PgUp, Up, WheelDown, WheelUp

Variables Detail

ClickedString Source code

var string ClickedString;

NewText Source code

var string NewText;

GUIScrollText

bClickText Source code

var(GUIScrollText) config bool bClickText;

Upon clicking on this text box, fill in ClickedString field

bNewContent Source code

var(GUIScrollText) EditConst protected bool bNewContent;

bNoTeletype Source code

var(GUIScrollText) EditConst bool bNoTeletype;

Dont do the teletyping effect at all

bRepeat Source code

var(GUIScrollText) EditConst bool bRepeat;

Should the sequence be repeated ?

bStopped Source code

var(GUIScrollText) EditConst protected bool bStopped;

CharDelay Source code

var(GUIScrollText) EditConst float CharDelay;

This is the delay between each char

Content Source code

var(GUIScrollText) EditConst protected string Content;

EOLDelay Source code

var(GUIScrollText) EditConst float EOLDelay;

This is the delay to use when reaching end of line

InitialDelay Source code

var(GUIScrollText) EditConst float InitialDelay;

Initial delay after new content was set

MaxHistory Source code

var(GUIScrollText) config int MaxHistory;

Maximum number of rows. Only used in conjunction with NewText. 0 indicates no limit.

oldWidth Source code

var(GUIScrollText) EditConst protected int oldWidth;

RepeatDelay Source code

var(GUIScrollText) EditConst float RepeatDelay;

This is used after all the text has been displayed and bRepeat is true

ScrollState Source code

var(GUIScrollText) EditConst protected eScrollState ScrollState;

Separator Source code

var(GUIScrollText) EditConst string Separator;

VisibleChars Source code

var(GUIScrollText) EditConst protected int VisibleChars;

VisibleLines Source code

var(GUIScrollText) EditConst protected int VisibleLines;

Enumerations Detail

eScrollState Source code

enum eScrollState
{

STS_None, STS_Initial, STS_Char, STS_EOL, STS_Repeat,

};

Delegates Detail

OnEndOfLine Source code

delegate OnEndOfLine ( )

Functions Detail

Click Source code

event Click ( ) )

EndScrolling Source code

function EndScrolling ( ) )

GetWordUnderCursor Source code

native final function string GetWordUnderCursor ( )

InitComponent Source code

function InitComponent ( GUIComponent MyOwner) )

InternalOnKeyEvent Source code

function bool InternalOnKeyEvent ( out byte Key, out byte State, float delta) )

InternalOnKeyType Source code

function bool InternalOnKeyType ( out byte Key, optional string Unicode) )

Restart Source code

function Restart ( ) )

SetContent Source code

function SetContent ( string NewContent, optional string sep) )

SkipChar Source code

function bool SkipChar ( ) )

Stop Source code

function Stop ( ) )

Timer Source code

event Timer ( ) )

Defaultproperties

defaultproperties
{
	ScrollState=STS_None
	Separator="|"
	TextAlign=TXTA_Left
	InitialDelay=0.0
	CharDelay=0.025
	EOLDelay=0.15
	RepeatDelay=3.0
	VisibleLines=-1
	bNeverSort=true
	MaxHistory=0
}

Creation time: st 23.5.2018 00:10:30.413 - Created with UnCodeX