Move page script: Move page script moved page UIOBJECT EditBox to WoW:UIOBJECT EditBox without leaving a redirect

2023-08-15T04:49:06Z

Move page script moved page UIOBJECT EditBox to UIOBJECT EditBox without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

Authors on WoWWiki: This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

2015-02-14T06:51:02Z

This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

← Older revision	Revision as of 06:51, 14 February 2015
Line 1:	Line 1:
		{{widget}}

		For summary of ''all'' EditBox properties / methods see [[UISUMMARY EditBox]]

		== Edit Box ==
		A user can input text into the edit box which can then be retrieved using the [[API EditBox GetText\|EditBox:GetText()]] function.

		When declaring an edit box object make sure that you either set "font" attribute for <EditBox> element, or include a <FontString> element, thus declaring which font is to be used to display text input into your edit box. If you do not do so EditBox will not display any text, just a blinking cursor.

		<EditBox name="TestEditBox">
		.. Size
		.. Anchors
		.. Layers
		.. etc.

		<FontString inherits="GameFontNormal"/>
		</EditBox>

		== XML ==
		See [[XML/EditBox]].

		== LUA API ==
		{{User:Watchout/Inheritance\|
		* [[UIOBJECT UIObject\|UIObject]]
		** [[UIOBJECT FontInstance\|FontInstance]]
		** [[UIOBJECT Region\|Region]]
		*** [[UIOBJECT Frame\|Frame]]}}

		=== Methods ===
		* [[API EditBox AddHistoryLine\|EditBox:AddHistoryLine("text")]] - Add text to the edit history.
		* [[API EditBox ClearFocus\|EditBox:ClearFocus()]] - Removes text input focus from this editbox element.
		* [[API EditBox GetAltArrowKeyMode\|EditBox:GetAltArrowKeyMode()]] - Returns value of '''ignoreArrows''' attribute, in 1/nil format.
		* [[API EditBox GetBlinkSpeed\|EditBox:GetBlinkSpeed()]] - Returns value of '''blinkSpeed''' attribute.
		* [[API EditBox GetHistoryLines\|EditBox:GetHistoryLines()]] - Get the number of history lines for this edit box
		* [[API EditBox GetInputLanguage\|EditBox:GetInputLanguage()]] - Get the input language (locale based not in-game)
		* [[API EditBox GetMaxBytes\|EditBox:GetMaxBytes()]]
		* [[API EditBox GetMaxLetters\|EditBox:GetMaxLetters()]] - Returns value of '''letters''' attribute.
		* [[API EditBox GetNumLetters\|EditBox:GetNumLetters()]] - Gets the number of letters in the box.
		* [[API EditBox GetNumber\|EditBox:GetNumber()]] - Returns number entered in the editbox, or 0 if editbox text is not a number.
		* [[API EditBox GetText\|EditBox:GetText()]] - Get the current text contained in the edit box.
		* [[API EditBox GetTextInsets\|EditBox:GetTextInsets()]] - Returns list of left,right,top,bottom text insets.
		* [[API EditBox HasFocus\|EditBox:HasFocus()]] - Returns true if the edit box has the focus.
		* [[API EditBox HighlightText\|EditBox:HighlightText([startPos,endPos])]] - Set the highlight to all or some of the edit box text.
		* [[API EditBox Insert\|EditBox:Insert("text")]] - Insert text into the edit box.
		* [[API EditBox IsAutoFocus\|EditBox:IsAutoFocus()]] - Returns value of '''autoFocus''' attribute, in 1/nil format.
		* [[API EditBox IsMultiLine\|EditBox:IsMultiLine()]] - Returns value of '''multiLine''' attribute, in 1/nil format.
		* [[API EditBox IsNumeric\|EditBox:IsNumeric()]] - Returns value of '''numeric''' attribute, in 1/nil format.
		* [[API EditBox IsPassword\|EditBox:IsPassword()]] - Returns value of '''password''' attribute, in 1/nil format.
		* [[API EditBox SetAltArrowKeyMode\|EditBox:SetAltArrowKeyMode()]]
		* [[API EditBox SetAutoFocus\|EditBox:SetAutoFocus()]]
		* [[API EditBox SetBlinkSpeed\|EditBox:SetBlinkSpeed()]]
		* [[API EditBox SetFocus\|EditBox:SetFocus()]]
		* [[API EditBox SetHistoryLines\|EditBox:SetHistoryLines()]] - Set the number of history lines to remember.
		* [[API EditBox SetMaxBytes\|EditBox:SetMaxBytes(maxBytes)]] - Set the maximum byte size for entered text.
		* [[API EditBox SetMaxLetters\|EditBox:SetMaxLetters(maxLetters)]] - Set the maximum number of letters for entered text.
		* [[API EditBox SetMultiLine\|EditBox:SetMultiLine()]]
		* [[API EditBox SetNumber\|EditBox:SetNumber(number)]]
		* [[API EditBox SetNumeric\|EditBox:SetNumeric()]]
		* [[API EditBox SetPassword\|EditBox:SetPassword()]]
		* [[API EditBox SetSpacing\|EditBox:SetSpacing()]] - Sets the spacing, between multiple lines
		* [[API EditBox SetText\|EditBox:SetText("text")]] - Set the text contained in the edit box.
		* [[API EditBox SetTextInsets\|EditBox:SetTextInsets(l,r,t,b)]]
		* [[API EditBox ToggleInputLanguage\|EditBox:ToggleInputLanguage()]]


		=== Event Handlers ===
		* [[UIHANDLER OnCursorChanged\|OnCursorChanged]]
		* [[UIHANDLER OnEditFocusGained\|OnEditFocusGained]]
		* [[UIHANDLER OnEditFocusLost\|OnEditFocusLost]]
		* [[UIHANDLER OnEnterPressed\|OnEnterPressed]]
		* [[UIHANDLER OnEscapePressed\|OnEscapePressed]]
		* [[UIHANDLER OnInputLanguageChanged\|OnInputLanguageChanged]]
		* [[UIHANDLER OnSpacePressed\|OnSpacePressed]]
		* [[UIHANDLER OnTabPressed\|OnTabPressed]]
		* [[UIHANDLER OnTextChanged\|OnTextChanged]]
		* [[UIHANDLER OnTextSet\|OnTextSet]]


		== On multi-line and EditBox:SetHeight() ==

		Note that multi-line EditBoxes will ignore any attempts to set its height via [[API Region SetHeight\|:SetHeight]]() or via Dimension attributes in XML. They will start out the height of a single line of text, and keep expanding their area as needed. This effect becomes visible if the editbox has a backdrop set, or a texture anchored to its corners.

		Explicitly setting the top and bottom anchors with [[API Region SetPoint\|:SetPoint]]() will however size it like expected.

Bear at 06:51, 14 February 2015

2015-02-14T06:51:01Z

← Older revision	Revision as of 06:51, 14 February 2015
(No difference)

WoWWiki>SinusPi: /* XML */

2009-09-17T17:10:57Z

XML

← Older revision	Revision as of 17:10, 17 September 2009
(No difference)

WoWWiki>Dschiggs: /* LUA API */

2009-08-19T11:49:05Z

LUA API

← Older revision	Revision as of 11:49, 19 August 2009
(No difference)

WoWWiki>Peeka: HasFocus wasnt here

2009-04-28T00:12:39Z

HasFocus wasnt here

← Older revision	Revision as of 00:12, 28 April 2009
(No difference)

WoWWiki>Fibby at 03:11, 8 September 2007

2007-09-08T03:11:34Z

← Older revision	Revision as of 03:11, 8 September 2007
(No difference)

WoWWiki>VelvetPaw at 22:30, 9 December 2006

2006-12-09T22:30:40Z

← Older revision	Revision as of 22:30, 9 December 2006
(No difference)

WoWWiki>Schelli at 10:05, 8 October 2006

2006-10-08T10:05:51Z

← Older revision	Revision as of 10:05, 8 October 2006
(No difference)

WoWWiki>Jncl: /* Edit Box */

2006-09-13T21:31:07Z

Edit Box

← Older revision	Revision as of 21:31, 13 September 2006
(No difference)

← Older revision	Revision as of 06:51, 14 February 2015
Line 1:	Line 1:
		{{widget}}

		For summary of ''all'' EditBox properties / methods see [[UISUMMARY EditBox]]

		== Edit Box ==
		A user can input text into the edit box which can then be retrieved using the [[API EditBox GetText\|EditBox:GetText()]] function.

		When declaring an edit box object make sure that you either set "font" attribute for <EditBox> element, or include a <FontString> element, thus declaring which font is to be used to display text input into your edit box. If you do not do so EditBox will not display any text, just a blinking cursor.

		<EditBox name="TestEditBox">
		.. Size
		.. Anchors
		.. Layers
		.. etc.

		<FontString inherits="GameFontNormal"/>
		</EditBox>

		== XML ==
		See [[XML/EditBox]].

		== LUA API ==
		{{User:Watchout/Inheritance\|
		* [[UIOBJECT UIObject\|UIObject]]
		** [[UIOBJECT FontInstance\|FontInstance]]
		** [[UIOBJECT Region\|Region]]
		*** [[UIOBJECT Frame\|Frame]]}}

		=== Methods ===
		* [[API EditBox AddHistoryLine\|EditBox:AddHistoryLine("text")]] - Add text to the edit history.
		* [[API EditBox ClearFocus\|EditBox:ClearFocus()]] - Removes text input focus from this editbox element.
		* [[API EditBox GetAltArrowKeyMode\|EditBox:GetAltArrowKeyMode()]] - Returns value of '''ignoreArrows''' attribute, in 1/nil format.
		* [[API EditBox GetBlinkSpeed\|EditBox:GetBlinkSpeed()]] - Returns value of '''blinkSpeed''' attribute.
		* [[API EditBox GetHistoryLines\|EditBox:GetHistoryLines()]] - Get the number of history lines for this edit box
		* [[API EditBox GetInputLanguage\|EditBox:GetInputLanguage()]] - Get the input language (locale based not in-game)
		* [[API EditBox GetMaxBytes\|EditBox:GetMaxBytes()]]
		* [[API EditBox GetMaxLetters\|EditBox:GetMaxLetters()]] - Returns value of '''letters''' attribute.
		* [[API EditBox GetNumLetters\|EditBox:GetNumLetters()]] - Gets the number of letters in the box.
		* [[API EditBox GetNumber\|EditBox:GetNumber()]] - Returns number entered in the editbox, or 0 if editbox text is not a number.
		* [[API EditBox GetText\|EditBox:GetText()]] - Get the current text contained in the edit box.
		* [[API EditBox GetTextInsets\|EditBox:GetTextInsets()]] - Returns list of left,right,top,bottom text insets.
		* [[API EditBox HasFocus\|EditBox:HasFocus()]] - Returns true if the edit box has the focus.
		* [[API EditBox HighlightText\|EditBox:HighlightText([startPos,endPos])]] - Set the highlight to all or some of the edit box text.
		* [[API EditBox Insert\|EditBox:Insert("text")]] - Insert text into the edit box.
		* [[API EditBox IsAutoFocus\|EditBox:IsAutoFocus()]] - Returns value of '''autoFocus''' attribute, in 1/nil format.
		* [[API EditBox IsMultiLine\|EditBox:IsMultiLine()]] - Returns value of '''multiLine''' attribute, in 1/nil format.
		* [[API EditBox IsNumeric\|EditBox:IsNumeric()]] - Returns value of '''numeric''' attribute, in 1/nil format.
		* [[API EditBox IsPassword\|EditBox:IsPassword()]] - Returns value of '''password''' attribute, in 1/nil format.
		* [[API EditBox SetAltArrowKeyMode\|EditBox:SetAltArrowKeyMode()]]
		* [[API EditBox SetAutoFocus\|EditBox:SetAutoFocus()]]
		* [[API EditBox SetBlinkSpeed\|EditBox:SetBlinkSpeed()]]
		* [[API EditBox SetFocus\|EditBox:SetFocus()]]
		* [[API EditBox SetHistoryLines\|EditBox:SetHistoryLines()]] - Set the number of history lines to remember.
		* [[API EditBox SetMaxBytes\|EditBox:SetMaxBytes(maxBytes)]] - Set the maximum byte size for entered text.
		* [[API EditBox SetMaxLetters\|EditBox:SetMaxLetters(maxLetters)]] - Set the maximum number of letters for entered text.
		* [[API EditBox SetMultiLine\|EditBox:SetMultiLine()]]
		* [[API EditBox SetNumber\|EditBox:SetNumber(number)]]
		* [[API EditBox SetNumeric\|EditBox:SetNumeric()]]
		* [[API EditBox SetPassword\|EditBox:SetPassword()]]
		* [[API EditBox SetSpacing\|EditBox:SetSpacing()]] - Sets the spacing, between multiple lines
		* [[API EditBox SetText\|EditBox:SetText("text")]] - Set the text contained in the edit box.
		* [[API EditBox SetTextInsets\|EditBox:SetTextInsets(l,r,t,b)]]
		* [[API EditBox ToggleInputLanguage\|EditBox:ToggleInputLanguage()]]


		=== Event Handlers ===
		* [[UIHANDLER OnCursorChanged\|OnCursorChanged]]
		* [[UIHANDLER OnEditFocusGained\|OnEditFocusGained]]
		* [[UIHANDLER OnEditFocusLost\|OnEditFocusLost]]
		* [[UIHANDLER OnEnterPressed\|OnEnterPressed]]
		* [[UIHANDLER OnEscapePressed\|OnEscapePressed]]
		* [[UIHANDLER OnInputLanguageChanged\|OnInputLanguageChanged]]
		* [[UIHANDLER OnSpacePressed\|OnSpacePressed]]
		* [[UIHANDLER OnTabPressed\|OnTabPressed]]
		* [[UIHANDLER OnTextChanged\|OnTextChanged]]
		* [[UIHANDLER OnTextSet\|OnTextSet]]


		== On multi-line and EditBox:SetHeight() ==

		Note that multi-line EditBoxes will ignore any attempts to set its height via [[API Region SetHeight\|:SetHeight]]() or via Dimension attributes in XML. They will start out the height of a single line of text, and keep expanding their area as needed. This effect becomes visible if the editbox has a backdrop set, or a texture anchored to its corners.

		Explicitly setting the top and bottom anchors with [[API Region SetPoint\|:SetPoint]]() will however size it like expected.

WoW:UIOBJECT EditBox - Revision history