api/AceConfigDialog-3.0

AceConfigDialog-3.0 generates AceGUI-3.0 based windows based on option tables.

AceConfigDialog:AddToBlizOptions(appName, name, parent, ...)

Add an option table into the Blizzard Interface Options panel.
You can optionally supply a descriptive name to use and a parent frame to use, as well as a path in the options table.
If no name is specified, the appName will be used instead.

If you specify a proper `parent` (by name), the interface options will generate a tree layout. Note that only one level of children is supported, so the parent always has to be a head-level note.

This function returns a reference to the container frame registered with the Interface Options. You can use this reference to open the options with the API function `InterfaceOptionsFrame_OpenToCategory`. For WoW 10.0, the second return parameter contains the category ID, which can be passed to `Settings.OpenToCategory`.

Parameters

appName: The application name as given to `:RegisterOptionsTable()`
name: A descriptive name to display in the options tree (defaults to appName)
parent: The parent to use in the interface options tree.
...: The path in the options table to feed into the interface options panel.

Return values

- The reference to the frame registered into the Interface Options.

- The registered category ID

AceConfigDialog:Close(appName)

Close a specific options window.

Parameters

appName: The application name as given to `:RegisterOptionsTable()`

AceConfigDialog:CloseAll()

Close all open options windows

AceConfigDialog:Open(appName [, container][, ...])

Open an option window at the specified path (if any).
This function can optionally feed the group into a pre-created container instead of creating a new container frame.

Parameters

appName: The application name as given to `:RegisterOptionsTable()`
container: An optional container frame to feed the options into
...: The path to open after creating the options window (see `:SelectGroup` for details)

AceConfigDialog:SelectGroup(appName, ...)

Selects the specified path in the options window.
The path specified has to match the keys of the groups in the table.

Parameters

appName: The application name as given to `:RegisterOptionsTable()`
...: The path to the key that should be selected

AceConfigDialog:SetDefaultSize(appName, width, height)

Sets the default size of the options window for a specific application.

Parameters

appName: The application name as given to `:RegisterOptionsTable()`
width: The default width
height: The default height

Comments

Forge_User_76680119
- Join Date: 9/6/2006
- Posts: 3
- Member Details
#1 Forge_User_76680119

View User Profile

Send Message

Posted Nov 1, 2010
Something I hadn't appreciated until this evening is that when using AceConfigDialog:AddToBlizOptions(appName, name, parent, ...) the appName MUST BE unique.

When coding my mod, I used example code I found on wowace.com that specified how to add profiles to your mod.

self.db = LibStub("AceDB-3.0"):New("MyApplicationName", self.defaults, "Default"); self.profileOptions = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db); LibStub("AceConfig-3.0"):RegisterOptionsTable("Profiles", self.profileOptions); self.profilesFrame = LibStub("AceConfigDialog-3.0"):AddToBlizOptions("Profiles", "Profiles", "MyApplicationName");

That works just fine. However if anyone else codes their mod the same, then the user ends up with an error message as two (or more) mods try to register the options page with the name "Profiles" In the example above, I would need to change the last two lines:

LibStub("AceConfig-3.0"):RegisterOptionsTable("MyApp Profiles", self.profileOptions); self.profilesFrame = LibStub("AceConfigDialog-3.0"):AddToBlizOptions("MyApp Profiles", "Profiles", "MyApplicationName");

The user never sees the text "MyApp Profiles" as the AddToBlizOptions function specifies that the display text is simply, "Profiles"
Rollback Post to Revision RollBack

_ForgeUser581183

Join Date: 3/7/2008
Posts: 19
Member Details

#2 Posted Dec 26, 2010

After adding your configuration dialog to the Blizzard Interface frame, you can also hook into the standard "Defaults" button presented to the user. You do this by assigning a handler to the default member of the returned frame:

self.optionsFrames.general = LibStub("AceConfigDialog-3.0"):AddToBlizOptions(
       "CorpseLooter", L["CorpseLooter"], , rootNodeName);
self.optionsFrames.general.default = 
      function() self:SetDefaultOptions() end;

When the user resets "These Settings" of your addon's configuration, your callback SetDefaultOptions will be called:

function CorpseLooter:SetDefaultOptions
    local profileDB = self.db.profile;
    profileDB.autoLoot = true;
    profileDB.lootAllCorpsesInRange = false;
end;

The issue then is that your configuration dialog, on screen, will show values that are not correct. You can force the configuration dialog to refresh itself by calling:

LibStub("AceConfigRegistry-3.0"):NotifyChange("CorpseLooter");

in other words:

function CorpseLooter:SetDefaultOptions
    local profileDB = self.db.profile;
    profileDB.autoLoot = true;
    profileDB.lootAllCorpsesInRange = false;

    --force config dialog to show new state of options
    LibStub("AceConfigRegistry-3.0"):NotifyChange("CorpseLooter");
end;

Zombull
- Join Date: 8/28/2006
- Posts: 30
- Member Details
#3 Zombull

View User Profile

Send Message

Posted May 7, 2011
The third parameter of the AddToBlizOptions() function needs the text display name of the parent item, not the appName.

AceConfigDialog:AddToBlizOptions("MyApp","My Top Level Page",nil,"general") AceConfigDialog:AddToBlizOptions("MyApp","Profiles","My Top Level Page","profiles")

I can't speak for anyone else, but I kept trying to use "MyApp" for the parent parameter and the parent relationship therefore failed causing the collapse button to not appear in the interface options tree.
Rollback Post to Revision RollBack
scotepi
- Location: Augusta, ME
- Join Date: 3/24/2005
- Posts: 40
- Member Details
#4 scotepi

View User Profile

Send Message

Posted Jan 14, 2012
It took me a little bit to figure this out, if you want to open your addon settings in the default Bliz frame use InterfaceOptionsFrame_OpenToCategory(appName) and not AceConfigDialog:Open(appName)

Last edited by scotepi: Jan 14, 2012

Rollback Post to Revision RollBack
Resike
Curse Premium
- Join Date: 10/9/2008
- Posts: 5
- Member Details
#5 Resike

View User Profile

Send Message

Posted Jul 29, 2014
A :Toggle(appName) function would be nice. Also a :SetMinResize(appname, width, height), :SetMaxResize(appname, width, height).

Last edited by Resike: Jul 29, 2014

Rollback Post to Revision RollBack
Sygon_Paul
Community Moderators
- Location: Edmonton
- Join Date: 5/8/2006
- Posts: 462
- Member Details
#8 Sygon_Paul

View User Profile

Send Message

Posted Oct 11, 2019
If you want to check if an AddOn's GUI is open, use AceConfigDialog.OpenFrames["AppName"]. This is useful to close GUIs during combat, or toggle between opened and closed states. Note the square backets, not curved.

function AppName:SlashHandler() if UnitAffectingCombat("player") then if Dialog.OpenFrames["AppName"] then Dialog:Close("AppName") end return end if Dialog.OpenFrames["AppName"] then Dialog:Close("AppName") else Dialog:Open("AppName") end end
Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

WowAce

Ace3

Addons

Pages

Table of Contents

AceConfigDialog:AddToBlizOptions(appName, name, parent, ...)

Parameters

Return values

AceConfigDialog:Close(appName)

Parameters

AceConfigDialog:CloseAll()

AceConfigDialog:Open(appName [, container][, ...])

Parameters

AceConfigDialog:SelectGroup(appName, ...)

Parameters

AceConfigDialog:SetDefaultSize(appName, width, height)

Parameters

Comments