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