X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fmenu.h;h=7d719729bbbc88e0c1631317160b766c1d53a3d8;hb=HEAD;hp=1d20ff03360b519870c7afd1e28cab8826f44608;hpb=3c92311b3c88e7da28aabe59d26c10a18c096399;p=chaz%2Fopenbox diff --git a/openbox/menu.h b/openbox/menu.h index 1d20ff03..7d719729 100644 --- a/openbox/menu.h +++ b/openbox/menu.h @@ -1,193 +1,232 @@ +/* -*- 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 struct _ObClient; +struct _ObMenuFrame; +struct _ObMenuEntryFrame; typedef struct _ObMenu ObMenu; typedef struct _ObMenuEntry ObMenuEntry; - -typedef void(*menu_controller_show)(ObMenu *self, int x, int y, - struct _ObClient *); -typedef void(*menu_controller_update)(ObMenu *self); -typedef void(*menu_controller_mouseover)(ObMenuEntry *self, gboolean enter); -typedef void(*menu_controller_selected)(ObMenuEntry *entry, - unsigned int button, - unsigned int x, unsigned int y); -typedef void(*menu_controller_hide)(ObMenu *self); - - -extern GHashTable *menu_hash; -extern GList *menu_visible; +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 (*ObMenuCleanupFunc)(struct _ObMenu *menu, 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 { - ObWindow obwin; - - /* The title displayed above the menu. - NULL for no titlebar */ - gchar *label; - - /* Name of the menu. - Used in the action showmenu */ + /* Name of the menu. Used in the showmenu action. */ gchar *name; + /* Displayed title */ + gchar *title; + gchar *collate_key; + /*! 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; - /* If the menu is currently displayed */ - gboolean shown; + /* plugin data */ + gpointer data; - /* If the rendering of the menu has changed and needs to be rerendered. */ - gboolean invalid; + ObMenuShowFunc show_func; + ObMenuHideFunc hide_func; + ObMenuUpdateFunc update_func; + ObMenuExecuteFunc execute_func; + ObMenuCleanupFunc cleanup_func; + ObMenuDestroyFunc destroy_func; + ObMenuPlaceFunc place_func; - /* Kind of lame.Each menu can only be a submenu, and each menu can only - have one submenu open */ - ObMenu *parent; - ObMenu *open_submenu; - GList *over; - - /* behaviour callbacks - TODO: Document and split code that HAS to be in the overridden callback */ - /* place a menu on screen */ - menu_controller_show show; - /* Hide the menu */ - menu_controller_hide hide; - /* render a menu */ - menu_controller_update update; - /* Event for a mouse enter/exit on an entry - TODO: May have to split from simple render updating? - */ - menu_controller_mouseover mouseover; - /* Entry is clicked/hit enter on */ - menu_controller_selected selected; - - - /* render stuff */ - struct _ObClient *client; - Window frame; - Window title; - RrAppearance *a_title; - gint title_min_w, title_h; - Window items; - RrAppearance *a_items; - gint bullet_w; - gint item_h; - Point location; - Size size; - guint xin_area; /* index of the xinerama head/area */ - - /* Name of plugin for menu */ - char *plugin; - /* plugin's data */ - void *plugin_data; + /* 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_RENDER_TYPE_NONE, - OB_MENU_ENTRY_RENDER_TYPE_SUBMENU, - OB_MENU_ENTRY_RENDER_TYPE_BOOLEAN, - OB_MENU_ENTRY_RENDER_TYPE_SEPARATOR, - OB_MENU_ENTRY_RENDER_TYPE_OTHER /* XXX what is this? */ -} ObMenuEntryRenderType; + OB_MENU_ENTRY_TYPE_NORMAL, + OB_MENU_ENTRY_TYPE_SUBMENU, + OB_MENU_ENTRY_TYPE_SEPARATOR +} ObMenuEntryType; -struct _ObMenuEntry -{ - char *label; - ObMenu *parent; +struct _ObNormalMenuEntry { + /* Icon stuff. If you set this, make sure you RrImageRef() it too. */ + RrImage *icon; + gint icon_alpha; - Action *action; - - ObMenuEntryRenderType render_type; - gboolean hilite; + gchar *label; + gchar *collate_key; + /*! 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; - gboolean boolean_value; - - ObMenu *submenu; - - /* render stuff */ - Window item; - RrAppearance *a_item; - RrAppearance *a_disabled; - RrAppearance *a_hilite; - gint y; - gint min_w; -} MenuEntry; - -typedef struct PluginMenuCreateData{ - xmlDocPtr doc; - xmlNodePtr node; - ObMenu *parent; -} PluginMenuCreateData; + /* List of ObActions */ + GSList *actions; -void menu_startup(); -void menu_shutdown(); + /* Mask icon */ + RrPixmapMask *mask; + RrColor *mask_normal_color; + RrColor *mask_selected_color; + RrColor *mask_disabled_color; + RrColor *mask_disabled_selected_color; -void menu_noop(); - -#define menu_new(l, n, p) \ - menu_new_full(l, n, p, menu_show_full, menu_render, menu_entry_fire, \ - menu_hide, menu_control_mouseover) - -ObMenu *menu_new_full(char *label, char *name, ObMenu *parent, - menu_controller_show show, menu_controller_update update, - menu_controller_selected selected, - menu_controller_hide hide, - menu_controller_mouseover mouseover); - -void menu_free(char *name); - -void menu_show(char *name, int x, int y, struct _ObClient *client); -void menu_show_full(ObMenu *menu, int x, int y, struct _ObClient *client); - -void menu_hide(ObMenu *self); - -void menu_clear(ObMenu *self); - -ObMenuEntry *menu_entry_new_full(char *label, Action *action, - ObMenuEntryRenderType render_type, - gpointer submenu); - -#define menu_entry_new(label, action) \ -menu_entry_new_full(label, action, OB_MENU_ENTRY_RENDER_TYPE_NONE, NULL) - -#define menu_entry_new_separator(label) \ -menu_entry_new_full(label, NULL, OB_MENU_ENTRY_RENDER_TYPE_SEPARATOR, NULL) - -#define menu_entry_new_submenu(label, submenu) \ -menu_entry_new_full(label, NULL, OB_MENU_ENTRY_RENDER_TYPE_SUBMENU, submenu) + gpointer data; +}; -#define menu_entry_new_boolean(label, action) \ -menu_entry_new_full(label, action, OB_MENU_ENTRY_RENDER_TYPE_BOOLEAN, NULL) +struct _ObSubmenuMenuEntry { + /* Icon stuff. If you set this, make sure you RrImageRef() it too. */ + RrImage *icon; + gint icon_alpha; -void menu_entry_free(ObMenuEntry *entry); + gchar *name; + ObMenu *submenu; + + guint show_from; +}; -void menu_entry_set_submenu(ObMenuEntry *entry, ObMenu *submenu); +struct _ObSeparatorMenuEntry { + gchar *label; +}; -void menu_add_entry(ObMenu *menu, ObMenuEntry *entry); +struct _ObMenuEntry +{ + guint ref; -ObMenuEntry *menu_find_entry(ObMenu *menu, Window win); -ObMenuEntry *menu_find_entry_by_submenu(ObMenu *menu, ObMenu *submenu); -ObMenuEntry *menu_find_entry_by_pos(ObMenu *menu, int x, int y); + ObMenuEntryType type; + ObMenu *menu; -void menu_entry_render(ObMenuEntry *self); + gint id; -void menu_entry_fire(ObMenuEntry *entry, - unsigned int button, unsigned int x, unsigned int y); + union u { + ObNormalMenuEntry normal; + ObSubmenuMenuEntry submenu; + ObSeparatorMenuEntry separator; + } data; +}; -void menu_render(ObMenu *self); -void menu_render_full(ObMenu *self); +void menu_startup(gboolean reconfig); +void menu_shutdown(gboolean reconfig); + +void menu_entry_ref(ObMenuEntry *self); +void menu_entry_unref(ObMenuEntry *self); + +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); + +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); + +/*! The show function is called right after a menu is shown */ +void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func); +/*! The hide function is called right before a menu is hidden */ +void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func); +/*! The update function is called when the menu should refresh its + contents, generally right before it is shown */ +void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func); +/*! The execute function is called when a user chooses to execute an + entry in the menu */ +void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func); +/*! The cleanup function is called after a menu is hidden, allowing it + to be cleaned up between uses */ +void menu_set_cleanup_func(ObMenu *menu, ObMenuCleanupFunc func); +/*! The destroy function is called when the menu is being destroyed + permanently */ +void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func); +/*! The place function is called when the menu is being shown and allows + the menu to choose its initial position */ +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); + +/*! This sorts groups of menu entries between consecutive separators */ +void menu_sort_entries(ObMenu *self); + +void menu_clear_entries(ObMenu *self); +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); -/*so plugins can call it? */ -void parse_menu_full(xmlDocPtr doc, xmlNodePtr node, void *data, gboolean new); -void menu_control_mouseover(ObMenuEntry *entry, gboolean enter); -void menu_control_keyboard_nav(unsigned int key); #endif