tooltip.h

/***************************************************************************
 *   Copyright (C) 2025 by OpenCPN developer team                          *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 **************************************************************************/
 
#ifndef _TOOLTIP_H__
#define _TOOLTIP_H__
 
#include <functional>
 
#include <wx/frame.h>
#include <wx/timer.h>
#include <wx/bitmap.h>
#include "color_types.h"
 
class Tooltip;  // forward
using TooltipCallback = std::function<void(const Tooltip *)>;
 
class Tooltip : public wxFrame {
public:
  Tooltip(wxWindow *parent, TooltipCallback on_destroy);
  ~Tooltip();
 
  void SetString(const wxString &text);
  void SetRelativePosition(const wxRect &windowRect, int offsetX = 2,
                           int offsetY = 0);
  void SetHiviz(bool hiviz);
  void SetColorScheme(ColorScheme cs);
 
  void SetAbsolutePosition(const wxPoint &pt);
 
  void SetBitmap();
  wxSize GetRenderedSize() const;
 
  void ShowTooltip(int delay_ms = 0);
  void HideTooltip();
 
  bool Destroy() override;
 
  // Event handlers
  void OnPaint(wxPaintEvent &event);
  void OnTimer(wxTimerEvent &event);
 
private:
  void CreateBitmap();
  void CalculateOptimalPosition();
 
  wxString m_string;
  wxSize m_size;
  wxPoint m_position;
  wxPoint m_requestedPosition;
  wxBitmap *m_pbm;
  wxColour m_back_color;
  wxColour m_text_color;
  ColorScheme m_cs;
  bool m_hiviz;
 
  wxTimer m_showTimer;
  bool m_showPending;
  TooltipCallback m_on_destroy;
 
  DECLARE_EVENT_TABLE()
};
 
class TooltipManager {
public:
  static TooltipManager &Get();
 
  void ShowTooltipForWindow(wxWindow *window, const wxString &text,
                            bool hiviz = false);
  void ShowTooltipAtPosition(wxWindow *parent, const wxString &text,
                             const wxPoint &position, bool hiviz = false);
 
  void HideTooltip();
  void HideAllTooltips();
  void SetColorScheme(ColorScheme cs);
  void EnableTooltips(bool enable);
  bool AreTooltipsEnabled() const { return m_enabled; }
 
  bool IsShown() const;
 
  void SetShowDelay(int ms) { m_showDelay = ms; }
  void SetHideDelay(int ms) { m_hideDelay = ms; }
 
private:
  TooltipManager();
  ~TooltipManager();
 
  Tooltip *GetOrCreateTooltip(wxWindow *parent);
  void CleanupTooltip();
 
  Tooltip *m_currentTooltip;
  wxWindow *m_currentParent;
  ColorScheme m_colorScheme;
  bool m_enabled;
  int m_showDelay;
  int m_hideDelay;
 
  // Singleton instance
  static TooltipManager *s_instance;
};
 
#endif  // _TOOLTIP_H__