SFX Header

Contents

• Overview
• Usage
  • AceGUI-3.0
  • AceConfigDialog-3.0

Overview

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.

Usage

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.

AceGUI-3.0

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)

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. [1]
:SetDisabled	boolean	nil	Sets the disabled state. [2]
:SetText	string	""	Sets the header text. [3]

Notes

Note

1. To center the text, pass true to the SetCenter method.

Note

2. When disabled, the border will be hidden.

Note

3. If the text is set to an empty string (""), the border will span the entire widget if enabled.

AceConfigDialog-3.0

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",
      },
   },
}

Reference: AceConfig-3.0 Options Tables

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. [1]
name	string	"Header Text"	The header text. [2] [3]
type	string	"input"	Sets the control type. This must be set to "header".

Notes

1. When disabled, the border will be hidden.
2. 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.
3. If the text is set to an empty string (""), the border will span the entire widget if enabled.