WidgetManager Interface Reference

Class containing global and util functions regarding widgets. More...

Static Public Member Functions
static proto void	TraceWidgets (int x, int y, notnull Widget rootWidget, notnull array< Widget > outWidgets)
	Gets all widgets at given position returning them in array from the closest to the farthest Widgets with DISABLED or IGNORE_CURSOR or without VISIBLE flags are ignored.
static proto void	SetLanguage (string languageCode)
static proto void	GetLanguage (out string languageCode)
static proto void	SetCursor (int cursorIndex)
static proto void	ReportMouse (int mousex, int mousey, notnull Widget rootWidget)
static proto void	GetReferenceScreenSize (out int width, out int height)
	Gets reference resolution used for DPI scaling To work with DPI scaling use WorkspaceWidget.DPIScale and WorkspaceWidget.DPIUnscale.
static proto void	GetMousePos (out int x, out int y)
	Gets current mouse position in native (current) resolution (not reference)
static proto Widget	GetWidgetUnderCursor ()
static proto int	GetTextCursorBlinkTime ()
	Returns how long is TextCursor shown/hidden for. Time in milliseconds.
static proto void	SetTextCursorBlinkTime (int milliseconds)
static proto string	Translate (string text, void param1=NULL, void param2=NULL, void param3=NULL, void param4=NULL, void param5=NULL, void param6=NULL, void param7=NULL, void param8=NULL, void param9=NULL)
	Convert given text to localized version (multibyte UTF-8) using text ID's and localization table.
static proto int	SearchLocalized (string text, notnull array< string > IDs, notnull out array< int > outIndices)
	Return indices of IDs which contains searched text. Search is case insensitive.

Static Public Attributes
static const string	NonBreakingSpace
	UTF8 encoded nbsp (Non Breaking Space) character usable in UI.

Detailed Description

Class containing global and util functions regarding widgets.

Member Function Documentation

GetLanguage()

static proto void WidgetManager.GetLanguage ( out string  languageCode )

static

GetMousePos()

static proto void WidgetManager.GetMousePos ( out int  x, out int  y  )

static

Gets current mouse position in native (current) resolution (not reference)

GetReferenceScreenSize()

static proto void WidgetManager.GetReferenceScreenSize ( out int  width, out int  height  )

static

Gets reference resolution used for DPI scaling To work with DPI scaling use WorkspaceWidget.DPIScale and WorkspaceWidget.DPIUnscale.

GetTextCursorBlinkTime()

static proto int WidgetManager.GetTextCursorBlinkTime ( )

static

Returns how long is TextCursor shown/hidden for. Time in milliseconds.

GetWidgetUnderCursor()

static proto Widget WidgetManager.GetWidgetUnderCursor ( )

static

ReportMouse()

static proto void WidgetManager.ReportMouse ( int  mousex, int  mousey, notnull Widget  rootWidget  )

static

SearchLocalized()

static proto int WidgetManager.SearchLocalized ( string  text, notnull array< string >  IDs, notnull out array< int >  outIndices  )

static

Return indices of IDs which contains searched text. Search is case insensitive.

SetCursor()

static proto void WidgetManager.SetCursor ( int  cursorIndex )

static

SetLanguage()

static proto void WidgetManager.SetLanguage ( string  languageCode )

static

SetTextCursorBlinkTime()

static proto void WidgetManager.SetTextCursorBlinkTime ( int  milliseconds )

static

See also

GetTextCursorBlinkTime

TraceWidgets()

static proto void WidgetManager.TraceWidgets ( int  x, int  y, notnull Widget  rootWidget, notnull array< Widget >  outWidgets  )

static

Gets all widgets at given position returning them in array from the closest to the farthest Widgets with DISABLED or IGNORE_CURSOR or without VISIBLE flags are ignored.

Parameters

x	X coordinate on screen in NATIVE resolution
y	Y coordinate on screen in NATIVE resolution
rootWidget	Where in the hierarchy should the tracing start. Is included in tracing.
outWidgets	Array filled with traced widgets sorted from the closest to the farthest

Translate()

static proto string WidgetManager.Translate ( string  text, void  param1 = NULL, void  param2 = NULL, void  param3 = NULL, void  param4 = NULL, void  param5 = NULL, void  param6 = NULL, void  param7 = NULL, void  param8 = NULL, void  param9 = NULL  )

static

Convert given text to localized version (multibyte UTF-8) using text ID's and localization table.

Member Data Documentation

NonBreakingSpace

const string WidgetManager.NonBreakingSpace

static

UTF8 encoded nbsp (Non Breaking Space) character usable in UI.

---

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

• Core/generated/UI/WidgetManager.c