From 6545c3e08c08d62e923ce955cbdbeab611c75bbc Mon Sep 17 00:00:00 2001 From: David Anderson Date: Sun, 25 Nov 2007 18:50:13 +0000 Subject: [PATCH] small clarification to param2 in MenuAction_End --HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%401731 --- plugins/include/menus.inc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/plugins/include/menus.inc b/plugins/include/menus.inc index 7bac6f76..46537ab2 100644 --- a/plugins/include/menus.inc +++ b/plugins/include/menus.inc @@ -54,7 +54,10 @@ enum MenuAction MenuAction_Display = (1<<1), /**< A menu is about to be displayed (param1=client, param2=MenuPanel Handle) */ MenuAction_Select = (1<<2), /**< An item was selected (param1=client, param2=item) */ MenuAction_Cancel = (1<<3), /**< The menu was cancelled (param1=client, param2=reason) */ - MenuAction_End = (1<<4), /**< A menu display has fully ended (param1=reason, param2=cancel reason) */ + MenuAction_End = (1<<4), /**< A menu display has fully ended. + param1 is the MenuEnd reason, and if it's MenuEnd_Cancelled, then + param2 is the MenuCancel reason from MenuAction_Cancel. + */ MenuAction_VoteEnd = (1<<5), /**< (VOTE ONLY): A vote sequence has succeeded (param1=chosen item) This is not called if SetVoteResultCallback has been used on the menu. */ MenuAction_VoteStart = (1<<6), /**< (VOTE ONLY): A vote sequence has started (nothing passed) */