add cleanup function for menus that fires when the menu is no longer visible

1 files changed, 15 insertions, 0 deletions

diff --git a/openbox/menu.h b/openbox/menu.h
index 16cf4291..c0cc199d 100644
--- a/openbox/menu.h
+++ b/openbox/menu.h
@@ -43,6 +43,7 @@ typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
                                   struct _ObMenuFrame *frame,
                                   struct _ObClient *client,
                                   guint state, gpointer data);
+typedef void (*ObMenuCleanupFunc)(struct _ObMenu *menu, gpointer data);
 typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
 /*! @param x is the mouse x coordinate. on return it should be the x coordinate
              for the menu
@@ -83,6 +84,7 @@ struct _ObMenu
     ObMenuHideFunc hide_func;
     ObMenuUpdateFunc update_func;
     ObMenuExecuteFunc execute_func;
+    ObMenuCleanupFunc cleanup_func;
     ObMenuDestroyFunc destroy_func;
     ObMenuPlaceFunc place_func;
 
@@ -176,11 +178,24 @@ void menu_show(gchar *name, gint x, gint y, gboolean mouse,
                struct _ObClient *client);
 gboolean menu_hide_delay_reached(void);
 
+/*! The show function is called right after a menu is shown */
 void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
+/*! The hide function is called right before a menu is hidden */
 void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
+/*! The update function is called when the menu should refresh its
+  contents, generally right before it is shown */
 void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
+/*! The execute function is called when a user chooses to execute an
+  entry in the menu */
 void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
+/*! The cleanup function is called after a menu is hidden, allowing it
+  to be cleaned up between uses */
+void menu_set_cleanup_func(ObMenu *menu, ObMenuCleanupFunc func);
+/*! The destroy function is called when the menu is being destroyed
+  permanently */
 void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
+/*! The place function is called when the menu is being shown and allows
+  the menu to choose its initial position */
 void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
 
 /* functions for building menus */