1/* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20/*
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 */
26
27#ifndef __GTK_MENU_ITEM_H__
28#define __GTK_MENU_ITEM_H__
29
30
31#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
32#error "Only <gtk/gtk.h> can be included directly."
33#endif
34
35#include <gtk/gtkitem.h>
36
37
38G_BEGIN_DECLS
39
40#define GTK_TYPE_MENU_ITEM (gtk_menu_item_get_type ())
41#define GTK_MENU_ITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItem))
42#define GTK_MENU_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
43#define GTK_IS_MENU_ITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MENU_ITEM))
44#define GTK_IS_MENU_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU_ITEM))
45#define GTK_MENU_ITEM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
46
47
48typedef struct _GtkMenuItem GtkMenuItem;
49typedef struct _GtkMenuItemClass GtkMenuItemClass;
50
51struct _GtkMenuItem
52{
53 GtkItem item;
54
55 GtkWidget *GSEAL (submenu);
56 GdkWindow *GSEAL (event_window);
57
58 guint16 GSEAL (toggle_size);
59 guint16 GSEAL (accelerator_width);
60 gchar *GSEAL (accel_path);
61
62 guint GSEAL (show_submenu_indicator) : 1;
63 guint GSEAL (submenu_placement) : 1;
64 guint GSEAL (submenu_direction) : 1;
65 guint GSEAL (right_justify): 1;
66 guint GSEAL (timer_from_keypress) : 1;
67 guint GSEAL (from_menubar) : 1;
68 guint GSEAL (timer);
69};
70
71struct _GtkMenuItemClass
72{
73 GtkItemClass parent_class;
74
75 /* If the following flag is true, then we should always hide
76 * the menu when the MenuItem is activated. Otherwise, the
77 * it is up to the caller. For instance, when navigating
78 * a menu with the keyboard, <Space> doesn't hide, but
79 * <Return> does.
80 */
81 guint hide_on_activate : 1;
82
83 void (* activate) (GtkMenuItem *menu_item);
84 void (* activate_item) (GtkMenuItem *menu_item);
85 void (* toggle_size_request) (GtkMenuItem *menu_item,
86 gint *requisition);
87 void (* toggle_size_allocate) (GtkMenuItem *menu_item,
88 gint allocation);
89 void (* set_label) (GtkMenuItem *menu_item,
90 const gchar *label);
91 const gchar *(* get_label) (GtkMenuItem *menu_item);
92
93 /* Padding for future expansion */
94 void (*_gtk_reserved1) (void);
95 void (*_gtk_reserved2) (void);
96};
97
98
99GType gtk_menu_item_get_type (void) G_GNUC_CONST;
100GtkWidget* gtk_menu_item_new (void);
101GtkWidget* gtk_menu_item_new_with_label (const gchar *label);
102GtkWidget* gtk_menu_item_new_with_mnemonic (const gchar *label);
103void gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
104 GtkWidget *submenu);
105GtkWidget* gtk_menu_item_get_submenu (GtkMenuItem *menu_item);
106void gtk_menu_item_select (GtkMenuItem *menu_item);
107void gtk_menu_item_deselect (GtkMenuItem *menu_item);
108void gtk_menu_item_activate (GtkMenuItem *menu_item);
109void gtk_menu_item_toggle_size_request (GtkMenuItem *menu_item,
110 gint *requisition);
111void gtk_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
112 gint allocation);
113void gtk_menu_item_set_right_justified (GtkMenuItem *menu_item,
114 gboolean right_justified);
115gboolean gtk_menu_item_get_right_justified (GtkMenuItem *menu_item);
116void gtk_menu_item_set_accel_path (GtkMenuItem *menu_item,
117 const gchar *accel_path);
118const gchar* gtk_menu_item_get_accel_path (GtkMenuItem *menu_item);
119
120void gtk_menu_item_set_label (GtkMenuItem *menu_item,
121 const gchar *label);
122const gchar *gtk_menu_item_get_label (GtkMenuItem *menu_item);
123
124void gtk_menu_item_set_use_underline (GtkMenuItem *menu_item,
125 gboolean setting);
126gboolean gtk_menu_item_get_use_underline (GtkMenuItem *menu_item);
127
128/* private */
129void _gtk_menu_item_refresh_accel_path (GtkMenuItem *menu_item,
130 const gchar *prefix,
131 GtkAccelGroup *accel_group,
132 gboolean group_changed);
133gboolean _gtk_menu_item_is_selectable (GtkWidget *menu_item);
134void _gtk_menu_item_popup_submenu (GtkWidget *menu_item,
135 gboolean with_delay);
136void _gtk_menu_item_popdown_submenu (GtkWidget *menu_item);
137
138#ifndef GTK_DISABLE_DEPRECATED
139void gtk_menu_item_remove_submenu (GtkMenuItem *menu_item);
140#define gtk_menu_item_right_justify(menu_item) gtk_menu_item_set_right_justified ((menu_item), TRUE)
141#endif /* GTK_DISABLE_DEPRECATED */
142
143G_END_DECLS
144
145#endif /* __GTK_MENU_ITEM_H__ */
146