EditBox
widget type79 methodsavailable in: camelot
CreateFrame("EditBox", …) makes one. It has every method of Frame, plus 79 of its own.
Inherits from
- EditBox · 79
- Frame · 126
- Region · 16
- ScriptRegion · 55
- ScriptRegionResizing · 13
- AnimatableObject · 3
- Object · 5
- FrameScriptObject · 21
The number is each type's own documented methods. A EditBox has all of them.
Methods
In the emulator: 56 implemented, 23 guessed.
| method | what it does | status |
|---|---|---|
AddHistoryLine | Adds a string to the edit box's history. · warcraft.wiki.gg ↗(text: string) | implemented |
ClearFocus | Clears the input text focus out of the edit box. · warcraft.wiki.gg ↗() | implemented |
ClearHighlightText | Removes the edit box's text selection. · by wowlua() | implemented |
ClearHistory | Clears the edit box's history of entered lines. · by wowlua() | implemented |
Disable | Disables the edit box so it no longer takes input. · by wowlua() | implemented |
Enable | Enables the edit box so it takes input. · by wowlua() | implemented |
GetAltArrowKeyMode | Returns true if the edit box ignores keyboard arrows. · warcraft.wiki.gg ↗(): boolean | guessed |
GetBlinkSpeed | Returns how fast the edit box's cursor blinks. · by wowlua(): number | guessed |
GetCursorPosition | Returns the position of the editbox cursor. · warcraft.wiki.gg ↗(): number | guessed |
GetDisplayText | Returns the text as the edit box shows it. · by wowlua(): string? | guessed |
GetFont | Returns the basic font properties. · warcraft.wiki.gg ↗(): (string, number, TBFFlags) | implemented |
GetFontObject | Returns the edit box's font object. · by wowlua(): Font | guessed |
GetHighlightColor | Returns the color of the edit box's text selection as red, green, blue and alpha. · by wowlua(): (number, number, number, number) | guessed |
GetHistoryLines | Returns how many entered lines the edit box keeps in its history. · by wowlua(): number | guessed |
GetIndentedWordWrap | Whether wrapped lines in the edit box are indented. · by wowlua(): boolean | guessed |
GetInputLanguage | Returns the language used for providing input to the edit box. · warcraft.wiki.gg ↗(): string | guessed |
GetJustifyH | Returns the edit box's horizontal text alignment. · by wowlua(): JustifyHorizontal | guessed |
GetJustifyV | Returns the edit box's vertical text alignment. · by wowlua(): JustifyVertical | guessed |
GetMaxBytes | Returns the most bytes of text the edit box accepts. · by wowlua(): number | guessed |
GetMaxLetters | Returns the most letters the edit box accepts. · by wowlua(): number | guessed |
GetNumLetters | Returns the number of letters in the edit box. · by wowlua(): number? | guessed |
GetNumLines | Returns the number of lines in the edit box. · by wowlua(): number | implemented |
GetNumber | Reads any number value in the edit box. · warcraft.wiki.gg ↗(): number? | implemented |
GetShadowColor | Returns the color of the edit box's text shadow as red, green, blue and alpha. · by wowlua(): (number, number, number, number) | guessed |
GetShadowOffset | Returns the offset of the edit box's text shadow. · by wowlua(): (number, number) | guessed |
GetSpacing | Returns the spacing between the edit box's lines. · by wowlua(): number | guessed |
GetText | Returns the value of an edit box. · warcraft.wiki.gg ↗(): string | implemented |
GetTextColor | Returns the edit box's text color as red, green, blue and alpha. · by wowlua(): (number, number, number, number) | guessed |
GetTextInsets | Returns the amount of padding applied to the edit box text. · warcraft.wiki.gg ↗(): (number, number, number, number) | implemented |
GetUTF8CursorPosition | Returns the cursor position in the edit box, counted in characters. · by wowlua(): number | guessed |
GetVisibleTextByteLimit | Returns the most bytes of text the edit box shows. · by wowlua(): number | guessed |
HasFocus | Whether the edit box has the keyboard focus. · by wowlua(): boolean | implemented |
HasText | Whether the edit box has text. · by wowlua(): boolean | guessed |
HighlightText | Selects text in an EditBox. · warcraft.wiki.gg ↗(start: number, stop: number) | implemented |
Insert | Inserts text at the current cursor position. · warcraft.wiki.gg ↗(text: string) | implemented |
IsAlphabeticOnly | Whether the edit box accepts only letters. · by wowlua(): boolean | implemented |
IsAutoFocus | Whether the edit box takes the keyboard focus when it is shown. · by wowlua(): boolean | implemented |
IsCountInvisibleLetters | Whether the edit box counts invisible characters, such as color codes, toward its letter limit. · by wowlua(): boolean | implemented |
IsEnabled | Whether the edit box is enabled. · by wowlua(): boolean | implemented |
IsInIMECompositionMode | Whether the player is composing text with an input method editor in the edit box. · by wowlua(): boolean | implemented |
IsMultiLine | Whether the edit box accepts several lines. · by wowlua(): boolean | implemented |
IsNumeric | Whether the edit box accepts only digits. · by wowlua(): boolean | implemented |
IsNumericFullRange | Whether the edit box accepts any number, including negative and decimal ones. · by wowlua(): boolean | implemented |
IsPassword | Whether the edit box hides its text as a password. · by wowlua(): boolean | implemented |
IsSecureText | Whether the edit box's text is secure. · by wowlua(): boolean | implemented |
ResetInputMode | Resets the edit box's input mode. · by wowlua() | guessed |
SetAlphabeticOnly | Sets whether the edit box accepts only letters. · by wowlua(enabled: boolean) | implemented |
SetAltArrowKeyMode | Sets whether the arrow keys move the cursor only while Alt is held. · by wowlua(altMode: boolean) | implemented |
SetAutoFocus | Sets whether the cursor should automatically focus on the edit box when it is shown. · warcraft.wiki.gg ↗(autoFocus: boolean) | implemented |
SetBlinkSpeed | Sets how fast the edit box's cursor blinks. · by wowlua(cursorBlinkSpeedSec: number) | implemented |
SetCountInvisibleLetters | Sets if invisible characters should count towards max letter count. · warcraft.wiki.gg ↗(countInvisibleLetters: boolean) | implemented |
SetCursorPosition | Sets the position of the cursor in the edit box. · warcraft.wiki.gg ↗(cursorPosition: number) | implemented |
SetEnabled | Enables or disables the edit box, allowing or preventing user interaction. · warcraft.wiki.gg ↗(enabled: boolean) | implemented |
SetFocus | Gives the edit box the keyboard focus. · by wowlua() | implemented |
SetFont | Sets the basic font properties. · warcraft.wiki.gg ↗(fontFile: string, height: uiFontHeight, flags: TBFFlags): boolean | implemented |
SetFontObject | Sets the edit box's font object. · by wowlua(font: Font) | implemented |
SetHighlightColor | Sets the object's highlight color. · warcraft.wiki.gg ↗(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetHistoryLines | Sets how many entered lines the edit box keeps in its history. · by wowlua(numHistoryLines: number) | implemented |
SetIndentedWordWrap | Sets whether wrapped lines in the edit box are indented. · by wowlua(isIndented: boolean) | implemented |
SetJustifyH | Sets the edit box's horizontal text alignment. · by wowlua(justifyH: JustifyHorizontal) | implemented |
SetJustifyV | Sets the edit box's vertical text alignment. · by wowlua(justifyV: JustifyVertical) | implemented |
SetMaxBytes | Sets the most bytes of text the edit box accepts. · by wowlua(maxBytes: number) | implemented |
SetMaxLetters | Sets the most letters the edit box accepts. · by wowlua(maxLetters: number) | implemented |
SetMultiLine | Sets whether the edit box shows more than one line of text. · warcraft.wiki.gg ↗(multiline: boolean) | implemented |
SetNumber | Sets the edit box's text to a number. · by wowlua(number: number) | implemented |
SetNumeric | Specifies that the EditBox can only contain numeric values. · warcraft.wiki.gg ↗(isNumeric: boolean) | implemented |
SetNumericFullRange | Sets whether the edit box accepts any number, including negative and decimal ones. · by wowlua(isNumeric: boolean) | implemented |
SetPassword | Sets whether all character in the EditBox are shown as *. · warcraft.wiki.gg ↗(isPassword: boolean) | implemented |
SetSecureText | Sets whether the edit box's text is secure. · by wowlua(isSecure: boolean) | implemented |
SetSecurityDisablePaste | Stops pasting into the edit box. · by wowlua() | implemented |
SetSecurityDisableSetText | Blocks setting the edit box's text. · by wowlua() | implemented |
SetShadowColor | Sets the color of the edit box's text shadow. · by wowlua(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetShadowOffset | Sets the offset of the edit box's text shadow. · by wowlua(offsetX: number, offsetY: number) | implemented |
SetSpacing | Sets the spacing between the edit box's lines. · by wowlua(fontHeight: number) | implemented |
SetText | Sets the edit box text. · warcraft.wiki.gg ↗(text: string) | implemented |
SetTextColor | Sets the text color. · warcraft.wiki.gg ↗(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetTextInsets | Sets the amount of padding applied to the edit box text. · warcraft.wiki.gg ↗(left: number, right: number, top: number, bottom: number) | implemented |
SetVisibleTextByteLimit | Sets the most bytes of text the edit box shows. · by wowlua(maxVisibleBytes: number) | implemented |
ToggleInputLanguage | Switches the edit box's input language. · by wowlua() | guessed |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.