filechooserbutton: Give proper names to the SELECT_FOLDER tests with cancelled dialog

[~andy/gtk] / gtk / gtkmenu.h

diff --git a/gtk/gtkmenu.h b/gtk/gtkmenu.h
index 1c00338334466a866f6d9a9ac9fba6f62fd2a2fa..d6843eba21595de962d28528a1bc236f5c0f3e81 100644 (file)
--- a/gtk/gtkmenu.h
+++ b/gtk/gtkmenu.h
@@ -12,9 +12,7 @@
  * Lesser General Public License for more details.
  *
  * 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.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
@@ -24,14 +22,14 @@
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
-#error "Only <gtk/gtk.h> can be included directly."
-#endif
-
 #ifndef __GTK_MENU_H__
 #define __GTK_MENU_H__
 
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #include <gtk/gtkaccelgroup.h>
 #include <gtk/gtkmenushell.h>
 
@@ -50,11 +48,48 @@ typedef struct _GtkMenu        GtkMenu;
 typedef struct _GtkMenuClass   GtkMenuClass;
 typedef struct _GtkMenuPrivate GtkMenuPrivate;
 
+/**
+ * GtkMenuPositionFunc:
+ * @menu: a #GtkMenu.
+ * @x: (out): address of the #gint representing the horizontal
+ *     position where the menu shall be drawn.
+ * @y: (out): address of the #gint representing the vertical position
+ *     where the menu shall be drawn.  This is an output parameter.
+ * @push_in: (out): This parameter controls how menus placed outside
+ *     the monitor are handled.  If this is set to %TRUE and part of
+ *     the menu is outside the monitor then GTK+ pushes the window
+ *     into the visible area, effectively modifying the popup
+ *     position.  Note that moving and possibly resizing the menu
+ *     around will alter the scroll position to keep the menu items
+ *     "in place", i.e. at the same monitor position they would have
+ *     been without resizing.  In practice, this behavior is only
+ *     useful for combobox popups or option menus and cannot be used
+ *     to simply confine a menu to monitor boundaries.  In that case,
+ *     changing the scroll offset is not desirable.
+ * @user_data: the data supplied by the user in the gtk_menu_popup()
+ *     @data parameter.
+ *
+ * A user function supplied when calling gtk_menu_popup() which
+ * controls the positioning of the menu when it is displayed.  The
+ * function sets the @x and @y parameters to the coordinates where the
+ * menu is to be drawn.  To make the menu appear on a different
+ * monitor than the mouse pointer, gtk_menu_set_monitor() must be
+ * called.
+ */
 typedef void (*GtkMenuPositionFunc) (GtkMenu   *menu,
                                     gint      *x,
                                     gint      *y,
                                     gboolean  *push_in,
                                     gpointer   user_data);
+
+/**
+ * GtkMenuDetachFunc:
+ * @attach_widget: the #GtkWidget that the menu is being detached from.
+ * @menu: the #GtkMenu being detached.
+ *
+ * A user function supplied when calling gtk_menu_attach_to_widget() which 
+ * will be called when the menu is later detached from the widget.
+ */
 typedef void (*GtkMenuDetachFunc)   (GtkWidget *attach_widget,
                                     GtkMenu   *menu);
 
@@ -80,6 +115,8 @@ struct _GtkMenuClass
 
 GType     gtk_menu_get_type              (void) G_GNUC_CONST;
 GtkWidget* gtk_menu_new                          (void);
+GDK_AVAILABLE_IN_3_4
+GtkWidget* gtk_menu_new_from_model        (GMenuModel *model);
 
 /* Display the menu onscreen */
 void      gtk_menu_popup                 (GtkMenu             *menu,
@@ -111,7 +148,7 @@ void           gtk_menu_popdown               (GtkMenu             *menu);
  */
 GtkWidget* gtk_menu_get_active           (GtkMenu             *menu);
 void      gtk_menu_set_active            (GtkMenu             *menu,
-                                          guint                index_);
+                                          guint                index);
 
 /* set/get the accelerator group that holds global accelerators (should
  * be added to the corresponding toplevel with gtk_window_add_accel_group().
@@ -145,9 +182,9 @@ gboolean   gtk_menu_get_tearoff_state     (GtkMenu             *menu);
 /* 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);
-G_CONST_RETURN gchar *gtk_menu_get_title  (GtkMenu             *menu);
+void          gtk_menu_set_title          (GtkMenu             *menu,
+                                           const gchar         *title);
+const gchar * gtk_menu_get_title          (GtkMenu             *menu);
 
 void       gtk_menu_reorder_child         (GtkMenu             *menu,
                                            GtkWidget           *child,