X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fmenu.h;h=16cf4291632bb220cb41686302d41728313bc2cb;hb=7aae8cc5262c1b36e3196845d62489b76af9063f;hp=66390e7565847db9000a455f2a11928603709f87;hpb=615cbd96075905d75533f9b615c4ee6a75f4f9a4;p=chaz%2Fopenbox

diff --git a/openbox/menu.h b/openbox/menu.h
index 66390e75..16cf4291 100644
--- a/openbox/menu.h
+++ b/openbox/menu.h
@@ -1,15 +1,33 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   menu.h for the Openbox window manager
+   Copyright (c) 2003-2007   Dana Jansens
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   See the COPYING file for a copy of the GNU General Public License.
+*/
+
 #ifndef __menu_h
 #define __menu_h
 
-#include "action.h"
 #include "window.h"
-#include "render/render.h"
 #include "geom.h"
+#include "obrender/render.h"
 
 #include <glib.h>
 
 struct _ObClient;
 struct _ObMenuFrame;
+struct _ObMenuEntryFrame;
 
 typedef struct _ObMenu ObMenu;
 typedef struct _ObMenuEntry ObMenuEntry;
@@ -17,9 +35,22 @@ typedef struct _ObNormalMenuEntry ObNormalMenuEntry;
 typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry;
 typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry;
 
-typedef void (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame, gpointer data);
-
-extern GList *menu_visible;
+typedef void (*ObMenuShowFunc)(struct _ObMenuFrame *frame, gpointer data);
+typedef void (*ObMenuHideFunc)(struct _ObMenuFrame *frame, gpointer data);
+typedef gboolean (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame,
+                                     gpointer data);
+typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
+                                  struct _ObMenuFrame *frame,
+                                  struct _ObClient *client,
+                                  guint state, 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
+    @param y is the mouse y coordinate. on return it should be the y coordinate
+             for the menu
+*/
+typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
+                                gboolean mouse, gpointer data);
 
 struct _ObMenu
 {
@@ -27,6 +58,20 @@ struct _ObMenu
     gchar *name;
     /* Displayed title */
     gchar *title;
+    /*! 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 */
+    gboolean show_all_shortcuts;
+
+    /* Command to execute to rebuild the menu */
+    gchar *execute;
 
     /* ObMenuEntry list */
     GList *entries;
@@ -34,7 +79,18 @@ struct _ObMenu
     /* plugin data */
     gpointer data;
 
+    ObMenuShowFunc show_func;
+    ObMenuHideFunc hide_func;
     ObMenuUpdateFunc update_func;
+    ObMenuExecuteFunc execute_func;
+    ObMenuDestroyFunc destroy_func;
+    ObMenuPlaceFunc place_func;
+
+    /* Pipe-menu parent, we get destroyed when it is destroyed */
+    ObMenu *pipe_creator;
+
+    /* The menu used as the destination for the "More..." entry for this menu*/
+    ObMenu *more_menu;
 };
 
 typedef enum
@@ -46,29 +102,52 @@ typedef enum
 
 struct _ObNormalMenuEntry {
     gchar *label;
+    /*! 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;
 
     /* List of ObActions */
     GSList *actions;
+
+    /* Icon stuff.  If you set this, make sure you RrImageRef() it too. */
+    RrImage *icon;
+    gint     icon_alpha;
+
+    /* 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 {
+    gchar *name;
     ObMenu *submenu;
+    guint show_from;
 };
 
 struct _ObSeparatorMenuEntry {
-    gchar foo; /* placeholder */
+    gchar *label;
 };
 
 struct _ObMenuEntry
 {
+    guint ref;
+
     ObMenuEntryType type;
     ObMenu *menu;
 
     gint id;
 
-    /* state */
-    gboolean enabled;
-
     union u {
         ObNormalMenuEntry normal;
         ObSubmenuMenuEntry submenu;
@@ -76,24 +155,53 @@ struct _ObMenuEntry
     } data;
 };
 
-void menu_startup();
-void menu_shutdown();
+void menu_startup(gboolean reconfig);
+void menu_shutdown(gboolean reconfig);
+
+void menu_entry_ref(ObMenuEntry *self);
+void menu_entry_unref(ObMenuEntry *self);
 
-void menu_parse();
+ObMenu* menu_new(const gchar *name, const gchar *title,
+                 gboolean allow_shortcut_selection, gpointer data);
+void menu_free(ObMenu *menu);
 
-gboolean menu_new(gchar *name, gchar *title, gpointer data);
-void menu_free(gchar *name);
+/*! 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_set_update_func(gchar *name, ObMenuUpdateFunc func);
+void menu_show_all_shortcuts(ObMenu *self, gboolean show);
 
-void menu_show(gchar *name, gint x, gint y, struct _ObClient *client);
+void menu_show(gchar *name, gint x, gint y, gboolean mouse,
+               struct _ObClient *client);
+gboolean menu_hide_delay_reached(void);
+
+void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
+void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
+void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
+void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
+void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
+void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
 
 /* functions for building menus */
-void menu_clear_entries(gchar *name);
-void menu_add_normal(gchar *name, gint id, gchar *label, GSList *actions);
-void menu_add_submenu(gchar *name, gint id, gchar *submenu);
-void menu_add_separator(gchar *name, gint id);
+/*! @param allow_shortcut this should be false when the label is coming from
+           outside data like window or desktop titles */
+ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
+                             GSList *actions, gboolean allow_shortcut);
+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);
+void menu_entry_remove(ObMenuEntry *self);
+
+void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
+                          gboolean allow_shortcut);
 
 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
 
+/* fills in the submenus, for use when a menu is being shown */
+void menu_find_submenus(ObMenu *self);
+
+ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from);
+
 #endif