gtkmenuitem.h 5.55 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * 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
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * 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_H_INSIDE__) && !defined (GTK_COMPILATION)
28 29 30
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34 35 36 37
#ifndef __GTK_MENU_ITEM_H__
#define __GTK_MENU_ITEM_H__


#include <gtk/gtkitem.h>


38
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
39

Tim Janik's avatar
Tim Janik committed
40
#define	GTK_TYPE_MENU_ITEM		(gtk_menu_item_get_type ())
Manish Singh's avatar
Manish Singh committed
41 42 43 44 45
#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
46 47


Tim Janik's avatar
Tim Janik committed
48
typedef struct _GtkMenuItem	  GtkMenuItem;
Elliot Lee's avatar
Elliot Lee committed
49 50 51 52 53
typedef struct _GtkMenuItemClass  GtkMenuItemClass;

struct _GtkMenuItem
{
  GtkItem item;
Tim Janik's avatar
Tim Janik committed
54 55 56 57 58 59 60 61

  GtkWidget *GSEAL (submenu);
  GdkWindow *GSEAL (event_window);

  guint16 GSEAL (toggle_size);
  guint16 GSEAL (accelerator_width);
  gchar  *GSEAL (accel_path);

62 63 64 65 66 67
  guint GSEAL (show_submenu_indicator) : 1;
  guint GSEAL (submenu_placement) : 1;
  guint GSEAL (submenu_direction) : 1;
  guint GSEAL (right_justify): 1;
  guint GSEAL (timer_from_keypress) : 1;
  guint GSEAL (from_menubar) : 1;
Tim Janik's avatar
Tim Janik committed
68
  guint GSEAL (timer);
Elliot Lee's avatar
Elliot Lee committed
69 70 71 72 73
};

struct _GtkMenuItemClass
{
  GtkItemClass parent_class;
Tim Janik's avatar
Tim Janik committed
74
  
75 76 77 78 79 80 81
  /* 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
82
  
83 84 85
  void (* activate)             (GtkMenuItem *menu_item);
  void (* activate_item)        (GtkMenuItem *menu_item);
  void (* toggle_size_request)  (GtkMenuItem *menu_item,
86
				 gint        *requisition);
87
  void (* toggle_size_allocate) (GtkMenuItem *menu_item,
88
				 gint         allocation);
89 90 91
  void (* set_label)            (GtkMenuItem *menu_item,
				 const gchar *label);
  G_CONST_RETURN gchar *(* get_label) (GtkMenuItem *menu_item);
92 93 94 95

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
Elliot Lee's avatar
Elliot Lee committed
96 97 98
};


Manish Singh's avatar
Manish Singh committed
99
GType	   gtk_menu_item_get_type	      (void) G_GNUC_CONST;
100 101
GtkWidget* gtk_menu_item_new                  (void);
GtkWidget* gtk_menu_item_new_with_label       (const gchar         *label);
102
GtkWidget* gtk_menu_item_new_with_mnemonic    (const gchar         *label);
103 104
void       gtk_menu_item_set_submenu          (GtkMenuItem         *menu_item,
					       GtkWidget           *submenu);
105
GtkWidget* gtk_menu_item_get_submenu          (GtkMenuItem         *menu_item);
106 107 108 109
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,
110
					       gint                *requisition);
111
void       gtk_menu_item_toggle_size_allocate (GtkMenuItem         *menu_item,
112
					       gint                 allocation);
113 114 115
void       gtk_menu_item_set_right_justified  (GtkMenuItem         *menu_item,
					       gboolean             right_justified);
gboolean   gtk_menu_item_get_right_justified  (GtkMenuItem         *menu_item);
116 117
void	   gtk_menu_item_set_accel_path	      (GtkMenuItem	   *menu_item,
					       const gchar	   *accel_path);
Tim Janik's avatar
Tim Janik committed
118
G_CONST_RETURN gchar* gtk_menu_item_get_accel_path (GtkMenuItem    *menu_item);
119

120 121 122 123 124 125 126 127
void       gtk_menu_item_set_label            (GtkMenuItem         *menu_item,
 					       const gchar         *label);
G_CONST_RETURN gchar *gtk_menu_item_get_label (GtkMenuItem         *menu_item);

void       gtk_menu_item_set_use_underline    (GtkMenuItem         *menu_item,
 					       gboolean             setting);
gboolean   gtk_menu_item_get_use_underline    (GtkMenuItem         *menu_item);

128
/* private */
129 130 131 132
void	  _gtk_menu_item_refresh_accel_path   (GtkMenuItem	   *menu_item,
					       const gchar	   *prefix,
					       GtkAccelGroup	   *accel_group,
					       gboolean		    group_changed);
133
gboolean  _gtk_menu_item_is_selectable        (GtkWidget           *menu_item);
134 135 136
void      _gtk_menu_item_popup_submenu        (GtkWidget           *menu_item,
                                               gboolean             with_delay);
void      _gtk_menu_item_popdown_submenu      (GtkWidget           *menu_item);
Elliot Lee's avatar
Elliot Lee committed
137

138
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
139 140

#endif /* __GTK_MENU_ITEM_H__ */