gtkmenu.h 6.53 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * 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
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * 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/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31
#ifndef __GTK_MENU_H__
#define __GTK_MENU_H__


#include <gdk/gdk.h>
Tim Janik's avatar
Tim Janik committed
32
#include <gtk/gtkaccelgroup.h>
Elliot Lee's avatar
Elliot Lee committed
33 34 35 36 37 38 39
#include <gtk/gtkmenushell.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

Tim Janik's avatar
Tim Janik committed
40
#define GTK_TYPE_MENU			(gtk_menu_get_type ())
Manish Singh's avatar
Manish Singh committed
41 42 43 44 45
#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
46 47


Tim Janik's avatar
Tim Janik committed
48
typedef struct _GtkMenu	      GtkMenu;
Elliot Lee's avatar
Elliot Lee committed
49 50
typedef struct _GtkMenuClass  GtkMenuClass;

51 52 53
typedef void (*GtkMenuPositionFunc) (GtkMenu   *menu,
				     gint      *x,
				     gint      *y,
54
				     gboolean  *push_in,
Tim Janik's avatar
Tim Janik committed
55
				     gpointer	user_data);
56 57
typedef void (*GtkMenuDetachFunc)   (GtkWidget *attach_widget,
				     GtkMenu   *menu);
Elliot Lee's avatar
Elliot Lee committed
58 59 60 61

struct _GtkMenu
{
  GtkMenuShell menu_shell;
Tim Janik's avatar
Tim Janik committed
62
  
Elliot Lee's avatar
Elliot Lee committed
63 64
  GtkWidget *parent_menu_item;
  GtkWidget *old_active_menu_item;
65

Tim Janik's avatar
Tim Janik committed
66
  GtkAccelGroup *accel_group;
67
  gchar         *accel_path;
Elliot Lee's avatar
Elliot Lee committed
68 69
  GtkMenuPositionFunc position_func;
  gpointer position_func_data;
70

71
  guint toggle_size;
72 73 74 75
  /* 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
   */
76
  GtkWidget *toplevel;
77
  
78
  GtkWidget *tearoff_window;
79 80 81 82 83 84
  GtkWidget *tearoff_hbox;
  GtkWidget *tearoff_scrollbar;
  GtkAdjustment *tearoff_adjustment;

  GdkWindow *view_window;
  GdkWindow *bin_window;
85

86 87 88 89 90
  gint scroll_offset;
  gint saved_scroll_offset;
  gint scroll_step;
  guint timeout_id;
  
91 92 93 94 95 96
  /* When a submenu of this menu is popped up, motion in this
   * region is ignored
   */
  GdkRegion *navigation_region;
  guint navigation_timeout;

97
  guint needs_destruction_ref_count : 1;
98
  guint torn_off : 1;
99 100 101 102 103 104 105 106 107 108 109
  /* The tearoff is active when it is torn off and the not-torn-off
   * menu is not popped up.
   */
  guint tearoff_active : 1; 

  guint scroll_fast : 1;

  guint upper_arrow_visible : 1;
  guint lower_arrow_visible : 1;
  guint upper_arrow_prelight : 1;
  guint lower_arrow_prelight : 1;
Elliot Lee's avatar
Elliot Lee committed
110 111 112 113 114
};

struct _GtkMenuClass
{
  GtkMenuShellClass parent_class;
115 116 117 118 119 120

  /* 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
121 122 123
};


Manish Singh's avatar
Manish Singh committed
124
GType	   gtk_menu_get_type		  (void) G_GNUC_CONST;
Tim Janik's avatar
Tim Janik committed
125
GtkWidget* gtk_menu_new			  (void);
126 127

/* Display the menu onscreen */
Tim Janik's avatar
Tim Janik committed
128 129 130 131 132 133 134
void	   gtk_menu_popup		  (GtkMenu	       *menu,
					   GtkWidget	       *parent_menu_shell,
					   GtkWidget	       *parent_menu_item,
					   GtkMenuPositionFunc	func,
					   gpointer		data,
					   guint		button,
					   guint32		activate_time);
135

136
/* Position the menu according to its position function. Called
137 138
 * from gtkmenuitem.c when a menu-item changes its allocation
 */
Tim Janik's avatar
Tim Janik committed
139
void	   gtk_menu_reposition		  (GtkMenu	       *menu);
140

Tim Janik's avatar
Tim Janik committed
141
void	   gtk_menu_popdown		  (GtkMenu	       *menu);
142 143 144 145

/* Keep track of the last menu item selected. (For the purposes
 * of the option menu
 */
Tim Janik's avatar
Tim Janik committed
146 147
GtkWidget* gtk_menu_get_active		  (GtkMenu	       *menu);
void	   gtk_menu_set_active		  (GtkMenu	       *menu,
148
					   guint		index_);
149

150
/* set/get the accelerator group that holds global accelerators (should
151 152 153
 * be added to the corresponding toplevel with gtk_window_add_accel_group().
 */
void	       gtk_menu_set_accel_group	  (GtkMenu	       *menu,
Tim Janik's avatar
Tim Janik committed
154
					   GtkAccelGroup       *accel_group);
155
GtkAccelGroup* gtk_menu_get_accel_group	  (GtkMenu	       *menu);
156 157
void           gtk_menu_set_accel_path    (GtkMenu             *menu,
					   const gchar         *accel_path);
158 159 160 161 162

/* 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.
 */
163 164 165
void	   gtk_menu_attach_to_widget	  (GtkMenu	       *menu,
					   GtkWidget	       *attach_widget,
					   GtkMenuDetachFunc	detacher);
166 167 168 169 170 171
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.
 */
172
GtkWidget* gtk_menu_get_attach_widget	  (GtkMenu	       *menu);
173

174 175
void       gtk_menu_set_tearoff_state     (GtkMenu             *menu,
					   gboolean             torn_off);
176
gboolean   gtk_menu_get_tearoff_state     (GtkMenu             *menu);
177 178 179 180 181 182

/* 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);
183
G_CONST_RETURN gchar *gtk_menu_get_title  (GtkMenu             *menu);
Elliot Lee's avatar
Elliot Lee committed
184

185 186 187 188
void       gtk_menu_reorder_child         (GtkMenu             *menu,
                                           GtkWidget           *child,
                                           gint                position);

189 190
void	   gtk_menu_set_screen		  (GtkMenu	       *menu,
					   GdkScreen	       *screen);
191
#ifndef GTK_DISABLE_DEPRECATED
192
#define gtk_menu_append(menu,child)	gtk_menu_shell_append  ((GtkMenuShell *)(menu),(child))
193 194
#define gtk_menu_prepend(menu,child)    gtk_menu_shell_prepend ((GtkMenuShell *)(menu),(child))
#define gtk_menu_insert(menu,child,pos)	gtk_menu_shell_insert ((GtkMenuShell *)(menu),(child),(pos))
195 196
#endif /* GTK_DISABLE_DEPRECATED */

Elliot Lee's avatar
Elliot Lee committed
197 198 199 200 201 202
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_MENU_H__ */