TTooltipText identifies a tool for which text is to be displayed. More...

#include <owl/commctrl.h>

Inheritance diagram for owl::TTooltipText:

Public Member Functions
	operator NMHDR & ()

void	SetText (LPCTSTR buff)
	Sets text of tooltip to specified buffer.

void	SetText (int resId, HINSTANCE hInstance)
	Sets the text of the tooltip.

void	CopyText (LPCTSTR buff)
	Sets the text of the tooltip.

void	CopyText (const tstring &s)

Detailed Description

TTooltipText identifies a tool for which text is to be displayed.

It is sent to the parent of the tooltip via a WM_NOTIFY/TTN_NEEDTEXT notification. It receives the text to be displayed.

Definition at line 153 of file commctrl.h.

Member Function Documentation

◆ CopyText() [1/2]

void owl::TTooltipText::CopyText ( const tstring & s )

inline

Definition at line 162 of file commctrl.h.

References CopyText().

◆ CopyText() [2/2]

void owl::TTooltipText::CopyText ( LPCTSTR text )

Sets the text of the tooltip.

The text is copied into the buffer owned by the 'TTooltipText'.

Note: The internal buffer can only handle 80 characters including the null-terminator. Longer strings will be truncated. Use SetText instead to avoid this.

Definition at line 320 of file tooltip.cpp.

References _T, _tcslen, COUNTOF, PRECONDITION, and WARNX.

◆ operator NMHDR &()

owl::TTooltipText::operator NMHDR & ( )

inline

Definition at line 155 of file commctrl.h.

◆ SetText() [1/2]

void owl::TTooltipText::SetText	(	int	resId,
		HINSTANCE	hInstance )

Sets the text of the tooltip.

The 'resId' identifies a string resource found in the module pointed to by the 'hInstance' parameter.

Definition at line 334 of file tooltip.cpp.

References CONST_CAST.

◆ SetText() [2/2]

void owl::TTooltipText::SetText ( LPCTSTR buff )

Sets text of tooltip to specified buffer.

NOTE: The buffer pointed to by the specified parameter must be valid for as long as the TTooltipText points to it. For temporary buffers, use the 'CopyText' method instead.

Definition at line 308 of file tooltip.cpp.

The documentation for this class was generated from the following files:

include/owl/commctrl.h
source/owlcore/tooltip.cpp