ContactlistTooltipRegister

From TrillWiki

The contactlistTooltipRegister function allows a plugin to add items to the enhanced tooltip for a particular contact.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "contactlistTooltipRegister", struct contactlist_tooltip_register_t *);

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

ContactlistTooltipRegister utilitizes the contactlist_tooltip_register_t structure.

struct contactlist_tooltip_register_t 
 { 
 	unsigned int				struct_size; 
 
 	int					tooltip_id; 
 
 	struct contactlist_entry_t		*contact; 
 
 	ttkCallback				callback; 
 	void					*data; 
 };

contact

The contact to register the tooltip for. The section, medium, real_name (or uri) are required.

callback

The callback where the notifications are sent when the tooltip is needed by the client.

data

The user data sent along with the above callback.

Return Value

Negative value on error, tooltip id on success.

Remarks

Be sure to unregister the tooltip when the plugin is stopped. A contact_tooltipRequest will be sent to the user when a tooltip is needed. For more information about the notification, please see the Contact Notifications section of the docs.

See also: contact_tooltipRequest