Data Structures
class	SCR_ScriptedWidgetTooltip

class	SCR_ScriptedWidgetTooltipPresets
	Class for a .conf file with multiple Tooltip presets. More...

Typedefs
typedef func	ScriptInvokerTooltipMethod

typedef ScriptInvokerBase< ScriptInvokerTooltipMethod >	ScriptInvokerTooltip

Enumerations
enum	SCR_ETooltipAlignmentHorizontal { SIDE_LEFT, SIDE_RIGHT }

Functions
void	ScriptInvokerTooltipMethod (SCR_ScriptedWidgetTooltip tooltipClass, Widget tooltipWidget, Widget hoverWidget, SCR_ScriptedWidgetTooltipPreset preset, string tag)

SCR_ScriptedWidgetTooltip ScriptedWidgetTooltip	BaseContainerProps (configRoot :true)
	Configuration for a Tooltip. More...

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

override void	Hide (WorkspaceWidget pWorkspace, Widget pToolTipWidget)

protected void	Update ()
	-— PROTECTED -— More...

protected void	OnHide ()

protected void	OnMenuChange (ChimeraMenuBase menu)

protected void	OnTabChange (ChimeraMenuBase menu)

protected void	Clear ()

protected void	InitContentPosition ()

protected void	InitContents ()

void	UpdatePosition (bool followTarget=true, bool animate=true, bool force=false)
	-— PUBLIC -— More...

bool	SetMessage (string message)

bool	ResetMessage ()

bool	SetMessageColor (Color color)

string	GetMessage ()

string	GetDefaultMessage ()

string	GetTag ()

bool	IsVisible ()

void	ForceHidden ()

Widget	GetContentWidget ()

Widget	GetTooltipWidget ()

Widget	GetHoverWidget ()

Widget	GetContentWrapper ()
	Override to change in which widget the content layout gets placed. More...

SCR_ScriptedWidgetTooltip ScriptedWidgetTooltip	SCR_BaseContainerCustomTitleField ("m_sTag")

SCR_ScriptedWidgetTooltipPreset	FindPreset (string tag)
	Finds a preset by tag. More...

Variables
protected ResourceName	m_sPresetsConfig

protected string	m_sPresetTag

protected ref SCR_ScriptedWidgetTooltipPreset	m_Preset

protected WorkspaceWidget	m_wWorkspace

protected Widget	m_wTooltipProxy

protected Widget	m_wHoverWidget

protected float	m_fTargetPosition [2]

protected RichTextWidget	m_wMessage

const protected string	WIDGET_MESSAGE = "Message"

const private float	DISTANCE_THRESHOLD = 0.001

ref array< ref SCR_ScriptedWidgetTooltipPreset >	m_aPresets

enum SCR_ETooltipAlignmentHorizontal	TOP

enum SCR_ETooltipAlignmentHorizontal	CENTER

enum SCR_ETooltipAlignmentHorizontal	BOTTOM

enum SCR_ETooltipAlignmentHorizontal	ABOVE

enum SCR_ETooltipAlignmentHorizontal	CURSOR

enum SCR_ETooltipAlignmentHorizontal	HOVERED_WIDGET

enum SCR_ETooltipAlignmentHorizontal	INVERT

enum SCR_ETooltipAlignmentHorizontal	NONE

enum SCR_ETooltipAlignmentHorizontal	LEFT

enum SCR_ETooltipAlignmentHorizontal	RIGHT

enum SCR_ETooltipAlignmentHorizontal	CENTER_LEFT

Typedef Documentation

◆ ScriptInvokerTooltip

typedef ScriptInvokerBase<ScriptInvokerTooltipMethod> ScriptInvokerTooltip

Definition at line 12 of file SCR_ScriptedWidgetTooltip.c.

◆ ScriptInvokerTooltipMethod

typedef func ScriptInvokerTooltipMethod

Definition at line 11 of file SCR_ScriptedWidgetTooltip.c.

Enumeration Type Documentation

◆ SCR_ETooltipAlignmentHorizontal

enum SCR_ETooltipAlignmentHorizontal

Enumerator
SIDE_LEFT
SIDE_RIGHT

Definition at line 775 of file SCR_ScriptedWidgetTooltip.c.

Function Documentation

◆ BaseContainerProps()

SCR_ScriptedWidgetTooltip ScriptedWidgetTooltip BaseContainerProps ( configRoot :true )

Configuration for a Tooltip.

Requires DPI scaled values

Returns true if the desired position causes the Tooltip to overflow, and prevents it by inverting the alignment. The tooltip is forcefully anchored to 0, 0 on Show(), so we just need to work with alignment

Definition at line 524 of file SCR_ScriptedWidgetTooltip.c.

◆ Clear()

protected void BaseContainerProps::Clear ( )

Definition at line 185 of file SCR_ScriptedWidgetTooltip.c.

◆ FindPreset()

SCR_ScriptedWidgetTooltipPreset BaseContainerProps::FindPreset ( string tag )

Finds a preset by tag.

Definition at line 411 of file SCR_ScriptedWidgetTooltip.c.

◆ ForceHidden()

void BaseContainerProps::ForceHidden ( )

Definition at line 319 of file SCR_ScriptedWidgetTooltip.c.

◆ GetContentWidget()

Widget BaseContainerProps::GetContentWidget ( )

Definition at line 329 of file SCR_ScriptedWidgetTooltip.c.

◆ GetContentWrapper()

Widget BaseContainerProps::GetContentWrapper ( )

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

Definition at line 348 of file SCR_ScriptedWidgetTooltip.c.

◆ GetDefaultMessage()

string BaseContainerProps::GetDefaultMessage ( )

Definition at line 301 of file SCR_ScriptedWidgetTooltip.c.

◆ GetHoverWidget()

Widget BaseContainerProps::GetHoverWidget ( )

Definition at line 341 of file SCR_ScriptedWidgetTooltip.c.

◆ GetMessage()

string BaseContainerProps::GetMessage ( )

Definition at line 292 of file SCR_ScriptedWidgetTooltip.c.

◆ GetTag()

string BaseContainerProps::GetTag ( )

Definition at line 307 of file SCR_ScriptedWidgetTooltip.c.

◆ GetTooltipWidget()

Widget BaseContainerProps::GetTooltipWidget ( )

Definition at line 335 of file SCR_ScriptedWidgetTooltip.c.

◆ Hide()

override void BaseContainerProps::Hide	(	WorkspaceWidget	pWorkspace,
		Widget	pToolTipWidget
	)

Definition at line 140 of file SCR_ScriptedWidgetTooltip.c.

◆ InitContentPosition()

protected void BaseContainerProps::InitContentPosition ( )

Definition at line 202 of file SCR_ScriptedWidgetTooltip.c.

◆ InitContents()

protected void BaseContainerProps::InitContents ( )

Definition at line 217 of file SCR_ScriptedWidgetTooltip.c.

◆ IsVisible()

bool BaseContainerProps::IsVisible ( )

Definition at line 313 of file SCR_ScriptedWidgetTooltip.c.

◆ OnHide()

protected void BaseContainerProps::OnHide ( )

Definition at line 164 of file SCR_ScriptedWidgetTooltip.c.

◆ OnMenuChange()

protected void BaseContainerProps::OnMenuChange ( ChimeraMenuBase menu )

Definition at line 173 of file SCR_ScriptedWidgetTooltip.c.

◆ OnTabChange()

protected void BaseContainerProps::OnTabChange ( ChimeraMenuBase menu )

Definition at line 179 of file SCR_ScriptedWidgetTooltip.c.

◆ ResetMessage()

bool BaseContainerProps::ResetMessage ( )

Definition at line 276 of file SCR_ScriptedWidgetTooltip.c.

◆ SCR_BaseContainerCustomTitleField()

SCR_ScriptedWidgetTooltip ScriptedWidgetTooltip SCR_BaseContainerCustomTitleField ( "m_sTag" )

Calculate desired position and alignment Returns false if the tooltip does not need to be moved

Definition at line 405 of file SCR_ScriptedWidgetTooltip.c.

◆ ScriptInvokerTooltipMethod()

void ScriptInvokerTooltipMethod	(	SCR_ScriptedWidgetTooltip	tooltipClass,
		Widget	tooltipWidget,
		Widget	hoverWidget,
		SCR_ScriptedWidgetTooltipPreset	preset,
		string	tag
	)