openbox/menuframe.h

   1 /* -*- indent-tabs-mode: t; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    menuframe.h for the Openbox window manager
   4    Copyright (c) 2003        Ben Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef ob__menuframe_h
  20 #define ob__menuframe_h
  21
  22 #include "geom.h"
  23 #include "window.h"
  24 #include "render/render.h"
  25
  26 #include <glib.h>
  27
  28 struct _ObClient;
  29 struct _ObMenu;
  30 struct _ObMenuEntry;
  31
  32 typedef struct _ObMenuFrame ObMenuFrame;
  33 typedef struct _ObMenuEntryFrame ObMenuEntryFrame;
  34
  35 extern GList *menu_frame_visible;
  36
  37 struct _ObMenuFrame
  38 {
  39     /* stuff to be an ObWindow */
  40     Window_InternalType type;
  41     Window window;
  42
  43     struct _ObMenu *menu;
  44
  45     /* The client that the visual instance of the menu is associated with for
  46        its actions */
  47     struct _ObClient *client;
  48
  49     ObMenuFrame *parent;
  50     ObMenuFrame *child;
  51
  52     GList *entries;
  53     ObMenuEntryFrame *selected;
  54
  55     /* If a titlebar is displayed for the menu or not (for top-level menus) */
  56     gboolean show_title;
  57
  58     /* On-screen area (including borders!) */
  59     Rect area;
  60     Strut item_margin;
  61     gint inner_w; /* inside the borders */
  62     gint title_h; /* includes the bwidth below it */
  63     gint item_h;  /* height of all normal items */
  64     gint text_x;  /* offset at which the text appears in the items */
  65     gint text_w;  /* width of the text area in the items */
  66
  67     Window title;
  68     Window items;
  69
  70     RrAppearance *a_title;
  71     RrAppearance *a_items;
  72 };
  73
  74 struct _ObMenuEntryFrame
  75 {
  76     struct _ObMenuEntry *entry;
  77     ObMenuFrame *frame;
  78
  79     Rect area;
  80
  81     Window window;
  82     Window icon;
  83     Window text;
  84     Window bullet;
  85
  86     RrAppearance *a_normal;
  87     RrAppearance *a_disabled;
  88     RrAppearance *a_selected;
  89
  90     RrAppearance *a_icon;
  91     RrAppearance *a_mask;
  92     RrAppearance *a_bullet_normal;
  93     RrAppearance *a_bullet_selected;
  94     RrAppearance *a_separator;
  95     RrAppearance *a_text_normal;
  96     RrAppearance *a_text_disabled;
  97     RrAppearance *a_text_selected;
  98 };
  99
 100 ObMenuFrame* menu_frame_new(struct _ObMenu *menu, struct _ObClient *client);
 101 void menu_frame_free(ObMenuFrame *self);
 102
 103 void menu_frame_move(ObMenuFrame *self, gint x, gint y);
 104 void menu_frame_move_on_screen(ObMenuFrame *self);
 105
 106 void menu_frame_show(ObMenuFrame *self, ObMenuFrame *parent);
 107 void menu_frame_hide(ObMenuFrame *self);
 108
 109 void menu_frame_hide_all();
 110 void menu_frame_hide_all_client(struct _ObClient *client);
 111
 112 void menu_frame_select(ObMenuFrame *self, ObMenuEntryFrame *entry);
 113 void menu_frame_select_previous(ObMenuFrame *self);
 114 void menu_frame_select_next(ObMenuFrame *self);
 115
 116 ObMenuFrame* menu_frame_under(gint x, gint y);
 117 ObMenuEntryFrame* menu_entry_frame_under(gint x, gint y);
 118
 119 void menu_entry_frame_show_submenu(ObMenuEntryFrame *self);
 120
 121 void menu_entry_frame_execute(ObMenuEntryFrame *self, guint state);
 122
 123 #endif