mapbutton.lua

   1 QuestHelper_File["mapbutton.lua"] = "Development Version"
   2
   3 --[[
   4    mapbutton.lua
   5
   6    This module contains code to place a button on the Map Frame, and provides the
   7    functionality of that button.
   8
   9    Currently Functionality:
  10    - Left click on button is equivalent to /qh hide
  11    - Right-click on button shows Settings menu
  12    - Button has tooltip to that effect
  13    - Button serves as hook to detect when map is hidden, in order to hide active menus (if any).
  14
  15    History:
  16       4-20-2008     Nesher      Created
  17       4-24-2008     Smariot     Added right-click menu
  18       4-24-2008     Nesher      Localized settings menu.  Added hook to hide menus when World Map is hidden.
  19 --]]
  20
  21 -------------------------------------------------------------------------------------
  22 -- Display a Settings menu.  Used from the map button's right-click, and from /qh settings.
  23 function QuestHelper:DoSettingsMenu()
  24     local menu = QuestHelper:CreateMenu()
  25     self:CreateMenuTitle(menu, QHText("MENU_SETTINGS"))
  26
  27     -- Flight Timer
  28     self:CreateMenuItem(menu, QHFormat("MENU_FLIGHT_TIMER", QuestHelper_Pref.flight_time and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  29                     :SetFunction(self.ToggleFlightTimes, self)
  30
  31     -- Ant Trails
  32     self:CreateMenuItem(menu, QHFormat("MENU_ANT_TRAILS", QuestHelper_Pref.show_ants and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  33                     :SetFunction(self.ToggleAnts, self)
  34
  35     -- Objective Tooltips
  36     self:CreateMenuItem(menu, QHFormat("MENU_OBJECTIVE_TIPS", QuestHelper_Pref.tooltip and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  37                     :SetFunction(self.ToggleTooltip, self)
  38
  39     -- Cartographer Waypoints
  40     if Cartographer_Waypoints then
  41       self:CreateMenuItem(menu, QHFormat("MENU_WAYPOINT_ARROW", QuestHelper_Pref.cart_wp and QHText("MENU_DISABLE") or QHText("MENU_ENABLE"))..(TomTom and " (Cartographer Waypoints)" or ""))
  42                     :SetFunction(self.ToggleCartWP, self)
  43     end
  44
  45     -- TomTom
  46     if TomTom then
  47       self:CreateMenuItem(menu, QHFormat("MENU_WAYPOINT_ARROW", QuestHelper_Pref.tomtom_wp and QHText("MENU_DISABLE") or QHText("MENU_ENABLE"))..(Cartographer_Waypoints and " (TomTom)" or ""))
  48                     :SetFunction(self.ToggleTomTomWP, self)
  49     end
  50
  51     -- Options regarding party members.
  52     local submenu = self:CreateMenu()
  53     self:CreateMenuItem(submenu, QHFormat("MENU_PARTY_SHARE", QuestHelper_Pref.share and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  54                  :SetFunction(self.ToggleShare, self)
  55     self:CreateMenuItem(submenu, QHFormat("MENU_PARTY_SOLO", QuestHelper_Pref.solo and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  56                  :SetFunction(self.ToggleSolo, self)
  57     self:CreateMenuItem(menu, QHText("MENU_PARTY")):SetSubmenu(submenu)
  58
  59     -- Map frame button
  60     self:CreateMenuItem(menu, QHFormat("MENU_MAP_BUTTON", QuestHelper_Pref.map_button and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  61                     :SetFunction(self.ToggleMapButton, self)
  62
  63     -- Icon Scale
  64     submenu = self:CreateMenu()
  65     for pct = 50,120,10 do
  66       local item = self:CreateMenuItem(submenu, pct.."%")
  67       local tex = self:CreateIconTexture(item, 10)
  68       item:SetFunction(QuestHelper.genericSetScale, QuestHelper, "scale", "icon scale", .5, 3, pct.."%")
  69       item:AddTexture(tex, true)
  70       tex:SetVertexColor(1, 1, 1, QuestHelper_Pref.scale == pct*0.01 and 1 or 0)
  71     end
  72     self:CreateMenuItem(menu, QHText("MENU_ICON_SCALE")):SetSubmenu(submenu)
  73
  74     -- Hidden Objectives
  75     submenu = self:CreateMenu()
  76     self:PopulateHidden(submenu)
  77     self:CreateMenuItem(menu, QHText("HIDDEN_TITLE")):SetSubmenu(submenu)
  78
  79     -- Tracker Options
  80     submenu = self:CreateMenu()
  81     self:CreateMenuItem(submenu, QHFormat("MENU_QUEST_TRACKER", QuestHelper_Pref.track and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  82                     :SetFunction(self.ToggleTrack, self)
  83     self:CreateMenuItem(submenu, QHFormat("MENU_TRACKER_LEVEL", QuestHelper_Pref.track_level and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  84                     :SetFunction(self.ToggleTrackLevel, self)
  85     self:CreateMenuItem(submenu, QHFormat("MENU_TRACKER_QCOLOUR", QuestHelper_Pref.track_qcolour and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  86                     :SetFunction(self.ToggleTrackQColour, self)
  87     self:CreateMenuItem(submenu, QHFormat("MENU_TRACKER_OCOLOUR", QuestHelper_Pref.track_ocolour and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
  88                     :SetFunction(self.ToggleTrackOColour, self)
  89     local submenu2 = self:CreateMenu()
  90     for pct = 60,120,10 do
  91       local item = self:CreateMenuItem(submenu2, pct.."%")
  92       local tex = self:CreateIconTexture(item, 10)
  93       item:SetFunction(self.TrackerScale, QuestHelper, pct.."%")
  94       item:AddTexture(tex, true)
  95       tex:SetVertexColor(1, 1, 1, QuestHelper_Pref.track_scale == pct*0.01 and 1 or 0)
  96     end
  97     self:CreateMenuItem(submenu, QHText("MENU_TRACKER_SCALE")):SetSubmenu(submenu2)
  98     self:CreateMenuItem(submenu, QHText("MENU_TRACKER_RESET"))
  99                     :SetFunction(self.ResetTrackerPosition, self)
 100     self:CreateMenuItem(menu, QHText("MENU_TRACKER_OPTIONS")):SetSubmenu(submenu)
 101
 102     -- Filters
 103     submenu = self:CreateMenu()
 104     self:CreateMenuItem(submenu, QHFormat("MENU_ZONE_FILTER", QuestHelper_Pref.filter_zone and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
 105                     :SetFunction(self.Filter, self, "ZONE")
 106     self:CreateMenuItem(submenu, QHFormat("MENU_DONE_FILTER", QuestHelper_Pref.filter_done and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
 107                     :SetFunction(self.Filter, self, "DONE")
 108     self:CreateMenuItem(submenu, QHFormat("MENU_BLOCKED_FILTER", QuestHelper_Pref.filter_blocked and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
 109                     :SetFunction(self.Filter, self, "BLOCKED")
 110     self:CreateMenuItem(submenu, QHFormat("MENU_WATCHED_FILTER", QuestHelper_Pref.filter_watched and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
 111                     :SetFunction(self.Filter, self, "WATCHED")
 112     self:CreateMenuItem(submenu, QHFormat("MENU_LEVEL_FILTER", QuestHelper_Pref.filter_level and QHText("MENU_DISABLE") or QHText("MENU_ENABLE")))
 113                     :SetFunction(self.Filter, self, "LEVEL")
 114     submenu2 = self:CreateMenu()
 115     self:CreateMenuItem(submenu, QHText("MENU_LEVEL_OFFSET")):SetSubmenu(submenu2)
 116
 117     for offset = -5,5 do
 118       local menu = self:CreateMenuItem(submenu2, (offset > 0 and "+" or "")..offset)
 119       menu:SetFunction(self.LevelOffset, self, offset)
 120       local tex = self:CreateIconTexture(item, 10)
 121       menu:AddTexture(tex, true)
 122       tex:SetVertexColor(1, 1, 1, QuestHelper_Pref.level == offset and 1 or 0)
 123     end
 124     self:CreateMenuItem(menu, QHText("MENU_FILTERS")):SetSubmenu(submenu)
 125
 126     submenu = self:CreateMenu()
 127     for scale = 0.2,2,0.2 do
 128       local menu = self:CreateMenuItem(submenu, (scale*100).."%")
 129       menu:SetFunction(QuestHelper.genericSetScale, QuestHelper, "perf_scale", "performance factor", .1, 5, scale)
 130       local tex = self:CreateIconTexture(item, 10)
 131       menu:AddTexture(tex, true)
 132       tex:SetVertexColor(1, 1, 1, QuestHelper_Pref.perf_scale == scale and 1 or 0)
 133     end
 134     self:CreateMenuItem(menu, QHText("MENU_PERFORMANCE")):SetSubmenu(submenu)
 135
 136     -- Locale
 137     submenu = self:CreateMenu()
 138     for loc, tbl in pairs(QuestHelper_Translations) do
 139       local item = self:CreateMenuItem(submenu, (tbl.LOCALE_NAME or "???").." ["..loc.."]")
 140       local tex = self:CreateIconTexture(item, 10)
 141       item:SetFunction(self.SetLocale, self, loc)
 142       item:AddTexture(tex, true)
 143       tex:SetVertexColor(1, 1, 1, QuestHelper_Pref.locale == loc and 1 or 0)
 144     end
 145     local item = self:CreateMenuItem(menu, QHText("MENU_LOCALE"))
 146     item:AddTexture(self:CreateIconTexture(item, 25), true) -- Add Globe icon to locale menu.
 147     item:SetSubmenu(submenu)
 148
 149     -- Stuff to read.
 150     submenu = self:CreateMenu()
 151     self:CreateMenuItem(submenu, QHText("MENU_HELP_SLASH")):SetFunction(self.Help, self)
 152     self:CreateMenuItem(submenu, QHText("MENU_HELP_CHANGES")):SetFunction(self.ChangeLog, self)
 153     self:CreateMenuItem(submenu, QHText("MENU_HELP_SUBMIT")):SetFunction(self.Submit, self)
 154     self:CreateMenuItem(menu, QHText("MENU_HELP")):SetSubmenu(submenu)
 155
 156     menu:ShowAtCursor()
 157 end
 158
 159 -------------------------------------------------------------------------------------
 160 -- Handle clicks on the button
 161 function QuestHelperWorldMapButton_OnClick(self, clicked)
 162
 163   -- Left button toggles whether QuestHelper is displayed (and hence active)
 164   if clicked == "LeftButton" then
 165     QuestHelper:ToggleHide()
 166
 167     -- Refresh the tooltip to match.  Presumably it's showing - how else could the button get clicked?
 168     -- Note: if I'm wrong about my assumption, this could leave the tooltip stranded until user mouses
 169     -- back over the button, but I don't think that's too serious.
 170     QuestHelperWorldMapButton_OnEnter(self)
 171   elseif clicked == "RightButton" and not QuestHelper_Pref.hide then
 172     QuestHelper:DoSettingsMenu()
 173   end
 174 end
 175
 176 -------------------------------------------------------------------------------------
 177 -- Display or update the tooltip
 178 function QuestHelperWorldMapButton_OnEnter(self)
 179     local theme = QuestHelper:GetColourTheme()
 180
 181     QuestHelper.tooltip:SetOwner(self, "ANCHOR_BOTTOMLEFT", self:GetWidth(), -5)
 182     QuestHelper.tooltip:ClearLines()
 183     QuestHelper.tooltip:AddLine(QHFormat("QH_BUTTON_TOOLTIP1", QHText(QuestHelper_Pref.hide and "QH_BUTTON_SHOW" or "QH_BUTTON_HIDE")),
 184                                 unpack(theme.tooltip))
 185     QuestHelper.tooltip:GetPrevLines():SetFont(QuestHelper.font.serif, 12)
 186     if not QuestHelper_Pref.hide then
 187         -- Add the settings menu tooltip when it's available
 188         QuestHelper.tooltip:AddLine(QHText("QH_BUTTON_TOOLTIP2"), unpack(theme.tooltip))
 189         QuestHelper.tooltip:GetPrevLines():SetFont(QuestHelper.font.serif, 12)
 190     end
 191     QuestHelper.tooltip:Show()
 192 end
 193
 194 -------------------------------------------------------------------------------------
 195 -- Handle when the world map gets hidden: hide the active menu if any.
 196 function QuestHelper_WorldMapHidden()
 197   if QuestHelper.active_menu then
 198     QuestHelper.active_menu:DoHide()
 199     if QuestHelper.active_menu.auto_release then
 200       QuestHelper.active_menu = nil
 201     end
 202   end
 203 end
 204
 205
 206 -------------------------------------------------------------------------------------
 207 -- Set up the Map Button
 208 function QuestHelper:InitMapButton()
 209
 210   if not self.MapButton then
 211     -- Create the button
 212     local button = CreateFrame("Button", "QuestHelperWorldMapButton", WorldMapFrame, "UIPanelButtonTemplate")
 213
 214     -- Assign the font QuestHelper selected for the currect locale.
 215     if button.GetFont then
 216       button:SetFont(self.font.serif, select(2, button:GetFont()))
 217     end
 218
 219     -- Set up the button
 220     button:SetText(QHText("QH_BUTTON_TEXT"))
 221     local width = button:GetTextWidth() + 30
 222     if width < 110 then
 223         width = 110
 224     end
 225     button:SetWidth(width)
 226     button:SetHeight(22)
 227
 228     -- Desaturate the button texture if QuestHelper is disabled.
 229     -- This line is also in QuestHelper:ToggleHide
 230     button:GetNormalTexture():SetDesaturated(QuestHelper_Pref.hide)
 231
 232     -- Add event handlers to provide Tooltip
 233     button:SetScript("OnEnter", QuestHelperWorldMapButton_OnEnter)
 234     button:SetScript("OnLeave", function(this)
 235         QuestHelper.tooltip:Hide()
 236     end)
 237
 238     -- Add Click handler
 239     button:SetScript("OnClick", QuestHelperWorldMapButton_OnClick)
 240     button:RegisterForClicks("LeftButtonUp", "RightButtonUp")
 241
 242     -- Add Hide handler, so we can dismiss any menus when map is closed
 243     button:SetScript("OnHide", QuestHelper_WorldMapHidden)
 244
 245     -- Position it on the World Map frame
 246 --~     if Cartographer then
 247 --~         -- If Cartographer is in use, coordinate with their buttons.
 248             -- Trouble is, this makes Cartographer's buttons conflict with the Zone Map dropdown.
 249             -- Re-enable this if Cartographer ever learns to work with the Zone Map dropdown.
 250 --~         Cartographer:AddMapButton(button, 3)
 251 --~     else
 252         -- Otherwise, just put it in the upper right corner
 253         button:SetPoint("RIGHT", WorldMapPositioningGuide, "RIGHT", -20, 0)
 254         button:SetPoint("BOTTOM", WorldMapZoomOutButton, "BOTTOM", 0, 0)
 255 --    end
 256
 257     -- Save the button so we can reference it later if need be
 258     self.MapButton = button
 259   else
 260     -- User must be toggling the button.  We've already got it, so just show it.
 261     self.MapButton:Show()
 262   end
 263 end
 264
 265 ----------------------------------------------------------------------------------
 266 -- Hide the map button
 267 function QuestHelper:HideMapButton()
 268   if self.MapButton then
 269     self.MapButton:Hide()
 270   end
 271 end