NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | List of all members
CTooltipInfo Class Reference

Search Toolkit Book for CTooltipInfo

Contents of a single tool tip including display text and an ID that will indicate which underlying visual element the tip is attached to. More...

#include <gui/objutils/tool_tip_info.hpp>

+ Collaboration diagram for CTooltipInfo:

Public Types

enum  EToolTipOptions {
  ePin = 0x01 , eSearch = 0x02 , eMagnify = 0x04 , eInfo = 0x08 ,
  eAllOptions = ePin | eSearch | eMagnify | eInfo
}
 Any combination of available buttons can be displayed by or-ing the desired options together, or choos eAllOptions for all buttons. More...
 

Public Member Functions

 CTooltipInfo (int opt=eAllOptions)
 Ctor allows override of button options. More...
 
void SetTipText (const std::string &tip_text)
 Set/get display text. More...
 
std::string GetTipText () const
 
void SetTitleText (const std::string &title_text)
 Set/get display text. More...
 
std::string GetTitleText () const
 
void SetTipID (std::string id)
 Set/get id that identifies the underlying element. More...
 
std::string GetTipID () const
 
void SetToolTipOptions (int opt)
 Set/get options that determine which buttons are displayed. More...
 
int GetToolTipOptions () const
 

Protected Attributes

std::string m_Text
 
std::string m_ID
 
std::string m_Title
 
int m_Options
 

Detailed Description

Contents of a single tool tip including display text and an ID that will indicate which underlying visual element the tip is attached to.

Definition at line 46 of file tool_tip_info.hpp.

Member Enumeration Documentation

◆ EToolTipOptions

Any combination of available buttons can be displayed by or-ing the desired options together, or choos eAllOptions for all buttons.

Enumerator
ePin 
eSearch 
eMagnify 
eInfo 
eAllOptions 

Definition at line 52 of file tool_tip_info.hpp.

Constructor & Destructor Documentation

◆ CTooltipInfo()

CTooltipInfo::CTooltipInfo ( int  opt = eAllOptions)
inline

Ctor allows override of button options.

Definition at line 61 of file tool_tip_info.hpp.

Member Function Documentation

◆ GetTipID()

std::string CTooltipInfo::GetTipID ( ) const
inline

Definition at line 73 of file tool_tip_info.hpp.

References m_ID.

Referenced by CStickyTooltipHandler::Notify(), and CSeqGraphicPane::TTHH_NeedTooltip().

◆ GetTipText()

std::string CTooltipInfo::GetTipText ( ) const
inline

◆ GetTitleText()

std::string CTooltipInfo::GetTitleText ( ) const
inline

Definition at line 69 of file tool_tip_info.hpp.

References m_Title.

◆ GetToolTipOptions()

int CTooltipInfo::GetToolTipOptions ( ) const
inline

Definition at line 77 of file tool_tip_info.hpp.

References m_Options.

◆ SetTipID()

void CTooltipInfo::SetTipID ( std::string  id)
inline

Set/get id that identifies the underlying element.

Definition at line 72 of file tool_tip_info.hpp.

References m_ID.

Referenced by IPhyloTreeRender::TTHH_GetTooltip(), and CSeqGraphicPane::TTHH_NeedTooltip().

◆ SetTipText()

void CTooltipInfo::SetTipText ( const std::string tip_text)
inline

Set/get display text.

Definition at line 64 of file tool_tip_info.hpp.

References m_Text.

Referenced by IPhyloTreeRender::TTHH_GetTooltip(), and CSeqGraphicPane::TTHH_NeedTooltip().

◆ SetTitleText()

void CTooltipInfo::SetTitleText ( const std::string title_text)
inline

Set/get display text.

Definition at line 68 of file tool_tip_info.hpp.

References m_Title.

Referenced by IPhyloTreeRender::TTHH_GetTooltip(), and CSeqGraphicPane::TTHH_NeedTooltip().

◆ SetToolTipOptions()

void CTooltipInfo::SetToolTipOptions ( int  opt)
inline

Set/get options that determine which buttons are displayed.

Definition at line 76 of file tool_tip_info.hpp.

References m_Options.

Referenced by CSeqGraphicPane::TTHH_NeedTooltip().

Member Data Documentation

◆ m_ID

std::string CTooltipInfo::m_ID
protected

Definition at line 81 of file tool_tip_info.hpp.

Referenced by GetTipID(), and SetTipID().

◆ m_Options

int CTooltipInfo::m_Options
protected

Definition at line 84 of file tool_tip_info.hpp.

Referenced by GetToolTipOptions(), and SetToolTipOptions().

◆ m_Text

std::string CTooltipInfo::m_Text
protected

Definition at line 80 of file tool_tip_info.hpp.

Referenced by GetTipText(), and SetTipText().

◆ m_Title

std::string CTooltipInfo::m_Title
protected

Definition at line 82 of file tool_tip_info.hpp.

Referenced by GetTitleText(), and SetTitleText().


The documentation for this class was generated from the following file:
Modified on Sun Jul 14 04:59:02 2024 by modify_doxy.py rev. 669887