openbox/menu.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    menu.h for the Openbox window manager
   4    Copyright (c) 2003-2007   Dana Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __menu_h
  20 #define __menu_h
  21
  22 #include "action.h"
  23 #include "window.h"
  24 #include "geom.h"
  25 #include "render/render.h"
  26 #include "parser/parse.h"
  27
  28 #include <glib.h>
  29
  30 struct _ObClient;
  31 struct _ObMenuFrame;
  32 struct _ObMenuEntryFrame;
  33
  34 typedef struct _ObMenu ObMenu;
  35 typedef struct _ObMenuEntry ObMenuEntry;
  36 typedef struct _ObNormalMenuEntry ObNormalMenuEntry;
  37 typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry;
  38 typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry;
  39
  40 typedef void (*ObMenuShowFunc)(struct _ObMenuFrame *frame, gpointer data);
  41 typedef void (*ObMenuHideFunc)(struct _ObMenuFrame *frame, gpointer data);
  42 typedef gboolean (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame,
  43                                      gpointer data);
  44 typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
  45                                   struct _ObMenuFrame *frame,
  46                                   struct _ObClient *client,
  47                                   guint state, gpointer data, Time time);
  48 typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
  49 /*! @param x is the mouse x coordinate. on return it should be the x coordinate
  50              for the menu
  51     @param y is the mouse y coordinate. on return it should be the y coordinate
  52              for the menu
  53 */
  54 typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
  55                                 gint button, gpointer data);
  56
  57 struct _ObMenu
  58 {
  59     /* Name of the menu. Used in the showmenu action. */
  60     gchar *name;
  61     /* Displayed title */
  62     gchar *title;
  63     /*! The shortcut key that would be used to activate this menu if it was
  64       displayed as a submenu */
  65     gunichar shortcut;
  66     /*! The shortcut's position in the string */
  67     guint shortcut_position;
  68     /*! If the shortcut was specified by & and should always be drawn */
  69     gboolean shortcut_always_show;
  70
  71     /*! If the shortcut key should be shown in menu entries even when it
  72       is the first character in the string */
  73     gboolean show_all_shortcuts;
  74
  75     /* Command to execute to rebuild the menu */
  76     gchar *execute;
  77
  78     /* ObMenuEntry list */
  79     GList *entries;
  80
  81     /* plugin data */
  82     gpointer data;
  83
  84     ObMenuShowFunc show_func;
  85     ObMenuHideFunc hide_func;
  86     ObMenuUpdateFunc update_func;
  87     ObMenuExecuteFunc execute_func;
  88     ObMenuDestroyFunc destroy_func;
  89     ObMenuPlaceFunc place_func;
  90
  91     /* Pipe-menu parent, we get destroyed when it is destroyed */
  92     ObMenu *pipe_creator;
  93
  94     /* The menu used as the destination for the "More..." entry for this menu*/
  95     ObMenu *more_menu;
  96 };
  97
  98 typedef enum
  99 {
 100     OB_MENU_ENTRY_TYPE_NORMAL,
 101     OB_MENU_ENTRY_TYPE_SUBMENU,
 102     OB_MENU_ENTRY_TYPE_SEPARATOR
 103 } ObMenuEntryType;
 104
 105 struct _ObNormalMenuEntry {
 106     gchar *label;
 107     /*! The shortcut key that would be used to activate this menu entry */
 108     gunichar shortcut;
 109     /*! The shortcut's position in the string */
 110     guint shortcut_position;
 111     /*! If the shortcut was specified by & and should always be drawn */
 112     gboolean shortcut_always_show;
 113
 114     /* state */
 115     gboolean enabled;
 116
 117     /* List of ObActions */
 118     GSList *actions;
 119
 120     /* Icon shit */
 121     gint icon_width;
 122     gint icon_height;
 123     gint icon_alpha;
 124     RrPixel32 *icon_data;
 125
 126     /* Mask icon */
 127     RrPixmapMask *mask;
 128     RrColor *mask_normal_color;
 129     RrColor *mask_selected_color;
 130     RrColor *mask_disabled_color;
 131     RrColor *mask_disabled_selected_color;
 132
 133     gpointer data;
 134 };
 135
 136 struct _ObSubmenuMenuEntry {
 137     gchar *name;
 138     ObMenu *submenu;
 139     guint show_from;
 140 };
 141
 142 struct _ObSeparatorMenuEntry {
 143     gchar *label;
 144 };
 145
 146 struct _ObMenuEntry
 147 {
 148     guint ref;
 149
 150     ObMenuEntryType type;
 151     ObMenu *menu;
 152
 153     gint id;
 154
 155     union u {
 156         ObNormalMenuEntry normal;
 157         ObSubmenuMenuEntry submenu;
 158         ObSeparatorMenuEntry separator;
 159     } data;
 160 };
 161
 162 void menu_startup(gboolean reconfig);
 163 void menu_shutdown(gboolean reconfig);
 164
 165 void menu_entry_ref(ObMenuEntry *self);
 166 void menu_entry_unref(ObMenuEntry *self);
 167
 168 /*! @param allow_shortcut this should be false when the label is coming from
 169            outside data like window or desktop titles */
 170 ObMenu* menu_new(const gchar *name, const gchar *title,
 171                  gboolean allow_shortcut_selection, gpointer data);
 172 void menu_free(ObMenu *menu);
 173
 174 /*! Repopulate a pipe-menu by running its command */
 175 void menu_pipe_execute(ObMenu *self);
 176 /*! Clear a pipe-menu's entries */
 177 void menu_clear_pipe_caches();
 178
 179 void menu_show_all_shortcuts(ObMenu *self, gboolean show);
 180
 181 void menu_show(gchar *name, gint x, gint y, gint button,
 182                struct _ObClient *client);
 183 gboolean menu_hide_delay_reached();
 184
 185 void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
 186 void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
 187 void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
 188 void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
 189 void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
 190 void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
 191
 192 /* functions for building menus */
 193 /*! @param allow_shortcut this should be false when the label is coming from
 194            outside data like window or desktop titles */
 195 ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
 196                              GSList *actions, gboolean allow_shortcut);
 197 ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
 198 ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
 199
 200 void menu_clear_entries(ObMenu *menu);
 201 void menu_entry_remove(ObMenuEntry *self);
 202
 203 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
 204                           gboolean allow_shortcut);
 205
 206 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
 207
 208 /* fills in the submenus, for use when a menu is being shown */
 209 void menu_find_submenus(ObMenu *self);
 210
 211 ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from);
 212
 213 #endif