]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkmenu.h
Set this to `$(libexecdir)/pkgconfig'; this is the directory where
[~andy/gtk] / gtk / gtkmenu.h
index ac47f54bafb1af480bee21361d879e26f86cd9e8..741a37ea54753c77d35130bf55d773b252858606 100644 (file)
@@ -2,20 +2,28 @@
  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GTK+ Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
+ */
+
 #ifndef __GTK_MENU_H__
 #define __GTK_MENU_H__
 
@@ -27,7 +35,6 @@
 
 #ifdef __cplusplus
 extern "C" {
-#pragma }
 #endif /* __cplusplus */
 
 
@@ -36,6 +43,7 @@ extern "C" {
 #define GTK_MENU_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU, GtkMenuClass))
 #define GTK_IS_MENU(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_MENU))
 #define GTK_IS_MENU_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU))
+#define GTK_MENU_GET_CLASS(obj)         (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_MENU, GtkMenuClass))
 
 
 typedef struct _GtkMenu              GtkMenu;
@@ -58,6 +66,22 @@ struct _GtkMenu
   GtkAccelGroup *accel_group;
   GtkMenuPositionFunc position_func;
   gpointer position_func_data;
+
+  /* Do _not_ touch these widgets directly. We hide the reference
+   * count from the toplevel to the menu, so it must be restored
+   * before operating on these widgets
+   */
+  GtkWidget *toplevel;
+  GtkWidget *tearoff_window;
+
+  /* When a submenu of this menu is popped up, motion in this
+   * region is ignored
+   */
+  GdkRegion *navigation_region;
+  guint navigation_timeout;
+
+  guint needs_destruction_ref_count : 1;
+  guint torn_off : 1;
 };
 
 struct _GtkMenuClass
@@ -66,8 +90,10 @@ struct _GtkMenuClass
 };
 
 
-GtkType           gtk_menu_get_type              (void);
+GtkType           gtk_menu_get_type              (void) G_GNUC_CONST;
 GtkWidget* gtk_menu_new                          (void);
+
+/* Wrappers for the Menu Shell operations */
 void      gtk_menu_append                (GtkMenu             *menu,
                                           GtkWidget           *child);
 void      gtk_menu_prepend               (GtkMenu             *menu,
@@ -75,6 +101,8 @@ void    gtk_menu_prepend               (GtkMenu             *menu,
 void      gtk_menu_insert                (GtkMenu             *menu,
                                           GtkWidget           *child,
                                           gint                 position);
+
+/* Display the menu onscreen */
 void      gtk_menu_popup                 (GtkMenu             *menu,
                                           GtkWidget           *parent_menu_shell,
                                           GtkWidget           *parent_menu_item,
@@ -82,19 +110,62 @@ void          gtk_menu_popup                 (GtkMenu             *menu,
                                           gpointer             data,
                                           guint                button,
                                           guint32              activate_time);
+
+/* Position the menu according to its position function. Called
+ * from gtkmenuitem.c when a menu-item changes its allocation
+ */
 void      gtk_menu_reposition            (GtkMenu             *menu);
+
 void      gtk_menu_popdown               (GtkMenu             *menu);
+
+/* Keep track of the last menu item selected. (For the purposes
+ * of the option menu
+ */
 GtkWidget* gtk_menu_get_active           (GtkMenu             *menu);
 void      gtk_menu_set_active            (GtkMenu             *menu,
                                           guint                index);
-void      gtk_menu_set_accel_group       (GtkMenu             *menu,
+
+/* set/get the accelerator group that holds global accelerators (should
+ * be added to the corresponding toplevel with gtk_window_add_accel_group().
+ */
+void          gtk_menu_set_accel_group   (GtkMenu             *menu,
                                           GtkAccelGroup       *accel_group);
+GtkAccelGroup* gtk_menu_get_accel_group          (GtkMenu             *menu);
+
+/* get the accelerator group that is used internally by the menu for
+ * underline accelerators while the menu is popped up.
+ */
+GtkAccelGroup* gtk_menu_get_uline_accel_group    (GtkMenu         *menu);
+GtkAccelGroup* gtk_menu_ensure_uline_accel_group (GtkMenu         *menu);
+
+
+/* A reference count is kept for a widget when it is attached to
+ * a particular widget. This is typically a menu item; it may also
+ * be a widget with a popup menu - for instance, the Notebook widget.
+ */
 void      gtk_menu_attach_to_widget      (GtkMenu             *menu,
                                           GtkWidget           *attach_widget,
                                           GtkMenuDetachFunc    detacher);
-GtkWidget* gtk_menu_get_attach_widget    (GtkMenu             *menu);
 void      gtk_menu_detach                (GtkMenu             *menu);
 
+/* This should be dumped in favor of data set when the menu is popped
+ * up - that is currently in the ItemFactory code, but should be
+ * in the Menu code.
+ */
+GtkWidget* gtk_menu_get_attach_widget    (GtkMenu             *menu);
+
+void       gtk_menu_set_tearoff_state     (GtkMenu             *menu,
+                                          gboolean             torn_off);
+
+/* This sets the window manager title for the window that
+ * appears when a menu is torn off
+ */
+void       gtk_menu_set_title             (GtkMenu             *menu,
+                                          const gchar         *title);
+
+void       gtk_menu_reorder_child         (GtkMenu             *menu,
+                                           GtkWidget           *child,
+                                           gint                position);
 
 #ifdef __cplusplus
 }