List tooltipRequest

From TrillWiki

The list_tooltipRequest notification is sent to a list callback when a tooltip is about to be shown. A list entry can then process this message to use the enhanced tooltips, or by pass it to use the normal tooltips.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

callback(int window_id, char *icontrol, "list_tooltipRequest", tooltip_request_t *data, void *userData);

Note that all Trillian functions and notifications begin with a lower-case letter, despite the Wiki requirement that all pages start with a capital letter.

Parameters

List tooltipRequest utilitizes the tooltip_request_t structure.

struct tooltip_request_t { 
 	unsigned int			struct_size; 
 
 	int				id; 
 
 	ttkCallback			callback; 
 	void				*data; 
 };

id

The tooltip id.

callback

The callback to send the tooltip_set notification to. If the plugin processes this entry, it must use this callback and the "tooltip_set" notification, with a tooltip_entry_t pointer.

data

The data to send along with the above callback in the user field.

Return Value

Return 1 if you process this message, return 0 to use the default tooltip.

Remarks

The icon must be added to the skin to be used. If you wish to just have it scale the existing icon, it will do that automatically if the icon is set to NULL.