add menu_sort_entries() which sorts all entries in an ObMenu

[dana/openbox.git] / openbox / menu.h

diff --git a/openbox/menu.h b/openbox/menu.h
index 6d4bbd4..7d71972 100644 (file)
--- a/openbox/menu.h
+++ b/openbox/menu.h
@@ -19,11 +19,9 @@
 #ifndef __menu_h
 #define __menu_h
 
-#include "action.h"
 #include "window.h"
 #include "geom.h"
-#include "render/render.h"
-#include "parser/parse.h"
+#include "obrender/render.h"
 
 #include <glib.h>
 
@@ -44,7 +42,8 @@ typedef gboolean (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame,
 typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
                                   struct _ObMenuFrame *frame,
                                   struct _ObClient *client,
-                                  guint state, gpointer data, Time time);
+                                  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
@@ -52,7 +51,7 @@ typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
              for the menu
 */
 typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
-                                gint button, gpointer data);
+                                gboolean mouse, gpointer data);
 
 struct _ObMenu
 {
@@ -60,11 +59,14 @@ struct _ObMenu
     gchar *name;
     /* Displayed title */
     gchar *title;
+    gchar *collate_key;
     /*! The shortcut key that would be used to activate this menu if it was
       displayed as a submenu */
     gunichar shortcut;
     /*! The shortcut's position in the string */
     guint shortcut_position;
+    /*! If the shortcut was specified by & and should always be drawn */
+    gboolean shortcut_always_show;
 
     /*! If the shortcut key should be shown in menu entries even when it
       is the first character in the string */
@@ -83,6 +85,7 @@ struct _ObMenu
     ObMenuHideFunc hide_func;
     ObMenuUpdateFunc update_func;
     ObMenuExecuteFunc execute_func;
+    ObMenuCleanupFunc cleanup_func;
     ObMenuDestroyFunc destroy_func;
     ObMenuPlaceFunc place_func;
 
@@ -101,11 +104,18 @@ typedef enum
 } ObMenuEntryType;
 
 struct _ObNormalMenuEntry {
+    /* Icon stuff.  If you set this, make sure you RrImageRef() it too. */
+    RrImage *icon;
+    gint     icon_alpha;
+
     gchar *label;
+    gchar *collate_key;
     /*! The shortcut key that would be used to activate this menu entry */
     gunichar shortcut;
     /*! The shortcut's position in the string */
     guint shortcut_position;
+    /*! If the shortcut was specified by & and should always be drawn */
+    gboolean shortcut_always_show;
 
     /* state */
     gboolean enabled;
@@ -113,23 +123,24 @@ struct _ObNormalMenuEntry {
     /* List of ObActions */
     GSList *actions;
 
-    /* Icon shit */
-    gint icon_width;
-    gint icon_height;
-    gint icon_alpha;
-    RrPixel32 *icon_data;
-
     /* Mask icon */
     RrPixmapMask *mask;
     RrColor *mask_normal_color;
     RrColor *mask_selected_color;
     RrColor *mask_disabled_color;
     RrColor *mask_disabled_selected_color;
+
+    gpointer data;
 };
 
 struct _ObSubmenuMenuEntry {
+    /* Icon stuff.  If you set this, make sure you RrImageRef() it too. */
+    RrImage *icon;
+    gint     icon_alpha;
+
     gchar *name;
     ObMenu *submenu;
+    
     guint show_from;
 };
 
@@ -159,25 +170,39 @@ void menu_shutdown(gboolean reconfig);
 void menu_entry_ref(ObMenuEntry *self);
 void menu_entry_unref(ObMenuEntry *self);
 
-/*! @param allow_shortcut this should be false when the label is coming from
-           outside data like window or desktop titles */
 ObMenu* menu_new(const gchar *name, const gchar *title,
                  gboolean allow_shortcut_selection, gpointer data);
 void menu_free(ObMenu *menu);
 
-/* Repopulate a pipe-menu by running its command */
+/*! Repopulate a pipe-menu by running its command */
 void menu_pipe_execute(ObMenu *self);
+/*! Clear a pipe-menu's entries */
+void menu_clear_pipe_caches(void);
 
 void menu_show_all_shortcuts(ObMenu *self, gboolean show);
 
-void menu_show(gchar *name, gint x, gint y, gint button,
+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 */
@@ -188,7 +213,10 @@ ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
 ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
 ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
 
-void menu_clear_entries(ObMenu *menu);
+/*! This sorts groups of menu entries between consecutive separators */
+void menu_sort_entries(ObMenu *self);
+
+void menu_clear_entries(ObMenu *self);
 void menu_entry_remove(ObMenuEntry *self);
 
 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,