Update

ui/EditBox.lua

@@ -0,0 +1,212 @@
+---@meta
+
+---@class EditBox : Frame, FontInstance
+EditBox = {
+	--- Adds text to the edit history.
+	--- @param text string The text to add to the history.
+	--- @example
+	--- myEditBox:AddHistoryLine("Previous input")
+	AddHistoryLine = function(self, text) end,
+
+	--- Removes text input focus from this edit box.
+	--- @example
+	--- myEditBox:ClearFocus()
+	ClearFocus = function(self) end,
+
+	--- Returns the value of the ignoreArrows attribute.
+	--- @return boolean ignoreArrows True if arrow keys are ignored.
+	--- @example
+	--- local ignoreArrows = myEditBox:GetAltArrowKeyMode()
+	GetAltArrowKeyMode = function(self) end,
+
+	--- Returns the blink speed of the cursor.
+	--- @return number blinkSpeed The blink speed of the cursor.
+	--- @example
+	--- local blinkSpeed = myEditBox:GetBlinkSpeed()
+	GetBlinkSpeed = function(self) end,
+
+	--- Gets the number of history lines for this edit box.
+	--- @return number historyLines The number of history lines.
+	--- @example
+	--- local historyLines = myEditBox:GetHistoryLines()
+	GetHistoryLines = function(self) end,
+
+	--- Gets the input language (locale based, not in-game).
+	--- @return string inputLanguage The current input language.
+	--- @example
+	--- local inputLanguage = myEditBox:GetInputLanguage()
+	GetInputLanguage = function(self) end,
+
+	--- Returns the maximum byte size for entered text.
+	--- @return number maxBytes The maximum byte size.
+	--- @example
+	--- local maxBytes = myEditBox:GetMaxBytes()
+	GetMaxBytes = function(self) end,
+
+	--- Returns the maximum number of letters for entered text.
+	--- @return number maxLetters The maximum number of letters.
+	--- @example
+	--- local maxLetters = myEditBox:GetMaxLetters()
+	GetMaxLetters = function(self) end,
+
+	--- Gets the number of letters in the box.
+	--- @return number numLetters The number of letters.
+	--- @example
+	--- local numLetters = myEditBox:GetNumLetters()
+	GetNumLetters = function(self) end,
+
+	--- Returns the number entered in the edit box, or 0 if the text is not a number.
+	--- @return number number The number entered.
+	--- @example
+	--- local number = myEditBox:GetNumber()
+	GetNumber = function(self) end,
+
+	--- Gets the current text contained in the edit box.
+	--- @return string text The current text.
+	--- @example
+	--- local text = myEditBox:GetText()
+	GetText = function(self) end,
+
+	--- Returns the text insets for the edit box.
+	--- @return number left The left inset.
+	--- @return number right The right inset.
+	--- @return number top The top inset.
+	--- @return number bottom The bottom inset.
+	--- @example
+	--- local left, right, top, bottom = myEditBox:GetTextInsets()
+	GetTextInsets = function(self) end,
+
+	--- Returns true if the edit box has focus.
+	--- @return boolean hasFocus True if the edit box has focus.
+	--- @example
+	--- local hasFocus = myEditBox:HasFocus()
+	HasFocus = function(self) end,
+
+	--- Sets the highlight to all or some of the edit box text.
+	--- @param startPos number? Optional. The start position of the highlight.
+	--- @param endPos number? Optional. The end position of the highlight.
+	--- @example
+	--- myEditBox:HighlightText(1, 5) -- Highlight first 5 characters
+	HighlightText = function(self, startPos, endPos) end,
+
+	--- Inserts text into the edit box.
+	--- @param text string The text to insert.
+	--- @example
+	--- myEditBox:Insert("Hello")
+	Insert = function(self, text) end,
+
+	--- Returns true if the edit box is set to auto focus.
+	--- @return boolean autoFocus True if auto focus is enabled.
+	--- @example
+	--- local autoFocus = myEditBox:IsAutoFocus()
+	IsAutoFocus = function(self) end,
+
+	--- Returns true if the edit box is multi-line.
+	--- @return boolean multiLine True if multi-line is enabled.
+	--- @example
+	--- local multiLine = myEditBox:IsMultiLine()
+	IsMultiLine = function(self) end,
+
+	--- Returns true if the edit box is numeric.
+	--- @return boolean numeric True if numeric input is enabled.
+	--- @example
+	--- local numeric = myEditBox:IsNumeric()
+	IsNumeric = function(self) end,
+
+	--- Returns true if the edit box is a password field.
+	--- @return boolean password True if password input is enabled.
+	--- @example
+	--- local password = myEditBox:IsPassword()
+	IsPassword = function(self) end,
+
+	--- Sets the mode for the Alt arrow key.
+	--- @param ignoreArrows boolean True to ignore arrow keys.
+	--- @example
+	--- myEditBox:SetAltArrowKeyMode(true)
+	SetAltArrowKeyMode = function(self, ignoreArrows) end,
+
+	--- Sets the auto focus mode for the edit box.
+	--- @param autoFocus boolean True to enable auto focus.
+	--- @example
+	--- myEditBox:SetAutoFocus(true)
+	SetAutoFocus = function(self, autoFocus) end,
+
+	--- Sets the blink speed of the cursor.
+	--- @param blinkSpeed number The blink speed to set.
+	--- @example
+	--- myEditBox:SetBlinkSpeed(0.5)
+	SetBlinkSpeed = function(self, blinkSpeed) end,
+
+	--- Sets focus to the edit box.
+	--- @example
+	--- myEditBox:SetFocus()
+	SetFocus = function(self) end,
+
+	--- Sets the number of history lines to remember.
+	--- @param historyLines number The number of history lines.
+	--- @example
+	--- myEditBox:SetHistoryLines(10)
+	SetHistoryLines = function(self, historyLines) end,
+
+	--- Sets the maximum byte size for entered text.
+	--- @param maxBytes number The maximum byte size.
+	--- @example
+	--- myEditBox:SetMaxBytes(255)
+	SetMaxBytes = function(self, maxBytes) end,
+
+	--- Sets the maximum number of letters for entered text.
+	--- @param maxLetters number The maximum number of letters.
+	--- @example
+	--- myEditBox:SetMaxLetters(100)
+	SetMaxLetters = function(self, maxLetters) end,
+
+	--- Sets the edit box to multi-line mode.
+	--- @param multiLine boolean True to enable multi-line.
+	--- @example
+	--- myEditBox:SetMultiLine(true)
+	SetMultiLine = function(self, multiLine) end,
+
+	--- Sets the number in the edit box.
+	--- @param number number The number to set.
+	--- @example
+	--- myEditBox:SetNumber(42)
+	SetNumber = function(self, number) end,
+
+	--- Sets the edit box to numeric mode.
+	--- @param numeric boolean True to enable numeric input.
+	--- @example
+	--- myEditBox:SetNumeric(true)
+	SetNumeric = function(self, numeric) end,
+
+	--- Sets the edit box to password mode.
+	--- @param password boolean True to enable password input.
+	--- @example
+	--- myEditBox:SetPassword(true)
+	SetPassword = function(self, password) end,
+
+	--- Sets the spacing between multiple lines.
+	--- @param spacing number The spacing value to set.
+	--- @example
+	--- myEditBox:SetSpacing(2)
+	SetSpacing = function(self, spacing) end,
+
+	--- Sets the text contained in the edit box.
+	--- @param text string The text to set.
+	--- @example
+	--- myEditBox:SetText("Hello World")
+	SetText = function(self, text) end,
+
+	--- Sets the text insets for the edit box.
+	--- @param left number The left inset.
+	--- @param right number The right inset.
+	--- @param top number The top inset.
+	--- @param bottom number The bottom inset.
+	--- @example
+	--- myEditBox:SetTextInsets(5, 5, 5, 5)
+	SetTextInsets = function(self, left, right, top, bottom) end,
+
+	--- Toggles the input language for the edit box.
+	--- @example
+	--- myEditBox:ToggleInputLanguage()
+	ToggleInputLanguage = function(self) end,
+}

ui/FontInstance.lua

@@ -0,0 +1,130 @@
+---@meta
+
+---@class FontInstance
+FontInstance = {
+	--- Returns the font path, height, and flags that may be used to construct an identical Font object.
+	--- @return string path The font path.
+	--- @return number height The height of the font.
+	--- @return string flags The font flags.
+	--- @example
+	--- local path, height, flags = myFontInstance:GetFont()
+	GetFont = function(self) end,
+
+	--- Returns the "parent" Font object, or nil if none.
+	--- @return FontObject|nil fontObject The parent font object.
+	--- @example
+	--- local fontObject = myFontInstance:GetFontObject()
+	GetFontObject = function(self) end,
+
+	--- Constructs a new Font object and assigns it to this FontInstance.
+	--- @param path string The font path.
+	--- @param height number The height of the font.
+	--- @param flags string The font flags.
+	--- @example
+	--- myFontInstance:SetFont("Fonts\\FRIZQT__.TTF", 12, "OUTLINE")
+	SetFont = function(self, path, height, flags) end,
+
+	--- Sets the "parent" Font object from which this object inherits properties.
+	--- @param fontObject FontObject The font object to set as parent.
+	--- @example
+	--- myFontInstance:SetFontObject(myFontObject)
+	SetFontObject = function(self, fontObject) end,
+
+	--- Returns the indentation when text wraps beyond the first line.
+	--- @return number indentation The indentation value.
+	--- @example
+	--- local indentation = myFontInstance:GetIndentedWordWrap()
+	GetIndentedWordWrap = function(self) end,
+
+	--- Returns the horizontal text justification.
+	--- @return string justifyH The horizontal justification ("LEFT", "RIGHT", "CENTER").
+	--- @example
+	--- local justifyH = myFontInstance:GetJustifyH()
+	GetJustifyH = function(self) end,
+
+	--- Returns the vertical text justification.
+	--- @return string justifyV The vertical justification ("TOP", "BOTTOM", "MIDDLE").
+	--- @example
+	--- local justifyV = myFontInstance:GetJustifyV()
+	GetJustifyV = function(self) end,
+
+	--- Returns the line spacing.
+	--- @return number spacing The line spacing value.
+	--- @example
+	--- local spacing = myFontInstance:GetSpacing()
+	GetSpacing = function(self) end,
+
+	--- Defines the indentation when text wraps beyond the first line.
+	--- @param indentation number The indentation value to set.
+	--- @example
+	--- myFontInstance:SetIndentedWordWrap(10)
+	SetIndentedWordWrap = function(self, indentation) end,
+
+	--- Defines the horizontal text justification.
+	--- @param justifyH string The horizontal justification ("LEFT", "RIGHT", "CENTER").
+	--- @example
+	--- myFontInstance:SetJustifyH("CENTER")
+	SetJustifyH = function(self, justifyH) end,
+
+	--- Defines the vertical text justification.
+	--- @param justifyV string The vertical justification ("TOP", "BOTTOM", "MIDDLE").
+	--- @example
+	--- myFontInstance:SetJustifyV("MIDDLE")
+	SetJustifyV = function(self, justifyV) end,
+
+	--- Sets the spacing between lines of text in the object.
+	--- @param spacing number The spacing value to set.
+	--- @example
+	--- myFontInstance:SetSpacing(2)
+	SetSpacing = function(self, spacing) end,
+
+	--- Returns the color of text shadow.
+	--- @return number r The red component of the shadow color.
+	--- @return number g The green component of the shadow color.
+	--- @return number b The blue component of the shadow color.
+	--- @return number a The alpha component of the shadow color.
+	--- @example
+	--- local r, g, b, a = myFontInstance:GetShadowColor()
+	GetShadowColor = function(self) end,
+
+	--- Returns the text shadow offset.
+	--- @return number offsetX The x offset of the shadow.
+	--- @return number offsetY The y offset of the shadow.
+	--- @example
+	--- local offsetX, offsetY = myFontInstance:GetShadowOffset()
+	GetShadowOffset = function(self) end,
+
+	--- Returns the default text color.
+	--- @return number r The red component of the text color.
+	--- @return number g The green component of the text color.
+	--- @return number b The blue component of the text color.
+	--- @return number a The alpha component of the text color.
+	--- @example
+	--- local r, g, b, a = myFontInstance:GetTextColor()
+	GetTextColor = function(self) end,
+
+	--- Sets the text shadow color.
+	--- @param r number The red component of the shadow color.
+	--- @param g number The green component of the shadow color.
+	--- @param b number The blue component of the shadow color.
+	--- @param a number? Optional. The alpha component of the shadow color.
+	--- @example
+	--- myFontInstance:SetShadowColor(0, 0, 0, 1) -- Black shadow
+	SetShadowColor = function(self, r, g, b, a) end,
+
+	--- Sets the text shadow offset.
+	--- @param x number The x offset of the shadow.
+	--- @param y number The y offset of the shadow.
+	--- @example
+	--- myFontInstance:SetShadowOffset(1, -1)
+	SetShadowOffset = function(self, x, y) end,
+
+	--- Sets the default text color.
+	--- @param r number The red component of the text color.
+	--- @param g number The green component of the text color.
+	--- @param b number The blue component of the text color.
+	--- @param a number? Optional. The alpha component of the text color.
+	--- @example
+	--- myFontInstance:SetTextColor(1, 1, 1) -- White text
+	SetTextColor = function(self, r, g, b, a) end,
+}

ui/FontString.lua

@@ -6,7 +6,7 @@
 ---@field top number
 ---@field bottom number
 
----@class FontString : UIObject, Region, ScriptRegion
+---@class FontString : Region, ScriptRegion
 FontString = {
 	--- Returns localized text depending on the specified gender.
 	--- @param self FontString
@@ -304,3 +304,31 @@ FontString = {
 	--- myFontString:SetWordWrap(true)
 	SetWordWrap = function(self, wrap) end,
 }
+
+---@alias FontObject
+---| 'GameFontNormal'
+---| 'GameFontNormalSmall'
+---| 'GameFontNormalLarge'
+---| 'GameFontHighlight'
+---| 'GameFontHighlightSmall'
+---| 'GameFontHighlightSmallOutline'
+---| 'GameFontHighlightLarge'
+---| 'GameFontDisable'
+---| 'GameFontDisableSmall'
+---| 'GameFontDisableLarge'
+---| 'GameFontGreen'
+---| 'GameFontGreenSmall'
+---| 'GameFontGreenLarge'
+---| 'GameFontRed'
+---| 'GameFontRedSmall'
+---| 'GameFontRedLarge'
+---| 'GameFontWhite'
+---| 'GameFontDarkGraySmall'
+---| 'NumberFontNormalYellow'
+---| 'NumberFontNormalSmallGray'
+---| 'QuestFontNormalSmall'
+---| 'DialogButtonHighlightText'
+---| 'ErrorFont'
+---| 'TextStatusBarText'
+---| 'CombatLogFont'
+---| string

ui/Frame.lua

@@ -13,14 +13,14 @@ Frame = {
 	--- local canChange = myFrame:CanChangeAttribute()
 	CanChangeAttribute = function(self) end,
 
-	--- Creates a fontstring.
-	--- @param name string? Optional. The name of the fontstring.
-	--- @param drawLayer string? Optional. The layer to draw the fontstring.
-	--- @param templateName string? Optional. The name of a template to use.
-	--- @return FontString The created fontstring.
+	--- Creates and returns a FontString as a child of this Frame.
+	--- @param name string? Optional. The name of the FontString.
+	--- @param layer string? Optional. The layer of the FontString.
+	--- @param inheritsFrom string? Optional. The name of the FontString to inherit from.
+	--- @return FontString fontString The created FontString.
 	--- @example
-	--- local fontString = myFrame:CreateFontString(nil, "OVERLAY", "GameFontNormal")
-	CreateFontString = function(self, name, drawLayer, templateName) end,
+	--- local myFontString = myFrame:CreateFontString("MyFontString", "OVERLAY")
+	CreateFontString = function(self, name, layer, inheritsFrom) end,
 
 	--- Draws a line.
 	--- @param name string? Optional. The name of the line.
@@ -42,15 +42,14 @@ Frame = {
 	--- local maskTexture = myFrame:CreateMaskTexture(nil, "OVERLAY", "MaskTemplate")
 	CreateMaskTexture = function(self, name, drawLayer, templateName, subLevel) end,
 
-	--- Creates a texture.
-	--- @param name string? Optional. The name of the texture.
-	--- @param drawLayer string? Optional. The layer to draw the texture.
-	--- @param templateName string? Optional. The name of a template to use.
-	--- @param subLevel number? Optional. The sublevel of the texture.
-	--- @return Texture The created texture.
+	--- Creates and returns a Texture as a child of this Frame.
+	--- @param name string? Optional. The name of the Texture.
+	--- @param layer string? Optional. The layer of the Texture.
+	--- @param inheritsFrom string? Optional. The name of the Texture to inherit from.
+	--- @return Texture texture The created Texture.
 	--- @example
-	--- local texture = myFrame:CreateTexture(nil, "BACKGROUND", "TextureTemplate")
-	CreateTexture = function(self, name, drawLayer, templateName, subLevel) end,
+	--- local myTexture = myFrame:CreateTexture("MyTexture", "BACKGROUND")
+	CreateTexture = function(self, name, layer, inheritsFrom) end,
 
 	--- Disables drawing on the specified layer.
 	--- @param layer string The layer to disable.
@@ -76,12 +75,12 @@ Frame = {
 	--- local id = myFrame:GetID()
 	GetID = function(self) end,
 
-	--- Shows the frame.
+	--- Shows this object (it will appear if its parent is visible).
 	--- @example
 	--- myFrame:Show()
 	Show = function(self) end,
 
-	--- Hides the frame.
+	--- Hides this object (it and all of its children will disappear).
 	--- @example
 	--- myFrame:Hide()
 	Hide = function(self) end,
@@ -103,15 +102,15 @@ Frame = {
 	SetMovable = function(self, movable) end,
 
 	--- Sets the frame's level.
-	--- @param frameLevel number The level to set.
+	--- @param level number The level to set.
 	--- @example
 	--- myFrame:SetFrameLevel(5)
-	SetFrameLevel = function(self, frameLevel) end,
+	SetFrameLevel = function(self, level) end,
 
 	--- Sets the frame's strata.
-	--- @param strata string The strata to set.
+	--- @param strata string The strata to set (e.g., "BACKGROUND", "MEDIUM", "HIGH").
 	--- @example
-	--- myFrame:SetFrameStrata("DIALOG")
+	--- myFrame:SetFrameStrata("HIGH")
 	SetFrameStrata = function(self, strata) end,
 
 	--- Registers the frame for a specific event.
@@ -125,4 +124,71 @@ Frame = {
 	--- @example
 	--- myFrame:UnregisterEvent("PLAYER_LOGIN")
 	UnregisterEvent = function(self, eventName) end,
+
+	--- Sets the backdrop of the frame according to the specification provided.
+	--- @param backdropTable table? Optional. A table defining the backdrop.
+	--- @example
+	--- myFrame:SetBackdrop({bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background"})
+	SetBackdrop = function(self, backdropTable) end,
+
+	--- Sets the frame's backdrop color.
+	--- @param r number The red component of the color.
+	--- @param g number The green component of the color.
+	--- @param b number The blue component of the color.
+	--- @param a number? Optional. The alpha component of the color.
+	--- @example
+	--- myFrame:SetBackdropColor(0, 0, 0, 0.5) -- Set to semi-transparent black
+	SetBackdropColor = function(self, r, g, b, a) end,
+
+	--- Sets the frame's backdrop border color.
+	--- @param r number The red component of the border color.
+	--- @param g number The green component of the border color.
+	--- @param b number The blue component of the border color.
+	--- @param a number? Optional. The alpha component of the border color.
+	--- @example
+	--- myFrame:SetBackdropBorderColor(1, 1, 1) -- Set to white
+	SetBackdropBorderColor = function(self, r, g, b, a) end,
+
+	--- Sets whether this frame will get keyboard input.
+	--- @param enableFlag boolean True to enable keyboard input.
+	--- @example
+	--- myFrame:EnableKeyboard(true)
+	EnableKeyboard = function(self, enableFlag) end,
+
+	--- Sets whether this frame will get mouse input.
+	--- @param enableFlag boolean True to enable mouse input.
+	--- @example
+	--- myFrame:EnableMouse(true)
+	EnableMouse = function(self, enableFlag) end,
+
+	--- Sets whether this frame will get mouse wheel notifications.
+	--- @param enableFlag boolean True to enable mouse wheel notifications.
+	--- @example
+	--- myFrame:EnableMouseWheel(true)
+	EnableMouseWheel = function(self, enableFlag) end,
+
+	--- Sets the height of the object.
+	--- @param height number The height to set.
+	--- @example
+	--- myFrame:SetHeight(200)
+	SetHeight = function(self, height) end,
+
+	--- Sets the width of the object.
+	--- @param width number The width to set.
+	--- @example
+	--- myFrame:SetWidth(300)
+	SetWidth = function(self, width) end,
+
+	--- Sets the size of the frame.
+	--- @param width number The width to set.
+	--- @param height number The height to set.
+	--- @example
+	--- myFrame:SetSize(300, 200)
+	SetSize = function(self, width, height) end,
+
+	--- Sets the parent for this frame.
+	--- @param parent Frame|string The parent frame or name of the parent frame.
+	--- @example
+	--- myFrame:SetParent(otherFrame)
+	SetParent = function(self, parent) end,
 }