gtkmenu.h 10.9 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * 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
Tim Janik's avatar
Tim Janik committed
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardon's avatar
Javier Jardon committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 24
 */

Elliot Lee's avatar
Elliot Lee committed
25 26 27
#ifndef __GTK_MENU_H__
#define __GTK_MENU_H__

28 29 30 31
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Tim Janik's avatar
Tim Janik committed
32
#include <gtk/gtkaccelgroup.h>
Elliot Lee's avatar
Elliot Lee committed
33 34
#include <gtk/gtkmenushell.h>

35
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
36

Tim Janik's avatar
Tim Janik committed
37
#define GTK_TYPE_MENU			(gtk_menu_get_type ())
Manish Singh's avatar
Manish Singh committed
38 39 40 41 42
#define GTK_MENU(obj)			(G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MENU, GtkMenu))
#define GTK_MENU_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU, GtkMenuClass))
#define GTK_IS_MENU(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MENU))
#define GTK_IS_MENU_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU))
#define GTK_MENU_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MENU, GtkMenuClass))
Elliot Lee's avatar
Elliot Lee committed
43 44


45 46 47
typedef struct _GtkMenu        GtkMenu;
typedef struct _GtkMenuClass   GtkMenuClass;
typedef struct _GtkMenuPrivate GtkMenuPrivate;
Elliot Lee's avatar
Elliot Lee committed
48

Matthias Clasen's avatar
Matthias Clasen committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
/**
 * GtkArrowPlacement:
 * @GTK_ARROWS_BOTH: Place one arrow on each end of the menu.
 * @GTK_ARROWS_START: Place both arrows at the top of the menu.
 * @GTK_ARROWS_END: Place both arrows at the bottom of the menu.
 *
 * Used to specify the placement of scroll arrows in scrolling menus.
 */
typedef enum
{
  GTK_ARROWS_BOTH,
  GTK_ARROWS_START,
  GTK_ARROWS_END
} GtkArrowPlacement;

64 65 66
/**
 * GtkMenuPositionFunc:
 * @menu: a #GtkMenu.
67
 * @x: (inout): address of the #gint representing the horizontal
68
 *     position where the menu shall be drawn.
69
 * @y: (inout): address of the #gint representing the vertical position
70
 *     where the menu shall be drawn.  This is an output parameter.
71
 * @push_in: (out): This parameter controls how menus placed outside
72 73 74 75 76
 *     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
77
 *     “in place”, i.e. at the same monitor position they would have
78 79 80 81 82 83 84 85 86 87 88 89 90 91
 *     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.
 */
92 93 94
typedef void (*GtkMenuPositionFunc) (GtkMenu   *menu,
				     gint      *x,
				     gint      *y,
95
				     gboolean  *push_in,
Tim Janik's avatar
Tim Janik committed
96
				     gpointer	user_data);
97 98 99 100 101 102 103 104 105

/**
 * 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.
 */
106 107
typedef void (*GtkMenuDetachFunc)   (GtkWidget *attach_widget,
				     GtkMenu   *menu);
Elliot Lee's avatar
Elliot Lee committed
108 109 110

struct _GtkMenu
{
111 112 113 114
  GtkMenuShell menu_shell;

  /*< private >*/
  GtkMenuPrivate *priv;
Elliot Lee's avatar
Elliot Lee committed
115 116 117 118 119
};

struct _GtkMenuClass
{
  GtkMenuShellClass parent_class;
120 121 122 123 124 125

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
126 127 128
};


129
GDK_AVAILABLE_IN_ALL
Manish Singh's avatar
Manish Singh committed
130
GType	   gtk_menu_get_type		  (void) G_GNUC_CONST;
131
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
132
GtkWidget* gtk_menu_new			  (void);
133
GDK_AVAILABLE_IN_3_4
134
GtkWidget* gtk_menu_new_from_model        (GMenuModel *model);
135 136

/* Display the menu onscreen */
137
GDK_DEPRECATED_IN_3_22_FOR((gtk_menu_popup_at_widget, gtk_menu_popup_at_pointer, gtk_menu_popup_at_rect))
Tim Janik's avatar
Tim Janik committed
138 139 140 141 142 143 144
void	   gtk_menu_popup		  (GtkMenu	       *menu,
					   GtkWidget	       *parent_menu_shell,
					   GtkWidget	       *parent_menu_item,
					   GtkMenuPositionFunc	func,
					   gpointer		data,
					   guint		button,
					   guint32		activate_time);
145
GDK_DEPRECATED_IN_3_22_FOR((gtk_menu_popup_at_widget, gtk_menu_popup_at_pointer, gtk_menu_popup_at_rect))
146 147 148 149 150 151
void       gtk_menu_popup_for_device      (GtkMenu             *menu,
                                           GdkDevice           *device,
                                           GtkWidget           *parent_menu_shell,
                                           GtkWidget           *parent_menu_item,
                                           GtkMenuPositionFunc  func,
                                           gpointer             data,
152
                                           GDestroyNotify       destroy,
153 154
                                           guint                button,
                                           guint32              activate_time);
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
GDK_AVAILABLE_IN_3_22
void       gtk_menu_popup_at_rect         (GtkMenu             *menu,
                                           GdkWindow           *rect_window,
                                           const GdkRectangle  *rect,
                                           GdkGravity           rect_anchor,
                                           GdkGravity           menu_anchor,
                                           const GdkEvent      *trigger_event);
GDK_AVAILABLE_IN_3_22
void       gtk_menu_popup_at_widget       (GtkMenu             *menu,
                                           GtkWidget           *widget,
                                           GdkGravity           widget_anchor,
                                           GdkGravity           menu_anchor,
                                           const GdkEvent      *trigger_event);
GDK_AVAILABLE_IN_3_22
void       gtk_menu_popup_at_pointer      (GtkMenu             *menu,
                                           const GdkEvent      *trigger_event);
171

172
/* Position the menu according to its position function. Called
173 174
 * from gtkmenuitem.c when a menu-item changes its allocation
 */
175
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
176
void	   gtk_menu_reposition		  (GtkMenu	       *menu);
177

178
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
179
void	   gtk_menu_popdown		  (GtkMenu	       *menu);
180 181 182 183

/* Keep track of the last menu item selected. (For the purposes
 * of the option menu
 */
184
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
185
GtkWidget* gtk_menu_get_active		  (GtkMenu	       *menu);
186
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
187
void	   gtk_menu_set_active		  (GtkMenu	       *menu,
188
					   guint		index);
189

190
/* set/get the accelerator group that holds global accelerators (should
191 192
 * be added to the corresponding toplevel with gtk_window_add_accel_group().
 */
193
GDK_AVAILABLE_IN_ALL
194
void	       gtk_menu_set_accel_group	  (GtkMenu	       *menu,
Tim Janik's avatar
Tim Janik committed
195
					   GtkAccelGroup       *accel_group);
196
GDK_AVAILABLE_IN_ALL
197
GtkAccelGroup* gtk_menu_get_accel_group	  (GtkMenu	       *menu);
198
GDK_AVAILABLE_IN_ALL
199 200
void           gtk_menu_set_accel_path    (GtkMenu             *menu,
					   const gchar         *accel_path);
201
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
202
const gchar*   gtk_menu_get_accel_path    (GtkMenu             *menu);
203 204 205 206 207

/* 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.
 */
208
GDK_AVAILABLE_IN_ALL
209 210 211
void	   gtk_menu_attach_to_widget	  (GtkMenu	       *menu,
					   GtkWidget	       *attach_widget,
					   GtkMenuDetachFunc	detacher);
212
GDK_AVAILABLE_IN_ALL
213 214 215 216 217 218
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.
 */
219
GDK_AVAILABLE_IN_ALL
220
GtkWidget* gtk_menu_get_attach_widget	  (GtkMenu	       *menu);
221

222
GDK_DEPRECATED_IN_3_10
223
void       gtk_menu_set_tearoff_state     (GtkMenu             *menu,
224 225
                                           gboolean             torn_off);
GDK_DEPRECATED_IN_3_10
226
gboolean   gtk_menu_get_tearoff_state     (GtkMenu             *menu);
227 228 229 230

/* This sets the window manager title for the window that
 * appears when a menu is torn off
 */
231
GDK_DEPRECATED_IN_3_10
232 233
void          gtk_menu_set_title          (GtkMenu             *menu,
                                           const gchar         *title);
234
GDK_DEPRECATED_IN_3_10
235
const gchar * gtk_menu_get_title          (GtkMenu             *menu);
Elliot Lee's avatar
Elliot Lee committed
236

237
GDK_AVAILABLE_IN_ALL
238 239 240 241
void       gtk_menu_reorder_child         (GtkMenu             *menu,
                                           GtkWidget           *child,
                                           gint                position);

242
GDK_AVAILABLE_IN_ALL
243 244
void	   gtk_menu_set_screen		  (GtkMenu	       *menu,
					   GdkScreen	       *screen);
245

246
GDK_AVAILABLE_IN_ALL
247 248 249 250 251 252 253
void       gtk_menu_attach                (GtkMenu             *menu,
                                           GtkWidget           *child,
                                           guint                left_attach,
                                           guint                right_attach,
                                           guint                top_attach,
                                           guint                bottom_attach);

254
GDK_AVAILABLE_IN_ALL
255 256
void       gtk_menu_set_monitor           (GtkMenu             *menu,
                                           gint                 monitor_num);
257
GDK_AVAILABLE_IN_ALL
Tim Janik's avatar
Tim Janik committed
258
gint       gtk_menu_get_monitor           (GtkMenu             *menu);
259 260 261 262 263

GDK_AVAILABLE_IN_3_22
void       gtk_menu_place_on_monitor      (GtkMenu             *menu,
                                           GdkMonitor          *monitor);

264
GDK_AVAILABLE_IN_ALL
265
GList*     gtk_menu_get_for_attach_widget (GtkWidget           *widget); 
266

267
GDK_AVAILABLE_IN_ALL
268 269
void     gtk_menu_set_reserve_toggle_size (GtkMenu  *menu,
                                          gboolean   reserve_toggle_size);
270
GDK_AVAILABLE_IN_ALL
271
gboolean gtk_menu_get_reserve_toggle_size (GtkMenu  *menu);
Matthias Clasen's avatar
Matthias Clasen committed
272

273
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkMenu, g_object_unref)
Matthias Clasen's avatar
Matthias Clasen committed
274

275
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
276 277

#endif /* __GTK_MENU_H__ */