HPL3/Amnesia: Rebirth/Scripting/cWidgetTextBox

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 23:07, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cWidgetTextBox has no public fields. ==Fu...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Contents

Fields

cWidgetTextBox has no public fields.

Functions

Return Type Function And Description
cGuiGlobalShortcut AddShortcut(int alKeyModifiers, eKey aKey, eGuiMessage aMsg = eGuiMessage_ButtonPressed, const cGuiMessageData &in aData = cGuiMessageData, bool abBypassVisibility = true, bool abBypassEnabled = true)
void AttachChild(iWidget@ apChild)
void CenterGlobalPositionInSet()
bool ClipsGraphics()
cVector2f GetBackgroundSize()
bool GetCallbackOnLostFocus()
bool GetCallbacksDisabled()
bool GetCanEdit()
cVector3f GetChildrenOffset()
bool GetClipActive()
cColor GetColorMul()
int GetDecimals()
cColor GetDefaultFontColor()
cVector2f GetDefaultFontSize()
iFontData GetDefaultFontType()
iWidget GetFocusNavigation(eUIArrow aDir)
bool GetForceCallBackOnEnter()
cVector3f GetGlobalPosition()
tWString GetIllegalChars()
bool GetLegalCharCodeLimitEnabled()
cVector3f GetLocalPosition()
float GetLowerBound()
int GetMaxTextLength()
bool GetMouseIsOver()
tString GetName()
float GetNumericAdd()
float GetNumericValue()
iWidget GetParent()
cGuiGfxElement GetPointerGfx()
cVector3f GetScrollAmount()
cGuiSet GetSet()
cVector2f GetSize()
tWString GetText()
tWString GetToolTip()
iWidget GetToolTipWidget()
eWidgetType GetType()
float GetUpperBound()
int GetUserValue()
bool HasFocus()
bool HasFocusNavigation()
void Init()
bool IsConnectedTo(iWidget@ apWidget, bool abIsStartWidget = true)
bool IsConnectedToChildren()
bool IsEnabled()
bool IsGlobalKeyPressListener()
bool IsGlobalUIInputListener()
bool IsRightUnderMouse()
bool IsVisible()
bool PointIsInside(const cVector2f &in avPoint, bool abOnlyClipped)
bool ProcessMessage(eGuiMessage aMessage, const cGuiMessageData &in aData, bool abSkipVisCheck = false, bool abSkipEnabledCheck = false)
void RemoveChild(iWidget@ apChild)
void SetAffectedByScroll(bool abX)
void SetCallbackOnLostFocus(bool abX)
void SetCallbacksDisabled(bool abX)
void SetCanEdit(bool abX)
void SetChildrenOffset(const cVector3f &in )
void SetClipActive(bool abX)
void SetColorMul(const cColor &in aColor)
void SetConnectedToChildren(bool abX)
void SetDecimals(int alX)
void SetDefaultFontColor(const cColor &in aColor)
void SetDefaultFontSize(const cVector2f &in avSize)
void SetDefaultFontType(iFontData@ apFont)
void SetEnabled(bool abX)
void SetFocusNavigation(eUIArrow aDir, iWidget@ apWidget)
void SetForceCallBackOnEnter(bool abX)
void SetGlobalKeyPressListener(bool abX)
void SetGlobalPosition(const cVector3f &in avPos)
void SetGlobalUIInputListener(bool abX)
void SetIllegalChars(const tWString &in asIllegalChars)
void SetLegalCharCodeLimitEnabled(bool abX)
void SetLowerBound(bool abX, float afValue = 0)
void SetMaxTextLength(int alLength)
void SetMaxTextSizeNeg(float afX)
void SetName(const tString &in asName)
void SetNumericAdd(float afX)
void SetNumericValue(float afX)
void SetPosition(const cVector3f &in avPos)
void SetScrollAmount(const cVector3f &in avX)
void SetSelectedText(int alStart = 0, int alCount = -1)
void SetShowButtons(bool abX)
void SetSize(const cVector2f &in avSize)
void SetText(const tWString &in asText)
void SetToolTip(const tWString &in asToolTip)
void SetToolTipEnabled(bool abX)
void SetUpperBound(bool abX, float afValue = 0)
void SetUserValue(int alX)
void SetVisible(bool abX)
void Update(float afTimeStep)

Details

AddShortcut

cGuiGlobalShortcut@ AddShortcut(int alKeyModifiers,
                                eKey aKey,
                                eGuiMessage aMsg = eGuiMessage_ButtonPressed,
                                const cGuiMessageData &in aData = cGuiMessageData,
                                bool abBypassVisibility = true,
                                bool abBypassEnabled = true)


Parameters

Returns:

  • cGuiGlobalShortcut@

AttachChild

void AttachChild(iWidget@ apChild)


Parameters

Returns:

  • void

CenterGlobalPositionInSet

void CenterGlobalPositionInSet()

Returns:

  • void

ClipsGraphics

bool ClipsGraphics()

Returns:

  • bool

GetBackgroundSize

cVector2f GetBackgroundSize()

Returns:

  • cVector2f

GetCallbackOnLostFocus

bool GetCallbackOnLostFocus()

Returns:

  • bool

GetCallbacksDisabled

bool GetCallbacksDisabled()

Returns:

  • bool

GetCanEdit

bool GetCanEdit()

Returns:

  • bool

GetChildrenOffset

const cVector3f& GetChildrenOffset()

Returns:

  • const cVector3f&

GetClipActive

bool GetClipActive()

Returns:

  • bool

GetColorMul

const cColor& GetColorMul()

Returns:

  • const cColor&

GetDecimals

int GetDecimals()

Returns:

  • int

GetDefaultFontColor

const cColor& GetDefaultFontColor()

Returns:

  • const cColor&

GetDefaultFontSize

const cVector2f& GetDefaultFontSize()

Returns:

  • const cVector2f&

GetDefaultFontType

iFontData@ GetDefaultFontType()

Returns:

  • iFontData@

GetFocusNavigation

iWidget@ GetFocusNavigation(eUIArrow aDir)


Parameters

Returns:

  • iWidget@

GetForceCallBackOnEnter

bool GetForceCallBackOnEnter()

Returns:

  • bool

GetGlobalPosition

const cVector3f& GetGlobalPosition()

Returns:

  • const cVector3f&

GetIllegalChars

const tWString& GetIllegalChars()

Returns:

  • const tWString&

GetLegalCharCodeLimitEnabled

bool GetLegalCharCodeLimitEnabled()

Returns:

  • bool

GetLocalPosition

const cVector3f& GetLocalPosition()

Returns:

  • const cVector3f&

GetLowerBound

float GetLowerBound()

Returns:

  • float

GetMaxTextLength

int GetMaxTextLength()

Returns:

  • int

GetMouseIsOver

bool GetMouseIsOver()

Returns:

  • bool

GetName

const tString& GetName()

Returns:

  • const tString&

GetNumericAdd

float GetNumericAdd()

Returns:

  • float

GetNumericValue

float GetNumericValue()

Returns:

  • float

GetParent

iWidget@ GetParent()

Returns:

  • iWidget@

GetPointerGfx

cGuiGfxElement@ GetPointerGfx()

Returns:

  • cGuiGfxElement@

GetScrollAmount

const cVector3f& GetScrollAmount()

Returns:

  • const cVector3f&

GetSet

cGuiSet@ GetSet()

Returns:

  • cGuiSet@

GetSize

const cVector2f& GetSize()

Returns:

  • const cVector2f&

GetText

const tWString& GetText()

Returns:

  • const tWString&

GetToolTip

const tWString& GetToolTip()

Returns:

  • const tWString&

GetToolTipWidget

iWidget@ GetToolTipWidget()

Returns:

  • iWidget@

GetType

eWidgetType GetType()

Returns:

  • eWidgetType

GetUpperBound

float GetUpperBound()

Returns:

  • float

GetUserValue

int GetUserValue()

Returns:

  • int

HasFocus

bool HasFocus()

Returns:

  • bool

HasFocusNavigation

bool HasFocusNavigation()

Returns:

  • bool

Init

void Init()

Returns:

  • void

IsConnectedTo

bool IsConnectedTo(iWidget@ apWidget,
                   bool abIsStartWidget = true)


Parameters

  • apWidget (iWidget@) —
  • abIsStartWidget (bool) —

Returns:

  • bool

IsConnectedToChildren

bool IsConnectedToChildren()

Returns:

  • bool

IsEnabled

bool IsEnabled()

Returns:

  • bool

IsGlobalKeyPressListener

bool IsGlobalKeyPressListener()

Returns:

  • bool

IsGlobalUIInputListener

bool IsGlobalUIInputListener()

Returns:

  • bool

IsRightUnderMouse

bool IsRightUnderMouse()

Returns:

  • bool

IsVisible

bool IsVisible()

Returns:

  • bool

PointIsInside

bool PointIsInside(const cVector2f &in avPoint,
                   bool abOnlyClipped)


Parameters

  • avPoint (cVector2f) —
  • abOnlyClipped (bool) —

Returns:

  • bool

ProcessMessage

bool ProcessMessage(eGuiMessage aMessage,
                    const cGuiMessageData &in aData,
                    bool abSkipVisCheck = false,
                    bool abSkipEnabledCheck = false)


Parameters

Returns:

  • bool

RemoveChild

void RemoveChild(iWidget@ apChild)


Parameters

Returns:

  • void

SetAffectedByScroll

void SetAffectedByScroll(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCallbackOnLostFocus

void SetCallbackOnLostFocus(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCallbacksDisabled

void SetCallbacksDisabled(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCanEdit

void SetCanEdit(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetChildrenOffset

void SetChildrenOffset(const cVector3f &in )


Parameters

Returns:

  • void

SetClipActive

void SetClipActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetColorMul

void SetColorMul(const cColor &in aColor)


Parameters

Returns:

  • void

SetConnectedToChildren

void SetConnectedToChildren(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetDecimals

void SetDecimals(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetDefaultFontColor

void SetDefaultFontColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetDefaultFontSize

void SetDefaultFontSize(const cVector2f &in avSize)


Parameters

Returns:

  • void

SetDefaultFontType

void SetDefaultFontType(iFontData@ apFont)


Parameters

Returns:

  • void

SetEnabled

void SetEnabled(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFocusNavigation

void SetFocusNavigation(eUIArrow aDir,
                        iWidget@ apWidget)


Parameters

Returns:

  • void

SetForceCallBackOnEnter

void SetForceCallBackOnEnter(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetGlobalKeyPressListener

void SetGlobalKeyPressListener(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetGlobalPosition

void SetGlobalPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetGlobalUIInputListener

void SetGlobalUIInputListener(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetIllegalChars

void SetIllegalChars(const tWString &in asIllegalChars)


Parameters

Returns:

  • void

SetLegalCharCodeLimitEnabled

void SetLegalCharCodeLimitEnabled(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetLowerBound

void SetLowerBound(bool abX,
                   float afValue = 0)


Parameters

  • abX (bool) —
  • afValue (float) —

Returns:

  • void

SetMaxTextLength

void SetMaxTextLength(int alLength)


Parameters

  • alLength (int) —

Returns:

  • void

SetMaxTextSizeNeg

void SetMaxTextSizeNeg(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetName

void SetName(const tString &in asName)


Parameters

Returns:

  • void

SetNumericAdd

void SetNumericAdd(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetNumericValue

void SetNumericValue(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetScrollAmount

void SetScrollAmount(const cVector3f &in avX)


Parameters

Returns:

  • void

SetSelectedText

void SetSelectedText(int alStart = 0,
                     int alCount = -1)


Parameters

  • alStart (int) —
  • alCount (int) —

Returns:

  • void

SetShowButtons

void SetShowButtons(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSize

void SetSize(const cVector2f &in avSize)


Parameters

Returns:

  • void

SetText

void SetText(const tWString &in asText)


Parameters

Returns:

  • void

SetToolTip

void SetToolTip(const tWString &in asToolTip)


Parameters

Returns:

  • void

SetToolTipEnabled

void SetToolTipEnabled(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetUpperBound

void SetUpperBound(bool abX,
                   float afValue = 0)


Parameters

  • abX (bool) —
  • afValue (float) —

Returns:

  • void

SetUserValue

void SetUserValue(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetVisible

void SetVisible(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

Update

void Update(float afTimeStep)


Parameters

  • afTimeStep (float) —

Returns:

  • void

References

See all references...