tooltips for inventory

because wtf do all those buttons mean anyway?

Author: Warboy1982

bin/data/Language/en-GB.yml

@@ -1052,7 +1052,7 @@ en-GB:
     other: "{N} Units outside Exit Area"
   STR_ABORT_MISSION_QUESTION: "Abort Mission?"
   STR_CORPSE: "Corpse"
-  STR_UNLOAD: "Unload"
+  STR_UNLOAD_CRAFT: "Unload"
   STR_NEW_BATTLE: "New Battle"
   STR_OPTIONS: "Options"
   STR_RIGHT_CLICK_TO_DELETE: "Right click to delete."
@@ -1359,3 +1359,4 @@ en-GB:
   STR_MAXIMIZE_INFO_SCREENS_DESC: "Inventory and various other screens will be displayed at full screen, regardless of scale settings."
   STR_JAPANESE_FONT: "If you have a Japanese font that works in OpenXCom: please, send it to us and let us know if we can use it."
   STR_NOT_ENOUGH_ITEMS_FOR_TEMPLATE: "Not enough items to copy template!"
+  STR_UNLOAD_WEAPON: "Unload weapon"

bin/data/Language/en-US.yml

@@ -1052,7 +1052,7 @@ en-US:
     other: "{N} Units outside Exit Area"
   STR_ABORT_MISSION_QUESTION: "Abort Mission?"
   STR_CORPSE: "Corpse"
-  STR_UNLOAD: "Unload"
+  STR_UNLOAD_CRAFT: "Unload"
   STR_NEW_BATTLE: "New Battle"
   STR_OPTIONS: "Options"
   STR_RIGHT_CLICK_TO_DELETE: "Right click to delete."
@@ -1359,3 +1359,4 @@ en-US:
   STR_MAXIMIZE_INFO_SCREENS_DESC: "Inventory and various other screens will be displayed at full screen, regardless of scale settings."
   STR_JAPANESE_FONT: "If you have a Japanese font that works in OpenXCom: please, send it to us and let us know if we can use it."
   STR_NOT_ENOUGH_ITEMS_FOR_TEMPLATE: "Not enough items to copy template!"
+  STR_UNLOAD_WEAPON: "Unload weapon"

src/Basescape/CraftEquipmentState.cpp

@@ -105,7 +105,7 @@ CraftEquipmentState::CraftEquipmentState(Base *base, size_t craft) : _sel(0), _c
 	_btnOk->onKeyboardPress((ActionHandler)&CraftEquipmentState::btnOkClick, Options::keyCancel);
 
 	_btnClear->setColor(Palette::blockOffset(15)+1);
-	_btnClear->setText(tr("STR_UNLOAD"));
+	_btnClear->setText(tr("STR_UNLOAD_WEAPON"));
 	_btnClear->onMouseClick((ActionHandler)&CraftEquipmentState::btnClearClick);
 	_btnClear->setVisible(isNewBattle);
 

src/Battlescape/InventoryState.cpp

@@ -170,17 +170,48 @@ InventoryState::InventoryState(bool tu, BattlescapeState *parent) : _tu(tu), _pa
 	_btnOk->onMouseClick((ActionHandler)&InventoryState::btnOkClick);
 	_btnOk->onKeyboardPress((ActionHandler)&InventoryState::btnOkClick, Options::keyCancel);
 	_btnOk->onKeyboardPress((ActionHandler)&InventoryState::btnOkClick, Options::keyBattleInventory);
+	_btnOk->setTooltip("STR_OK");
+	_btnOk->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnOk->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnPrev->onMouseClick((ActionHandler)&InventoryState::btnPrevClick);
 	_btnPrev->onKeyboardPress((ActionHandler)&InventoryState::btnPrevClick, Options::keyBattlePrevUnit);
+	_btnPrev->setTooltip("STR_PREVIOUS_UNIT");
+	_btnPrev->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnPrev->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnNext->onMouseClick((ActionHandler)&InventoryState::btnNextClick);
 	_btnNext->onKeyboardPress((ActionHandler)&InventoryState::btnNextClick, Options::keyBattleNextUnit);
+	_btnNext->setTooltip("STR_NEXT_UNIT");
+	_btnNext->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnNext->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnUnload->onMouseClick((ActionHandler)&InventoryState::btnUnloadClick);
+	_btnUnload->setTooltip("STR_UNLOAD_CRAFT");
+	_btnUnload->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnUnload->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnGround->onMouseClick((ActionHandler)&InventoryState::btnGroundClick);
+	_btnGround->setTooltip("STR_SCROLL_RIGHT");
+	_btnGround->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnGround->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnRank->onMouseClick((ActionHandler)&InventoryState::btnRankClick);
+	_btnRank->setTooltip("STR_UNIT_STATS");
+	_btnRank->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnRank->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnCreateTemplate->onMouseClick((ActionHandler)&InventoryState::btnCreateTemplateClick);
 	_btnCreateTemplate->onKeyboardPress((ActionHandler)&InventoryState::btnCreateTemplateClick, Options::keyInvCreateTemplate);
+	_btnCreateTemplate->setTooltip("STR_CREATE_INVENTORY_TEMPLATE");
+	_btnCreateTemplate->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnCreateTemplate->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
+
 	_btnApplyTemplate->onMouseClick((ActionHandler)&InventoryState::btnApplyTemplateClick);
 	_btnApplyTemplate->onKeyboardPress((ActionHandler)&InventoryState::btnApplyTemplateClick, Options::keyInvApplyTemplate);
+	_btnApplyTemplate->setTooltip("STR_APPLY_INVENTORY_TEMPLATE");
+	_btnApplyTemplate->onMouseIn((ActionHandler)&InventoryState::txtTooltipIn);
+	_btnApplyTemplate->onMouseOut((ActionHandler)&InventoryState::txtTooltipOut);
 
 
 	// only use copy/paste buttons in setup (i.e. non-tu) mode
@@ -202,6 +233,9 @@ InventoryState::InventoryState(bool tu, BattlescapeState *parent) : _tu(tu), _pa
 	_txtReact->setVisible(Options::showMoreStatsInInventoryView && !_tu);
 	_txtPSkill->setVisible(Options::showMoreStatsInInventoryView && !_tu);
 	_txtPStr->setVisible(Options::showMoreStatsInInventoryView && !_tu);
+
+	
+	_currentTooltip = "";
 }
 
 static void _clearInventoryTemplate(std::vector<EquipmentLayoutItem*> &inventoryTemplate)
@@ -707,7 +741,10 @@ void InventoryState::invMouseOver(Action *)
 	}
 	else
 	{
-		_txtItem->setText(L"");
+		if (_currentTooltip == "")
+		{
+			_txtItem->setText(L"");
+		}
 		_txtAmmo->setText(L"");
 		_selAmmo->clear();
 		_btnCreateTemplate->setVisible(!_tu);
@@ -752,4 +789,32 @@ void InventoryState::handle(Action *action)
 #endif
 }
 
+/**
+* Shows a tooltip for the appropriate button.
+* @param action Pointer to an action.
+*/
+void InventoryState::txtTooltipIn(Action *action)
+{
+	if (_inv->getSelectedItem() == 0 && Options::battleTooltips)
+	{
+		_currentTooltip = action->getSender()->getTooltip();
+		_txtItem->setText(tr(_currentTooltip));
+	}
+}
+
+/**
+* Clears the tooltip text.
+* @param action Pointer to an action.
+*/
+void InventoryState::txtTooltipOut(Action *action)
+{
+	if (_inv->getSelectedItem() == 0 && Options::battleTooltips)
+	{
+		if (_currentTooltip == action->getSender()->getTooltip())
+		{
+			_currentTooltip = "";
+			_txtItem->setText(L"");
+		}
+	}
+}
 }

src/Battlescape/InventoryState.h

@@ -52,6 +52,7 @@ class InventoryState : public State
 	SavedBattleGame *_battleGame;
 	const bool _tu;
 	BattlescapeState *_parent;
+	std::string _currentTooltip;
 public:
 	/// Creates the Inventory state.
 	InventoryState(bool tu, BattlescapeState *parent);
@@ -87,6 +88,10 @@ class InventoryState : public State
 	void invMouseOut(Action *action);
 	/// Handles keypresses.
 	void handle(Action *action);
+	/// Handler for showing tooltip.
+	void txtTooltipIn(Action *action);
+	/// Handler for hiding tooltip.
+	void txtTooltipOut(Action *action);
 };
 
 }