wow/ouroloot: gui.lua comparison

comparison gui.lua @ 83:940e53dd18c3

- More cosmetic cleanup. - Implement "GUI noob" option. Basic entries for Loot and History tabs. - Disable wipe->kill toggling once the entry is actually a kill. Duh.

author	Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date	Mon, 18 Jun 2012 03:02:10 +0000
parents	0f6355bcfe68
children	c87bf3e756f3

comparison

equal deleted inserted replaced

-:ae17128ef3f2
+:940e53dd18c3
 ------ Popup dialogs
 ]]
 ------ Constants
 local eoi_st_rowheight			= 20
-local eoi_st_displayed_rows		= math.floor(416/eoi_st_rowheight) --math.floor(366/eoi_st_rowheight)
+local eoi_st_displayed_rows		= math.floor(416/eoi_st_rowheight)
 local eoi_st_textured_item_format = "|T%s:"..(eoi_st_rowheight-2).."|t %s[%s]|r%s"
 local eoi_st_otherrow_bgcolortable = {
 	wipe	= { ["r"] = 0.3, ["g"] = 0.3, ["b"] = 0.3},
 	kill	= { ["r"] = 0.2, ["g"] = 0.2, ["b"] = 0.2},
 	time	= { ["r"] = 0x0/255, ["g"] = 0x0/255, ["b"] = 1, ["a"] = 0.3},
 local pprint, tabledump = addon.pprint, flib.tabledump
 local GetItemInfo, ITEM_QUALITY_COLORS = GetItemInfo, ITEM_QUALITY_COLORS
 local GetNumRaidMembers = GetNumRaidMembers
 -- En masse forward decls of symbols defined inside local blocks
-local _generate_text, _populate_text_specials
+local _generate_text, _populate_text_specials, _markup
 local eoi_dropdownfuncs, _tabtexts, _taborder -- filled out in gui block scope
 local _do_debugging_tooltip, _hide_debugging_tooltip, _build_debugging_tooltip
 local _new_rebroadcast_hyperlink
 --[[
 argument.
 ]]
 local tabs_OnGroupSelected = {}
 local mkbutton
 local tabs_OnGroupSelected_func, tabs_generated_text_OGS
+-- Similarly for the popup tips on the right side of the window.
+local noob_tips = {}
 -- Class color support
 local class_colors-- = {}
 do
 	local function fill_out_class_colors()
 	fill_out_class_colors()
 	if CUSTOM_CLASS_COLORS and CUSTOM_CLASS_COLORS.RegisterCallback then
 		CUSTOM_CLASS_COLORS:RegisterCallback(fill_out_class_colors)
 	end
 	addon.class_colors = class_colors
+end
+do
+	local replacement_colors = {
+		["+"]="|cffffffff",   -- white
+		["<"]="|cff00ff00",   -- light green
+		[">"]="|r" }
+	function _markup (t)
+		-- wonder if it would be worth memoizing this also
+		return t:gsub("[%+<>]",replacement_colors)
+		        :gsub("([^\n])\n([^\n])", "%1 %2")
+		        :gsub("|r\n\n", "|r\n")
+	end
 end
 -- Working around this bug:
 -- http://forums.wowace.com/showpost.php?p=295202&postcount=31
 do
 			-- which looks reasonably pleasing
 			[[Broadcast this entry]], "|cff3588ff", onclick)
 		rebroadcast_map[ident] = u
 		return clicky
 	end
+end
+-- UI tips window
+local hide_noobtips_frame = flib.nullfunc
+local function get_noobtips_frame()
+	local f = CreateFrame("Frame")
+	f:SetBackdrop{
+		bgFile = [[Interface\Tooltips\UI-Tooltip-Background]],
+		--bgFile = [[Interface\DialogFrame\UI-DialogBox-Background]],
+		edgeFile = [[Interface\Tooltips\UI-Tooltip-Border]],
+		--edgeFile = [[Interface\DialogFrame\UI-DialogBox-Border]],
+		tile = true,
+		tileSize = 8,
+		--tileSize = 32,
+		edgeSize = 12,
+		--edgeSize = 32,
+		insets = { left = 2, right = 2, top = 2, bottom = 2 }
+		--insets = { left = 11, right = 12, top = 12, bottom = 11 }
+	}
+	f:SetBackdropColor(TOOLTIP_DEFAULT_BACKGROUND_COLOR.r,
+		TOOLTIP_DEFAULT_BACKGROUND_COLOR.g, TOOLTIP_DEFAULT_BACKGROUND_COLOR.b)
+	f:SetBackdropBorderColor(TOOLTIP_DEFAULT_COLOR.r, TOOLTIP_DEFAULT_COLOR.g,
+		TOOLTIP_DEFAULT_COLOR.b)
+	f:SetMovable(false)
+	f:EnableMouse(false)
+	f:SetFrameStrata("TOOLTIP")
+	f:SetToplevel(true)
+	f:SetClampedToScreen(true)
+	f:SetWidth(220)
+	local t = f:CreateFontString (nil, "ARTWORK", "GameFontHighlightSmall")
+	--t:SetPoint ("TOPLEFT", f, "TOPLEFT", 14, -15)
+	t:SetPoint ("TOPLEFT", f, "TOPLEFT", 10, -10)
+	t:SetJustifyH("LEFT")
+	f.text = t
+	f.DoTextWork = function (self, text)
+		self.text:SetText(text)
+		self.text:SetWidth (self:GetWidth() - 20)
+		self:SetHeight (self.text:GetHeight() + 20)
+	end
+	get_noobtips_frame = function() return f end
+	hide_noobtips_frame = function() f:Hide() end
+	return f
 end
 ------ Main GUI Window
 local _d   -- display when it's open, eoiST when it's not
 		isTitle = true,
 		notClickable = true,
 		notCheckable = true,
 	}},
 	{
-		"Change from 'wipe' to 'kill'|Also collapses previous wipe entries.",
+		"Change from 'wipe' to 'kill'|Also collapses previous wipe entries.", -- KILLWIPE
 		"Rebroadcast this boss%boss|Broadcasts the kill event and all subsequent loot until next boss.",
 		"Delete this boss event|Permanent, no going back!",
 		"Delete remaining entries for this boss%boss|Erases everything from here down until a new boss/day.\n\nHold down the Shift key to also delete the player's corresponding History entry.",
 		"Insert new loot entry%loot|Inserts new loot above this one, prompting you for information.",
 		"Insert new boss kill event%boss|Inserts new event above this one, prompting you for information.",
 		end
 		EasyMenu (eoi_player_dropdown, dropdownmenuframe, cellFrame, 0, 0, "MENU")
 	elseif kind == 'boss' then
 		eoi_boss_dropdown[1].text = e.bossname
+		-- KILLWIPE:  update '2' if this is not the 2nd entry in eoi_boss_dropdown
+		eoi_boss_dropdown[2].tooltipWhileDisabled = nil
+		eoi_boss_dropdown[2].disabled = e.reason ~= 'wipe' and true or nil
 		EasyMenu (eoi_boss_dropdown, dropdownmenuframe, cellFrame, 0, 0, "MENU")
 	elseif kind == 'time' then
 		eoi_time_dropdown[1].text = e.startday.text
 		EasyMenu (eoi_time_dropdown, dropdownmenuframe, cellFrame, 0, 0, "MENU")
 		specials:AddChild(b)
 	end
 	-- ...and call it.
 	return tabs_OnGroupSelected["eoi"](ocontainer,specials)
 end
+noob_tips["eoi"] = _markup[[
+<Shift-Left> while over an item link to paste it into chat.
+<Right>-click any row to display a dropdown menu.  The menu is different for
+the Player column than it is for the Item/Notes columns, and different for
+loot entries than it is for other rows.]]
 -- Tab 2/3 (generated text)
 function tabs_generated_text_OGS (container, specials, text_kind)
 	container:SetLayout("Fill")
 		g_loot.printed[text_kind] = 0
 		g_generated.last_instance = nil
 		g_generated[pos] = nil
 		addon:Print("'%s' has been regenerated.", _tabtexts[text_kind].title)
 		return addon:redisplay()
-		--return tabs_OnGroupSelected_func(container,"OnGroupSelected",text_kind)
 	end)
 	specials:AddChild(w)
 	if addon:is_plugin(text_kind) then
 		local pname = addon:is_plugin(text_kind):GetName()
 		w = mkbutton("Reset SVs & ReloadUI",
 		end)
 		specials:AddChild(b)
 	end
 	return tabs_OnGroupSelected["hist"](container,specials)
 end
+noob_tips["hist"] = _markup[[
+<Left>-click a row to see all history for that player.  <Right>-click any row
+to return to showing all players.
+<Shift-Left> while over an item link to paste it into chat.  <Shift-Right>
+any row to display a dropdown menu.]]
 -- Tab 5:  Help (content in verbage.lua)
 do
 	local tabs_help_OnGroupSelected_func = function (treeg,event,category)
 			spacer:SetHeight(5)
 			container:AddChild(spacer)
 			local speedbump = GUI:Create("InteractiveLabel")
 			speedbump:SetFullWidth(true)
 			speedbump:SetFontObject(GameFontHighlightLarge)
-			speedbump:SetImage("Interface\\DialogFrame\\DialogAlertIcon")
+			speedbump:SetImage[[Interface\DialogFrame\DialogAlertIcon]]
 			speedbump:SetImageSize(50,50)
 			speedbump:SetText("The debugging/testing settings on the rest of this panel can seriously bork up the addon if you make a mistake.  If you're okay with the possibility of losing data, click this warning to load the panel.")
 			speedbump:SetCallback("OnClick", function (_sb)
 				adv_lower = adv_real
 				return addon:redisplay()
-				--return tabs_OnGroupSelected_func(container.parent,"OnGroupSelected","opt")
 			end)
 			container:AddChild(speedbump)
 			spacer = GUI:Create("Spacer")
 			spacer:SetFullWidth(true)
 			spacer:SetHeight(5)
 	end
 	tabs_OnGroupSelected["opt"] = function(container,specials)
 		opts = OuroLootSV_opts
-		--container:SetLayout("List")
 		container:SetLayout("Fill")
 		local scroll, grp, w
 		scroll = GUI:Create("ScrollFrame")
 		scroll:SetLayout("Flow")
 		grp = GUI:Create("InlineGroup")
 		grp:SetLayout("Flow")
 		grp:SetFullWidth(true)
 		grp:SetTitle("User Options     [these are saved across sessions]")
-		-- The relative width fields used to be done to take up less vertical space, but
+		-- The relative width fields used to be done to take up less vertical
-		-- that turned out to look messy.  Now they're just a straight line for the most part.
+		-- space, but that turned out to look messy.  Now they're just a
+		-- straight line for the most part.
+		-- the nubtoggle!
+		w = mkoption('gui_noob', [[Show UI Tips]], 0.85,
+			[[Toggles display of the "helpful tips" box on the right side.  Useful if you've just installed/upgraded.]])
+		w:SetImage[[Interface\OptionsFrame\UI-OptionsFrame-NewFeatureIcon]]
+		grp:AddChild(w)
+		w = GUI:Create("Spacer") w:SetFullWidth(true) w:SetHeight(10) grp:AddChild(w)
 		-- reminder popup
-		w = mkoption ('popup_on_join', "Show reminder popup", 0.49,
+		w = mkoption ('popup_on_join', "Show reminder popup on new raid", 0.49,
 			[[When joining a raid and not already tracking, display a dialog asking for instructions.]])
 		grp:AddChild(w)
 		-- toggle scroll-to-bottom on first tab
 		w = mkoption('scroll_to_bottom', "Scroll to bottom when opening display", 0.49,
 			[[Register "/loot" as a slash command in addition to the normal "/ouroloot".  Relog to take effect.]])
 		grp:AddChild(w)
 		-- chatty boss mode
 		w = mkoption('chatty_on_kill', "Be chatty on boss kill", 0.49,
-			[[Print something to chat output when DBM tells Ouro Loot about a successful boss kill.]])
+			[[Print something to chat output when the boss mod tells Ouro Loot about a successful boss kill.]])
 		grp:AddChild(w)
 		-- less noise in main panel
 		w = mkoption('no_tracking_wipes', "Do not track wipes", 0.49,
 			[[Do not add 'wipe' entries on the main loot grid, or generate any text for them.]])
 		grp:AddChild(w)
 		-- cutesy abbrevs
 		w = mkoption('snarky_boss', "Use snarky boss names", 0.49,
-			[[Irreverent replacement names for boss events.]])
+			[[Irreverent replacement names for boss events.  See abbreviations.lua for details.]])
 		grp:AddChild(w)
 		-- LOD plugins in all cases
 		w = mkoption('display_disabled_LODs', "Include disabled plugins", 0.49,
 			[[Show loadable plugins even if they've been disabled (and offer to enable them).  Relog to take effect.]])
 			local pair = GUI:Create("InlineGroup")
 			pair:SetLayout("List")
 			pair:SetRelativeWidth(0.49)
 			local editbox, checkbox
 			editbox = mkbutton("EditBox", nil, opts.keybinding_text,
-				[[Keybinding text format is fragile!  Relog to take effect.]])
+				[[Keybinding text format is fragile (ALT then CTRL then SHIFT)!  Relog to take effect.]])
 			editbox:SetFullWidth(true)
 			editbox:SetLabel("Keybinding text")
 			editbox:SetCallback("OnEnterPressed", function(_w,event,value)
 				opts.keybinding_text = value
 			end)
 			_w:SetDisabled(true)
 			addon:DoPing()
 			addon:ScheduleTimer(function(b)
 				if b:IsVisible() then
 					return addon:redisplay()
-					--return tabs_OnGroupSelected_func(container,"OnGroupSelected","opt")
 				end
 			end, 5, _w)
 		end)
 		specials:AddChild(w)
 -- Simply to avoid recreating the same function over and over
 local tabs_OnGroupSelected_func_args = { [2] = "OnGroupSelected" }
 tabs_OnGroupSelected_func = function (tabs,event,group)
 	tabs_OnGroupSelected_func_args[1] = tabs
 	tabs_OnGroupSelected_func_args[3] = group
+	hide_noobtips_frame()
 	tabs:ReleaseChildren()
 	local spec = tabs:GetUserData("special buttons group")
 	spec:ReleaseChildren()
 	local h = GUI:Create("Heading")
 	h:SetFullWidth(true)
 	end
 	local status,err = pcall (tabs_OnGroupSelected[group], tabs, spec, group)
 	if not status then
 		addon:horrible_horrible_error(err)
 	end
+	if OuroLootSV_opts.gui_noob then
+		local tip = noob_tips[group]
+		if type(tip) == 'function' then
+			tip = tip()
+		end
+		if type(tip) == 'string' and tip ~= "" then
+			local w = get_noobtips_frame()
+			w:SetParent (_d.content)
+			w:ClearAllPoints()
+			w:SetPoint("BOTTOMLEFT", _d.frame, "BOTTOMRIGHT", 3, 3)
+			w:Show()
+			w:DoTextWork(tip)
+		end
+	end
 	--[====[
 	Unfortunately, :GetHeight() called on anything useful out of a TabGroup
 	returns the static default size (about 50 pixels) until the refresh
 	cycle *after* all the frames are shown.  Trying to fix it up after a
 	single OnUpdate doesn't work either.  So for now it's all hardcoded.
-	Using this to determine the actual height of the usable area.
+	Using this to determine the actual height of the usable area.  (Will
-	366 pixels
+	error until an ST is shown, which only happens if it's tracking, etc.)
+	416 pixels
 	if group == "eoi" then
 		local stframe = tabs.children[1].frame
 		print(stframe:GetTop(),"-",stframe:GetBottom(),"=",
 		      stframe:GetTop()-stframe:GetBottom())
 		print(stframe:GetRight(),"-",stframe:GetLeft(),"=",
 --[[
 mkbutton ("WidgetType", 'display key', "Text On Widget", "the mouseover display text")
 mkbutton ( [Button]     'display key', "Text On Widget", "the mouseover display text")
 mkbutton ( [Button]      [text]        "Text On Widget", "the mouseover display text")
 ]]
-do
+function mkbutton (opt_widget_type, opt_key, label, status)
-	local replacement_colors = { ["+"]="|cffffffff", ["<"]="|cff00ff00", [">"]="|r" }
+	if not label then
-	function mkbutton (opt_widget_type, opt_key, label, status)
+		opt_widget_type, opt_key, label, status = "Button", opt_widget_type, opt_widget_type, opt_key
-		if not label then
+	elseif not status then
-			opt_widget_type, opt_key, label, status = "Button", opt_widget_type, opt_widget_type, opt_key
+		opt_widget_type, opt_key, label, status = "Button", opt_widget_type, opt_key, label
-		elseif not status then
+	end
-			opt_widget_type, opt_key, label, status = "Button", opt_widget_type, opt_key, label
+	local button = assert(GUI:Create(opt_widget_type))
-		end
+	if button.SetText then button:SetText(tostring(label)) end
-		local button = assert(GUI:Create(opt_widget_type))
+	status = _markup(status)
-		if button.SetText then button:SetText(tostring(label)) end
+	button:SetCallback("OnEnter", function() setstatus(status) end) -- maybe factor that closure out
-		status = status:gsub("[%+<>]",replacement_colors)
+	button:SetCallback("OnLeave", statusy_OnLeave)
-		button:SetCallback("OnEnter", function() setstatus(status) end) -- maybe factor that closure out
+	-- retrieval key may be specified as nil if all the parameters are given
-		button:SetCallback("OnLeave", statusy_OnLeave)
+	if opt_key then _d:SetUserData (opt_key, button) end
-		-- retrieval key may be specified as nil if all the parameters are given
+	return button
-		if opt_key then _d:SetUserData (opt_key, button) end
-		return button
-	end
 end
 --[[
 Creates the main window.
 ]]
 	display:SetLayout("Flow")
 	display:SetStatusTable{width=900,height=550}   -- default height is 500
 	display:EnableResize(false)
 	display:SetCallback("OnClose", function(_display)
 		UIDROPDOWNMENU_SHOW_TIME = prev_fade_time
+		hide_noobtips_frame()
 		_d = _display:GetUserData("eoiST")
 		self.display = nil
 		GUI:Release(_display)
 		flib.clear()
 		collectgarbage()

Mercurial > wow > ouroloot

comparison gui.lua @ 83:940e53dd18c3