Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCR_DownloadManagerListComponent Interface Reference

Download manager list that can group download entries into various sections. More...

Inheritance diagram for SCR_DownloadManagerListComponent:
[legend]

Public Member Functions

override void HandlerAttached (Widget w)
 
override void OnTabShow ()
 
override void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
override void OnMenuFocusGained ()
 
Widget AddEntry (ResourceName entryPath, SCR_WorkshopItemActionDownload action)
 Add new widget in category based based on category type.
 
void ChangeEntryCategory (notnull Widget entry, EDownloadManagerActionState type)
 Change widget in category based based on category type.
 
void RemoveEntry (notnull SCR_DownloadManagerEntry entry)
 
SCR_DownloadManagerEntry DownloadActionLine (notnull SCR_WorkshopItemActionDownload action)
 Find line containing selected download action.
 
SCR_DownloadManagerEntry EntryWithItem (notnull SCR_WorkshopItem item)
 Find line containing selected item.
 
SCR_DownloadManagerEntry FocusedEntry ()
 Return addon preset line component of currently focused widget if has any.
 
void ShowPauseResumeAllButton (bool show)
 
void ShowFallbackText (bool show)
 
bool HasContent ()
 Return true if there are entries in list.
 
- Public Member Functions inherited from SCR_SubMenuBase
void OnMenuFocusGained ()
 
void OnMenuFocusLost ()
 
void OnMenuShow ()
 
void OnMenuHide ()
 
void OnMenuUpdate (float tDelta)
 
void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
void OnTabShow ()
 
void OnTabHide ()
 
void OnTabRemove ()
 
void OnTabChange ()
 
bool GetShown ()
 
int GetIndex ()
 
ScriptInvokerVoid GetOnRequestCloseMenu ()
 
ScriptInvokerInt2 GetOnRequestTabChange ()
 
- Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void HandlerAttached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
Widget GetRootWidget ()
 
bool IsVisible ()
 

Protected Member Functions

void OnEntryFocus ()
 
void OnEntryFocusLost ()
 
void UpdateNavButtons (SCR_DownloadManagerEntry entry)
 
void OnClickPauseResume ()
 
void OnClickCancel ()
 
void OnClickRetry ()
 
void OnClickPauseResumeAll ()
 
void EnablePauseResumeAll ()
 
void FocusFirstLine ()
 
- Protected Member Functions inherited from SCR_SubMenuBase
void ShowNavigationButtons (bool show)
 
void FlagNavigationButtonVisibility (SCR_InputButtonComponent button, bool show)
 
void SetNavigationButtonVisibile (SCR_InputButtonComponent button, bool show, bool animate=false)
 
SCR_InputButtonComponent CreateNavigationButton (string actionName, string label, bool rightFooter=false, bool show=true)
 
void RequestCloseMenu ()
 
void RequestTabChange (int newTabIndex)
 

Protected Attributes

string m_sList
 
string m_sFallbackTextWrapWidget
 
ref array< ref SCR_DownloadManagerListCategorym_aCategories
 
ScrollLayoutWidget m_ScrollLayout
 
Widget m_wList
 
Widget m_wFallbackTextWrap
 
SCR_InputButtonComponent m_NavPauseResume
 
SCR_InputButtonComponent m_NavPauseResumeAll
 
SCR_InputButtonComponent m_NavCancel
 
SCR_InputButtonComponent m_NavRetry
 
ref array< ref SCR_DownloadManagerEntrym_aAddonLines = {}
 
bool m_bAllPaused = false
 
SCR_DownloadManagerEntry m_FocusedEntry
 
- Protected Attributes inherited from SCR_SubMenuBase
ResourceName m_sNavigationButtonLayout
 
SCR_DynamicFooterComponent m_DynamicFooter
 
ref array< SCR_InputButtonComponentm_aNavigationButtons = {}
 
ref map< SCR_InputButtonComponent, bool > m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()
 
Widget m_wMenuRoot
 
int m_iIndex
 
bool m_bShown
 
bool m_bFocused
 
ref ScriptInvokerVoid m_OnRequestCloseMenu
 
ref ScriptInvokerInt2 m_OnRequestTabChange
 
- Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget m_wRoot
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
 Base method for component lookup through the widget library.
 
- Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker m_OnClick = new ScriptInvoker
 

Detailed Description

Download manager list that can group download entries into various sections.

Member Function Documentation

◆ AddEntry()

Widget SCR_DownloadManagerListComponent.AddEntry ( ResourceName  entryPath,
SCR_WorkshopItemActionDownload  action 
)

Add new widget in category based based on category type.

◆ ChangeEntryCategory()

void SCR_DownloadManagerListComponent.ChangeEntryCategory ( notnull Widget  entry,
EDownloadManagerActionState  type 
)

Change widget in category based based on category type.

◆ DownloadActionLine()

SCR_DownloadManagerEntry SCR_DownloadManagerListComponent.DownloadActionLine ( notnull SCR_WorkshopItemActionDownload  action)

Find line containing selected download action.

◆ EnablePauseResumeAll()

void SCR_DownloadManagerListComponent.EnablePauseResumeAll ( )
protected

◆ EntryWithItem()

SCR_DownloadManagerEntry SCR_DownloadManagerListComponent.EntryWithItem ( notnull SCR_WorkshopItem  item)

Find line containing selected item.

◆ FocusedEntry()

SCR_DownloadManagerEntry SCR_DownloadManagerListComponent.FocusedEntry ( )

Return addon preset line component of currently focused widget if has any.

◆ FocusFirstLine()

void SCR_DownloadManagerListComponent.FocusFirstLine ( )
protected

◆ HandlerAttached()

override void SCR_DownloadManagerListComponent.HandlerAttached ( Widget  w)

◆ HasContent()

bool SCR_DownloadManagerListComponent.HasContent ( )

Return true if there are entries in list.

◆ OnClickCancel()

void SCR_DownloadManagerListComponent.OnClickCancel ( )
protected

◆ OnClickPauseResume()

void SCR_DownloadManagerListComponent.OnClickPauseResume ( )
protected

◆ OnClickPauseResumeAll()

void SCR_DownloadManagerListComponent.OnClickPauseResumeAll ( )
protected

◆ OnClickRetry()

void SCR_DownloadManagerListComponent.OnClickRetry ( )
protected

◆ OnEntryFocus()

void SCR_DownloadManagerListComponent.OnEntryFocus ( )
protected

◆ OnEntryFocusLost()

void SCR_DownloadManagerListComponent.OnEntryFocusLost ( )
protected

◆ OnMenuFocusGained()

override void SCR_DownloadManagerListComponent.OnMenuFocusGained ( )

Implements SCR_SubMenuBase.

◆ OnTabCreate()

override void SCR_DownloadManagerListComponent.OnTabCreate ( Widget  menuRoot,
ResourceName  buttonsLayout,
int  index 
)

Implements SCR_SubMenuBase.

◆ OnTabShow()

override void SCR_DownloadManagerListComponent.OnTabShow ( )

Implements SCR_SubMenuBase.

◆ RemoveEntry()

void SCR_DownloadManagerListComponent.RemoveEntry ( notnull SCR_DownloadManagerEntry  entry)

◆ ShowFallbackText()

void SCR_DownloadManagerListComponent.ShowFallbackText ( bool  show)

◆ ShowPauseResumeAllButton()

void SCR_DownloadManagerListComponent.ShowPauseResumeAllButton ( bool  show)

◆ UpdateNavButtons()

void SCR_DownloadManagerListComponent.UpdateNavButtons ( SCR_DownloadManagerEntry  entry)
protected

Member Data Documentation

◆ m_aAddonLines

ref array<ref SCR_DownloadManagerEntry> SCR_DownloadManagerListComponent.m_aAddonLines = {}
protected

◆ m_aCategories

ref array<ref SCR_DownloadManagerListCategory> SCR_DownloadManagerListComponent.m_aCategories
protected

◆ m_bAllPaused

bool SCR_DownloadManagerListComponent.m_bAllPaused = false
protected

◆ m_FocusedEntry

SCR_DownloadManagerEntry SCR_DownloadManagerListComponent.m_FocusedEntry
protected

◆ m_NavCancel

SCR_InputButtonComponent SCR_DownloadManagerListComponent.m_NavCancel
protected

◆ m_NavPauseResume

SCR_InputButtonComponent SCR_DownloadManagerListComponent.m_NavPauseResume
protected

◆ m_NavPauseResumeAll

SCR_InputButtonComponent SCR_DownloadManagerListComponent.m_NavPauseResumeAll
protected

◆ m_NavRetry

SCR_InputButtonComponent SCR_DownloadManagerListComponent.m_NavRetry
protected

◆ m_ScrollLayout

ScrollLayoutWidget SCR_DownloadManagerListComponent.m_ScrollLayout
protected

◆ m_sFallbackTextWrapWidget

string SCR_DownloadManagerListComponent.m_sFallbackTextWrapWidget
protected

◆ m_sList

string SCR_DownloadManagerListComponent.m_sList
protected

◆ m_wFallbackTextWrap

Widget SCR_DownloadManagerListComponent.m_wFallbackTextWrap
protected

◆ m_wList

Widget SCR_DownloadManagerListComponent.m_wList
protected

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