]> Pileus Git - ~andy/gtk/blob - gtk/gtkmenuitem.h
a879bce7419f537fe4c6a81d0ce4bcbc56289b2c
[~andy/gtk] / gtk / gtkmenuitem.h
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 #include <gdk/gdk.h>
32 #include <gtk/gtkitem.h>
33
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif /* __cplusplus */
38
39
40 #define GTK_TYPE_MENU_ITEM              (gtk_menu_item_get_type ())
41 #define GTK_MENU_ITEM(obj)              (GTK_CHECK_CAST ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItem))
42 #define GTK_MENU_ITEM_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
43 #define GTK_IS_MENU_ITEM(obj)           (GTK_CHECK_TYPE ((obj), GTK_TYPE_MENU_ITEM))
44 #define GTK_IS_MENU_ITEM_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU_ITEM))
45 #define GTK_MENU_ITEM_GET_CLASS(obj)    (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
46
47
48 typedef struct _GtkMenuItem       GtkMenuItem;
49 typedef struct _GtkMenuItemClass  GtkMenuItemClass;
50
51 struct _GtkMenuItem
52 {
53   GtkItem item;
54   
55   GtkWidget *submenu;
56   
57   guint   accelerator_signal;
58   guint16 toggle_size;
59   guint16 accelerator_width;
60   
61   guint show_toggle_indicator : 1;
62   guint show_submenu_indicator : 1;
63   guint submenu_placement : 1;
64   guint submenu_direction : 1;
65   guint right_justify: 1;
66   guint timer;
67 };
68
69 struct _GtkMenuItemClass
70 {
71   GtkItemClass parent_class;
72   
73   /* If the following flag is true, then we should always hide
74    * the menu when the MenuItem is activated. Otherwise, the 
75    * it is up to the caller. For instance, when navigating
76    * a menu with the keyboard, <Space> doesn't hide, but
77    * <Return> does.
78    */
79   guint hide_on_activate : 1;
80   
81   void (* activate)             (GtkMenuItem *menu_item);
82   void (* activate_item)        (GtkMenuItem *menu_item);
83   void (* toggle_size_request)  (GtkMenuItem *menu_item,
84                                  gint        *requisition);
85   void (* toggle_size_allocate) (GtkMenuItem *menu_item,
86                                  gint         allocation);
87 };
88
89
90 GtkType    gtk_menu_item_get_type             (void) G_GNUC_CONST;
91 GtkWidget* gtk_menu_item_new                  (void);
92 GtkWidget* gtk_menu_item_new_with_label       (const gchar         *label);
93 void       gtk_menu_item_set_submenu          (GtkMenuItem         *menu_item,
94                                                GtkWidget           *submenu);
95 void       gtk_menu_item_remove_submenu       (GtkMenuItem         *menu_item);
96 void       gtk_menu_item_set_placement        (GtkMenuItem         *menu_item,
97                                                GtkSubmenuPlacement  placement);
98 void       gtk_menu_item_configure            (GtkMenuItem         *menu_item,
99                                                gboolean             show_toggle_indicator,
100                                                gboolean             show_submenu_indicator);
101 void       gtk_menu_item_select               (GtkMenuItem         *menu_item);
102 void       gtk_menu_item_deselect             (GtkMenuItem         *menu_item);
103 void       gtk_menu_item_activate             (GtkMenuItem         *menu_item);
104 void       gtk_menu_item_toggle_size_request  (GtkMenuItem         *menu_item,
105                                                gint                *requisition);
106 void       gtk_menu_item_toggle_size_allocate (GtkMenuItem         *menu_item,
107                                                gint                 allocation);
108 void       gtk_menu_item_right_justify        (GtkMenuItem         *menu_item);
109
110
111
112 #ifdef __cplusplus
113 }
114 #endif /* __cplusplus */
115
116
117 #endif /* __GTK_MENU_ITEM_H__ */