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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_MENU_ITEM_H__
  26 #define __GTK_MENU_ITEM_H__
  27
  28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  29 #error "Only <gtk/gtk.h> can be included directly."
  30 #endif
  31
  32 #include <gtk/gtkbin.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 typedef struct _GtkMenuItemPrivate GtkMenuItemPrivate;
  48
  49 struct _GtkMenuItem
  50 {
  51   GtkBin bin;
  52
  53   /*< private >*/
  54   GtkMenuItemPrivate *priv;
  55 };
  56
  57 struct _GtkMenuItemClass
  58 {
  59   GtkBinClass parent_class;
  60
  61   /* If the following flag is true, then we should always
  62    * hide the menu when the MenuItem is activated. Otherwise,
  63    * it is up to the caller. For instance, when navigating
  64    * a menu with the keyboard, <Space> doesn't hide, but
  65    * <Return> does.
  66    */
  67   guint hide_on_activate : 1;
  68
  69   void (* activate)             (GtkMenuItem *menu_item);
  70   void (* activate_item)        (GtkMenuItem *menu_item);
  71   void (* toggle_size_request)  (GtkMenuItem *menu_item,
  72                                  gint        *requisition);
  73   void (* toggle_size_allocate) (GtkMenuItem *menu_item,
  74                                  gint         allocation);
  75   void (* set_label)            (GtkMenuItem *menu_item,
  76                                  const gchar *label);
  77   const gchar * (* get_label)   (GtkMenuItem *menu_item);
  78
  79   void (* select)               (GtkMenuItem *menu_item);
  80   void (* deselect)             (GtkMenuItem *menu_item);
  81
  82   /* Padding for future expansion */
  83   void (*_gtk_reserved1) (void);
  84   void (*_gtk_reserved2) (void);
  85   void (*_gtk_reserved3) (void);
  86   void (*_gtk_reserved4) (void);
  87 };
  88
  89
  90 GType      gtk_menu_item_get_type             (void) G_GNUC_CONST;
  91
  92 GtkWidget* gtk_menu_item_new                  (void);
  93 GtkWidget* gtk_menu_item_new_with_label       (const gchar         *label);
  94 GtkWidget* gtk_menu_item_new_with_mnemonic    (const gchar         *label);
  95 void       gtk_menu_item_set_submenu          (GtkMenuItem         *menu_item,
  96                                                GtkWidget           *submenu);
  97 GtkWidget* gtk_menu_item_get_submenu          (GtkMenuItem         *menu_item);
  98 void       gtk_menu_item_select               (GtkMenuItem         *menu_item);
  99 void       gtk_menu_item_deselect             (GtkMenuItem         *menu_item);
 100 void       gtk_menu_item_activate             (GtkMenuItem         *menu_item);
 101 void       gtk_menu_item_toggle_size_request  (GtkMenuItem         *menu_item,
 102                                                gint                *requisition);
 103 void       gtk_menu_item_toggle_size_allocate (GtkMenuItem         *menu_item,
 104                                                gint                 allocation);
 105 GDK_DEPRECATED_IN_3_2
 106 void       gtk_menu_item_set_right_justified  (GtkMenuItem         *menu_item,
 107                                                gboolean             right_justified);
 108 GDK_DEPRECATED_IN_3_2
 109 gboolean   gtk_menu_item_get_right_justified  (GtkMenuItem         *menu_item);
 110 void          gtk_menu_item_set_accel_path    (GtkMenuItem         *menu_item,
 111                                                const gchar         *accel_path);
 112 const gchar * gtk_menu_item_get_accel_path    (GtkMenuItem    *menu_item);
 113
 114 void          gtk_menu_item_set_label         (GtkMenuItem         *menu_item,
 115                                                const gchar         *label);
 116 const gchar * gtk_menu_item_get_label         (GtkMenuItem         *menu_item);
 117
 118 void       gtk_menu_item_set_use_underline    (GtkMenuItem         *menu_item,
 119                                                gboolean             setting);
 120 gboolean   gtk_menu_item_get_use_underline    (GtkMenuItem         *menu_item);
 121
 122 void       gtk_menu_item_set_reserve_indicator (GtkMenuItem        *menu_item,
 123                                                 gboolean            reserve);
 124 gboolean   gtk_menu_item_get_reserve_indicator (GtkMenuItem        *menu_item);
 125
 126 G_END_DECLS
 127
 128 #endif /* __GTK_MENU_ITEM_H__ */