Pileus Git - ~andy/gtk/blob - gtk/gtkmenushell.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_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_MENU_SHELL_H__
  32 #define __GTK_MENU_SHELL_H__
  33
  34
  35 #include <gtk/gtkcontainer.h>
  36
  37
  38 G_BEGIN_DECLS
  39
  40 #define GTK_TYPE_MENU_SHELL             (gtk_menu_shell_get_type ())
  41 #define GTK_MENU_SHELL(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_MENU_SHELL, GtkMenuShell))
  42 #define GTK_MENU_SHELL_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_MENU_SHELL, GtkMenuShellClass))
  43 #define GTK_IS_MENU_SHELL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_MENU_SHELL))
  44 #define GTK_IS_MENU_SHELL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_MENU_SHELL))
  45 #define GTK_MENU_SHELL_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_MENU_SHELL, GtkMenuShellClass))
  46
  47
  48 typedef struct _GtkMenuShell        GtkMenuShell;
  49 typedef struct _GtkMenuShellClass   GtkMenuShellClass;
  50 typedef struct _GtkMenuShellPrivate GtkMenuShellPrivate;
  51
  52 struct _GtkMenuShell
  53 {
  54   GtkContainer container;
  55
  56   /*< private >*/
  57   GtkMenuShellPrivate *priv;
  58 };
  59
  60 struct _GtkMenuShellClass
  61 {
  62   GtkContainerClass parent_class;
  63
  64   guint submenu_placement : 1;
  65
  66   void     (*deactivate)       (GtkMenuShell *menu_shell);
  67   void     (*selection_done)   (GtkMenuShell *menu_shell);
  68
  69   void     (*move_current)     (GtkMenuShell *menu_shell,
  70                                 GtkMenuDirectionType direction);
  71   void     (*activate_current) (GtkMenuShell *menu_shell,
  72                                 gboolean      force_hide);
  73   void     (*cancel)           (GtkMenuShell *menu_shell);
  74   void     (*select_item)      (GtkMenuShell *menu_shell,
  75                                 GtkWidget    *menu_item);
  76   void     (*insert)           (GtkMenuShell *menu_shell,
  77                                 GtkWidget    *child,
  78                                 gint          position);
  79   gint     (*get_popup_delay)  (GtkMenuShell *menu_shell);
  80   gboolean (*move_selected)    (GtkMenuShell *menu_shell,
  81                                 gint          distance);
  82
  83   /* Padding for future expansion */
  84   void (*_gtk_reserved1) (void);
  85   void (*_gtk_reserved2) (void);
  86   void (*_gtk_reserved3) (void);
  87   void (*_gtk_reserved4) (void);
  88 };
  89
  90
  91 GType    gtk_menu_shell_get_type       (void) G_GNUC_CONST;
  92
  93 void     gtk_menu_shell_append         (GtkMenuShell *menu_shell,
  94                                         GtkWidget    *child);
  95 void     gtk_menu_shell_prepend        (GtkMenuShell *menu_shell,
  96                                         GtkWidget    *child);
  97 void     gtk_menu_shell_insert         (GtkMenuShell *menu_shell,
  98                                         GtkWidget    *child,
  99                                         gint          position);
 100 void     gtk_menu_shell_deactivate     (GtkMenuShell *menu_shell);
 101 void     gtk_menu_shell_select_item    (GtkMenuShell *menu_shell,
 102                                         GtkWidget    *menu_item);
 103 void     gtk_menu_shell_deselect       (GtkMenuShell *menu_shell);
 104 void     gtk_menu_shell_activate_item  (GtkMenuShell *menu_shell,
 105                                         GtkWidget    *menu_item,
 106                                         gboolean      force_deactivate);
 107 void     gtk_menu_shell_select_first   (GtkMenuShell *menu_shell,
 108                                         gboolean      search_sensitive);
 109 void     gtk_menu_shell_cancel         (GtkMenuShell *menu_shell);
 110 gboolean gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell);
 111 void     gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
 112                                         gboolean      take_focus);
 113
 114 GtkWidget *gtk_menu_shell_get_selected_item (GtkMenuShell *menu_shell);
 115 GtkWidget *gtk_menu_shell_get_parent_shell  (GtkMenuShell *menu_shell);
 116
 117 G_END_DECLS
 118
 119 #endif /* __GTK_MENU_SHELL_H__ */