gtkmenu.h 7.62 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
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
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

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

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34
#ifndef __GTK_MENU_H__
#define __GTK_MENU_H__


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


39
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
40

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


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

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

struct _GtkMenu
{
Tim Janik's avatar
Tim Janik committed
62
  GtkMenuShell GSEAL (menu_shell);
Tim Janik's avatar
Tim Janik committed
63
  
Tim Janik's avatar
Tim Janik committed
64 65
  GtkWidget *GSEAL (parent_menu_item);
  GtkWidget *GSEAL (old_active_menu_item);
66

Tim Janik's avatar
Tim Janik committed
67 68 69 70
  GtkAccelGroup *GSEAL (accel_group);
  gchar         *GSEAL (accel_path);
  GtkMenuPositionFunc GSEAL (position_func);
  gpointer GSEAL (position_func_data);
71

Tim Janik's avatar
Tim Janik committed
72
  guint GSEAL (toggle_size);
73 74 75 76
  /* 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
   */
Tim Janik's avatar
Tim Janik committed
77
  GtkWidget *GSEAL (toplevel);
78
  
Tim Janik's avatar
Tim Janik committed
79 80 81 82 83 84 85 86 87 88 89 90
  GtkWidget *GSEAL (tearoff_window);
  GtkWidget *GSEAL (tearoff_hbox);
  GtkWidget *GSEAL (tearoff_scrollbar);
  GtkAdjustment *GSEAL (tearoff_adjustment);

  GdkWindow *GSEAL (view_window);
  GdkWindow *GSEAL (bin_window);

  gint GSEAL (scroll_offset);
  gint GSEAL (saved_scroll_offset);
  gint GSEAL (scroll_step);
  guint GSEAL (timeout_id);
91
  
92 93 94
  /* When a submenu of this menu is popped up, motion in this
   * region is ignored
   */
Tim Janik's avatar
Tim Janik committed
95 96
  GdkRegion *GSEAL (navigation_region);
  guint GSEAL (navigation_timeout);
97

98 99
  guint GSEAL (needs_destruction_ref_count) : 1;
  guint GSEAL (torn_off) : 1;
100 101 102
  /* The tearoff is active when it is torn off and the not-torn-off
   * menu is not popped up.
   */
103
  guint GSEAL (tearoff_active) : 1;
104

105
  guint GSEAL (scroll_fast) : 1;
106

107 108 109 110
  guint GSEAL (upper_arrow_visible) : 1;
  guint GSEAL (lower_arrow_visible) : 1;
  guint GSEAL (upper_arrow_prelight) : 1;
  guint GSEAL (lower_arrow_prelight) : 1;
Elliot Lee's avatar
Elliot Lee committed
111 112 113 114 115
};

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

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


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

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

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

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

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

151
/* set/get the accelerator group that holds global accelerators (should
152 153 154
 * 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
155
					   GtkAccelGroup       *accel_group);
156
GtkAccelGroup* gtk_menu_get_accel_group	  (GtkMenu	       *menu);
157 158
void           gtk_menu_set_accel_path    (GtkMenu             *menu,
					   const gchar         *accel_path);
Tim Janik's avatar
Tim Janik committed
159
const gchar*   gtk_menu_get_accel_path    (GtkMenu             *menu);
160 161 162 163 164

/* 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.
 */
Tim Janik's avatar
Tim Janik committed
165 166 167
void	   gtk_menu_attach_to_widget	  (GtkMenu	       *menu,
					   GtkWidget	       *attach_widget,
					   GtkMenuDetachFunc	detacher);
168 169 170 171 172 173
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.
 */
174
GtkWidget* gtk_menu_get_attach_widget	  (GtkMenu	       *menu);
175

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

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

187 188 189 190
void       gtk_menu_reorder_child         (GtkMenu             *menu,
                                           GtkWidget           *child,
                                           gint                position);

191 192
void	   gtk_menu_set_screen		  (GtkMenu	       *menu,
					   GdkScreen	       *screen);
193 194 195 196 197 198 199 200

void       gtk_menu_attach                (GtkMenu             *menu,
                                           GtkWidget           *child,
                                           guint                left_attach,
                                           guint                right_attach,
                                           guint                top_attach,
                                           guint                bottom_attach);

201 202
void       gtk_menu_set_monitor           (GtkMenu             *menu,
                                           gint                 monitor_num);
Tim Janik's avatar
Tim Janik committed
203
gint       gtk_menu_get_monitor           (GtkMenu             *menu);
204
GList*     gtk_menu_get_for_attach_widget (GtkWidget           *widget); 
205

206
#ifndef GTK_DISABLE_DEPRECATED
207
#define gtk_menu_append(menu,child)	gtk_menu_shell_append  ((GtkMenuShell *)(menu),(child))
208 209
#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))
210 211
#endif /* GTK_DISABLE_DEPRECATED */

212
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
213 214

#endif /* __GTK_MENU_H__ */