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 G_BEGIN_DECLS
  37
  38 #define GTK_TYPE_MENU                   (gtk_menu_get_type ())
  39 #define GTK_MENU(obj)                   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MENU, GtkMenu))
  40 #define GTK_MENU_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU, GtkMenuClass))
  41 #define GTK_IS_MENU(obj)                (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MENU))
  42 #define GTK_IS_MENU_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU))
  43 #define GTK_MENU_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MENU, GtkMenuClass))
  44
  45
  46 typedef struct _GtkMenu       GtkMenu;
  47 typedef struct _GtkMenuClass  GtkMenuClass;
  48
  49 typedef void (*GtkMenuPositionFunc) (GtkMenu   *menu,
  50                                      gint      *x,
  51                                      gint      *y,
  52                                      gboolean  *push_in,
  53                                      gpointer   user_data);
  54 typedef void (*GtkMenuDetachFunc)   (GtkWidget *attach_widget,
  55                                      GtkMenu   *menu);
  56
  57 struct _GtkMenu
  58 {
  59   GtkMenuShell menu_shell;
  60
  61   GtkWidget *parent_menu_item;
  62   GtkWidget *old_active_menu_item;
  63
  64   GtkAccelGroup *accel_group;
  65   gchar         *accel_path;
  66   GtkMenuPositionFunc position_func;
  67   gpointer position_func_data;
  68
  69   guint toggle_size;
  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
  76   GtkWidget *tearoff_window;
  77   GtkWidget *tearoff_hbox;
  78   GtkWidget *tearoff_scrollbar;
  79   GtkAdjustment *tearoff_adjustment;
  80
  81   GdkWindow *view_window;
  82   GdkWindow *bin_window;
  83
  84   gint scroll_offset;
  85   gint saved_scroll_offset;
  86   gint scroll_step;
  87   guint timeout_id;
  88
  89   /* When a submenu of this menu is popped up, motion in this
  90    * region is ignored
  91    */
  92   GdkRegion *navigation_region;
  93   guint navigation_timeout;
  94
  95   guint needs_destruction_ref_count : 1;
  96   guint torn_off : 1;
  97   /* The tearoff is active when it is torn off and the not-torn-off
  98    * menu is not popped up.
  99    */
 100   guint tearoff_active : 1;
 101
 102   guint scroll_fast : 1;
 103
 104   guint upper_arrow_visible : 1;
 105   guint lower_arrow_visible : 1;
 106   guint upper_arrow_prelight : 1;
 107   guint lower_arrow_prelight : 1;
 108 };
 109
 110 struct _GtkMenuClass
 111 {
 112   GtkMenuShellClass parent_class;
 113
 114   /* Padding for future expansion */
 115   void (*_gtk_reserved1) (void);
 116   void (*_gtk_reserved2) (void);
 117   void (*_gtk_reserved3) (void);
 118   void (*_gtk_reserved4) (void);
 119 };
 120
 121
 122 GType      gtk_menu_get_type              (void) G_GNUC_CONST;
 123 GtkWidget* gtk_menu_new                   (void);
 124
 125 /* Display the menu onscreen */
 126 void       gtk_menu_popup                 (GtkMenu             *menu,
 127                                            GtkWidget           *parent_menu_shell,
 128                                            GtkWidget           *parent_menu_item,
 129                                            GtkMenuPositionFunc  func,
 130                                            gpointer             data,
 131                                            guint                button,
 132                                            guint32              activate_time);
 133
 134 /* Position the menu according to its position function. Called
 135  * from gtkmenuitem.c when a menu-item changes its allocation
 136  */
 137 void       gtk_menu_reposition            (GtkMenu             *menu);
 138
 139 void       gtk_menu_popdown               (GtkMenu             *menu);
 140
 141 /* Keep track of the last menu item selected. (For the purposes
 142  * of the option menu
 143  */
 144 GtkWidget* gtk_menu_get_active            (GtkMenu             *menu);
 145 void       gtk_menu_set_active            (GtkMenu             *menu,
 146                                            guint                index_);
 147
 148 /* set/get the accelerator group that holds global accelerators (should
 149  * be added to the corresponding toplevel with gtk_window_add_accel_group().
 150  */
 151 void           gtk_menu_set_accel_group   (GtkMenu             *menu,
 152                                            GtkAccelGroup       *accel_group);
 153 GtkAccelGroup* gtk_menu_get_accel_group   (GtkMenu             *menu);
 154 void           gtk_menu_set_accel_path    (GtkMenu             *menu,
 155                                            const gchar         *accel_path);
 156
 157 /* A reference count is kept for a widget when it is attached to
 158  * a particular widget. This is typically a menu item; it may also
 159  * be a widget with a popup menu - for instance, the Notebook widget.
 160  */
 161 void       gtk_menu_attach_to_widget      (GtkMenu             *menu,
 162                                            GtkWidget           *attach_widget,
 163                                            GtkMenuDetachFunc    detacher);
 164 void       gtk_menu_detach                (GtkMenu             *menu);
 165
 166 /* This should be dumped in favor of data set when the menu is popped
 167  * up - that is currently in the ItemFactory code, but should be
 168  * in the Menu code.
 169  */
 170 GtkWidget* gtk_menu_get_attach_widget     (GtkMenu             *menu);
 171
 172 void       gtk_menu_set_tearoff_state     (GtkMenu             *menu,
 173                                            gboolean             torn_off);
 174 gboolean   gtk_menu_get_tearoff_state     (GtkMenu             *menu);
 175
 176 /* This sets the window manager title for the window that
 177  * appears when a menu is torn off
 178  */
 179 void       gtk_menu_set_title             (GtkMenu             *menu,
 180                                            const gchar         *title);
 181 G_CONST_RETURN gchar *gtk_menu_get_title  (GtkMenu             *menu);
 182
 183 void       gtk_menu_reorder_child         (GtkMenu             *menu,
 184                                            GtkWidget           *child,
 185                                            gint                position);
 186
 187 void       gtk_menu_set_screen            (GtkMenu             *menu,
 188                                            GdkScreen           *screen);
 189
 190 void       gtk_menu_attach                (GtkMenu             *menu,
 191                                            GtkWidget           *child,
 192                                            guint                left_attach,
 193                                            guint                right_attach,
 194                                            guint                top_attach,
 195                                            guint                bottom_attach);
 196
 197 void       gtk_menu_set_monitor           (GtkMenu             *menu,
 198                                            gint                 monitor_num);
 199 GList*     gtk_menu_get_for_attach_widget (GtkWidget           *widget);
 200
 201 #ifndef GTK_DISABLE_DEPRECATED
 202 #define gtk_menu_append(menu,child)     gtk_menu_shell_append  ((GtkMenuShell *)(menu),(child))
 203 #define gtk_menu_prepend(menu,child)    gtk_menu_shell_prepend ((GtkMenuShell *)(menu),(child))
 204 #define gtk_menu_insert(menu,child,pos) gtk_menu_shell_insert ((GtkMenuShell *)(menu),(child),(pos))
 205 #endif /* GTK_DISABLE_DEPRECATED */
 206
 207 G_END_DECLS
 208
 209 #endif /* __GTK_MENU_H__ */