NCBI C++ ToolKit
Public Member Functions | List of all members
ITooltipHandlerHost Class Referenceabstract

Search Toolkit Book for ITooltipHandlerHost

#include <gui/widgets/gl/tooltip_handler.hpp>

+ Inheritance diagram for ITooltipHandlerHost:

Public Member Functions

virtual ~ITooltipHandlerHost ()
 
virtual bool TC_NeedTooltip (const wxPoint &pt)=0
 Returns "true" if client wants to dispaly a tooltip. More...
 
virtual string TC_GetTooltip (const wxRect &rect)=0
 Returns tooltip string and coordinates for area tootlip associated with. More...
 
virtual wxWindow * TC_GetWindow ()=0
 Returns pointer to the widget hosting ITooltipClient. More...
 

Detailed Description

Definition at line 47 of file tooltip_handler.hpp.

Constructor & Destructor Documentation

◆ ~ITooltipHandlerHost()

virtual ITooltipHandlerHost::~ITooltipHandlerHost ( )
inlinevirtual

Definition at line 51 of file tooltip_handler.hpp.

Member Function Documentation

◆ TC_GetTooltip()

virtual string ITooltipHandlerHost::TC_GetTooltip ( const wxRect &  rect)
pure virtual

Returns tooltip string and coordinates for area tootlip associated with.

Client may choose not modify x, y, w, z, in that case tooltip will be associated with current mouse position.

Implemented in CGlWidgetPane, CSeqTextPane, CHitMatrixPane, and CCrossAlnPane.

Referenced by CTooltipHandler::OnMotion().

◆ TC_GetWindow()

virtual wxWindow* ITooltipHandlerHost::TC_GetWindow ( )
pure virtual

Returns pointer to the widget hosting ITooltipClient.

Default implementation returns "this";

Implemented in CGlWidgetPane.

Referenced by CTooltip::Move(), CTooltip::On(), and CTooltip::WinMove().

◆ TC_NeedTooltip()

virtual bool ITooltipHandlerHost::TC_NeedTooltip ( const wxPoint &  pt)
pure virtual

Returns "true" if client wants to dispaly a tooltip.

"x" and "y" are cordinates of the mouse pointer

Implemented in CSeqTextPane, CGlWidgetPane, CHitMatrixPane, and CCrossAlnPane.

Referenced by CTooltipHandler::OnMotion().


The documentation for this class was generated from the following file:
Modified on Fri Apr 12 17:15:22 2024 by modify_doxy.py rev. 669887