Search Toolkit Book for CStickyTooltipHandler
CStickyTooltipHandler : Class that manages all the tooltips for a specific window. More...
#include <gui/widgets/wx/sticky_tooltip_handler.hpp>
CStickyTooltipHandler : Class that manages all the tooltips for a specific window.
Primarily it responds to move, size, and dock/undock messages of the hosting window in order to make the tips look as if they are attached to the window. The tooltip windows are toplevel windows just like their hosting windows. This means quite a bit is also done to make sure that the tips always appear in front of their parent window, and never jump in front of another application window that is on top of their parent window. The details of managing this feature are in some cases platform dependent.
Definition at line 241 of file sticky_tooltip_handler.hpp.
◆ CStickyTooltipHandler() ◆ ~CStickyTooltipHandler() CStickyTooltipHandler::~CStickyTooltipHandler ( ) virtual ◆ AddTip() ◆ AddUnpinned() ◆ checkChildFocus() bool CStickyTooltipHandler::checkChildFocus ( wxWindow * fwin, wxWindow * checkwin ) protected ◆ CheckForNewTip() void CStickyTooltipHandler::CheckForNewTip ( wxPoint pos )Checks if a new tip should be popped up for the current location.
Definition at line 782 of file sticky_tooltip_handler.cpp.
References delta(), CTooltipFrame::GetInitialMousePos(), i, m_ClearUnpinnedDelay, m_Host, m_TimerClearUnpinned, m_TipInitPos, m_TipPopupDelay, m_ToolTips, m_UnpinnedMouseMoveThreshold, m_UnpinnedTip, NCBI_CATCH, NULL, and IStickyTooltipHandlerHost::TTHH_NeedTooltip().
Referenced by Notify(), OnMotion(), OnMouseWheel(), and OnTimer().
◆ ClearUnpinned() void CStickyTooltipHandler::ClearUnpinned ( ) virtualDelete the current unpinned tip (if any)
Definition at line 659 of file sticky_tooltip_handler.cpp.
References eCmdTipInactive, eCmdTipRemoved, m_Host, m_TimerClearUnpinned, m_UnpinnedTip, NULL, CTooltipFrame::Show(), IStickyTooltipHandlerHost::TTHH_GetWindow(), and UpdateTips().
Referenced by AddUnpinned(), OnLeaveWindow(), OnRightMouseDown(), OnTimer(), ParentShow(), Suspend(), and UnpinPinned().
◆ GetClearUnpinnedDelay() int& CStickyTooltipHandler::GetClearUnpinnedDelay ( ) inline ◆ GetEvtHandler() virtual wxEvtHandler* CStickyTooltipHandler::GetEvtHandler ( ) inlinevirtual ◆ GetMoveThreshold() float& CStickyTooltipHandler::GetMoveThreshold ( ) inline ◆ GetPopupDistance() float& CStickyTooltipHandler::GetPopupDistance ( ) inline ◆ GetTipPopupDelay() int& CStickyTooltipHandler::GetTipPopupDelay ( ) inline ◆ GetUnpinnedMoveThreshold() float& CStickyTooltipHandler::GetUnpinnedMoveThreshold ( ) inline ◆ Notify() void CStickyTooltipHandler::Notify ( )Definition at line 694 of file sticky_tooltip_handler.cpp.
References AddUnpinned(), CheckForNewTip(), delta(), CTooltipInfo::GetTipID(), m_Host, m_MouseMoveThreshold, m_PopupDistance, m_TipInitPos, CTooltipFrame::SetInitialMousePos(), CTooltipFrame::SetLinkEventHandler(), CTooltipFrame::Show(), IStickyTooltipHandlerHost::TTHH_GetTooltip(), IStickyTooltipHandlerHost::TTHH_GetWindow(), IStickyTooltipHandlerHost::TTHH_PopupMenuDisplayed(), and wxT.
◆ OnActivateCmd() void CStickyTooltipHandler::OnActivateCmd ( wxCommandEvent & event ) ◆ OnCloseTip() void CStickyTooltipHandler::OnCloseTip ( wxCommandEvent & event )Commands from buttons on individual tips.
◆ OnLeaveWindow() void CStickyTooltipHandler::OnLeaveWindow ( wxMouseEvent & event ) ◆ OnLinkClicked() virtual bool CStickyTooltipHandler::OnLinkClicked ( const wxString & href ) inlinevirtual ◆ OnMainWindowDockCmd() void CStickyTooltipHandler::OnMainWindowDockCmd ( wxCommandEvent & event ) ◆ OnMotion() void CStickyTooltipHandler::OnMotion ( wxMouseEvent & event ) ◆ OnMouseWheel() void CStickyTooltipHandler::OnMouseWheel ( wxMouseEvent & event ) ◆ OnPinTip() void CStickyTooltipHandler::OnPinTip ( wxCommandEvent & event ) ◆ OnReCreateCmd() void CStickyTooltipHandler::OnReCreateCmd ( wxCommandEvent & event ) ◆ OnRightMouseDown() void CStickyTooltipHandler::OnRightMouseDown ( wxMouseEvent & event ) ◆ OnSetFocus() void CStickyTooltipHandler::OnSetFocus ( ) virtual ◆ OnSize() void CStickyTooltipHandler::OnSize ( wxSizeEvent & event ) ◆ OnSuspendCmd() void CStickyTooltipHandler::OnSuspendCmd ( wxCommandEvent & event ) ◆ OnTimer() void CStickyTooltipHandler::OnTimer ( wxTimerEvent & event ) virtualDetermines which tip mouse is on (if any) and brings it to front.
Definition at line 430 of file sticky_tooltip_handler.cpp.
References CTooltipFrame::AddChildWindow(), checkChildFocus(), CheckForNewTip(), ClearUnpinned(), eCmdTipActive, eCmdTipInactive, CTooltipFrame::FitToWindow(), IStickyTooltipHandlerHost::IsDragging(), CTooltipFrame::LaunchedBrowser(), m_ActiveTip, m_Host, m_ToolTips, m_UnpinnedTip, NULL, r(), IStickyTooltipHandlerHost::RaiseOverlappingWindows(), CTooltipFrame::RemoveChildWindow(), CTooltipFrame::SetLaunchedFalse(), CTooltipFrame::SetToDefaultSize(), CTooltipFrame::TipPopupMenuDisplayed(), IStickyTooltipHandlerHost::TTHH_GetWindow(), IStickyTooltipHandlerHost::TTHH_PopupMenuDisplayed(), TTMGR_TIMER_CLEAR_UNPINNED, TTMGR_TIMER_ID, and wxT.
◆ OnTipMove() void CStickyTooltipHandler::OnTipMove ( wxCommandEvent & event ) ◆ OnTipRelease() ◆ OnWindowHideCmd() void CStickyTooltipHandler::OnWindowHideCmd ( wxCommandEvent & event ) ◆ OnWindowMoveCmd() void CStickyTooltipHandler::OnWindowMoveCmd ( wxCommandEvent & event ) ◆ OnWindowShowCmd() void CStickyTooltipHandler::OnWindowShowCmd ( wxCommandEvent & event ) ◆ ParentMove() void CStickyTooltipHandler::ParentMove ( const wxPoint & screen_pos ) virtual ◆ ParentShow() void CStickyTooltipHandler::ParentShow ( bool show ) virtual ◆ PinUnpinned() ◆ ReCreate() void CStickyTooltipHandler::ReCreate ( int dock_count =0 ) virtual
Recreates suspended tips (old tips are deleted).
Definition at line 598 of file sticky_tooltip_handler.cpp.
References _ASSERT, AddTip(), CTooltipFrame::FitToWindow(), IStickyTooltipHandlerHost::InitWindowGroup(), m_Host, m_SuspendCount, m_SuspendedTips, m_ToolTips, CTooltipFrame::OnPinButton(), IStickyTooltipHandlerHost::RaiseOverlappingWindows(), CTooltipFrame::SetLinkEventHandler(), CTooltipFrame::SetPinned(), CTooltipFrame::SetTargetSize(), CTooltipFrame::Show(), IStickyTooltipHandlerHost::TTHH_GetWindow(), and UpdateTips().
Referenced by OnMainWindowDockCmd(), and OnReCreateCmd().
◆ RegisterCommands() void CStickyTooltipHandler::RegisterCommands ( ) static ◆ Resize() void CStickyTooltipHandler::Resize ( void ) virtual ◆ SetHost() ◆ SetPane() virtual void CStickyTooltipHandler::SetPane ( CGlPane * pane ) inlinevirtual ◆ Suspend() void CStickyTooltipHandler::Suspend ( void ) virtual ◆ UnpinPinned()Remove a tip from m_ToolTips, and set m_UnpinnedTip to the tip.
Definition at line 345 of file sticky_tooltip_handler.cpp.
References _ASSERT, ClearUnpinned(), eCmdTipInactive, m_ActiveTip, m_Host, m_Timer, m_ToolTips, m_UnpinnedTip, NULL, IStickyTooltipHandlerHost::TTHH_GetWindow(), and UpdateTips().
Referenced by OnPinTip().
◆ UpdateTips() void CStickyTooltipHandler::UpdateTips ( )Any command that updates tip position should use this to keep the list of user-accessible tip information up-to-date.
Definition at line 1011 of file sticky_tooltip_handler.cpp.
References i, CGlRect< T >::Init(), m_Host, m_ToolTips, m_UnpinnedTip, NULL, IStickyTooltipHandlerHost::TipLocation::TipID, IStickyTooltipHandlerHost::TipLocation::TipRect, IStickyTooltipHandlerHost::TTHH_GetWindow(), and IStickyTooltipHandlerHost::x_SetCurrentTips().
Referenced by AddTip(), AddUnpinned(), ClearUnpinned(), OnTipMove(), ParentMove(), ParentShow(), ReCreate(), Resize(), Suspend(), UnpinPinned(), and ~CStickyTooltipHandler().
◆ m_ActiveTip ◆ m_ClearUnpinnedDelay int CStickyTooltipHandler::m_ClearUnpinnedDelay protected ◆ m_HostHost window for tips.
Definition at line 336 of file sticky_tooltip_handler.hpp.
Referenced by AddUnpinned(), CheckForNewTip(), ClearUnpinned(), Notify(), OnActivateCmd(), OnLeaveWindow(), OnLinkClicked(), OnTimer(), OnTipMove(), OnWindowMoveCmd(), ParentShow(), ReCreate(), Resize(), SetHost(), UnpinPinned(), and UpdateTips().
◆ m_MouseMoveThreshold float CStickyTooltipHandler::m_MouseMoveThreshold protected ◆ m_Pane CGlPane* CStickyTooltipHandler::m_Pane protected ◆ m_PopupDistance float CStickyTooltipHandler::m_PopupDistance protected ◆ m_SuspendCount int CStickyTooltipHandler::m_SuspendCount protected ◆ m_SuspendedTips std::vector<CTooltipFrame*> CStickyTooltipHandler::m_SuspendedTips protected ◆ m_Timer wxTimer CStickyTooltipHandler::m_Timer protected ◆ m_TimerClearUnpinned wxTimer CStickyTooltipHandler::m_TimerClearUnpinned protected ◆ m_TipInitPos wxPoint CStickyTooltipHandler::m_TipInitPos protected ◆ m_TipPopupDelay int CStickyTooltipHandler::m_TipPopupDelay protected ◆ m_ToolTipsAll tooltips for current window (m_Host)
Definition at line 354 of file sticky_tooltip_handler.hpp.
Referenced by AddTip(), CheckForNewTip(), OnTimer(), ParentMove(), ParentShow(), ReCreate(), Resize(), Suspend(), UnpinPinned(), UpdateTips(), and ~CStickyTooltipHandler().
◆ m_UnpinnedMouseMoveThreshold float CStickyTooltipHandler::m_UnpinnedMouseMoveThreshold protected ◆ m_UnpinnedTipThe documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4