InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
AbstractTip Class Referenceabstract

#include <AbstractTip.h>

Inheritance diagram for AbstractTip:
ITipIPMUnknownCusCondTxtIconTip

Public Member Functions

 AbstractTip (IPMUnknown *boss)
 
virtual PMString GetTipText (const PMPoint &mouseLocation)=0
 
virtual bool16 UpdateToolTipOnMouseMove ()
 
virtual void SetTipText (const PMString tipText)
 

Detailed Description

This class is a new base class used to implement ITip for essentially all widgets. It

See Also
ITip

Member Function Documentation

virtual PMString AbstractTip::GetTipText (const PMPoint & mouseLocation)
pure virtual

Tips are expected to return a PMString to use as their tip. To have no tip, return PMString(). You may also fill in the WindowPlacementAdvice, if you have a preference about where the tip window appears.

Parameters
mouseLocation
Returns
string to use as tip, or PMString() if no tip

Implements ITip.

Implemented in CusCondTxtIconTip.

virtual void AbstractTip::SetTipText (const PMString tipText)
inlinevirtual

***This API is currently not implemented in general case. Only implement in (IID_ITIP, kGeneratedGraphicTipImpl) for a specific case*** Set the tooltip text

Parameters
newTipText- string to use as tip

Implements ITip.