LPFNART_GUI_TEXTREPLACEFUNC

This callback function gets called whenever a "tool tip" is about to be displayed over a button.

Declaration:

	Copy Code
typedef BOOL (FAR PASCAL* LPFNART_GUI_TEXTREPLACEFUNC)( LPVOID lpPrivate, DWORD dwTextID, const LPSTR lpszText, LPSTR FAR* lpszNewText );

Arguments:

Name	Type	Description
lpPrivate	LPVOID	A far pointer to private data being passed to the callback.
dwTextID	DWORD	The button ID.
lpszText	const LPSTR	The current text string for the tool tip.
lpszNewText	LPSTR FAR*	The replacement string for the tool tip.

Return Value:

Returns the number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

None

Remarks:

This callback function gives you a chance to replace the default text for the button's tool tip. Tool tips are the little text boxes that appear when you let the mouse pointer rest over an ART button. For example, if you are over the Filled Rectangle button, a small rectangle appears next to it saying "Filled Rectangle".

In order to use this callback, it must be registered with ART using the function ART_callback_register().