Files
wow_Meta/ui/SimpleHTML.lua
2025-05-04 22:57:31 +02:00

156 lines
5.8 KiB
Lua

---@meta
---@class SimpleHTML : Frame
SimpleHTML = {
--- Gets the font properties for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return string fontFile, number height, string flags
--- @example
--- local fontFile, height, flags = myHTML:GetFont("p")
GetFont = function(self, element) end,
--- Gets the font object for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return FontObject fontObject The font object.
--- @example
--- local fontObject = myHTML:GetFontObject("h1")
GetFontObject = function(self, element) end,
--- Gets the hyperlink format string.
--- @return string format The hyperlink format.
--- @example
--- local format = myHTML:GetHyperlinkFormat()
GetHyperlinkFormat = function(self) end,
--- Gets whether hyperlinks are enabled.
--- @return boolean enabled True if hyperlinks are enabled.
--- @example
--- local enabled = myHTML:GetHyperlinksEnabled()
GetHyperlinksEnabled = function(self) end,
--- Gets the horizontal justification for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return string justifyH The horizontal justification.
--- @example
--- local justifyH = myHTML:GetJustifyH("p")
GetJustifyH = function(self, element) end,
--- Gets the vertical justification for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return string justifyV The vertical justification.
--- @example
--- local justifyV = myHTML:GetJustifyV("p")
GetJustifyV = function(self, element) end,
--- Gets the shadow color for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return number r, number g, number b, number a The shadow color.
--- @example
--- local r, g, b, a = myHTML:GetShadowColor("p")
GetShadowColor = function(self, element) end,
--- Gets the shadow offset for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return number x, number y The shadow offset.
--- @example
--- local x, y = myHTML:GetShadowOffset("p")
GetShadowOffset = function(self, element) end,
--- Gets the line spacing for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return number spacing The line spacing.
--- @example
--- local spacing = myHTML:GetSpacing("p")
GetSpacing = function(self, element) end,
--- Gets the text color for an HTML element.
--- @param element? string Optional. The HTML element to query.
--- @return number r, number g, number b, number a The text color.
--- @example
--- local r, g, b, a = myHTML:GetTextColor("p")
GetTextColor = function(self, element) end,
--- Sets the font properties for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param fontFile string The font file path.
--- @param height number The font height.
--- @param flags? string Optional. The font flags.
--- @example
--- myHTML:SetFont("p", "Fonts\\FRIZQT__.TTF", 12, "OUTLINE")
SetFont = function(self, element, fontFile, height, flags) end,
--- Sets the font object for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param fontObject FontObject The font object.
--- @example
--- myHTML:SetFontObject("h1", GameFontNormalLarge)
SetFontObject = function(self, element, fontObject) end,
--- Sets the hyperlink format string.
--- @param format string The hyperlink format.
--- @example
--- myHTML:SetHyperlinkFormat("|cff0000ff|H%s|h%s|h|r")
SetHyperlinkFormat = function(self, format) end,
--- Sets whether hyperlinks are enabled.
--- @param enabled boolean True to enable hyperlinks.
--- @example
--- myHTML:SetHyperlinksEnabled(true)
SetHyperlinksEnabled = function(self, enabled) end,
--- Sets the horizontal justification for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param justifyH string The horizontal justification.
--- @example
--- myHTML:SetJustifyH("p", "CENTER")
SetJustifyH = function(self, element, justifyH) end,
--- Sets the vertical justification for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param justifyV string The vertical justification.
--- @example
--- myHTML:SetJustifyV("p", "MIDDLE")
SetJustifyV = function(self, element, justifyV) end,
--- Sets the shadow color for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param r number The red component.
--- @param g number The green component.
--- @param b number The blue component.
--- @param a? number Optional. The alpha component.
--- @example
--- myHTML:SetShadowColor("p", 0, 0, 0, 1)
SetShadowColor = function(self, element, r, g, b, a) end,
--- Sets the shadow offset for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param x number The horizontal offset.
--- @param y number The vertical offset.
--- @example
--- myHTML:SetShadowOffset("p", 1, -1)
SetShadowOffset = function(self, element, x, y) end,
--- Sets the line spacing for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param spacing number The line spacing.
--- @example
--- myHTML:SetSpacing("p", 2)
SetSpacing = function(self, element, spacing) end,
--- Sets the text color for an HTML element.
--- @param element? string Optional. The HTML element to set.
--- @param r number The red component.
--- @param g number The green component.
--- @param b number The blue component.
--- @param a? number Optional. The alpha component.
--- @example
--- myHTML:SetTextColor("p", 1, 1, 1, 1)
SetTextColor = function(self, element, r, g, b, a) end,
--- Sets the HTML text to display.
--- @param text string The HTML text.
--- @example
--- myHTML:SetText("<p>Hello <b>World</b></p>")
SetText = function(self, text) end,
}