SFX Header - SFX-WoW/AceGUI-3.0_SFX-Widgets GitHub Wiki

Contents

The SFX-Header widget adds a header with left-aligned text and a vertically-centered border. The alignment of the text and the visibility of the border can be adjusted.

The SFX-Header widget can be used as a standard AceGUI-3.0 widget or can be referenced in an AceConfig-3.0 options table.

To use this widget with AceGUI-3.0, reference it as you would any other widget.

Example

local header = AceGUI:Create("SFX-Header")
header:SetText("Header Text")
frame:AddChild(header)

Note

Reference: AceGUI-3.0 Tutorial

Methods

The SFX-Header widget supports the following widget methods.

Method Parameter Default Description
:SetCenter boolean nil Sets the text alignment.
:SetDisabled boolean nil Sets the disabled state.
:SetText string "" Sets the header text.

Notes

  • To center the text, pass true to the SetCenter method.
  • When disabled, the border will be hidden.
  • If the text is set to an empty string (""), the border will span the entire widget if enabled.

To use this widget with AceConfigDialog-3.0, pass "SFX-Header" to the dialogControl field of a control entry in your options table and specify the type as "header".

Example

-- Options Table
local Options = {
   type = "group",
   name = "Options",
   args = {
      Header = {
         type = "header",
         name = "Header Text",
         -- disabled = true,
         dialogControl = "SFX-Header",
      },
   },
}

Fields

The SFX-Header widget supports the standard header control fields.

Field Type Value Description
dialogControl string "SFX-Header" Sets the widget type. This must be set to "SFX-Header".
disabled boolean nil Optional. Sets the disabled state.
name string "Header Text" The header text.
type string "input" Sets the control type. This must be set to "header".

Notes

  • When disabled, the border will be hidden.
  • To center the header's text, add three consecutive greater-than symbols (>>>) to the name string. Note that all occurrences of this pattern will be removed.
  • If the text is set to an empty string (""), the border will span the entire widget if enabled.
⚠️ **GitHub.com Fallback** ⚠️