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 gboolean (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame,
  41                                      gpointer data);
  42 typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
  43                                   guint state, gpointer data, Time time);
  44 typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
  45 /*! @param x is the mouse x coordinate. on return it should be the x coordinate
  46              for the menu
  47     @param y is the mouse y coordinate. on return it should be the y coordinate
  48              for the menu
  49 */
  50 typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
  51                                 gint button, gpointer data);
  52
  53 struct _ObMenu
  54 {
  55     /* Name of the menu. Used in the showmenu action. */
  56     gchar *name;
  57     /* Displayed title */
  58     gchar *title;
  59     /*! The shortcut key that would be used to activate this menu if it was
  60       displayed as a submenu */
  61     gunichar shortcut;
  62     /*! The shortcut's position in the string */
  63     guint shortcut_position;
  64
  65     /*! If the shortcut key should be shown in menu entries even when it
  66       is the first character in the string */
  67     gboolean show_all_shortcuts;
  68
  69     /* Command to execute to rebuild the menu */
  70     gchar *execute;
  71
  72     /* ObMenuEntry list */
  73     GList *entries;
  74
  75     /* plugin data */
  76     gpointer data;
  77
  78     ObMenuUpdateFunc update_func;
  79     ObMenuExecuteFunc execute_func;
  80     ObMenuDestroyFunc destroy_func;
  81     ObMenuPlaceFunc place_func;
  82
  83     /* Pipe-menu parent, we get destroyed when it is destroyed */
  84     ObMenu *pipe_creator;
  85 };
  86
  87 typedef enum
  88 {
  89     OB_MENU_ENTRY_TYPE_NORMAL,
  90     OB_MENU_ENTRY_TYPE_SUBMENU,
  91     OB_MENU_ENTRY_TYPE_SEPARATOR
  92 } ObMenuEntryType;
  93
  94 struct _ObNormalMenuEntry {
  95     gchar *label;
  96     /*! The shortcut key that would be used to activate this menu entry */
  97     gunichar shortcut;
  98     /*! The shortcut's position in the string */
  99     guint shortcut_position;
 100
 101     /* state */
 102     gboolean enabled;
 103
 104     /* List of ObActions */
 105     GSList *actions;
 106
 107     /* Icon shit */
 108     gint icon_width;
 109     gint icon_height;
 110     RrPixel32 *icon_data;
 111
 112     /* Mask icon */
 113     RrPixmapMask *mask;
 114     RrColor *mask_normal_color;
 115     RrColor *mask_selected_color;
 116     RrColor *mask_disabled_color;
 117     RrColor *mask_disabled_selected_color;
 118 };
 119
 120 struct _ObSubmenuMenuEntry {
 121     gchar *name;
 122     ObMenu *submenu;
 123 };
 124
 125 struct _ObSeparatorMenuEntry {
 126     gchar *label;
 127 };
 128
 129 struct _ObMenuEntry
 130 {
 131     ObMenuEntryType type;
 132     ObMenu *menu;
 133
 134     gint id;
 135
 136     union u {
 137         ObNormalMenuEntry normal;
 138         ObSubmenuMenuEntry submenu;
 139         ObSeparatorMenuEntry separator;
 140     } data;
 141 };
 142
 143 void menu_startup(gboolean reconfig);
 144 void menu_shutdown(gboolean reconfig);
 145
 146 /*! @param allow_shortcut this should be false when the label is coming from
 147            outside data like window or desktop titles */
 148 ObMenu* menu_new(const gchar *name, const gchar *title,
 149                  gboolean allow_shortcut, gpointer data);
 150 void menu_free(ObMenu *menu);
 151
 152 /* Repopulate a pipe-menu by running its command */
 153 void menu_pipe_execute(ObMenu *self);
 154
 155 void menu_show_all_shortcuts(ObMenu *self, gboolean show);
 156
 157 void menu_show(gchar *name, gint x, gint y, gint button,
 158                struct _ObClient *client);
 159
 160 void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
 161 void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
 162 void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
 163 void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
 164
 165 /* functions for building menus */
 166 /*! @param allow_shortcut this should be false when the label is coming from
 167            outside data like window or desktop titles */
 168 ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
 169                              GSList *actions, gboolean allow_shortcut);
 170 ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
 171 ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
 172
 173 void menu_clear_entries(ObMenu *menu);
 174 void menu_entry_remove(ObMenuEntry *self);
 175
 176 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
 177                           gboolean allow_shortcut);
 178
 179 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
 180
 181 /* fills in the submenus, for use when a menu is being shown */
 182 void menu_find_submenus(ObMenu *self);
 183
 184 #endif