GUI.GUIComponent

Extends

GUI

Modifiers

Config ( TribesGui ) PerObjectConfig HideCategories ( Menu , Object ) Native

Core.Object
|   
+-- GUI.GUI
   |   
   +-- GUI.GUIComponent

Direct Known Subclasses:

GUIActorContainerBase, GUIContextMenu, GUIHorzScrollZone, GUIImage, GUIListBase, GUIMultiComponent, GUIProgressBar, GUISlider, GUITextComponent, GUIVertScrollZone

Delegates Summary
		OnActivate ()
	bool	OnCapturedMouseMove (float deltaX, float deltaY))
		OnChange (GUIComponent Sender)
		OnClick (GUIComponent Sender)
		OnClientDraw (Canvas Canvas)
		OnDblClick (GUIComponent Sender)
		OnDeActivate ()
	bool	OnDraw (Canvas Canvas))
		OnFocused (GUIComponent Self))
		OnHide ()
		OnHitTest (float MouseX, float MouseY)
	bool	OnKeyEvent (out byte Key, out byte State, float delta))
	bool	OnKeyType (out byte Key, optional string Unicode))
		OnLostFocus (GUIComponent Self)
		OnMenuStateChanged (GUIComponent Sender, eMenuState NewState)
		OnMessage (coerce string Msg, float MsgLife)
		OnMousePressed (GUIComponent Sender)
		OnMouseRelease (GUIComponent Sender)
	bool	OnPreDraw (Canvas Canvas))
	bool	OnRawXController (byte Id, out byte Key, out byte State, out float Axis))
		OnRender (canvas Canvas)
		OnRePositionCompleted (GUIComponent Sender, name NewPosLabel)
		OnRightClick (GUIComponent Sender)
		OnShow ()
	bool	OnUpdateComponent (Canvas Canvas))
		OnWatched (GUIComponent Self)
	bool	OnXControllerEvent (byte Id, eXControllerCodes iCode))

Functions Summary
		Activate ()))
	float	ActualHeight ()
	float	ActualLeft ()
	Float	ActualTop ()
	float	ActualWidth ()
		ChangeStyle (String newStyle))
		Click ()))
		Construct (GUIController MyController))
		CyclePositions ()))
		DblClick ()))
		DeActivate ()))
		DisableComponent ()))
		EnableComponent ()))
		FillOwner ()))
		Focus ()))
		Free (optional bool bForce ))
		Hide ()))
		InitComponent (GUIComponent MyOwner))
		InitDelegates ()
	bool	IsAtPosition (name PositionLabel ))
	bool	IsInBounds ()))
	bool	IsInClientBounds ()))
		KillTimer ()
		LoadLayoutFromHistory ()))
		LoseFocus ()))
		MenuStateChange (eMenuState Newstate))
		MousePressed ()))
		MouseReleased ()))
		OnChangeLayout ()))
		OnConstruct (GUIController MyController))
		OnResolutionChanged (int OldResolutionX, int OldResolutionY, int ResolutionX, int ResolutionY)
	PlayerController	PlayerOwner ()))
		Press ()))
		RedoLayout ()))
		RegisterNotifyResolutionChanged ()))
		RePosition (name PositionLabel, optional bool bInstantly ))
		RePositionCompleted ()))
		RePositionTo (sDynamicPositionSpec NewPosition ))
		SaveLayout (bool FlushToDisk))
		SaveLayoutToHistory ()))
		SetActive (bool bActive))
		SetDirty ()))
		SetEnabled (bool newEnabled))
		SetFocusInstead (GUIComponent other ))
		SetHint (string NewHint))
		SetLinkOverrides (GUIComponent cUp, UIComponent cDown, UIComponent cLeft, UIComponent cRight))
		SetLinks (GUIComponent cUp, UIComponent cDown, UIComponent cLeft, UIComponent cRight))
		SetRadioGroup (GUIRadioButton group ))
		SetTimer (float Interval, optional bool bRepeat)
		SetVisibility (bool newVisible))
		Show ()))
		StopCycling ()))
	string	StripColorCodes (string InString))
		Timer ()
		UndoLayout ()))
		Watched ()))

bAllowPressedEffect Source code

Bounds[4] Source code

ClientBounds[4] Source code

LinkOverrides[4] Source code

Links[4] Source code

SaveColor Source code

SaveFont Source code

SaveStyle Source code

SaveX Source code

SaveY Source code

TimerIndex Source code

GUIComponent

bAcceptsInput Source code

Does this control ever accept input

bAllowHTMLTextFormatting Source code

If true, this control will parse out HTML style formatting codes from text strings

bBoundToParent Source code

Use the Parents Bounds for all positioning

bCanBeShown Source code

Should this control ever be drawn

bCaptureMouse Source code

Set this if the control should capture the mouse when pressed

bCaptureTabs Source code

This control wants tabs

bDrawStyle Source code

If true, this control will draw its GUIStyle before any further drawing

bFocusOnWatch Source code

If true, watching focuses

bHideMouseCursor Source code

If true, no mouse cursor will be displayed over this control (while the control is active)

bHitTestOnClientBounds Source code

Set this if the control should perform hit tests using the client bounds instead of the bounds

bMaintainFocus Source code

If true, will not lose focus after a new control recieves focus

bMouseOverSound Source code

Should component bleep when mouse goes over it

bNeverFocus Source code

This control should never fully receive focus

bPersistent Source code

If set, component is saved across open/close/reopen, only instanciated once.

bRepeatClick Source code

Have the system accept holding down of the mouse

bRepeatCycling Source code

If set, this component will continue cycling after it processes to the end of the MovePositions array

bRequireReleaseClick Source code

If True, this component wants the click on release even if it's not active

bScaled Source code

Is this component using scaling

bScaleToParent Source code

Use the Parent for scaling

bSwallowAllKeyEvents Source code

Set this if the control should swallow all native key events

bTabStop Source code

Does a TAB/Shift-Tab stop here

CyclePosition Source code

If set to a MovePositions index, the component will begin cycling from that index when activated

FocusInstead Source code

Who should get the focus instead of this control if bNeverFocus

Hint Source code

The hint that gets displayed for this component

MouseCursorIndex Source code

The mouse cursor to use when over this control

MovePositions Source code

The PositionSpecs used to handle dynamic RePosition()ing

RadioGroup Source code

If not None, this component will be enabled/disabled as part of the specified radio group.

RenderWeight Source code

Used to determine sorting in the controls stack

StyleName Source code

Name of my Style

TabOrder Source code

Used to figure out tabbing

WinHeight Source code

Where does this component exist (in world space) - Grr.. damn Left()

WinLeft Source code

Where does this component exist (in world space) - Grr.. damn Left()

WinTop Source code

Where does this component exist (in world space) - Grr.. damn Left()

WinWidth Source code

Where does this component exist (in world space) - Grr.. damn Left()

GUIState

bActiveInput Source code

is active for input

bDirty Source code

When true, will update the component on its next PreDraw

bInited Source code

has this component been initialized yet

bPlayerMoveAllowed Source code

bRepositioning Source code

If true, the timer for this component should be repositioning based on the current TransitionSpec

bSaved Source code

Have any updates to this component been saved?

bTimerRepeat Source code

Does the Timer Repeat?

bVisible Source code

Is this component currently visible

MenuOwner Source code

Callback to the Component that owns this one

MenuState Source code

Used to determine the current state of this component

MoveGroup Source code

What move group this component belongs to, -1 by default is none

Style Source code

My GUI Style

TimerCountdown Source code

Clock time

TimerInterval Source code

Timer interval

TransitionSpec Source code

The current transitioning spec

UndoHistory Source code

Layout history used for undo/redo operations

UndoLevel Source code

Where in the undo history we currently are

Menu

OnClickSound Source code

EClickSound Source code

sDynamicPositionSpec Source code

KeyName:

Name used to reference this position spec

TransitionTime:

The amount of time that will be taken to transition to these coords on a RePosition() call

WinHeight:

Height of this spec

WinLeft:

Left position of this spec

WinTop:

Top position of this spec

WinWidth:

Width of this spec

sTransitionSpec Source code

NewPos:

New position spec

OldWinHeight:

Height of this spec

OldWinLeft:

Left position of this spec

OldWinTop:

Top position of this spec

OldWinWidth:

Width of this spec

OnActivate Source code

OnCapturedMouseMove Source code

OnChange Source code

OnClick Source code

OnClientDraw Source code

OnDblClick Source code

OnDeActivate Source code

OnDraw Source code

OnFocused Source code

OnHide Source code

OnHitTest Source code

OnKeyEvent Source code

OnKeyType Source code

OnLostFocus Source code

OnMenuStateChanged Source code

OnMessage Source code

OnMousePressed Source code

OnMouseRelease Source code

OnPreDraw Source code

OnRawXController Source code

OnRender Source code

OnRePositionCompleted Source code

OnRightClick Source code

OnShow Source code

OnUpdateComponent Source code

OnWatched Source code

OnXControllerEvent Source code

Activate Source code

ActualHeight Source code

ActualLeft Source code

ActualTop Source code

ActualWidth Source code

ChangeStyle Source code

Click Source code

Construct Source code

CyclePositions Source code

DblClick Source code

DeActivate Source code

DisableComponent Source code

EnableComponent Source code

FillOwner Source code

Focus Source code

Free Source code

Hide Source code

InitComponent Source code

InitDelegates Source code

IsAtPosition Source code

IsInBounds Source code

IsInClientBounds Source code

KillTimer Source code

LoadLayoutFromHistory Source code

LoseFocus Source code

MenuStateChange Source code

MousePressed Source code

MouseReleased Source code

OnChangeLayout Source code

OnConstruct Source code

OnResolutionChanged Source code

PlayerOwner Source code

Press Source code

RedoLayout Source code

RegisterNotifyResolutionChanged Source code

RePosition Source code

RePositionCompleted Source code

RePositionTo Source code

SaveLayout Source code

SaveLayoutToHistory Source code

SetActive Source code

SetDirty Source code

SetEnabled Source code

SetFocusInstead Source code

SetHint Source code

SetLinkOverrides Source code

SetLinks Source code

SetRadioGroup Source code

SetTimer Source code

SetVisibility Source code

Show Source code

StopCycling Source code

StripColorCodes Source code

Timer Source code

UndoLayout Source code

Watched Source code

defaultproperties
{
	MenuState=MSAT_Blurry
	bBoundToParent=true
	bScaleToParent=true
	bAcceptsInput=true
	bCanBeShown=true
	bCaptureTabs=false
	bCaptureMouse=false
	bNeverFocus=false
	bRepeatClick=false
	WinTop=0.4
	WinLeft=0.4
	WinWidth=0.2
	WinHeight=0.2
	MouseCursorIndex=0
	bFocusOnWatch=false
	bRequireReleaseClick=false
	TimerIndex=-1
	bMouseOverSound=false
	OnClickSound=CS_None
    RenderWeight=0.5
    bTabStop=false
    UndoLevel=0
    bSaved=true
    MoveGroup=-1
    CyclePosition=-1
    bScaled=True
	bDrawStyle=false
	bAllowPressedEffect=true
}