openbox/menuframe.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    menuframe.h for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #ifndef ob__menuframe_h
  21 #define ob__menuframe_h
  22
  23 #include "geom.h"
  24 #include "window.h"
  25 #include "obrender/render.h"
  26
  27 #include <glib.h>
  28
  29 struct _ObClient;
  30 struct _ObMenu;
  31 struct _ObMenuEntry;
  32
  33 typedef struct _ObMenuFrame ObMenuFrame;
  34 typedef struct _ObMenuEntryFrame ObMenuEntryFrame;
  35
  36 extern GList *menu_frame_visible;
  37
  38 struct _ObMenuFrame
  39 {
  40     /* stuff to be an ObWindow */
  41     ObWindow obwin;
  42     Window window;
  43
  44     struct _ObMenu *menu;
  45
  46     /* The client that the visual instance of the menu is associated with for
  47        its actions */
  48     struct _ObClient *client;
  49
  50     ObMenuFrame *parent;
  51     ObMenuEntryFrame *parent_entry;
  52     ObMenuFrame *child;
  53     ObMenuEntryFrame *child_entry;
  54
  55     GList *entries;
  56     ObMenuEntryFrame *selected;
  57
  58     /* show entries from the menu starting at this index */
  59     guint show_from;
  60
  61     /* If the submenus are being drawn to the right or the left */
  62     gboolean direction_right;
  63
  64     /* On-screen area (including borders!) */
  65     Rect area;
  66     Strut item_margin;
  67     gint inner_w; /* inside the borders */
  68     gint item_h;  /* height of all normal items */
  69     gint text_x;  /* offset at which the text appears in the items */
  70     gint text_w;  /* width of the text area in the items */
  71     gint text_h;  /* height of the items */
  72
  73     gint monitor; /* monitor on which to show the menu in xinerama */
  74
  75     /* We make a copy of this for each menu, so that we don't have to re-render
  76        the background of the entire menu each time we render an item inside it.
  77     */
  78     RrAppearance *a_items;
  79
  80     gboolean got_press; /* don't allow a KeyRelease event to run things in the
  81                            menu until it has seen a KeyPress.  this is to
  82                            avoid having the keybinding used to show the menu
  83                            end up running something inside the menu */
  84     guint press_keycode; /* the KeyCode that was used in the last KeyPress */
  85     gboolean press_doexec; /* if the upcoming KeyRelease should be used to
  86                               execute the menu item that was selected by the
  87                               KeyPress */
  88 };
  89
  90 struct _ObMenuEntryFrame
  91 {
  92     struct _ObMenuEntry *entry;
  93     ObMenuFrame *frame;
  94
  95     guint ignore_enters;
  96
  97     Rect area;
  98     gint border;
  99
 100     Window window;
 101     Window icon;
 102     Window text;
 103     Window bullet;
 104 };
 105
 106 extern GHashTable *menu_frame_map;
 107
 108 void menu_frame_startup(gboolean reconfig);
 109 void menu_frame_shutdown(gboolean reconfig);
 110
 111 ObMenuFrame* menu_frame_new(struct _ObMenu *menu,
 112                             guint show_from,
 113                             struct _ObClient *client);
 114 void menu_frame_free(ObMenuFrame *self);
 115
 116 void menu_frame_move(ObMenuFrame *self, gint x, gint y);
 117 void menu_frame_move_on_screen(ObMenuFrame *self, gint x, gint y,
 118                                gint *dx, gint *dy);
 119
 120 gboolean menu_frame_show_topmenu(ObMenuFrame *self, gint x, gint y,
 121                                  gint button);
 122 gboolean menu_frame_show_submenu(ObMenuFrame *self, ObMenuFrame *parent,
 123                                  ObMenuEntryFrame *parent_entry);
 124
 125 void menu_frame_hide_all(void);
 126 void menu_frame_hide_all_client(struct _ObClient *client);
 127
 128 void menu_frame_render(ObMenuFrame *self);
 129
 130 void menu_frame_select(ObMenuFrame *self, ObMenuEntryFrame *entry,
 131                        gboolean immediate);
 132 void menu_frame_select_previous(ObMenuFrame *self);
 133 void menu_frame_select_next(ObMenuFrame *self);
 134 void menu_frame_select_first(ObMenuFrame *self);
 135 void menu_frame_select_last(ObMenuFrame *self);
 136
 137 ObMenuFrame* menu_frame_under(gint x, gint y);
 138 ObMenuEntryFrame* menu_entry_frame_under(gint x, gint y);
 139
 140 void menu_entry_frame_show_submenu(ObMenuEntryFrame *self);
 141
 142 void menu_entry_frame_execute(ObMenuEntryFrame *self, guint state);
 143
 144 #endif