gtkmenuitem.h 4.87 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Tim Janik's avatar
Tim Janik committed
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31 32 33 34
#ifndef __GTK_MENU_ITEM_H__
#define __GTK_MENU_ITEM_H__


#include <gdk/gdk.h>
#include <gtk/gtkitem.h>


35
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
36

Tim Janik's avatar
Tim Janik committed
37
#define	GTK_TYPE_MENU_ITEM		(gtk_menu_item_get_type ())
Manish Singh's avatar
Manish Singh committed
38 39 40 41 42
#define GTK_MENU_ITEM(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItem))
#define GTK_MENU_ITEM_CLASS(klass)	(G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
#define GTK_IS_MENU_ITEM(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MENU_ITEM))
#define GTK_IS_MENU_ITEM_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU_ITEM))
#define GTK_MENU_ITEM_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MENU_ITEM, GtkMenuItemClass))
Elliot Lee's avatar
Elliot Lee committed
43 44


Tim Janik's avatar
Tim Janik committed
45
typedef struct _GtkMenuItem	  GtkMenuItem;
Elliot Lee's avatar
Elliot Lee committed
46 47 48 49 50
typedef struct _GtkMenuItemClass  GtkMenuItemClass;

struct _GtkMenuItem
{
  GtkItem item;
Tim Janik's avatar
Tim Janik committed
51
  
Elliot Lee's avatar
Elliot Lee committed
52
  GtkWidget *submenu;
53
  GdkWindow *event_window;
Tim Janik's avatar
Tim Janik committed
54
  
Elliot Lee's avatar
Elliot Lee committed
55
  guint16 toggle_size;
56
  guint16 accelerator_width;
57
  gchar  *accel_path;
Tim Janik's avatar
Tim Janik committed
58
  
Elliot Lee's avatar
Elliot Lee committed
59 60 61 62
  guint show_submenu_indicator : 1;
  guint submenu_placement : 1;
  guint submenu_direction : 1;
  guint right_justify: 1;
63
  guint timer_from_keypress : 1;
Tim Janik's avatar
Tim Janik committed
64
  guint timer;
Elliot Lee's avatar
Elliot Lee committed
65 66 67 68 69
};

struct _GtkMenuItemClass
{
  GtkItemClass parent_class;
Tim Janik's avatar
Tim Janik committed
70
  
71 72 73 74 75 76 77
  /* If the following flag is true, then we should always hide
   * the menu when the MenuItem is activated. Otherwise, the 
   * it is up to the caller. For instance, when navigating
   * a menu with the keyboard, <Space> doesn't hide, but
   * <Return> does.
   */
  guint hide_on_activate : 1;
Tim Janik's avatar
Tim Janik committed
78
  
79 80 81
  void (* activate)             (GtkMenuItem *menu_item);
  void (* activate_item)        (GtkMenuItem *menu_item);
  void (* toggle_size_request)  (GtkMenuItem *menu_item,
82
				 gint        *requisition);
83
  void (* toggle_size_allocate) (GtkMenuItem *menu_item,
84
				 gint         allocation);
85 86 87 88 89 90

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
91 92 93
};


Manish Singh's avatar
Manish Singh committed
94
GType	   gtk_menu_item_get_type	      (void) G_GNUC_CONST;
95 96
GtkWidget* gtk_menu_item_new                  (void);
GtkWidget* gtk_menu_item_new_with_label       (const gchar         *label);
97
GtkWidget* gtk_menu_item_new_with_mnemonic    (const gchar         *label);
98 99
void       gtk_menu_item_set_submenu          (GtkMenuItem         *menu_item,
					       GtkWidget           *submenu);
100
GtkWidget* gtk_menu_item_get_submenu          (GtkMenuItem         *menu_item);
101 102 103 104 105
void       gtk_menu_item_remove_submenu       (GtkMenuItem         *menu_item);
void       gtk_menu_item_select               (GtkMenuItem         *menu_item);
void       gtk_menu_item_deselect             (GtkMenuItem         *menu_item);
void       gtk_menu_item_activate             (GtkMenuItem         *menu_item);
void       gtk_menu_item_toggle_size_request  (GtkMenuItem         *menu_item,
106
					       gint                *requisition);
107
void       gtk_menu_item_toggle_size_allocate (GtkMenuItem         *menu_item,
108
					       gint                 allocation);
109 110 111
void       gtk_menu_item_set_right_justified  (GtkMenuItem         *menu_item,
					       gboolean             right_justified);
gboolean   gtk_menu_item_get_right_justified  (GtkMenuItem         *menu_item);
112 113 114
void	   gtk_menu_item_set_accel_path	      (GtkMenuItem	   *menu_item,
					       const gchar	   *accel_path);

115
/* private */
116 117 118 119
void	  _gtk_menu_item_refresh_accel_path   (GtkMenuItem	   *menu_item,
					       const gchar	   *prefix,
					       GtkAccelGroup	   *accel_group,
					       gboolean		    group_changed);
120
gboolean  _gtk_menu_item_is_selectable        (GtkWidget           *menu_item);
121
void      _gtk_menu_item_popup_submenu        (GtkWidget           *menu_item);
Elliot Lee's avatar
Elliot Lee committed
122

123 124 125
#ifndef GTK_DISABLE_DEPRECATED
#define gtk_menu_item_right_justify(menu_item) gtk_menu_item_set_right_justified ((menu_item), TRUE)
#endif /* GTK_DISABLE_DEPRECATED */
Elliot Lee's avatar
Elliot Lee committed
126

127
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
128 129

#endif /* __GTK_MENU_ITEM_H__ */