X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fmenu.h;h=f0fc42baa49d6a18b1e6e61e8b10eaa7e1661ec6;hb=38268dc917ac9e59d9e8ef87825c9489ced77e95;hp=d1a99dcfde0eb8082935b3476ef33cf9d4eca1ef;hpb=22be74583bcf40fd5e762eb818676aa12f7152c4;p=chaz%2Fopenbox diff --git a/openbox/menu.h b/openbox/menu.h index d1a99dcf..f0fc42ba 100644 --- a/openbox/menu.h +++ b/openbox/menu.h @@ -1,61 +1,209 @@ +/* -*- 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 "geom.h" +#include "render/render.h" +#include "parser/parse.h" + #include -typedef struct Menu { - char *label; - +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, Time time); +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 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; - /* GList *tail; */ - - /* ? */ - gboolean shown; - gboolean invalid; - - struct Menu *parent; - - /* waste o' pointers */ - void (*show)( /* some bummu */); - void (*hide)( /* some bummu */); - void (*update)( /* some bummu */); - void (*mouseover)( /* some bummu */); - void (*selected)( /* some bummu */); -} Menu; - -typedef enum MenuEntryRenderType { - MenuEntryRenderType_None = 0, - MenuEntryRenderType_Submenu 1 << 0, - MenuEntryRenderType_Boolean 1 << 1, - MenuEntryRenderType_Separator 1 << 2, - - MenuEntryRenderType_Other 1 << 7 -} MenuEntryType; - - -typedef struct { - char *label; - Menu *parent; - - Action action; - - MenuEntryRenderType render_type; + + /* 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; + + /* state */ gboolean enabled; - gboolean boolean_value; - gpointer render_data; - Menu *submenu; -} MenuEntry; + /* 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); -Menu *menu_new(char *label, Menu *parent); -MenuEntry *menu_entry_new_full(char *label, Action *action, - MenuEntryRenderType render_type, - gpointer render_data, gpointer submenu); +ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id); -#define menu_entry_new(label, action) \ - menu_entry_new(label, action, MenuEntryRenderType_None, NULL, NULL) +/* fills in the submenus, for use when a menu is being shown */ +void menu_find_submenus(ObMenu *self); -void menu_entry_set_submenu(MenuEntry *entry, Menu *submenu); +ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from); -void menu_add_entry(Menu *menu, MenuEntry *entry); #endif