Pileus Git - ~andy/gtk/blob - 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 G_BEGIN_DECLS
  36
  37 #define GTK_TYPE_MENU_ITEM              (gtk_menu_item_get_type ())
  38 #define GTK_MENU_ITEM(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItem))
  39 #define GTK_MENU_ITEM_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
  40 #define GTK_IS_MENU_ITEM(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MENU_ITEM))
  41 #define GTK_IS_MENU_ITEM_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU_ITEM))
  42 #define GTK_MENU_ITEM_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
  43
  44
  45 typedef struct _GtkMenuItem       GtkMenuItem;
  46 typedef struct _GtkMenuItemClass  GtkMenuItemClass;
  47
  48 struct _GtkMenuItem
  49 {
  50   GtkItem item;
  51
  52   GtkWidget *submenu;
  53   GdkWindow *event_window;
  54
  55   guint16 toggle_size;
  56   guint16 accelerator_width;
  57   gchar  *accel_path;
  58
  59   guint show_submenu_indicator : 1;
  60   guint submenu_placement : 1;
  61   guint submenu_direction : 1;
  62   guint right_justify: 1;
  63   guint timer_from_keypress : 1;
  64   guint from_menubar : 1;
  65   guint timer;
  66 };
  67
  68 struct _GtkMenuItemClass
  69 {
  70   GtkItemClass parent_class;
  71
  72   /* If the following flag is true, then we should always hide
  73    * the menu when the MenuItem is activated. Otherwise, the
  74    * it is up to the caller. For instance, when navigating
  75    * a menu with the keyboard, <Space> doesn't hide, but
  76    * <Return> does.
  77    */
  78   guint hide_on_activate : 1;
  79
  80   void (* activate)             (GtkMenuItem *menu_item);
  81   void (* activate_item)        (GtkMenuItem *menu_item);
  82   void (* toggle_size_request)  (GtkMenuItem *menu_item,
  83                                  gint        *requisition);
  84   void (* toggle_size_allocate) (GtkMenuItem *menu_item,
  85                                  gint         allocation);
  86
  87   /* Padding for future expansion */
  88   void (*_gtk_reserved1) (void);
  89   void (*_gtk_reserved2) (void);
  90   void (*_gtk_reserved3) (void);
  91   void (*_gtk_reserved4) (void);
  92 };
  93
  94
  95 GType      gtk_menu_item_get_type             (void) G_GNUC_CONST;
  96 GtkWidget* gtk_menu_item_new                  (void);
  97 GtkWidget* gtk_menu_item_new_with_label       (const gchar         *label);
  98 GtkWidget* gtk_menu_item_new_with_mnemonic    (const gchar         *label);
  99 void       gtk_menu_item_set_submenu          (GtkMenuItem         *menu_item,
 100                                                GtkWidget           *submenu);
 101 GtkWidget* gtk_menu_item_get_submenu          (GtkMenuItem         *menu_item);
 102 void       gtk_menu_item_remove_submenu       (GtkMenuItem         *menu_item);
 103 void       gtk_menu_item_select               (GtkMenuItem         *menu_item);
 104 void       gtk_menu_item_deselect             (GtkMenuItem         *menu_item);
 105 void       gtk_menu_item_activate             (GtkMenuItem         *menu_item);
 106 void       gtk_menu_item_toggle_size_request  (GtkMenuItem         *menu_item,
 107                                                gint                *requisition);
 108 void       gtk_menu_item_toggle_size_allocate (GtkMenuItem         *menu_item,
 109                                                gint                 allocation);
 110 void       gtk_menu_item_set_right_justified  (GtkMenuItem         *menu_item,
 111                                                gboolean             right_justified);
 112 gboolean   gtk_menu_item_get_right_justified  (GtkMenuItem         *menu_item);
 113 void       gtk_menu_item_set_accel_path       (GtkMenuItem         *menu_item,
 114                                                const gchar         *accel_path);
 115
 116 /* private */
 117 void      _gtk_menu_item_refresh_accel_path   (GtkMenuItem         *menu_item,
 118                                                const gchar         *prefix,
 119                                                GtkAccelGroup       *accel_group,
 120                                                gboolean             group_changed);
 121 gboolean  _gtk_menu_item_is_selectable        (GtkWidget           *menu_item);
 122 void      _gtk_menu_item_popup_submenu        (GtkWidget           *menu_item);
 123
 124 #ifndef GTK_DISABLE_DEPRECATED
 125 #define gtk_menu_item_right_justify(menu_item) gtk_menu_item_set_right_justified ((menu_item), TRUE)
 126 #endif /* GTK_DISABLE_DEPRECATED */
 127
 128 G_END_DECLS
 129
 130 #endif /* __GTK_MENU_ITEM_H__ */