SCR_ScriptedWidgetTooltip Interface Reference

Inheritance diagram for SCR_ScriptedWidgetTooltip:

Public Member Functions
override void	Show (WorkspaceWidget pWorkspace, Widget pToolTipWidget, float desiredPosX, float desiredPosY)
override void	Hide (WorkspaceWidget pWorkspace, Widget pToolTipWidget)
void	UpdatePosition (bool followTarget=true, bool animate=true, bool force=false)
	-— PUBLIC -—
void	ForceHidden ()
bool	IsValid (string tag, Widget hoverWidget=null, ResourceName presets=string.Empty)
string	GetTag ()
SCR_ScriptedWidgetTooltipContentBase	GetContent ()
Widget	GetContentRoot ()
bool	IsVisible ()
Widget	GetHoverWidget ()
Widget	GetContentWrapper ()
	Override to change in which widget the content layout gets placed.

Static Public Member Functions
static override Widget	CreateTooltipWidget ()
	-— OVERRIDES -—
static bool	ForceHideCurrentTooltip ()
static SCR_ScriptedWidgetTooltip	GetCurrentTooltip ()
static ScriptInvokerTooltip	GetOnTooltipShowInit ()
static ScriptInvokerTooltip	GetOnTooltipShow ()
static ScriptInvokerTooltip	GetOnTooltipHide ()

Protected Member Functions
void	DelayedPositionInit (int totalFrames)
	-— PROTECTED -—
void	Update ()
void	OnHide ()
void	OnMenuChange (ChimeraMenuBase menu)
void	OnTabChange (SCR_TabViewComponent tabView, Widget widget)
void	Clear ()
void	InitContentPosition ()

Protected Attributes
ResourceName	m_sPresetsConfig
string	m_sPresetTag
ref SCR_ScriptedWidgetTooltipPreset	m_Preset
WorkspaceWidget	m_wWorkspace
Widget	m_wTooltipProxy
Widget	m_wHoverWidget
float	m_fTargetPosition [2]

Static Protected Attributes
static WidgetAnimationPosition	m_PositionAnimation
static SCR_ScriptedWidgetTooltip	m_CurrentTooltip
static ref ScriptInvokerTooltip	m_OnTooltipShowInit
static ref ScriptInvokerTooltip	m_OnTooltipShow
static ref ScriptInvokerTooltip	m_OnTooltipHide
const string	DEBUG_BORDER_NAME = "DebugBorder"

Member Function Documentation

Clear()

void SCR_ScriptedWidgetTooltip.Clear ( )

protected

CreateTooltipWidget()

static override Widget SCR_ScriptedWidgetTooltip.CreateTooltipWidget ( )

static

-— OVERRIDES -—

Override in child classes to change the proxy layout

DelayedPositionInit()

void SCR_ScriptedWidgetTooltip.DelayedPositionInit ( int totalFrames )

protected

-— PROTECTED -—

ForceHidden()

void SCR_ScriptedWidgetTooltip.ForceHidden

(

)

ForceHideCurrentTooltip()

static bool SCR_ScriptedWidgetTooltip.ForceHideCurrentTooltip ( )

static

GetContent()

SCR_ScriptedWidgetTooltipContentBase SCR_ScriptedWidgetTooltip.GetContent

(

)

GetContentRoot()

Widget SCR_ScriptedWidgetTooltip.GetContentRoot

(

)

GetContentWrapper()

Widget SCR_ScriptedWidgetTooltip.GetContentWrapper

(

)

Override to change in which widget the content layout gets placed.

GetCurrentTooltip()

static SCR_ScriptedWidgetTooltip SCR_ScriptedWidgetTooltip.GetCurrentTooltip ( )

static

GetHoverWidget()

Widget SCR_ScriptedWidgetTooltip.GetHoverWidget

(

)

GetOnTooltipHide()

static ScriptInvokerTooltip SCR_ScriptedWidgetTooltip.GetOnTooltipHide ( )

static

GetOnTooltipShow()

static ScriptInvokerTooltip SCR_ScriptedWidgetTooltip.GetOnTooltipShow ( )

static

GetOnTooltipShowInit()

static ScriptInvokerTooltip SCR_ScriptedWidgetTooltip.GetOnTooltipShowInit ( )

static

GetTag()

string SCR_ScriptedWidgetTooltip.GetTag

(

)

Hide()

override void SCR_ScriptedWidgetTooltip.Hide	(	WorkspaceWidget	pWorkspace,
		Widget	pToolTipWidget )

InitContentPosition()

void SCR_ScriptedWidgetTooltip.InitContentPosition ( )

protected

IsValid()

bool SCR_ScriptedWidgetTooltip.IsValid	(	string	tag,
		Widget	hoverWidget = null,
		ResourceName	presets = string::Empty )

IsVisible()

bool SCR_ScriptedWidgetTooltip.IsVisible

(

)

OnHide()

void SCR_ScriptedWidgetTooltip.OnHide ( )

protected

OnMenuChange()

void SCR_ScriptedWidgetTooltip.OnMenuChange ( ChimeraMenuBase menu )

protected

OnTabChange()

void SCR_ScriptedWidgetTooltip.OnTabChange ( SCR_TabViewComponent tabView, Widget widget )

protected

Show()

override void SCR_ScriptedWidgetTooltip.Show	(	WorkspaceWidget	pWorkspace,
		Widget	pToolTipWidget,
		float	desiredPosX,
		float	desiredPosY )

Forced hiding events

Update()

void SCR_ScriptedWidgetTooltip.Update ( )

protected

UpdatePosition()

void SCR_ScriptedWidgetTooltip.UpdatePosition	(	bool	followTarget = true,
		bool	animate = true,
		bool	force = false )

-— PUBLIC -—

Member Data Documentation

DEBUG_BORDER_NAME

const string SCR_ScriptedWidgetTooltip.DEBUG_BORDER_NAME = "DebugBorder"

staticprotected

m_CurrentTooltip

SCR_ScriptedWidgetTooltip SCR_ScriptedWidgetTooltip.m_CurrentTooltip

staticprotected

m_fTargetPosition

float SCR_ScriptedWidgetTooltip.m_fTargetPosition[2]

protected

m_OnTooltipHide

ref ScriptInvokerTooltip SCR_ScriptedWidgetTooltip.m_OnTooltipHide

staticprotected

m_OnTooltipShow

ref ScriptInvokerTooltip SCR_ScriptedWidgetTooltip.m_OnTooltipShow

staticprotected

m_OnTooltipShowInit

ref ScriptInvokerTooltip SCR_ScriptedWidgetTooltip.m_OnTooltipShowInit

staticprotected

m_PositionAnimation

WidgetAnimationPosition SCR_ScriptedWidgetTooltip.m_PositionAnimation

staticprotected

m_Preset

ref SCR_ScriptedWidgetTooltipPreset SCR_ScriptedWidgetTooltip.m_Preset

protected

m_sPresetsConfig

ResourceName SCR_ScriptedWidgetTooltip.m_sPresetsConfig

protected

m_sPresetTag

string SCR_ScriptedWidgetTooltip.m_sPresetTag

protected

m_wHoverWidget

Widget SCR_ScriptedWidgetTooltip.m_wHoverWidget

protected

m_wTooltipProxy

Widget SCR_ScriptedWidgetTooltip.m_wTooltipProxy

protected

m_wWorkspace

WorkspaceWidget SCR_ScriptedWidgetTooltip.m_wWorkspace

protected

---

The documentation for this interface was generated from the following file:

• Game/UI/Components/WidgetLibrary/SCR_ScriptedWidgetTooltip.c