PrefsAction

From TrillWiki

This is sent to let the plugin know that the preferences window has closed and what action the user has taken.

Compatibility: 1.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_main("prefsAction", plugin_prefs_action_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

PrefsAction utilitizes the plugin_prefs_action_t structure.

struct plugin_prefs_action_t { 
 	unsigned int			struct_size; 
 
 	int 				type;  //0 = cancel, 1 = apply, 2 = ok 
 };

type

The type may equal either TRILLIAN_PREFS_CANCEL, TRILLIAN_PREFS_APPLY or TRILLIAN_PREFS_OK. For both cancel and ok, the dialog should be destroyed. For both apply and ok, the user's settings must be saved.

Return Value

Must return 0.

Remarks

Do not save settings when the user hits cancel unless it is impossible not to.