Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_LoadingOverlay Class Reference
Inheritance diagram for SCR_LoadingOverlay:
ScriptedWidgetComponent

Protected Member Functions

void HideAndDelete ()
 Hides the overlay. The overlay will be destroyed, and the SCR_LoadingOverlay component will be deleted.
void SetShown (bool show)
 Shows or hides the overlay. The overlay is not destroyed if hidden and can be shown again.
void SetText (string text)
void ShowBackground (bool show)
void ShowBlur (bool show)
Widget GetRootWidget ()
void SetFocus ()
override void HandlerAttached (Widget w)
void Init (Widget overlayRoot, SCR_LoadingOverlayHelperComponent helper)
void SetSizeFromTarget ()
override bool OnUpdate (Widget w)
override bool OnClick (Widget w, int x, int y, int button)
override bool OnModalClosed (Widget modalRoot)
override bool OnDoubleClick (Widget w, int x, int y, int button)
override bool OnItemSelected (Widget w, int row, int column, int oldRow, int oldColumn)
override bool OnFocus (Widget w, int x, int y)
override bool OnFocusLost (Widget w, int x, int y)
override bool OnMouseEnter (Widget w, int x, int y)
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool OnMouseWheel (Widget w, int x, int y, int wheel)
override bool OnMouseButtonDown (Widget w, int x, int y, int button)
override bool OnMouseButtonUp (Widget w, int x, int y, int button)
override bool OnController (Widget w, int control, int value)
 control is one of ControlID
override bool OnChar (Widget w, int charCode)
override bool OnChange (Widget w, bool finished)
override bool OnModalClickOut (Widget modalRoot, int x, int y, int button)

Static Protected Member Functions

static SCR_LoadingOverlay ShowForWidget (Widget targetWidget, string text=string.Empty, bool showBlur=true, bool showBackground=true)
static void HideForWidget (Widget targetWidget)
 Hides overlay for given target widget.

Protected Attributes

bool m_bRenderTopMost = false
bool m_bShown = true
bool m_bShownAtStart
bool m_bShowBackground

Detailed Description

Definition at line 49 of file SCR_LoadingOverlay.c.

Member Function Documentation

◆ GetRootWidget()

Widget SCR_LoadingOverlay::GetRootWidget ( )
inlineprotected

Definition at line 200 of file SCR_LoadingOverlay.c.

◆ HandlerAttached()

override void SCR_LoadingOverlay::HandlerAttached ( Widget w)
inlineprotected

Definition at line 222 of file SCR_LoadingOverlay.c.

◆ HideAndDelete()

void SCR_LoadingOverlay::HideAndDelete ( )
inlineprotected

Hides the overlay. The overlay will be destroyed, and the SCR_LoadingOverlay component will be deleted.

Definition at line 139 of file SCR_LoadingOverlay.c.

◆ HideForWidget()

void SCR_LoadingOverlay::HideForWidget ( Widget targetWidget)
inlinestaticprotected

Hides overlay for given target widget.

Definition at line 122 of file SCR_LoadingOverlay.c.

◆ Init()

void SCR_LoadingOverlay::Init ( Widget overlayRoot,
SCR_LoadingOverlayHelperComponent helper )
inlineprotected

Definition at line 243 of file SCR_LoadingOverlay.c.

◆ OnChange()

override bool SCR_LoadingOverlay::OnChange ( Widget w,
bool finished )
inlineprotected

Definition at line 333 of file SCR_LoadingOverlay.c.

◆ OnChar()

override bool SCR_LoadingOverlay::OnChar ( Widget w,
int charCode )
inlineprotected

Definition at line 332 of file SCR_LoadingOverlay.c.

◆ OnClick()

override bool SCR_LoadingOverlay::OnClick ( Widget w,
int x,
int y,
int button )
inlineprotected

Definition at line 316 of file SCR_LoadingOverlay.c.

◆ OnController()

override bool SCR_LoadingOverlay::OnController ( Widget w,
int control,
int value )
inlineprotected

control is one of ControlID

Definition at line 331 of file SCR_LoadingOverlay.c.

◆ OnDoubleClick()

override bool SCR_LoadingOverlay::OnDoubleClick ( Widget w,
int x,
int y,
int button )
inlineprotected

Definition at line 321 of file SCR_LoadingOverlay.c.

◆ OnFocus()

override bool SCR_LoadingOverlay::OnFocus ( Widget w,
int x,
int y )
inlineprotected

Definition at line 323 of file SCR_LoadingOverlay.c.

◆ OnFocusLost()

override bool SCR_LoadingOverlay::OnFocusLost ( Widget w,
int x,
int y )
inlineprotected

Definition at line 324 of file SCR_LoadingOverlay.c.

◆ OnItemSelected()

override bool SCR_LoadingOverlay::OnItemSelected ( Widget w,
int row,
int column,
int oldRow,
int oldColumn )
inlineprotected

Definition at line 322 of file SCR_LoadingOverlay.c.

◆ OnModalClickOut()

override bool SCR_LoadingOverlay::OnModalClickOut ( Widget modalRoot,
int x,
int y,
int button )
inlineprotected

Definition at line 334 of file SCR_LoadingOverlay.c.

◆ OnModalClosed()

override bool SCR_LoadingOverlay::OnModalClosed ( Widget modalRoot)
inlineprotected

Definition at line 320 of file SCR_LoadingOverlay.c.

◆ OnMouseButtonDown()

override bool SCR_LoadingOverlay::OnMouseButtonDown ( Widget w,
int x,
int y,
int button )
inlineprotected

Definition at line 328 of file SCR_LoadingOverlay.c.

◆ OnMouseButtonUp()

override bool SCR_LoadingOverlay::OnMouseButtonUp ( Widget w,
int x,
int y,
int button )
inlineprotected

Definition at line 329 of file SCR_LoadingOverlay.c.

◆ OnMouseEnter()

override bool SCR_LoadingOverlay::OnMouseEnter ( Widget w,
int x,
int y )
inlineprotected

Definition at line 325 of file SCR_LoadingOverlay.c.

◆ OnMouseLeave()

override bool SCR_LoadingOverlay::OnMouseLeave ( Widget w,
Widget enterW,
int x,
int y )
inlineprotected

Definition at line 326 of file SCR_LoadingOverlay.c.

◆ OnMouseWheel()

override bool SCR_LoadingOverlay::OnMouseWheel ( Widget w,
int x,
int y,
int wheel )
inlineprotected

Definition at line 327 of file SCR_LoadingOverlay.c.

◆ OnUpdate()

override bool SCR_LoadingOverlay::OnUpdate ( Widget w)
inlineprotected

Definition at line 295 of file SCR_LoadingOverlay.c.

◆ SetFocus()

void SCR_LoadingOverlay::SetFocus ( )
inlineprotected

Sets the fake button as focused widget, can be used if you need to reset focus from the widgets under this loading overlay

Definition at line 209 of file SCR_LoadingOverlay.c.

◆ SetShown()

void SCR_LoadingOverlay::SetShown ( bool show)
inlineprotected

Shows or hides the overlay. The overlay is not destroyed if hidden and can be shown again.

Definition at line 162 of file SCR_LoadingOverlay.c.

◆ SetSizeFromTarget()

void SCR_LoadingOverlay::SetSizeFromTarget ( )
inlineprotected

Definition at line 267 of file SCR_LoadingOverlay.c.

◆ SetText()

void SCR_LoadingOverlay::SetText ( string text)
inlineprotected

Definition at line 176 of file SCR_LoadingOverlay.c.

◆ ShowBackground()

void SCR_LoadingOverlay::ShowBackground ( bool show)
inlineprotected

Definition at line 184 of file SCR_LoadingOverlay.c.

◆ ShowBlur()

void SCR_LoadingOverlay::ShowBlur ( bool show)
inlineprotected

Definition at line 192 of file SCR_LoadingOverlay.c.

◆ ShowForWidget()

SCR_LoadingOverlay SCR_LoadingOverlay::ShowForWidget ( Widget targetWidget,
string text = string.Empty,
bool showBlur = true,
bool showBackground = true )
inlinestaticprotected

Shows an overlay over target widget You can call it multiple times for same widget. If an overlay already exists, new one will not be created, and the old overlay will be returned.

Definition at line 72 of file SCR_LoadingOverlay.c.

Member Data Documentation

◆ m_bRenderTopMost

bool SCR_LoadingOverlay::m_bRenderTopMost = false
protected

Definition at line 57 of file SCR_LoadingOverlay.c.

◆ m_bShowBackground

bool SCR_LoadingOverlay::m_bShowBackground
protected

Definition at line 67 of file SCR_LoadingOverlay.c.

◆ m_bShown

bool SCR_LoadingOverlay::m_bShown = true
protected

Definition at line 59 of file SCR_LoadingOverlay.c.

◆ m_bShownAtStart

bool SCR_LoadingOverlay::m_bShownAtStart
protected

Definition at line 64 of file SCR_LoadingOverlay.c.

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