Contact tooltipRequest

From TrillWiki

The contact_tooltipRequest notification is sent to a contact callback when an enhanced tooltip is about to be displayed. A contact can use the enhanced tooltip or the text based tooltip (if its not processed) supplied when the contact is added or updated. This event is also sent to plugins who register to receive contact tooltip requests.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

callback(int window_id, char *icontrol, "contact_tooltipRequest", contactlist_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

Contact tooltipRequest utilitizes the contactlist_tooltip_request_t structure.

struct contactlist_tooltip_request_t
{
    unsigned int                struct_size;

    struct contactlist_entry_t  *contact;

    ttkCallback                 callback;
    void                        *data;
};

contact

The information regarding the contact that the tooltip is for. For more information about these fields, see one of the other contact notifications or functions.

callback

The callback to call the tooltip_set notification if the tooltip is processed. The "tooltip_set" is sent along with a tooltip_item_t* of the items to be added to the tooltip.

data

The user data to send along with the above callback and "tooltip_set" event.

Return Value

Must return 1 if the event is processed, 0 otherwise. A plugin who registers for the tooltip event (non medium) must always return 1.

Remarks

None.