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 "render/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     Window_InternalType type;
  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
  54     GList *entries;
  55     ObMenuEntryFrame *selected;
  56
  57     /* If the submenus are being drawn to the right or the left */
  58     gboolean direction_right;
  59
  60     /* On-screen area (including borders!) */
  61     Rect area;
  62     Strut item_margin;
  63     gint inner_w; /* inside the borders */
  64     gint title_h;  /* height of all title items */
  65     gint item_h;  /* height of all normal items */
  66     gint text_x;  /* offset at which the text appears in the items */
  67     gint text_w;  /* width of the text area in the items */
  68
  69     gint monitor; /* monitor on which to show the menu in xinerama */
  70
  71     RrAppearance *a_title;
  72     RrAppearance *a_items;
  73 };
  74
  75 struct _ObMenuEntryFrame
  76 {
  77     struct _ObMenuEntry *entry;
  78     ObMenuFrame *frame;
  79
  80     guint ignore_enters;
  81
  82     Rect area;
  83
  84     Window window;
  85     Window icon;
  86     Window text;
  87     Window bullet;
  88
  89     RrAppearance *a_normal;
  90     RrAppearance *a_disabled;
  91     RrAppearance *a_selected;
  92
  93     RrAppearance *a_icon;
  94     RrAppearance *a_mask;
  95     RrAppearance *a_bullet_normal;
  96     RrAppearance *a_bullet_selected;
  97     RrAppearance *a_separator;
  98     RrAppearance *a_text_normal;
  99     RrAppearance *a_text_disabled;
 100     RrAppearance *a_text_selected;
 101 };
 102
 103 extern GHashTable *menu_frame_map;
 104
 105 void menu_frame_startup(gboolean reconfig);
 106 void menu_frame_shutdown(gboolean reconfig);
 107
 108 ObMenuFrame* menu_frame_new(struct _ObMenu *menu, struct _ObClient *client);
 109 void menu_frame_free(ObMenuFrame *self);
 110
 111 void menu_frame_move(ObMenuFrame *self, gint x, gint y);
 112 void menu_frame_move_on_screen(ObMenuFrame *self, gint *dx, gint *dy);
 113
 114 void menu_frame_place_topmenu(ObMenuFrame *self, gint x, gint y);
 115 void menu_frame_place_submenu(ObMenuFrame *self);
 116
 117 gboolean menu_frame_show_topmenu(ObMenuFrame *self, gint x, gint y);
 118 gboolean menu_frame_show_submenu(ObMenuFrame *self, ObMenuFrame *parent,
 119                                  ObMenuEntryFrame *parent_entry);
 120 void menu_frame_hide(ObMenuFrame *self);
 121
 122 void menu_frame_hide_all();
 123 void menu_frame_hide_all_client(struct _ObClient *client);
 124
 125 void menu_frame_select(ObMenuFrame *self, ObMenuEntryFrame *entry);
 126 void menu_frame_select_previous(ObMenuFrame *self);
 127 void menu_frame_select_next(ObMenuFrame *self);
 128
 129 ObMenuFrame* menu_frame_under(gint x, gint y);
 130 ObMenuEntryFrame* menu_entry_frame_under(gint x, gint y);
 131
 132 void menu_entry_frame_show_submenu(ObMenuEntryFrame *self);
 133
 134 void menu_entry_frame_execute(ObMenuEntryFrame *self, guint state, Time time);
 135
 136 #endif