src/menu.h

   1 /*
   2  *  Window Maker window manager
   3  *
   4  *  Copyright (c) 1997-2003 Alfredo K. Kojima
   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  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19  *  USA.
  20  */
  21
  22 #ifndef WMMENU_H_
  23 #define WMMENU_H_
  24
  25 #include "wcore.h"
  26
  27 #define MI_DIAMOND      0
  28 #define MI_CHECK        1
  29 #define MI_MINIWINDOW   2
  30 #define MI_HIDDEN       3
  31 #define MI_SHADED       4
  32
  33 typedef struct WMenuEntry {
  34     int order;
  35     char *text;                        /* entry text */
  36     char *rtext;                       /* text to show in the right part */
  37     void (*callback)(struct WMenu *menu, struct WMenuEntry *entry);
  38     void (*free_cdata)(void *data);    /* proc to be used to free clientdata */
  39     void *clientdata;                  /* data to pass to callback */
  40     int cascade;                       /* cascade menu index */
  41 #ifdef USER_MENU
  42     WMPropList *instances;             /* allowed instances */
  43 #endif /* USER_MENU */
  44     struct {
  45         unsigned int enabled:1;        /* entry is selectable */
  46         unsigned int indicator:1;      /* left indicator */
  47         unsigned int indicator_on:1;
  48         unsigned int indicator_type:3;
  49         unsigned int editable:1;
  50     } flags;
  51 } WMenuEntry;
  52
  53
  54 typedef struct WMenu {
  55     struct WMenu *parent;
  56     struct WMenu *brother;
  57
  58     time_t timestamp;                  /* for the root menu. Last time
  59                                         * menu was reloaded */
  60
  61     /* decorations */
  62     struct WFrameWindow *frame;
  63     WCoreWindow *menu;                 /* the window menu */
  64     Pixmap menu_texture_data;
  65     int frame_x, frame_y;              /* position of the frame in root*/
  66
  67     WMenuEntry **entries;              /* array of entries. This is shared
  68                                         * by the menu and it's "brother" */
  69     short alloced_entries;             /* number of entries allocated in
  70                                         * entry array */
  71     struct WMenu **cascades;           /* array of cascades */
  72     short cascade_no;
  73
  74     short entry_no;                    /* number of entries */
  75     short selected_entry;
  76
  77     short entry_height;                /* height of each entry */
  78
  79     WMHandlerID timer;                 /* timer for the autoscroll */
  80
  81     void *jump_back;                   /* jump back data */
  82
  83     /* to be called when some entry is edited */
  84     void (*on_edit)(struct WMenu *menu, struct WMenuEntry *entry);
  85     /* to be called when destroyed */
  86     void (*on_destroy)(struct WMenu *menu);
  87
  88     struct {
  89         unsigned int titled:1;
  90         unsigned int realized:1;       /* whether the window was configured */
  91         unsigned int app_menu:1;       /* this is a application or root menu */
  92         unsigned int mapped:1;         /* if menu is already mapped on screen*/
  93         unsigned int buttoned:1;       /* if the close button is visible
  94                                         * (menu was torn off) */
  95         unsigned int open_to_left:1;   /* direction to open submenus */
  96         unsigned int lowered:1;
  97
  98         unsigned int brother:1;        /* if this is a copy of the menu*/
  99         unsigned int editing:1;
 100         unsigned int jump_back_pending:1;
 101
 102         unsigned int inside_handler:1;
 103     } flags;
 104 } WMenu;
 105
 106
 107 void wMenuPaint(WMenu *menu);
 108 void wMenuDestroy(WMenu *menu, int recurse);
 109 void wMenuRealize(WMenu *menu);
 110 WMenuEntry *wMenuInsertCascade(WMenu *menu, int index, char *text,
 111                                WMenu *cascade);
 112 WMenuEntry *wMenuInsertCallback(WMenu *menu, int index, char *text,
 113                                 void (*callback)(WMenu *menu, WMenuEntry *entry),
 114                                 void *clientdata);
 115
 116 void wMenuEntrySetCascade(WMenu *menu, WMenuEntry *entry, WMenu *cascade);
 117
 118 #define wMenuAddCallback(menu, text, callback, data) \
 119     wMenuInsertCallback(menu, -1, text, callback, data)
 120
 121 void wMenuRemoveItem(WMenu *menu, int index);
 122
 123 WMenu *wMenuCreate(WScreen *screen, char *title, int main_menu);
 124 WMenu *wMenuCreateForApp(WScreen *screen, char *title, int main_menu);
 125 void wMenuMap(WMenu *menu);
 126 void wMenuMapAt(WMenu *menu, int x, int y, int keyboard);
 127 #define wMenuMapCopyAt(menu, x, y) wMenuMapAt((menu)->brother, (x), (y), False)
 128 void wMenuUnmap(WMenu *menu);
 129 void wMenuSetEnabled(WMenu *menu, int index, int enable);
 130 void wMenuMove(WMenu *menu, int x, int y, int submenus);
 131 void wMenuEntryRemoveCascade(WMenu *menu, WMenuEntry *entry);
 132 void wMenuScroll(WMenu *menu, XEvent *event);
 133 WMenu *wMenuUnderPointer(WScreen *screen);
 134 void wMenuSaveState(WScreen *scr);
 135 void wMenuRestoreState(WScreen *scr);
 136
 137
 138 #endif