NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | Private Attributes | List of all members
CTooltipWnd Class Reference

Search Toolkit Book for CTooltipWnd

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

+ Inheritance diagram for CTooltipWnd:
+ Collaboration diagram for CTooltipWnd:

Public Member Functions

 CTooltipWnd ()
 Constructors. More...
 
 CTooltipWnd (CTooltip *tooltip)
 
bool Create (wxWindow *parent, wxWindowID id=ID_CTOOLTIPWND, const wxString &title=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(0, 0), long style=wxFRAME_TOOL_WINDOW|wxFRAME_FLOAT_ON_PARENT|wxFRAME_NO_TASKBAR)
 Creation. More...
 
 ~CTooltipWnd ()
 Destructor. More...
 
void Init ()
 Initialises member variables. More...
 
void CreateControls ()
 Creates the controls and sizers. More...
 
void OnMouse (wxMouseEvent &event)
 All mouse events event handler for ID_CTOOLTIPWND. More...
 
wxString GetTooltipText () const
 
void SetTooltipText (wxString value)
 
wxBitmap GetBitmapResource (const wxString &name)
 Retrieves bitmap resources. More...
 
wxIcon GetIconResource (const wxString &name)
 Retrieves icon resources. More...
 

Static Public Member Functions

static bool ShowToolTips ()
 Should we show tooltips? More...
 

Public Attributes

wxStaticText * m_TooltipCtrl
 

Private Types

enum  { ID_CTOOLTIPWND = 10000 , ID_PANEL1 = 10002 }
 Control identifiers. More...
 

Private Attributes

wxString m_TooltipText
 
CTooltipm_Tooltip
 

Detailed Description

CTooltipWnd class declaration

Definition at line 75 of file tooltip_wnd.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private

Control identifiers.

Enumerator
ID_CTOOLTIPWND 
ID_PANEL1 

Definition at line 129 of file tooltip_wnd.hpp.

Constructor & Destructor Documentation

◆ CTooltipWnd() [1/2]

CTooltipWnd::CTooltipWnd ( )

Constructors.

CTooltipWnd type definition

CTooltipWnd event table definition

CTooltipWnd constructors

Definition at line 69 of file tooltip_wnd.cpp.

References Init().

◆ CTooltipWnd() [2/2]

CTooltipWnd::CTooltipWnd ( CTooltip tooltip)

Definition at line 74 of file tooltip_wnd.cpp.

References Init().

◆ ~CTooltipWnd()

CTooltipWnd::~CTooltipWnd ( )

Destructor.

CTooltipWnd destructor

Definition at line 107 of file tooltip_wnd.cpp.

Member Function Documentation

◆ Create()

bool CTooltipWnd::Create ( wxWindow *  parent,
wxWindowID  id = ID_CTOOLTIPWND,
const wxString &  title = wxEmptyString,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(0, 0),
long  style = wxFRAME_TOOL_WINDOW|wxFRAME_FLOAT_ON_PARENT|wxFRAME_NO_TASKBAR 
)

Creation.

CTooltipWnd creator

Definition at line 83 of file tooltip_wnd.cpp.

References CreateControls(), and ncbi::grid::netcache::search::fields::size.

Referenced by CTooltip::On().

◆ CreateControls()

void CTooltipWnd::CreateControls ( )

Creates the controls and sizers.

Control creation for CTooltipWnd

Definition at line 130 of file tooltip_wnd.cpp.

References ID_PANEL1, m_TooltipCtrl, and m_TooltipText.

Referenced by Create().

◆ GetBitmapResource()

wxBitmap CTooltipWnd::GetBitmapResource ( const wxString &  name)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 166 of file tooltip_wnd.cpp.

◆ GetIconResource()

wxIcon CTooltipWnd::GetIconResource ( const wxString &  name)

Retrieves icon resources.

Get icon resources

Definition at line 179 of file tooltip_wnd.cpp.

◆ GetTooltipText()

wxString CTooltipWnd::GetTooltipText ( ) const
inline

Definition at line 111 of file tooltip_wnd.hpp.

References m_TooltipText.

◆ Init()

void CTooltipWnd::Init ( void  )

Initialises member variables.

Member initialisation

Definition at line 118 of file tooltip_wnd.cpp.

References m_TooltipCtrl, and NULL.

Referenced by CTooltipWnd().

◆ OnMouse()

void CTooltipWnd::OnMouse ( wxMouseEvent &  event)

All mouse events event handler for ID_CTOOLTIPWND.

All mouse events event handler for ID_CTOOLTIPWND

Definition at line 193 of file tooltip_wnd.cpp.

References CTooltip::Hide(), and m_Tooltip.

◆ SetTooltipText()

void CTooltipWnd::SetTooltipText ( wxString  value)
inline

Definition at line 112 of file tooltip_wnd.hpp.

References m_TooltipText, and rapidjson::value.

Referenced by CTooltip::On().

◆ ShowToolTips()

bool CTooltipWnd::ShowToolTips ( )
static

Should we show tooltips?

Should we show tooltips?

Definition at line 157 of file tooltip_wnd.cpp.

Member Data Documentation

◆ m_Tooltip

CTooltip* CTooltipWnd::m_Tooltip
private

Definition at line 135 of file tooltip_wnd.hpp.

Referenced by OnMouse().

◆ m_TooltipCtrl

wxStaticText* CTooltipWnd::m_TooltipCtrl

Definition at line 125 of file tooltip_wnd.hpp.

Referenced by CreateControls(), and Init().

◆ m_TooltipText

wxString CTooltipWnd::m_TooltipText
private

Definition at line 127 of file tooltip_wnd.hpp.

Referenced by CreateControls(), GetTooltipText(), and SetTooltipText().


The documentation for this class was generated from the following files:
Modified on Fri Jun 14 16:48:59 2024 by modify_doxy.py rev. 669887