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