PIXEL.TextEntry

Base panel: Panel (opens in a new tab)
Source: cl_text_entry.lua (opens in a new tab)
Description: PIXEL styled text entry container with integrated label.

Methods

The following methods are available on the PIXEL.TextEntry panel:

boolean PANEL:IsEnabled()

Returns whether text input is enabled.

PANEL:SetEnabled( boolean )

Enables or disables text input.

string PANEL:GetValue()

Returns current text value.

PANEL:SetValue( string )

Sets current text value.

boolean PANEL:IsMultiline()

Returns whether multiline input is enabled.

PANEL:SetMultiline( boolean )

Enables or disables multiline input.

boolean PANEL:IsEditing()

Returns whether this entry currently has keyboard focus.

boolean PANEL:GetEnterAllowed()

Returns whether Enter submits single-line input.

PANEL:SetEnterAllowed( boolean )

Sets whether Enter submits single-line input.

boolean PANEL:GetUpdateOnType()

Returns whether value updates fire while typing.

PANEL:SetUpdateOnType( boolean )

Enables or disables update-on-type behavior.

boolean PANEL:GetNumeric()

Returns whether numeric-only input mode is enabled.

PANEL:SetNumeric( boolean )

Enables or disables numeric-only input mode.

boolean PANEL:GetHistoryEnabled()

Returns whether history navigation is enabled.

PANEL:SetHistoryEnabled( boolean )

Enables or disables history navigation.

boolean PANEL:GetTabbingDisabled()

Returns whether tabbing is disabled.

PANEL:SetTabbingDisabled( boolean )

Enables or disables tabbing behavior.

string PANEL:GetPlaceholderText()

Returns placeholder text.

PANEL:SetPlaceholderText( string )

Sets placeholder text.

string PANEL:GetFont()

Returns active text font.

PANEL:SetFont( string )

Sets active text font.

number PANEL:GetInt()

Returns current value rounded to nearest integer.

number PANEL:GetFloat()

Returns current value parsed as a float.

PANEL:SetEditable( boolean )

Sets whether editing is allowed.

boolean PANEL:AllowInput( string )

Callback used to filter raw character input.

string[] PANEL:GetAutoComplete( string )

Callback used to provide autocomplete suggestions.

PANEL:OnKeyCode( number )

Callback fired when a key code is received.

GetPlaceholderText IsEnabled