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

#include <ITip.h>

Inheritance diagram for ITip:
IPMUnknownAbstractTipCusCondTxtIconTip

Public Member Functions

virtual PMString GetTipText (const PMPoint &mouseLocation)=0
 
virtual void SetTipText (const PMString tipText)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Defines the tip inteface

Member Function Documentation

virtual PMString ITip::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

Implemented in AbstractTip, and CusCondTxtIconTip.

virtual void ITip::SetTipText (const PMString tipText)
pure virtual

***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

Implemented in AbstractTip.