Pileus Git - ~andy/gtk/blob - gtk/gtkmenu.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __GTK_MENU_H__
  28 #define __GTK_MENU_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkaccelgroup.h>
  33 #include <gtk/gtkmenushell.h>
  34
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif /* __cplusplus */
  39
  40
  41 #define GTK_TYPE_MENU                   (gtk_menu_get_type ())
  42 #define GTK_MENU(obj)                   (GTK_CHECK_CAST ((obj), GTK_TYPE_MENU, GtkMenu))
  43 #define GTK_MENU_CLASS(klass)           (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU, GtkMenuClass))
  44 #define GTK_IS_MENU(obj)                (GTK_CHECK_TYPE ((obj), GTK_TYPE_MENU))
  45 #define GTK_IS_MENU_CLASS(klass)        (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU))
  46 #define GTK_MENU_GET_CLASS(obj)         (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_MENU, GtkMenuClass))
  47
  48
  49 typedef struct _GtkMenu       GtkMenu;
  50 typedef struct _GtkMenuClass  GtkMenuClass;
  51
  52 typedef void (*GtkMenuPositionFunc) (GtkMenu   *menu,
  53                                      gint      *x,
  54                                      gint      *y,
  55                                      gpointer   user_data);
  56 typedef void (*GtkMenuDetachFunc)   (GtkWidget *attach_widget,
  57                                      GtkMenu   *menu);
  58
  59 struct _GtkMenu
  60 {
  61   GtkMenuShell menu_shell;
  62
  63   GtkWidget *parent_menu_item;
  64   GtkWidget *old_active_menu_item;
  65
  66   GtkAccelGroup *accel_group;
  67   GtkMenuPositionFunc position_func;
  68   gpointer position_func_data;
  69
  70   /* Do _not_ touch these widgets directly. We hide the reference
  71    * count from the toplevel to the menu, so it must be restored
  72    * before operating on these widgets
  73    */
  74   GtkWidget *toplevel;
  75   GtkWidget *tearoff_window;
  76
  77   /* When a submenu of this menu is popped up, motion in this
  78    * region is ignored
  79    */
  80   GdkRegion *navigation_region;
  81   guint navigation_timeout;
  82
  83   guint needs_destruction_ref_count : 1;
  84   guint torn_off : 1;
  85 };
  86
  87 struct _GtkMenuClass
  88 {
  89   GtkMenuShellClass parent_class;
  90 };
  91
  92
  93 GtkType    gtk_menu_get_type              (void) G_GNUC_CONST;
  94 GtkWidget* gtk_menu_new                   (void);
  95
  96 /* Wrappers for the Menu Shell operations */
  97 void       gtk_menu_append                (GtkMenu             *menu,
  98                                            GtkWidget           *child);
  99 void       gtk_menu_prepend               (GtkMenu             *menu,
 100                                            GtkWidget           *child);
 101 void       gtk_menu_insert                (GtkMenu             *menu,
 102                                            GtkWidget           *child,
 103                                            gint                 position);
 104
 105 /* Display the menu onscreen */
 106 void       gtk_menu_popup                 (GtkMenu             *menu,
 107                                            GtkWidget           *parent_menu_shell,
 108                                            GtkWidget           *parent_menu_item,
 109                                            GtkMenuPositionFunc  func,
 110                                            gpointer             data,
 111                                            guint                button,
 112                                            guint32              activate_time);
 113
 114 /* Position the menu according to its position function. Called
 115  * from gtkmenuitem.c when a menu-item changes its allocation
 116  */
 117 void       gtk_menu_reposition            (GtkMenu             *menu);
 118
 119 void       gtk_menu_popdown               (GtkMenu             *menu);
 120
 121 /* Keep track of the last menu item selected. (For the purposes
 122  * of the option menu
 123  */
 124 GtkWidget* gtk_menu_get_active            (GtkMenu             *menu);
 125 void       gtk_menu_set_active            (GtkMenu             *menu,
 126                                            guint                index);
 127
 128 /* set/get the accelerator group that holds global accelerators (should
 129  * be added to the corresponding toplevel with gtk_window_add_accel_group().
 130  */
 131 void           gtk_menu_set_accel_group   (GtkMenu             *menu,
 132                                            GtkAccelGroup       *accel_group);
 133 GtkAccelGroup* gtk_menu_get_accel_group   (GtkMenu             *menu);
 134
 135 /* get the accelerator group that is used internally by the menu for
 136  * underline accelerators while the menu is popped up.
 137  */
 138 GtkAccelGroup* gtk_menu_get_uline_accel_group    (GtkMenu         *menu);
 139 GtkAccelGroup* gtk_menu_ensure_uline_accel_group (GtkMenu         *menu);
 140
 141
 142 /* A reference count is kept for a widget when it is attached to
 143  * a particular widget. This is typically a menu item; it may also
 144  * be a widget with a popup menu - for instance, the Notebook widget.
 145  */
 146 void       gtk_menu_attach_to_widget      (GtkMenu             *menu,
 147                                            GtkWidget           *attach_widget,
 148                                            GtkMenuDetachFunc    detacher);
 149 void       gtk_menu_detach                (GtkMenu             *menu);
 150
 151 /* This should be dumped in favor of data set when the menu is popped
 152  * up - that is currently in the ItemFactory code, but should be
 153  * in the Menu code.
 154  */
 155 GtkWidget* gtk_menu_get_attach_widget     (GtkMenu             *menu);
 156
 157 void       gtk_menu_set_tearoff_state     (GtkMenu             *menu,
 158                                            gboolean             torn_off);
 159
 160 /* This sets the window manager title for the window that
 161  * appears when a menu is torn off
 162  */
 163 void       gtk_menu_set_title             (GtkMenu             *menu,
 164                                            const gchar         *title);
 165
 166 void       gtk_menu_reorder_child         (GtkMenu             *menu,
 167                                            GtkWidget           *child,
 168                                            gint                position);
 169
 170 #ifdef __cplusplus
 171 }
 172 #endif /* __cplusplus */
 173
 174
 175 #endif /* __GTK_MENU_H__ */