wow/ouroloot: options.lua comparison

comparison options.lua @ 99:966d06c8d9c9

- Brought plugin handling code up to date. SVs are kept in DB namespaces like they should have been. - Removed/commented all datarev code, until it becomes necessary after MoP. - Textgen special blocks for plugins do not automatically get a "reset&reload" button anymore. - New method to register option pages on the main tab. No sub-entry pages supported yet. Titles and reset&reload added here instead.

author	Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date	Sun, 29 Jul 2012 23:12:18 +0000
parents	b5a55c69ef67
children	a57133ee3c9b

comparison

equal deleted inserted replaced

-:b5a55c69ef67
+:966d06c8d9c9
 --	[49426] = true, -- Emblem of Frost
 }
 -- Mark these as straight to guild vault:
 addon.default_itemvault = {
-	[52078] = true, -- Chaos Orb
+	[52078] = true, -- Chaos Orb  (Cata heroics)
-	[69237] = true, -- Living Ember
+	[69237] = true, -- Living Ember  (Cata Firelands)
-	[71998] = true, -- Essence of Destruction
+	[71998] = true, -- Essence of Destruction  (Cata Dragon Soul)
 }
 local options_tree = {
 	{
 		value = "pong",
 		text = "Pongs",
 	},
 	{
 		value = "basic",
-		text = "Options",
+		text = "Main Options",
 		children = {
 			{
 				value = "filter",
 				text = "Item Filters",
 			},
 				value = "profiles",
 				text = "Profiles",
 			},
 		},
 	},
+	'NEW INSERTIONS HERE',  -- commenting this puts them all at the bottom
 	{
 		value = "adv",
 		text = "Advanced/Debugging",
 	},
 }
 local mkbutton = addon.gui_state_pointer.mkbutton
 local gui = addon.gui_state_pointer
 local AceGUI = LibStub("AceGUI-3.0")
 local flib = LibStub("LibFarmbuyer")
 local opts
+local error, assert = addon.error, addon.assert
 local function mktoggle (opt, label, width, desc, opt_func)
 	local w = mkbutton("CheckBoxSmallLabel", nil, "", desc)
 	w:SetRelativeWidth(width)
 	w:SetType("checkbox")
 ---------------
 -- Tab 6:  Options
 do
 	local funkified = {}
 	for key,f in pairs(controls) do
-		-- this is how TreeGroup makes unique keys
+		-- this is how TreeGroup makes unique keys out of nested entries
 		local funkykey = key:gsub('_','\001')
 		funkified[funkykey] = { f }
 	end
 	controls = funkified
 end
 	for id in pairs(opts.itemfilter) do GetItemInfo(id) end
 	for id in pairs(opts.itemvault) do GetItemInfo(id) end
 	preload = nil
 end
--- Clicking an entry on the left tree column.
+local aceconfig_list = {}
+-- Selecting an entry on the left tree column.
 local opt_OnGroupSelected_func = function (treeg,event,category)
 	opts = addon.db.profile
 	local catfuncs = controls[category]
 	if not catfuncs then
 		addon:horrible_horrible_error(("Category '%s' has no handler function!"):format(category:gsub('\001','_')))
 	end
 	treeg:ReleaseChildren()
-	local sf = AceGUI:Create("ScrollFrame")
+	if aceconfig_list[category] then
-	sf:SetStatusTable(status_for_scroll)
+		-- aceconfigdialog makes too many assumptions about scrolling
-	sf:SetLayout("Flow")
+		for _,func in ipairs(catfuncs) do
-	-- This forces the scrolling area to be bigger than the visible area; else
+			if func(treeg,category) then break end
-	-- some of the text gets cut off without ever triggering the scrollbar.
+		end
-	sf.content:SetHeight(700)
-	for _,func in ipairs(catfuncs) do
-		if func(sf) then break end
-	end
-	treeg:AddChild(sf)
-	if treeg:GetUserData("options restore scroll") then
-		if status_for_scroll.scrollvalue then
-			sf:SetScroll(status_for_scroll.scrollvalue)
-		end
-		treeg:SetUserData("options restore scroll", false)
 	else
-		sf:SetScroll(0)
+		local sf = AceGUI:Create("ScrollFrame")
+		sf:SetStatusTable(status_for_scroll)
+		sf:SetLayout("Flow")
+		-- This forces the scrolling area to be bigger than the visible area; else
+		-- some of the text gets cut off without ever triggering the scrollbar.
+		sf.content:SetHeight(700)
+		for _,func in ipairs(catfuncs) do
+			if func(sf,category) then break end
+		end
+		treeg:AddChild(sf)
+		if treeg:GetUserData("options restore scroll") then
+			if status_for_scroll.scrollvalue then
+				sf:SetScroll(status_for_scroll.scrollvalue)
+			end
+			treeg:SetUserData("options restore scroll", false)
+		else
+			sf:SetScroll(0)
+		end
 	end
 end
 -- Clicking the Options tab as a whole (tabs_OnGroupSelected["opt"]).
 local tabs_OGS = function (container, specials)
 end
 addon:register_tab_control_AT_END ("opt", [[Options]],
 	[[Options for fine-tuning behavior]], tabs_OGS)
+---------------
+-- Registering new options entries
+local insertion_index = #options_tree
+for i = #options_tree, 1, -1 do
+	if options_tree[i] == 'NEW INSERTIONS HERE' then
+		insertion_index = i
+		break
+	end
+end
+if insertion_index then
+	table.remove (options_tree, insertion_index)
+else
+	insertion_index = #options_tree + 1
+end
+--[[
+PLUGIN is the module table itself.
+PARENT is nil to register in the tree list directly.
+TEXT is either the text to display in the tree list, or nil to use the
+moduleName field out of PLUGIN (not :GetName()).
+OPTIONS is either
+I)  a function to call directly
+II) an aceconfig-style options table
+(I) Will augment options.args.name with coloring/sizing, if it exists.
+(Set options.args.name.name before registering.)  Will create it if not
+	present.
+(II)  Title added unconditionally.  Callback is
+options (scrollframe_container, plugin, unique_code)
+	  where UNIQUE_CODE is what's used by the TreeGroup widget in identifying
+	  the "button" clicked in the lefthand tree list.
+Will append a reset button IFF an options database has been registered already.
+]]
+function addon:register_options_entry (plugin, parent, text, options)
+	-- if this changes at all, fix up plugin_reset_button accordingly
+	local code = plugin:GetName()
+	--if parent
+	text = text or plugin.moduleName
+	local handler
+	local pdb = self.db:GetNamespace (plugin.moduleName, --[[silent=]]true)
+	if type(options) == 'table' then
+		-- AceConfig-style options table
+		aceconfig_list[code] = true
+		if not options.args.name then
+			options.args.name = {
+				name = plugin.moduleName,
+				type = 'description',
+			}
+		end
+		options.args.name.name = '|cff30adff' .. options.args.name.name .. '|r'
+		options.args.name.fontSize = 'large'
+		options.args.name.width = 'full'
+		options.args.name.cmdHidden = true
+		options.args.name.order = 1
+		if pdb then
+			options.args.INSERTED_SPACER = {
+				name = '',
+				type = 'description',
+				cmdHidden = true,
+				width = 'full',
+				order = 9000,
+			}
+			options.args.RESET = {
+				name = "Reset",
+				desc = ([[Reset settings for <%s> plugin back to defaults.  Shift-click to also trigger a UI reload.]]):format(plugin:GetName()),
+				type = 'execute',
+				func = function()
+					pdb:ResetProfile()
+					if IsShiftKeyDown() then ReloadUI() end
+				end,
+				order = 9001,
+			}
+		end
+		LibStub("AceConfig-3.0"):RegisterOptionsTable(plugin:GetName(), options)
+		handler = function (sf)
+			LibStub("AceConfigDialog-3.0"):Open (plugin:GetName(), sf)
+		end
+	elseif type(options) == 'function' then
+		-- AceGUI callback
+		if pdb then
+			handler = function (sf)
+				sf:AddChildren(mktitle(text))
+				local ret = options (sf, plugin, code)
+				local w = mkbutton("Reset",
+					([[Reset settings for <%s> plugin back to defaults.  Shift-click to also trigger a UI reload.]]):format(text))
+				w:SetRelativeWidth(0.3)
+				w:SetCallback("OnClick", function(_w)
+					pdb:ResetProfile()
+					if IsShiftKeyDown() then ReloadUI() end
+				end)
+				sf:AddChildren(spacer(10),w)
+				return ret
+			end
+		else
+			handler = function (sf)
+				sf:AddChildren(mktitle(text))
+				return options (sf, plugin, code)
+			end
+		end
+	else
+		error(("Error: 'options' parameter for plugin '%s' is neither table nor function"):format(plugin:GetName()))
+	end
+	if not controls[code] then
+		controls[code] = {}
+	end
+	table.insert (controls[code], handler)
+	table.insert (options_tree, insertion_index, {
+		value = code,
+		text = text,  -- maybe call markup on this?
+	})
+	insertion_index = insertion_index + 1
+	-- The treegroup will rescan options_tree (via RefreshTree) several times
+	-- before the player actually sees anything; no more work needs doing.
+	return -- something that can be used as 'parent'
+end
 -- vim:noet

Mercurial > wow > ouroloot

comparison options.lua @ 99:966d06c8d9c9