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 #include "obt/keyboard.h"
  27
  28 #include <glib.h>
  29
  30 struct _ObClient;
  31 struct _ObMenu;
  32 struct _ObMenuEntry;
  33
  34 typedef struct _ObMenuFrame ObMenuFrame;
  35 typedef struct _ObMenuEntryFrame ObMenuEntryFrame;
  36
  37 extern GList *menu_frame_visible;
  38
  39 struct _ObMenuFrame
  40 {
  41     /* stuff to be an ObWindow */
  42     ObWindow obwin;
  43     Window window;
  44
  45     struct _ObMenu *menu;
  46
  47     /* The client that the visual instance of the menu is associated with for
  48        its actions */
  49     struct _ObClient *client;
  50     gint ox, oy;
  51
  52     ObMenuFrame *parent;
  53     ObMenuEntryFrame *parent_entry;
  54     ObMenuFrame *child;
  55     ObMenuEntryFrame *child_entry;
  56
  57     GList *entries;
  58     ObMenuEntryFrame *selected;
  59
  60     /* show entries from the menu starting at this index */
  61     guint show_from;
  62
  63     /* If the submenus are being drawn to the right or the left */
  64     gboolean direction_right;
  65
  66     /* On-screen area (including borders!) */
  67     Rect area;
  68     Strut item_margin;
  69     gint inner_w; /* inside the borders */
  70     gint item_h;  /* height of all normal items */
  71     gint text_x;  /* offset at which the text appears in the items */
  72     gint text_w;  /* width of the text area in the items */
  73     gint text_h;  /* height of the items */
  74
  75     gint monitor; /* monitor on which to show the menu in xinerama */
  76
  77     /* We make a copy of this for each menu, so that we don't have to re-render
  78        the background of the entire menu each time we render an item inside it.
  79     */
  80     RrAppearance *a_items;
  81
  82     gboolean got_press; /* don't allow a KeyRelease event to run things in the
  83                            menu until it has seen a KeyPress.  this is to
  84                            avoid having the keybinding used to show the menu
  85                            end up running something inside the menu */
  86     guint press_keycode; /* the KeyCode that was used in the last KeyPress */
  87     gboolean press_doexec; /* if the upcoming KeyRelease should be used to
  88                               execute the menu item that was selected by the
  89                               KeyPress */
  90 };
  91
  92 struct _ObMenuEntryFrame
  93 {
  94     struct _ObMenuEntry *entry;
  95     ObMenuFrame *frame;
  96
  97     guint ignore_enters;
  98
  99     Rect area;
 100     gint border;
 101
 102     Window window;
 103     Window icon;
 104     Window text;
 105     Window bullet;
 106 };
 107
 108 extern GHashTable *menu_frame_map;
 109
 110 void menu_frame_startup(gboolean reconfig);
 111 void menu_frame_shutdown(gboolean reconfig);
 112
 113 ObMenuFrame* menu_frame_new(struct _ObMenu *menu,
 114                             guint show_from,
 115                             struct _ObClient *client);
 116 void menu_frame_free(ObMenuFrame *self);
 117
 118 ObtIC* menu_frame_ic(ObMenuFrame *self);
 119
 120 void menu_frame_move(ObMenuFrame *self, gint x, gint y);
 121 void menu_frame_move_on_screen(ObMenuFrame *self, gint x, gint y,
 122                                gint *dx, gint *dy);
 123
 124 gboolean menu_frame_show_topmenu(ObMenuFrame *self, GravityPoint pos,
 125                                  gint monitor, gboolean mouse);
 126 gboolean menu_frame_show_submenu(ObMenuFrame *self, ObMenuFrame *parent,
 127                                  ObMenuEntryFrame *parent_entry);
 128
 129 void menu_frame_hide_all(void);
 130 void menu_frame_hide_all_client(struct _ObClient *client);
 131
 132 void menu_frame_render(ObMenuFrame *self);
 133
 134 void menu_frame_select(ObMenuFrame *self, ObMenuEntryFrame *entry,
 135                        gboolean immediate);
 136 void menu_frame_select_previous(ObMenuFrame *self);
 137 void menu_frame_select_next(ObMenuFrame *self);
 138 void menu_frame_select_first(ObMenuFrame *self);
 139 void menu_frame_select_last(ObMenuFrame *self);
 140
 141 ObMenuFrame* menu_frame_under(gint x, gint y);
 142 ObMenuEntryFrame* menu_entry_frame_under(gint x, gint y);
 143
 144 void menu_entry_frame_show_submenu(ObMenuEntryFrame *self);
 145
 146 void menu_entry_frame_execute(ObMenuEntryFrame *self, guint state);
 147
 148 #endif