Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
KSP.UI.Screens.AppUIInputPanel Class Reference

A panel that will display dynamic input fields based on the bound data class More...

Inheritance diagram for KSP.UI.Screens.AppUIInputPanel:

Public Member Functions

bool AnyTextFieldHasFocus ()
 
AppUIMember GetControl (string fieldName)
 Get a Control from the Input Panel by field name. More...
 
void RefreshUI ()
 Refresh the UIPanel Members without a reinitialize More...
 
void ReleaseData ()
 Release the data object and clean up the inputs - you want to do this if you hide the panel and dont want it to do updates More...
 
void SetErrorState (bool state)
 Set the Controls in the Panel error state on or off. Will turn each control on or off depending on their hideOnError flag. More...
 
void Setup (AppUI_Data data, Callback onDataChanged)
 Link the panel to the passed in data More...
 

Public Attributes

AppUI_Data data
 The data object that is being displayed More...
 
Transform rowParent
 
ScrollRect scrollTargetForMemberEvents
 
TextMeshProUGUI textTargetForHover
 The text label that will be updated when the XSelectable members in the panel are hovered More...
 

Properties

bool SetupComplete [get]
 True if Setup has been called and controls are setup. False if Setup has not been called, or ReleaseData has been called and controls are not setup. More...
 

Detailed Description

A panel that will display dynamic input fields based on the bound data class

Member Function Documentation

bool KSP.UI.Screens.AppUIInputPanel.AnyTextFieldHasFocus ( )
inline
AppUIMember KSP.UI.Screens.AppUIInputPanel.GetControl ( string  fieldName)
inline

Get a Control from the Input Panel by field name.

Parameters
fieldNameThe Field Name.
Returns
The control or null if no field found.
void KSP.UI.Screens.AppUIInputPanel.RefreshUI ( )
inline

Refresh the UIPanel Members without a reinitialize

void KSP.UI.Screens.AppUIInputPanel.ReleaseData ( )
inline

Release the data object and clean up the inputs - you want to do this if you hide the panel and dont want it to do updates

void KSP.UI.Screens.AppUIInputPanel.SetErrorState ( bool  state)
inline

Set the Controls in the Panel error state on or off. Will turn each control on or off depending on their hideOnError flag.

Parameters
stateTrue for error. False for no error.
void KSP.UI.Screens.AppUIInputPanel.Setup ( AppUI_Data  data,
Callback  onDataChanged 
)
inline

Link the panel to the passed in data

Parameters
datadata class to display fields
onDataChangedA callback that can be registered so that the data class can indicate changes back to the UI that wraps the panel

Member Data Documentation

AppUI_Data KSP.UI.Screens.AppUIInputPanel.data

The data object that is being displayed

Transform KSP.UI.Screens.AppUIInputPanel.rowParent
ScrollRect KSP.UI.Screens.AppUIInputPanel.scrollTargetForMemberEvents
TextMeshProUGUI KSP.UI.Screens.AppUIInputPanel.textTargetForHover

The text label that will be updated when the XSelectable members in the panel are hovered

Property Documentation

bool KSP.UI.Screens.AppUIInputPanel.SetupComplete
get

True if Setup has been called and controls are setup. False if Setup has not been called, or ReleaseData has been called and controls are not setup.


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