X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fmenu.h;h=6288d870e9cd22ea66cf9725b5989e6f221e5223;hb=6a79805b7c4116ee6ced87e78fb488f3274098ef;hp=74519343abb9ad1f8826768330c66fe34e725090;hpb=9e85e930da614ebef4e714ec890644d6e7241871;p=chaz%2Fopenbox diff --git a/openbox/menu.h b/openbox/menu.h index 74519343..6288d870 100644 --- a/openbox/menu.h +++ b/openbox/menu.h @@ -1,3 +1,21 @@ +/* -*- 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 @@ -19,11 +37,22 @@ typedef struct _ObNormalMenuEntry ObNormalMenuEntry; typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry; typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry; -typedef void (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame, gpointer data); -typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry, gpointer data); +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); - -extern ObParseInst *menu_parse_inst; +/*! @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, + gint button, gpointer data); struct _ObMenu { @@ -31,6 +60,18 @@ struct _ObMenu 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; @@ -38,9 +79,18 @@ struct _ObMenu /* 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 @@ -52,6 +102,10 @@ typedef enum 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; @@ -62,20 +116,31 @@ struct _ObNormalMenuEntry { /* 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; }; struct _ObSubmenuMenuEntry { gchar *name; ObMenu *submenu; + guint show_from; }; struct _ObSeparatorMenuEntry { - gchar foo; /* placeholder */ + gchar *label; }; struct _ObMenuEntry { + guint ref; + ObMenuEntryType type; ObMenu *menu; @@ -88,30 +153,55 @@ struct _ObMenuEntry } data; }; -void menu_startup(); -void menu_shutdown(); +void menu_startup(gboolean reconfig); +void menu_shutdown(gboolean reconfig); -void menu_parse(); +void menu_entry_ref(ObMenuEntry *self); +void menu_entry_unref(ObMenuEntry *self); -gboolean menu_new(gchar *name, gchar *title, gpointer data); -void menu_free(gchar *name); +/*! @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); -gboolean menu_open_plugin(ObParseInst *i, gchar *name, gchar *plugin); +/*! 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_set_update_func(gchar *name, ObMenuUpdateFunc func); -void menu_set_execute_func(gchar *name, ObMenuExecuteFunc func); -void menu_set_destroy_func(gchar *name, ObMenuDestroyFunc func); +void menu_show_all_shortcuts(ObMenu *self, gboolean show); -void menu_show(gchar *name, gint x, gint y, struct _ObClient *client); +void menu_show(gchar *name, gint x, gint y, gint button, + 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 */ -void menu_clear_entries(gchar *name); -void menu_add_normal(gchar *name, gint id, gchar *label, GSList *actions); -void menu_add_submenu(gchar *name, gint id, gchar *submenu); -void menu_add_separator(gchar *name, gint id); +/*! @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