openbox/menu.h

   1 #ifndef __menu_h
   2 #define __menu_h
   3
   4 #include "action.h"
   5 #include "window.h"
   6 #include "geom.h"
   7 #include "render/render.h"
   8 #include "parser/parse.h"
   9
  10 #include <glib.h>
  11
  12 struct _ObClient;
  13 struct _ObMenuFrame;
  14 struct _ObMenuEntryFrame;
  15
  16 typedef struct _ObMenu ObMenu;
  17 typedef struct _ObMenuEntry ObMenuEntry;
  18 typedef struct _ObNormalMenuEntry ObNormalMenuEntry;
  19 typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry;
  20 typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry;
  21
  22 typedef void (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame, gpointer data);
  23 typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry, gpointer data);
  24 typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
  25
  26 struct _ObMenu
  27 {
  28     /* Name of the menu. Used in the showmenu action. */
  29     gchar *name;
  30     /* Displayed title */
  31     gchar *title;
  32
  33     /* Command to execute to rebuild the menu */
  34     gchar *execute;
  35
  36     /* ObMenuEntry list */
  37     GList *entries;
  38
  39     /* plugin data */
  40     gpointer data;
  41
  42     ObMenuUpdateFunc update_func;
  43     ObMenuExecuteFunc execute_func;
  44     ObMenuDestroyFunc destroy_func;
  45 };
  46
  47 typedef enum
  48 {
  49     OB_MENU_ENTRY_TYPE_NORMAL,
  50     OB_MENU_ENTRY_TYPE_SUBMENU,
  51     OB_MENU_ENTRY_TYPE_SEPARATOR
  52 } ObMenuEntryType;
  53
  54 struct _ObNormalMenuEntry {
  55     gchar *label;
  56
  57     /* state */
  58     gboolean enabled;
  59
  60     /* List of ObActions */
  61     GSList *actions;
  62
  63     /* Icon shit */
  64     gint icon_width;
  65     gint icon_height;
  66     RrPixel32 *icon_data;
  67
  68     /* Mask icon */
  69     RrPixmapMask *mask;
  70     RrColor *mask_color;
  71 };
  72
  73 struct _ObSubmenuMenuEntry {
  74     gchar *name;
  75     ObMenu *submenu;
  76 };
  77
  78 struct _ObSeparatorMenuEntry {
  79     gchar foo; /* placeholder */
  80 };
  81
  82 struct _ObMenuEntry
  83 {
  84     ObMenuEntryType type;
  85     ObMenu *menu;
  86
  87     gint id;
  88
  89     union u {
  90         ObNormalMenuEntry normal;
  91         ObSubmenuMenuEntry submenu;
  92         ObSeparatorMenuEntry separator;
  93     } data;
  94 };
  95
  96 void menu_startup();
  97 void menu_shutdown();
  98
  99 ObMenu* menu_new(gchar *name, gchar *title, gpointer data);
 100 void menu_free(ObMenu *menu);
 101
 102 /* Repopulate a pipe-menu by running its command */
 103 void menu_pipe_execute(ObMenu *self);
 104
 105 void menu_show(gchar *name, gint x, gint y, struct _ObClient *client);
 106
 107 void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
 108 void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
 109 void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
 110
 111 /* functions for building menus */
 112 ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, gchar *label,
 113                              GSList *actions);
 114 ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, gchar *submenu);
 115 ObMenuEntry* menu_add_separator(ObMenu *menu, gint id);
 116
 117 void menu_clear_entries(ObMenu *menu);
 118 void menu_entry_remove(ObMenuEntry *self);
 119
 120 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
 121
 122 /* fills in the submenus, for use when a menu is being shown */
 123 void menu_find_submenus(ObMenu *self);
 124
 125 #endif