openbox/menu.h (raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
/* -*- 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 "window.h" #include "geom.h" #include "render/render.h" #include "parser/parse.h" #include <glib.h> struct _ObClient; struct _ObMenuFrame; struct _ObMenuEntryFrame; typedef struct _ObMenu ObMenu; typedef struct _ObMenuEntry ObMenuEntry; typedef struct _ObNormalMenuEntry ObNormalMenuEntry; typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry; typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry; 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 { /* Name of the menu. Used in the showmenu action. */ 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; /* 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 { OB_MENU_ENTRY_TYPE_NORMAL, OB_MENU_ENTRY_TYPE_SUBMENU, OB_MENU_ENTRY_TYPE_SEPARATOR } ObMenuEntryType; 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 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 { gchar *name; ObMenu *submenu; guint show_from; }; struct _ObSeparatorMenuEntry { gchar *label; }; struct _ObMenuEntry { guint ref; ObMenuEntryType type; ObMenu *menu; gint id; union u { ObNormalMenuEntry normal; ObSubmenuMenuEntry submenu; ObSeparatorMenuEntry separator; } data; }; void menu_startup(gboolean reconfig); 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 */ void menu_pipe_execute(ObMenu *self); /*! Clear a pipe-menu's entries */ void menu_clear_pipe_caches(); void menu_show_all_shortcuts(ObMenu *self, gboolean show); void menu_show(gchar *name, gint x, gint y, gboolean mouse, struct _ObClient *client); gboolean menu_hide_delay_reached(); 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 */ /*! @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 |